Enum value maps for TargetChange_TargetChangeType.
var (
TargetChange_TargetChangeType_name = map[int32]string{
0: "NO_CHANGE",
1: "ADD",
2: "REMOVE",
3: "CURRENT",
4: "RESET",
}
TargetChange_TargetChangeType_value = map[string]int32{
"NO_CHANGE": 0,
"ADD": 1,
"REMOVE": 2,
"CURRENT": 3,
"RESET": 4,
}
)
Enum value maps for StructuredQuery_Direction.
var (
StructuredQuery_Direction_name = map[int32]string{
0: "DIRECTION_UNSPECIFIED",
1: "ASCENDING",
2: "DESCENDING",
}
StructuredQuery_Direction_value = map[string]int32{
"DIRECTION_UNSPECIFIED": 0,
"ASCENDING": 1,
"DESCENDING": 2,
}
)
Enum value maps for StructuredQuery_CompositeFilter_Operator.
var (
StructuredQuery_CompositeFilter_Operator_name = map[int32]string{
0: "OPERATOR_UNSPECIFIED",
1: "AND",
}
StructuredQuery_CompositeFilter_Operator_value = map[string]int32{
"OPERATOR_UNSPECIFIED": 0,
"AND": 1,
}
)
Enum value maps for StructuredQuery_FieldFilter_Operator.
var (
StructuredQuery_FieldFilter_Operator_name = map[int32]string{
0: "OPERATOR_UNSPECIFIED",
1: "LESS_THAN",
2: "LESS_THAN_OR_EQUAL",
3: "GREATER_THAN",
4: "GREATER_THAN_OR_EQUAL",
5: "EQUAL",
6: "NOT_EQUAL",
7: "ARRAY_CONTAINS",
8: "IN",
9: "ARRAY_CONTAINS_ANY",
10: "NOT_IN",
}
StructuredQuery_FieldFilter_Operator_value = map[string]int32{
"OPERATOR_UNSPECIFIED": 0,
"LESS_THAN": 1,
"LESS_THAN_OR_EQUAL": 2,
"GREATER_THAN": 3,
"GREATER_THAN_OR_EQUAL": 4,
"EQUAL": 5,
"NOT_EQUAL": 6,
"ARRAY_CONTAINS": 7,
"IN": 8,
"ARRAY_CONTAINS_ANY": 9,
"NOT_IN": 10,
}
)
Enum value maps for StructuredQuery_UnaryFilter_Operator.
var (
StructuredQuery_UnaryFilter_Operator_name = map[int32]string{
0: "OPERATOR_UNSPECIFIED",
2: "IS_NAN",
3: "IS_NULL",
4: "IS_NOT_NAN",
5: "IS_NOT_NULL",
}
StructuredQuery_UnaryFilter_Operator_value = map[string]int32{
"OPERATOR_UNSPECIFIED": 0,
"IS_NAN": 2,
"IS_NULL": 3,
"IS_NOT_NAN": 4,
"IS_NOT_NULL": 5,
}
)
Enum value maps for DocumentTransform_FieldTransform_ServerValue.
var (
DocumentTransform_FieldTransform_ServerValue_name = map[int32]string{
0: "SERVER_VALUE_UNSPECIFIED",
1: "REQUEST_TIME",
}
DocumentTransform_FieldTransform_ServerValue_value = map[string]int32{
"SERVER_VALUE_UNSPECIFIED": 0,
"REQUEST_TIME": 1,
}
)
var File_google_firestore_v1beta1_common_proto protoreflect.FileDescriptor
var File_google_firestore_v1beta1_document_proto protoreflect.FileDescriptor
var File_google_firestore_v1beta1_firestore_proto protoreflect.FileDescriptor
var File_google_firestore_v1beta1_query_proto protoreflect.FileDescriptor
var File_google_firestore_v1beta1_write_proto protoreflect.FileDescriptor
func RegisterFirestoreServer(s *grpc.Server, srv FirestoreServer)
An array value.
type ArrayValue struct {
// Values in the array.
Values []*Value `protobuf:"bytes,1,rep,name=values,proto3" json:"values,omitempty"`
// contains filtered or unexported fields
}
func (*ArrayValue) Descriptor() ([]byte, []int)
Deprecated: Use ArrayValue.ProtoReflect.Descriptor instead.
func (x *ArrayValue) GetValues() []*Value
func (*ArrayValue) ProtoMessage()
func (x *ArrayValue) ProtoReflect() protoreflect.Message
func (x *ArrayValue) Reset()
func (x *ArrayValue) String() string
The request for [Firestore.BatchGetDocuments][google.firestore.v1beta1.Firestore.BatchGetDocuments].
type BatchGetDocumentsRequest struct {
// Required. The database name. In the format:
// `projects/{project_id}/databases/{database_id}`.
Database string `protobuf:"bytes,1,opt,name=database,proto3" json:"database,omitempty"`
// The names of the documents to retrieve. In the format:
// `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
// The request will fail if any of the document is not a child resource of the
// given `database`. Duplicate names will be elided.
Documents []string `protobuf:"bytes,2,rep,name=documents,proto3" json:"documents,omitempty"`
// The fields to return. If not set, returns all fields.
//
// If a document has a field that is not present in this mask, that field will
// not be returned in the response.
Mask *DocumentMask `protobuf:"bytes,3,opt,name=mask,proto3" json:"mask,omitempty"`
// The consistency mode for this transaction.
// If not set, defaults to strong consistency.
//
// Types that are assignable to ConsistencySelector:
// *BatchGetDocumentsRequest_Transaction
// *BatchGetDocumentsRequest_NewTransaction
// *BatchGetDocumentsRequest_ReadTime
ConsistencySelector isBatchGetDocumentsRequest_ConsistencySelector `protobuf_oneof:"consistency_selector"`
// contains filtered or unexported fields
}
func (*BatchGetDocumentsRequest) Descriptor() ([]byte, []int)
Deprecated: Use BatchGetDocumentsRequest.ProtoReflect.Descriptor instead.
func (m *BatchGetDocumentsRequest) GetConsistencySelector() isBatchGetDocumentsRequest_ConsistencySelector
func (x *BatchGetDocumentsRequest) GetDatabase() string
func (x *BatchGetDocumentsRequest) GetDocuments() []string
func (x *BatchGetDocumentsRequest) GetMask() *DocumentMask
func (x *BatchGetDocumentsRequest) GetNewTransaction() *TransactionOptions
func (x *BatchGetDocumentsRequest) GetReadTime() *timestamppb.Timestamp
func (x *BatchGetDocumentsRequest) GetTransaction() []byte
func (*BatchGetDocumentsRequest) ProtoMessage()
func (x *BatchGetDocumentsRequest) ProtoReflect() protoreflect.Message
func (x *BatchGetDocumentsRequest) Reset()
func (x *BatchGetDocumentsRequest) String() string
type BatchGetDocumentsRequest_NewTransaction struct {
// Starts a new transaction and reads the documents.
// Defaults to a read-only transaction.
// The new transaction ID will be returned as the first response in the
// stream.
NewTransaction *TransactionOptions `protobuf:"bytes,5,opt,name=new_transaction,json=newTransaction,proto3,oneof"`
}
type BatchGetDocumentsRequest_ReadTime struct {
// Reads documents as they were at the given time.
// This may not be older than 270 seconds.
ReadTime *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=read_time,json=readTime,proto3,oneof"`
}
type BatchGetDocumentsRequest_Transaction struct {
// Reads documents in a transaction.
Transaction []byte `protobuf:"bytes,4,opt,name=transaction,proto3,oneof"`
}
The streamed response for [Firestore.BatchGetDocuments][google.firestore.v1beta1.Firestore.BatchGetDocuments].
type BatchGetDocumentsResponse struct {
// A single result.
// This can be empty if the server is just returning a transaction.
//
// Types that are assignable to Result:
// *BatchGetDocumentsResponse_Found
// *BatchGetDocumentsResponse_Missing
Result isBatchGetDocumentsResponse_Result `protobuf_oneof:"result"`
// The transaction that was started as part of this request.
// Will only be set in the first response, and only if
// [BatchGetDocumentsRequest.new_transaction][google.firestore.v1beta1.BatchGetDocumentsRequest.new_transaction] was set in the request.
Transaction []byte `protobuf:"bytes,3,opt,name=transaction,proto3" json:"transaction,omitempty"`
// The time at which the document was read.
// This may be monotically increasing, in this case the previous documents in
// the result stream are guaranteed not to have changed between their
// read_time and this one.
ReadTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=read_time,json=readTime,proto3" json:"read_time,omitempty"`
// contains filtered or unexported fields
}
func (*BatchGetDocumentsResponse) Descriptor() ([]byte, []int)
Deprecated: Use BatchGetDocumentsResponse.ProtoReflect.Descriptor instead.
func (x *BatchGetDocumentsResponse) GetFound() *Document
func (x *BatchGetDocumentsResponse) GetMissing() string
func (x *BatchGetDocumentsResponse) GetReadTime() *timestamppb.Timestamp
func (m *BatchGetDocumentsResponse) GetResult() isBatchGetDocumentsResponse_Result
func (x *BatchGetDocumentsResponse) GetTransaction() []byte
func (*BatchGetDocumentsResponse) ProtoMessage()
func (x *BatchGetDocumentsResponse) ProtoReflect() protoreflect.Message
func (x *BatchGetDocumentsResponse) Reset()
func (x *BatchGetDocumentsResponse) String() string
type BatchGetDocumentsResponse_Found struct {
// A document that was requested.
Found *Document `protobuf:"bytes,1,opt,name=found,proto3,oneof"`
}
type BatchGetDocumentsResponse_Missing struct {
// A document name that was requested but does not exist. In the format:
// `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
Missing string `protobuf:"bytes,2,opt,name=missing,proto3,oneof"`
}
The request for [Firestore.BatchWrite][google.firestore.v1beta1.Firestore.BatchWrite].
type BatchWriteRequest struct {
// Required. The database name. In the format:
// `projects/{project_id}/databases/{database_id}`.
Database string `protobuf:"bytes,1,opt,name=database,proto3" json:"database,omitempty"`
// The writes to apply.
//
// Method does not apply writes atomically and does not guarantee ordering.
// Each write succeeds or fails independently. You cannot write to the same
// document more than once per request.
Writes []*Write `protobuf:"bytes,2,rep,name=writes,proto3" json:"writes,omitempty"`
// Labels associated with this batch write.
Labels map[string]string `protobuf:"bytes,3,rep,name=labels,proto3" json:"labels,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// contains filtered or unexported fields
}
func (*BatchWriteRequest) Descriptor() ([]byte, []int)
Deprecated: Use BatchWriteRequest.ProtoReflect.Descriptor instead.
func (x *BatchWriteRequest) GetDatabase() string
func (x *BatchWriteRequest) GetLabels() map[string]string
func (x *BatchWriteRequest) GetWrites() []*Write
func (*BatchWriteRequest) ProtoMessage()
func (x *BatchWriteRequest) ProtoReflect() protoreflect.Message
func (x *BatchWriteRequest) Reset()
func (x *BatchWriteRequest) String() string
The response from [Firestore.BatchWrite][google.firestore.v1beta1.Firestore.BatchWrite].
type BatchWriteResponse struct {
// The result of applying the writes.
//
// This i-th write result corresponds to the i-th write in the
// request.
WriteResults []*WriteResult `protobuf:"bytes,1,rep,name=write_results,json=writeResults,proto3" json:"write_results,omitempty"`
// The status of applying the writes.
//
// This i-th write status corresponds to the i-th write in the
// request.
Status []*status.Status `protobuf:"bytes,2,rep,name=status,proto3" json:"status,omitempty"`
// contains filtered or unexported fields
}
func (*BatchWriteResponse) Descriptor() ([]byte, []int)
Deprecated: Use BatchWriteResponse.ProtoReflect.Descriptor instead.
func (x *BatchWriteResponse) GetStatus() []*status.Status
func (x *BatchWriteResponse) GetWriteResults() []*WriteResult
func (*BatchWriteResponse) ProtoMessage()
func (x *BatchWriteResponse) ProtoReflect() protoreflect.Message
func (x *BatchWriteResponse) Reset()
func (x *BatchWriteResponse) String() string
The request for [Firestore.BeginTransaction][google.firestore.v1beta1.Firestore.BeginTransaction].
type BeginTransactionRequest struct {
// Required. The database name. In the format:
// `projects/{project_id}/databases/{database_id}`.
Database string `protobuf:"bytes,1,opt,name=database,proto3" json:"database,omitempty"`
// The options for the transaction.
// Defaults to a read-write transaction.
Options *TransactionOptions `protobuf:"bytes,2,opt,name=options,proto3" json:"options,omitempty"`
// contains filtered or unexported fields
}
func (*BeginTransactionRequest) Descriptor() ([]byte, []int)
Deprecated: Use BeginTransactionRequest.ProtoReflect.Descriptor instead.
func (x *BeginTransactionRequest) GetDatabase() string
func (x *BeginTransactionRequest) GetOptions() *TransactionOptions
func (*BeginTransactionRequest) ProtoMessage()
func (x *BeginTransactionRequest) ProtoReflect() protoreflect.Message
func (x *BeginTransactionRequest) Reset()
func (x *BeginTransactionRequest) String() string
The response for [Firestore.BeginTransaction][google.firestore.v1beta1.Firestore.BeginTransaction].
type BeginTransactionResponse struct {
// The transaction that was started.
Transaction []byte `protobuf:"bytes,1,opt,name=transaction,proto3" json:"transaction,omitempty"`
// contains filtered or unexported fields
}
func (*BeginTransactionResponse) Descriptor() ([]byte, []int)
Deprecated: Use BeginTransactionResponse.ProtoReflect.Descriptor instead.
func (x *BeginTransactionResponse) GetTransaction() []byte
func (*BeginTransactionResponse) ProtoMessage()
func (x *BeginTransactionResponse) ProtoReflect() protoreflect.Message
func (x *BeginTransactionResponse) Reset()
func (x *BeginTransactionResponse) String() string
The request for [Firestore.Commit][google.firestore.v1beta1.Firestore.Commit].
type CommitRequest struct {
// Required. The database name. In the format:
// `projects/{project_id}/databases/{database_id}`.
Database string `protobuf:"bytes,1,opt,name=database,proto3" json:"database,omitempty"`
// The writes to apply.
//
// Always executed atomically and in order.
Writes []*Write `protobuf:"bytes,2,rep,name=writes,proto3" json:"writes,omitempty"`
// If set, applies all writes in this transaction, and commits it.
Transaction []byte `protobuf:"bytes,3,opt,name=transaction,proto3" json:"transaction,omitempty"`
// contains filtered or unexported fields
}
func (*CommitRequest) Descriptor() ([]byte, []int)
Deprecated: Use CommitRequest.ProtoReflect.Descriptor instead.
func (x *CommitRequest) GetDatabase() string
func (x *CommitRequest) GetTransaction() []byte
func (x *CommitRequest) GetWrites() []*Write
func (*CommitRequest) ProtoMessage()
func (x *CommitRequest) ProtoReflect() protoreflect.Message
func (x *CommitRequest) Reset()
func (x *CommitRequest) String() string
The response for [Firestore.Commit][google.firestore.v1beta1.Firestore.Commit].
type CommitResponse struct {
// The result of applying the writes.
//
// This i-th write result corresponds to the i-th write in the
// request.
WriteResults []*WriteResult `protobuf:"bytes,1,rep,name=write_results,json=writeResults,proto3" json:"write_results,omitempty"`
// The time at which the commit occurred. Any read with an equal or greater
// `read_time` is guaranteed to see the effects of the commit.
CommitTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=commit_time,json=commitTime,proto3" json:"commit_time,omitempty"`
// contains filtered or unexported fields
}
func (*CommitResponse) Descriptor() ([]byte, []int)
Deprecated: Use CommitResponse.ProtoReflect.Descriptor instead.
func (x *CommitResponse) GetCommitTime() *timestamppb.Timestamp
func (x *CommitResponse) GetWriteResults() []*WriteResult
func (*CommitResponse) ProtoMessage()
func (x *CommitResponse) ProtoReflect() protoreflect.Message
func (x *CommitResponse) Reset()
func (x *CommitResponse) String() string
The request for [Firestore.CreateDocument][google.firestore.v1beta1.Firestore.CreateDocument].
type CreateDocumentRequest struct {
// Required. The parent resource. For example:
// `projects/{project_id}/databases/{database_id}/documents` or
// `projects/{project_id}/databases/{database_id}/documents/chatrooms/{chatroom_id}`
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. The collection ID, relative to `parent`, to list. For example: `chatrooms`.
CollectionId string `protobuf:"bytes,2,opt,name=collection_id,json=collectionId,proto3" json:"collection_id,omitempty"`
// The client-assigned document ID to use for this document.
//
// Optional. If not specified, an ID will be assigned by the service.
DocumentId string `protobuf:"bytes,3,opt,name=document_id,json=documentId,proto3" json:"document_id,omitempty"`
// Required. The document to create. `name` must not be set.
Document *Document `protobuf:"bytes,4,opt,name=document,proto3" json:"document,omitempty"`
// The fields to return. If not set, returns all fields.
//
// If the document has a field that is not present in this mask, that field
// will not be returned in the response.
Mask *DocumentMask `protobuf:"bytes,5,opt,name=mask,proto3" json:"mask,omitempty"`
// contains filtered or unexported fields
}
func (*CreateDocumentRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateDocumentRequest.ProtoReflect.Descriptor instead.
func (x *CreateDocumentRequest) GetCollectionId() string
func (x *CreateDocumentRequest) GetDocument() *Document
func (x *CreateDocumentRequest) GetDocumentId() string
func (x *CreateDocumentRequest) GetMask() *DocumentMask
func (x *CreateDocumentRequest) GetParent() string
func (*CreateDocumentRequest) ProtoMessage()
func (x *CreateDocumentRequest) ProtoReflect() protoreflect.Message
func (x *CreateDocumentRequest) Reset()
func (x *CreateDocumentRequest) String() string
A position in a query result set.
type Cursor struct {
// The values that represent a position, in the order they appear in
// the order by clause of a query.
//
// Can contain fewer values than specified in the order by clause.
Values []*Value `protobuf:"bytes,1,rep,name=values,proto3" json:"values,omitempty"`
// If the position is just before or just after the given values, relative
// to the sort order defined by the query.
Before bool `protobuf:"varint,2,opt,name=before,proto3" json:"before,omitempty"`
// contains filtered or unexported fields
}
func (*Cursor) Descriptor() ([]byte, []int)
Deprecated: Use Cursor.ProtoReflect.Descriptor instead.
func (x *Cursor) GetBefore() bool
func (x *Cursor) GetValues() []*Value
func (*Cursor) ProtoMessage()
func (x *Cursor) ProtoReflect() protoreflect.Message
func (x *Cursor) Reset()
func (x *Cursor) String() string
The request for [Firestore.DeleteDocument][google.firestore.v1beta1.Firestore.DeleteDocument].
type DeleteDocumentRequest struct {
// Required. The resource name of the Document to delete. In the format:
// `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// An optional precondition on the document.
// The request will fail if this is set and not met by the target document.
CurrentDocument *Precondition `protobuf:"bytes,2,opt,name=current_document,json=currentDocument,proto3" json:"current_document,omitempty"`
// contains filtered or unexported fields
}
func (*DeleteDocumentRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteDocumentRequest.ProtoReflect.Descriptor instead.
func (x *DeleteDocumentRequest) GetCurrentDocument() *Precondition
func (x *DeleteDocumentRequest) GetName() string
func (*DeleteDocumentRequest) ProtoMessage()
func (x *DeleteDocumentRequest) ProtoReflect() protoreflect.Message
func (x *DeleteDocumentRequest) Reset()
func (x *DeleteDocumentRequest) String() string
A Firestore document.
Must not exceed 1 MiB - 4 bytes.
type Document struct {
// The resource name of the document, for example
// `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// The document's fields.
//
// The map keys represent field names.
//
// A simple field name contains only characters `a` to `z`, `A` to `Z`,
// `0` to `9`, or `_`, and must not start with `0` to `9`. For example,
// `foo_bar_17`.
//
// Field names matching the regular expression `__.*__` are reserved. Reserved
// field names are forbidden except in certain documented contexts. The map
// keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be
// empty.
//
// Field paths may be used in other contexts to refer to structured fields
// defined here. For `map_value`, the field path is represented by the simple
// or quoted field names of the containing fields, delimited by `.`. For
// example, the structured field
// `"foo" : { map_value: { "x&y" : { string_value: "hello" }}}` would be
// represented by the field path `foo.x&y`.
//
// Within a field path, a quoted field name starts and ends with “ ` “ and
// may contain any character. Some characters, including “ ` “, must be
// escaped using a `\`. For example, “ `x&y` “ represents `x&y` and
// “ `bak\`tik` “ represents “ bak`tik “.
Fields map[string]*Value `protobuf:"bytes,2,rep,name=fields,proto3" json:"fields,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// Output only. The time at which the document was created.
//
// This value increases monotonically when a document is deleted then
// recreated. It can also be compared to values from other documents and
// the `read_time` of a query.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Output only. The time at which the document was last changed.
//
// This value is initially set to the `create_time` then increases
// monotonically with each change to the document. It can also be
// compared to values from other documents and the `read_time` of a query.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// contains filtered or unexported fields
}
func (*Document) Descriptor() ([]byte, []int)
Deprecated: Use Document.ProtoReflect.Descriptor instead.
func (x *Document) GetCreateTime() *timestamppb.Timestamp
func (x *Document) GetFields() map[string]*Value
func (x *Document) GetName() string
func (x *Document) GetUpdateTime() *timestamppb.Timestamp
func (*Document) ProtoMessage()
func (x *Document) ProtoReflect() protoreflect.Message
func (x *Document) Reset()
func (x *Document) String() string
A Document[google.firestore.v1beta1.Document] has changed.
May be the result of multiple [writes][google.firestore.v1beta1.Write], including deletes, that ultimately resulted in a new value for the Document[google.firestore.v1beta1.Document].
Multiple DocumentChange[google.firestore.v1beta1.DocumentChange] messages may be returned for the same logical change, if multiple targets are affected.
type DocumentChange struct {
// The new state of the [Document][google.firestore.v1beta1.Document].
//
// If `mask` is set, contains only fields that were updated or added.
Document *Document `protobuf:"bytes,1,opt,name=document,proto3" json:"document,omitempty"`
// A set of target IDs of targets that match this document.
TargetIds []int32 `protobuf:"varint,5,rep,packed,name=target_ids,json=targetIds,proto3" json:"target_ids,omitempty"`
// A set of target IDs for targets that no longer match this document.
RemovedTargetIds []int32 `protobuf:"varint,6,rep,packed,name=removed_target_ids,json=removedTargetIds,proto3" json:"removed_target_ids,omitempty"`
// contains filtered or unexported fields
}
func (*DocumentChange) Descriptor() ([]byte, []int)
Deprecated: Use DocumentChange.ProtoReflect.Descriptor instead.
func (x *DocumentChange) GetDocument() *Document
func (x *DocumentChange) GetRemovedTargetIds() []int32
func (x *DocumentChange) GetTargetIds() []int32
func (*DocumentChange) ProtoMessage()
func (x *DocumentChange) ProtoReflect() protoreflect.Message
func (x *DocumentChange) Reset()
func (x *DocumentChange) String() string
A Document[google.firestore.v1beta1.Document] has been deleted.
May be the result of multiple [writes][google.firestore.v1beta1.Write], including updates, the last of which deleted the Document[google.firestore.v1beta1.Document].
Multiple DocumentDelete[google.firestore.v1beta1.DocumentDelete] messages may be returned for the same logical delete, if multiple targets are affected.
type DocumentDelete struct {
// The resource name of the [Document][google.firestore.v1beta1.Document] that was deleted.
Document string `protobuf:"bytes,1,opt,name=document,proto3" json:"document,omitempty"`
// A set of target IDs for targets that previously matched this entity.
RemovedTargetIds []int32 `protobuf:"varint,6,rep,packed,name=removed_target_ids,json=removedTargetIds,proto3" json:"removed_target_ids,omitempty"`
// The read timestamp at which the delete was observed.
//
// Greater or equal to the `commit_time` of the delete.
ReadTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=read_time,json=readTime,proto3" json:"read_time,omitempty"`
// contains filtered or unexported fields
}
func (*DocumentDelete) Descriptor() ([]byte, []int)
Deprecated: Use DocumentDelete.ProtoReflect.Descriptor instead.
func (x *DocumentDelete) GetDocument() string
func (x *DocumentDelete) GetReadTime() *timestamppb.Timestamp
func (x *DocumentDelete) GetRemovedTargetIds() []int32
func (*DocumentDelete) ProtoMessage()
func (x *DocumentDelete) ProtoReflect() protoreflect.Message
func (x *DocumentDelete) Reset()
func (x *DocumentDelete) String() string
A set of field paths on a document. Used to restrict a get or update operation on a document to a subset of its fields. This is different from standard field masks, as this is always scoped to a Document[google.firestore.v1beta1.Document], and takes in account the dynamic nature of Value[google.firestore.v1beta1.Value].
type DocumentMask struct {
// The list of field paths in the mask. See [Document.fields][google.firestore.v1beta1.Document.fields] for a field
// path syntax reference.
FieldPaths []string `protobuf:"bytes,1,rep,name=field_paths,json=fieldPaths,proto3" json:"field_paths,omitempty"`
// contains filtered or unexported fields
}
func (*DocumentMask) Descriptor() ([]byte, []int)
Deprecated: Use DocumentMask.ProtoReflect.Descriptor instead.
func (x *DocumentMask) GetFieldPaths() []string
func (*DocumentMask) ProtoMessage()
func (x *DocumentMask) ProtoReflect() protoreflect.Message
func (x *DocumentMask) Reset()
func (x *DocumentMask) String() string
A Document[google.firestore.v1beta1.Document] has been removed from the view of the targets.
Sent if the document is no longer relevant to a target and is out of view. Can be sent instead of a DocumentDelete or a DocumentChange if the server can not send the new value of the document.
Multiple DocumentRemove[google.firestore.v1beta1.DocumentRemove] messages may be returned for the same logical write or delete, if multiple targets are affected.
type DocumentRemove struct {
// The resource name of the [Document][google.firestore.v1beta1.Document] that has gone out of view.
Document string `protobuf:"bytes,1,opt,name=document,proto3" json:"document,omitempty"`
// A set of target IDs for targets that previously matched this document.
RemovedTargetIds []int32 `protobuf:"varint,2,rep,packed,name=removed_target_ids,json=removedTargetIds,proto3" json:"removed_target_ids,omitempty"`
// The read timestamp at which the remove was observed.
//
// Greater or equal to the `commit_time` of the change/delete/remove.
ReadTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=read_time,json=readTime,proto3" json:"read_time,omitempty"`
// contains filtered or unexported fields
}
func (*DocumentRemove) Descriptor() ([]byte, []int)
Deprecated: Use DocumentRemove.ProtoReflect.Descriptor instead.
func (x *DocumentRemove) GetDocument() string
func (x *DocumentRemove) GetReadTime() *timestamppb.Timestamp
func (x *DocumentRemove) GetRemovedTargetIds() []int32
func (*DocumentRemove) ProtoMessage()
func (x *DocumentRemove) ProtoReflect() protoreflect.Message
func (x *DocumentRemove) Reset()
func (x *DocumentRemove) String() string
A transformation of a document.
type DocumentTransform struct {
// The name of the document to transform.
Document string `protobuf:"bytes,1,opt,name=document,proto3" json:"document,omitempty"`
// The list of transformations to apply to the fields of the document, in
// order.
// This must not be empty.
FieldTransforms []*DocumentTransform_FieldTransform `protobuf:"bytes,2,rep,name=field_transforms,json=fieldTransforms,proto3" json:"field_transforms,omitempty"`
// contains filtered or unexported fields
}
func (*DocumentTransform) Descriptor() ([]byte, []int)
Deprecated: Use DocumentTransform.ProtoReflect.Descriptor instead.
func (x *DocumentTransform) GetDocument() string
func (x *DocumentTransform) GetFieldTransforms() []*DocumentTransform_FieldTransform
func (*DocumentTransform) ProtoMessage()
func (x *DocumentTransform) ProtoReflect() protoreflect.Message
func (x *DocumentTransform) Reset()
func (x *DocumentTransform) String() string
A transformation of a field of the document.
type DocumentTransform_FieldTransform struct {
// The path of the field. See [Document.fields][google.firestore.v1beta1.Document.fields] for the field path syntax
// reference.
FieldPath string `protobuf:"bytes,1,opt,name=field_path,json=fieldPath,proto3" json:"field_path,omitempty"`
// The transformation to apply on the field.
//
// Types that are assignable to TransformType:
//
// *DocumentTransform_FieldTransform_SetToServerValue
// *DocumentTransform_FieldTransform_Increment
// *DocumentTransform_FieldTransform_Maximum
// *DocumentTransform_FieldTransform_Minimum
// *DocumentTransform_FieldTransform_AppendMissingElements
// *DocumentTransform_FieldTransform_RemoveAllFromArray
TransformType isDocumentTransform_FieldTransform_TransformType `protobuf_oneof:"transform_type"`
// contains filtered or unexported fields
}
func (*DocumentTransform_FieldTransform) Descriptor() ([]byte, []int)
Deprecated: Use DocumentTransform_FieldTransform.ProtoReflect.Descriptor instead.
func (x *DocumentTransform_FieldTransform) GetAppendMissingElements() *ArrayValue
func (x *DocumentTransform_FieldTransform) GetFieldPath() string
func (x *DocumentTransform_FieldTransform) GetIncrement() *Value
func (x *DocumentTransform_FieldTransform) GetMaximum() *Value
func (x *DocumentTransform_FieldTransform) GetMinimum() *Value
func (x *DocumentTransform_FieldTransform) GetRemoveAllFromArray() *ArrayValue
func (x *DocumentTransform_FieldTransform) GetSetToServerValue() DocumentTransform_FieldTransform_ServerValue
func (m *DocumentTransform_FieldTransform) GetTransformType() isDocumentTransform_FieldTransform_TransformType
func (*DocumentTransform_FieldTransform) ProtoMessage()
func (x *DocumentTransform_FieldTransform) ProtoReflect() protoreflect.Message
func (x *DocumentTransform_FieldTransform) Reset()
func (x *DocumentTransform_FieldTransform) String() string
type DocumentTransform_FieldTransform_AppendMissingElements struct {
// Append the given elements in order if they are not already present in
// the current field value.
// If the field is not an array, or if the field does not yet exist, it is
// first set to the empty array.
//
// Equivalent numbers of different types (e.g. 3L and 3.0) are
// considered equal when checking if a value is missing.
// NaN is equal to NaN, and Null is equal to Null.
// If the input contains multiple equivalent values, only the first will
// be considered.
//
// The corresponding transform_result will be the null value.
AppendMissingElements *ArrayValue `protobuf:"bytes,6,opt,name=append_missing_elements,json=appendMissingElements,proto3,oneof"`
}
type DocumentTransform_FieldTransform_Increment struct {
// Adds the given value to the field's current value.
//
// This must be an integer or a double value.
// If the field is not an integer or double, or if the field does not yet
// exist, the transformation will set the field to the given value.
// If either of the given value or the current field value are doubles,
// both values will be interpreted as doubles. Double arithmetic and
// representation of double values follow IEEE 754 semantics.
// If there is positive/negative integer overflow, the field is resolved
// to the largest magnitude positive/negative integer.
Increment *Value `protobuf:"bytes,3,opt,name=increment,proto3,oneof"`
}
type DocumentTransform_FieldTransform_Maximum struct {
// Sets the field to the maximum of its current value and the given value.
//
// This must be an integer or a double value.
// If the field is not an integer or double, or if the field does not yet
// exist, the transformation will set the field to the given value.
// If a maximum operation is applied where the field and the input value
// are of mixed types (that is - one is an integer and one is a double)
// the field takes on the type of the larger operand. If the operands are
// equivalent (e.g. 3 and 3.0), the field does not change.
// 0, 0.0, and -0.0 are all zero. The maximum of a zero stored value and
// zero input value is always the stored value.
// The maximum of any numeric value x and NaN is NaN.
Maximum *Value `protobuf:"bytes,4,opt,name=maximum,proto3,oneof"`
}
type DocumentTransform_FieldTransform_Minimum struct {
// Sets the field to the minimum of its current value and the given value.
//
// This must be an integer or a double value.
// If the field is not an integer or double, or if the field does not yet
// exist, the transformation will set the field to the input value.
// If a minimum operation is applied where the field and the input value
// are of mixed types (that is - one is an integer and one is a double)
// the field takes on the type of the smaller operand. If the operands are
// equivalent (e.g. 3 and 3.0), the field does not change.
// 0, 0.0, and -0.0 are all zero. The minimum of a zero stored value and
// zero input value is always the stored value.
// The minimum of any numeric value x and NaN is NaN.
Minimum *Value `protobuf:"bytes,5,opt,name=minimum,proto3,oneof"`
}
type DocumentTransform_FieldTransform_RemoveAllFromArray struct {
// Remove all of the given elements from the array in the field.
// If the field is not an array, or if the field does not yet exist, it is
// set to the empty array.
//
// Equivalent numbers of the different types (e.g. 3L and 3.0) are
// considered equal when deciding whether an element should be removed.
// NaN is equal to NaN, and Null is equal to Null.
// This will remove all equivalent values if there are duplicates.
//
// The corresponding transform_result will be the null value.
RemoveAllFromArray *ArrayValue `protobuf:"bytes,7,opt,name=remove_all_from_array,json=removeAllFromArray,proto3,oneof"`
}
A value that is calculated by the server.
type DocumentTransform_FieldTransform_ServerValue int32
const (
// Unspecified. This value must not be used.
DocumentTransform_FieldTransform_SERVER_VALUE_UNSPECIFIED DocumentTransform_FieldTransform_ServerValue = 0
// The time at which the server processed the request, with millisecond
// precision. If used on multiple fields (same or different documents) in
// a transaction, all the fields will get the same server timestamp.
DocumentTransform_FieldTransform_REQUEST_TIME DocumentTransform_FieldTransform_ServerValue = 1
)
func (DocumentTransform_FieldTransform_ServerValue) Descriptor() protoreflect.EnumDescriptor
func (x DocumentTransform_FieldTransform_ServerValue) Enum() *DocumentTransform_FieldTransform_ServerValue
func (DocumentTransform_FieldTransform_ServerValue) EnumDescriptor() ([]byte, []int)
Deprecated: Use DocumentTransform_FieldTransform_ServerValue.Descriptor instead.
func (x DocumentTransform_FieldTransform_ServerValue) Number() protoreflect.EnumNumber
func (x DocumentTransform_FieldTransform_ServerValue) String() string
func (DocumentTransform_FieldTransform_ServerValue) Type() protoreflect.EnumType
type DocumentTransform_FieldTransform_SetToServerValue struct {
// Sets the field to the given server value.
SetToServerValue DocumentTransform_FieldTransform_ServerValue `protobuf:"varint,2,opt,name=set_to_server_value,json=setToServerValue,proto3,enum=google.firestore.v1beta1.DocumentTransform_FieldTransform_ServerValue,oneof"`
}
A digest of all the documents that match a given target.
type ExistenceFilter struct {
// The target ID to which this filter applies.
TargetId int32 `protobuf:"varint,1,opt,name=target_id,json=targetId,proto3" json:"target_id,omitempty"`
// The total count of documents that match [target_id][google.firestore.v1beta1.ExistenceFilter.target_id].
//
// If different from the count of documents in the client that match, the
// client must manually determine which documents no longer match the target.
Count int32 `protobuf:"varint,2,opt,name=count,proto3" json:"count,omitempty"`
// contains filtered or unexported fields
}
func (*ExistenceFilter) Descriptor() ([]byte, []int)
Deprecated: Use ExistenceFilter.ProtoReflect.Descriptor instead.
func (x *ExistenceFilter) GetCount() int32
func (x *ExistenceFilter) GetTargetId() int32
func (*ExistenceFilter) ProtoMessage()
func (x *ExistenceFilter) ProtoReflect() protoreflect.Message
func (x *ExistenceFilter) Reset()
func (x *ExistenceFilter) String() string
FirestoreClient is the client API for Firestore service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
type FirestoreClient interface {
// Gets a single document.
GetDocument(ctx context.Context, in *GetDocumentRequest, opts ...grpc.CallOption) (*Document, error)
// Lists documents.
ListDocuments(ctx context.Context, in *ListDocumentsRequest, opts ...grpc.CallOption) (*ListDocumentsResponse, error)
// Updates or inserts a document.
UpdateDocument(ctx context.Context, in *UpdateDocumentRequest, opts ...grpc.CallOption) (*Document, error)
// Deletes a document.
DeleteDocument(ctx context.Context, in *DeleteDocumentRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// Gets multiple documents.
//
// Documents returned by this method are not guaranteed to be returned in the
// same order that they were requested.
BatchGetDocuments(ctx context.Context, in *BatchGetDocumentsRequest, opts ...grpc.CallOption) (Firestore_BatchGetDocumentsClient, error)
// Starts a new transaction.
BeginTransaction(ctx context.Context, in *BeginTransactionRequest, opts ...grpc.CallOption) (*BeginTransactionResponse, error)
// Commits a transaction, while optionally updating documents.
Commit(ctx context.Context, in *CommitRequest, opts ...grpc.CallOption) (*CommitResponse, error)
// Rolls back a transaction.
Rollback(ctx context.Context, in *RollbackRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// Runs a query.
RunQuery(ctx context.Context, in *RunQueryRequest, opts ...grpc.CallOption) (Firestore_RunQueryClient, error)
// Partitions a query by returning partition cursors that can be used to run
// the query in parallel. The returned partition cursors are split points that
// can be used by RunQuery as starting/end points for the query results.
PartitionQuery(ctx context.Context, in *PartitionQueryRequest, opts ...grpc.CallOption) (*PartitionQueryResponse, error)
// Streams batches of document updates and deletes, in order.
Write(ctx context.Context, opts ...grpc.CallOption) (Firestore_WriteClient, error)
// Listens to changes.
Listen(ctx context.Context, opts ...grpc.CallOption) (Firestore_ListenClient, error)
// Lists all the collection IDs underneath a document.
ListCollectionIds(ctx context.Context, in *ListCollectionIdsRequest, opts ...grpc.CallOption) (*ListCollectionIdsResponse, error)
// Applies a batch of write operations.
//
// The BatchWrite method does not apply the write operations atomically
// and can apply them out of order. Method does not allow more than one write
// per document. Each write succeeds or fails independently. See the
// [BatchWriteResponse][google.firestore.v1beta1.BatchWriteResponse] for the success status of each write.
//
// If you require an atomically applied set of writes, use
// [Commit][google.firestore.v1beta1.Firestore.Commit] instead.
BatchWrite(ctx context.Context, in *BatchWriteRequest, opts ...grpc.CallOption) (*BatchWriteResponse, error)
// Creates a new document.
CreateDocument(ctx context.Context, in *CreateDocumentRequest, opts ...grpc.CallOption) (*Document, error)
}
func NewFirestoreClient(cc grpc.ClientConnInterface) FirestoreClient
FirestoreServer is the server API for Firestore service.
type FirestoreServer interface {
// Gets a single document.
GetDocument(context.Context, *GetDocumentRequest) (*Document, error)
// Lists documents.
ListDocuments(context.Context, *ListDocumentsRequest) (*ListDocumentsResponse, error)
// Updates or inserts a document.
UpdateDocument(context.Context, *UpdateDocumentRequest) (*Document, error)
// Deletes a document.
DeleteDocument(context.Context, *DeleteDocumentRequest) (*emptypb.Empty, error)
// Gets multiple documents.
//
// Documents returned by this method are not guaranteed to be returned in the
// same order that they were requested.
BatchGetDocuments(*BatchGetDocumentsRequest, Firestore_BatchGetDocumentsServer) error
// Starts a new transaction.
BeginTransaction(context.Context, *BeginTransactionRequest) (*BeginTransactionResponse, error)
// Commits a transaction, while optionally updating documents.
Commit(context.Context, *CommitRequest) (*CommitResponse, error)
// Rolls back a transaction.
Rollback(context.Context, *RollbackRequest) (*emptypb.Empty, error)
// Runs a query.
RunQuery(*RunQueryRequest, Firestore_RunQueryServer) error
// Partitions a query by returning partition cursors that can be used to run
// the query in parallel. The returned partition cursors are split points that
// can be used by RunQuery as starting/end points for the query results.
PartitionQuery(context.Context, *PartitionQueryRequest) (*PartitionQueryResponse, error)
// Streams batches of document updates and deletes, in order.
Write(Firestore_WriteServer) error
// Listens to changes.
Listen(Firestore_ListenServer) error
// Lists all the collection IDs underneath a document.
ListCollectionIds(context.Context, *ListCollectionIdsRequest) (*ListCollectionIdsResponse, error)
// Applies a batch of write operations.
//
// The BatchWrite method does not apply the write operations atomically
// and can apply them out of order. Method does not allow more than one write
// per document. Each write succeeds or fails independently. See the
// [BatchWriteResponse][google.firestore.v1beta1.BatchWriteResponse] for the success status of each write.
//
// If you require an atomically applied set of writes, use
// [Commit][google.firestore.v1beta1.Firestore.Commit] instead.
BatchWrite(context.Context, *BatchWriteRequest) (*BatchWriteResponse, error)
// Creates a new document.
CreateDocument(context.Context, *CreateDocumentRequest) (*Document, error)
}
type Firestore_BatchGetDocumentsClient interface {
Recv() (*BatchGetDocumentsResponse, error)
grpc.ClientStream
}
type Firestore_BatchGetDocumentsServer interface {
Send(*BatchGetDocumentsResponse) error
grpc.ServerStream
}
type Firestore_ListenClient interface {
Send(*ListenRequest) error
Recv() (*ListenResponse, error)
grpc.ClientStream
}
type Firestore_ListenServer interface {
Send(*ListenResponse) error
Recv() (*ListenRequest, error)
grpc.ServerStream
}
type Firestore_RunQueryClient interface {
Recv() (*RunQueryResponse, error)
grpc.ClientStream
}
type Firestore_RunQueryServer interface {
Send(*RunQueryResponse) error
grpc.ServerStream
}
type Firestore_WriteClient interface {
Send(*WriteRequest) error
Recv() (*WriteResponse, error)
grpc.ClientStream
}
type Firestore_WriteServer interface {
Send(*WriteResponse) error
Recv() (*WriteRequest, error)
grpc.ServerStream
}
The request for [Firestore.GetDocument][google.firestore.v1beta1.Firestore.GetDocument].
type GetDocumentRequest struct {
// Required. The resource name of the Document to get. In the format:
// `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// The fields to return. If not set, returns all fields.
//
// If the document has a field that is not present in this mask, that field
// will not be returned in the response.
Mask *DocumentMask `protobuf:"bytes,2,opt,name=mask,proto3" json:"mask,omitempty"`
// The consistency mode for this transaction.
// If not set, defaults to strong consistency.
//
// Types that are assignable to ConsistencySelector:
// *GetDocumentRequest_Transaction
// *GetDocumentRequest_ReadTime
ConsistencySelector isGetDocumentRequest_ConsistencySelector `protobuf_oneof:"consistency_selector"`
// contains filtered or unexported fields
}
func (*GetDocumentRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetDocumentRequest.ProtoReflect.Descriptor instead.
func (m *GetDocumentRequest) GetConsistencySelector() isGetDocumentRequest_ConsistencySelector
func (x *GetDocumentRequest) GetMask() *DocumentMask
func (x *GetDocumentRequest) GetName() string
func (x *GetDocumentRequest) GetReadTime() *timestamppb.Timestamp
func (x *GetDocumentRequest) GetTransaction() []byte
func (*GetDocumentRequest) ProtoMessage()
func (x *GetDocumentRequest) ProtoReflect() protoreflect.Message
func (x *GetDocumentRequest) Reset()
func (x *GetDocumentRequest) String() string
type GetDocumentRequest_ReadTime struct {
// Reads the version of the document at the given time.
// This may not be older than 270 seconds.
ReadTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=read_time,json=readTime,proto3,oneof"`
}
type GetDocumentRequest_Transaction struct {
// Reads the document in a transaction.
Transaction []byte `protobuf:"bytes,3,opt,name=transaction,proto3,oneof"`
}
The request for [Firestore.ListCollectionIds][google.firestore.v1beta1.Firestore.ListCollectionIds].
type ListCollectionIdsRequest struct {
// Required. The parent document. In the format:
// `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
// For example:
// `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// The maximum number of results to return.
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// A page token. Must be a value from
// [ListCollectionIdsResponse][google.firestore.v1beta1.ListCollectionIdsResponse].
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// contains filtered or unexported fields
}
func (*ListCollectionIdsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListCollectionIdsRequest.ProtoReflect.Descriptor instead.
func (x *ListCollectionIdsRequest) GetPageSize() int32
func (x *ListCollectionIdsRequest) GetPageToken() string
func (x *ListCollectionIdsRequest) GetParent() string
func (*ListCollectionIdsRequest) ProtoMessage()
func (x *ListCollectionIdsRequest) ProtoReflect() protoreflect.Message
func (x *ListCollectionIdsRequest) Reset()
func (x *ListCollectionIdsRequest) String() string
The response from [Firestore.ListCollectionIds][google.firestore.v1beta1.Firestore.ListCollectionIds].
type ListCollectionIdsResponse struct {
// The collection ids.
CollectionIds []string `protobuf:"bytes,1,rep,name=collection_ids,json=collectionIds,proto3" json:"collection_ids,omitempty"`
// A page token that may be used to continue the list.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}
func (*ListCollectionIdsResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListCollectionIdsResponse.ProtoReflect.Descriptor instead.
func (x *ListCollectionIdsResponse) GetCollectionIds() []string
func (x *ListCollectionIdsResponse) GetNextPageToken() string
func (*ListCollectionIdsResponse) ProtoMessage()
func (x *ListCollectionIdsResponse) ProtoReflect() protoreflect.Message
func (x *ListCollectionIdsResponse) Reset()
func (x *ListCollectionIdsResponse) String() string
The request for [Firestore.ListDocuments][google.firestore.v1beta1.Firestore.ListDocuments].
type ListDocumentsRequest struct {
// Required. The parent resource name. In the format:
// `projects/{project_id}/databases/{database_id}/documents` or
// `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
// For example:
// `projects/my-project/databases/my-database/documents` or
// `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. The collection ID, relative to `parent`, to list. For example: `chatrooms`
// or `messages`.
CollectionId string `protobuf:"bytes,2,opt,name=collection_id,json=collectionId,proto3" json:"collection_id,omitempty"`
// The maximum number of documents to return.
PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// The `next_page_token` value returned from a previous List request, if any.
PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// The order to sort results by. For example: `priority desc, name`.
OrderBy string `protobuf:"bytes,6,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
// The fields to return. If not set, returns all fields.
//
// If a document has a field that is not present in this mask, that field
// will not be returned in the response.
Mask *DocumentMask `protobuf:"bytes,7,opt,name=mask,proto3" json:"mask,omitempty"`
// The consistency mode for this transaction.
// If not set, defaults to strong consistency.
//
// Types that are assignable to ConsistencySelector:
// *ListDocumentsRequest_Transaction
// *ListDocumentsRequest_ReadTime
ConsistencySelector isListDocumentsRequest_ConsistencySelector `protobuf_oneof:"consistency_selector"`
// If the list should show missing documents. A missing document is a
// document that does not exist but has sub-documents. These documents will
// be returned with a key but will not have fields, [Document.create_time][google.firestore.v1beta1.Document.create_time],
// or [Document.update_time][google.firestore.v1beta1.Document.update_time] set.
//
// Requests with `show_missing` may not specify `where` or
// `order_by`.
ShowMissing bool `protobuf:"varint,12,opt,name=show_missing,json=showMissing,proto3" json:"show_missing,omitempty"`
// contains filtered or unexported fields
}
func (*ListDocumentsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListDocumentsRequest.ProtoReflect.Descriptor instead.
func (x *ListDocumentsRequest) GetCollectionId() string
func (m *ListDocumentsRequest) GetConsistencySelector() isListDocumentsRequest_ConsistencySelector
func (x *ListDocumentsRequest) GetMask() *DocumentMask
func (x *ListDocumentsRequest) GetOrderBy() string
func (x *ListDocumentsRequest) GetPageSize() int32
func (x *ListDocumentsRequest) GetPageToken() string
func (x *ListDocumentsRequest) GetParent() string
func (x *ListDocumentsRequest) GetReadTime() *timestamppb.Timestamp
func (x *ListDocumentsRequest) GetShowMissing() bool
func (x *ListDocumentsRequest) GetTransaction() []byte
func (*ListDocumentsRequest) ProtoMessage()
func (x *ListDocumentsRequest) ProtoReflect() protoreflect.Message
func (x *ListDocumentsRequest) Reset()
func (x *ListDocumentsRequest) String() string
type ListDocumentsRequest_ReadTime struct {
// Reads documents as they were at the given time.
// This may not be older than 270 seconds.
ReadTime *timestamppb.Timestamp `protobuf:"bytes,10,opt,name=read_time,json=readTime,proto3,oneof"`
}
type ListDocumentsRequest_Transaction struct {
// Reads documents in a transaction.
Transaction []byte `protobuf:"bytes,8,opt,name=transaction,proto3,oneof"`
}
The response for [Firestore.ListDocuments][google.firestore.v1beta1.Firestore.ListDocuments].
type ListDocumentsResponse struct {
// The Documents found.
Documents []*Document `protobuf:"bytes,1,rep,name=documents,proto3" json:"documents,omitempty"`
// The next page token.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}
func (*ListDocumentsResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListDocumentsResponse.ProtoReflect.Descriptor instead.
func (x *ListDocumentsResponse) GetDocuments() []*Document
func (x *ListDocumentsResponse) GetNextPageToken() string
func (*ListDocumentsResponse) ProtoMessage()
func (x *ListDocumentsResponse) ProtoReflect() protoreflect.Message
func (x *ListDocumentsResponse) Reset()
func (x *ListDocumentsResponse) String() string
A request for [Firestore.Listen][google.firestore.v1beta1.Firestore.Listen]
type ListenRequest struct {
// Required. The database name. In the format:
// `projects/{project_id}/databases/{database_id}`.
Database string `protobuf:"bytes,1,opt,name=database,proto3" json:"database,omitempty"`
// The supported target changes.
//
// Types that are assignable to TargetChange:
// *ListenRequest_AddTarget
// *ListenRequest_RemoveTarget
TargetChange isListenRequest_TargetChange `protobuf_oneof:"target_change"`
// Labels associated with this target change.
Labels map[string]string `protobuf:"bytes,4,rep,name=labels,proto3" json:"labels,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// contains filtered or unexported fields
}
func (*ListenRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListenRequest.ProtoReflect.Descriptor instead.
func (x *ListenRequest) GetAddTarget() *Target
func (x *ListenRequest) GetDatabase() string
func (x *ListenRequest) GetLabels() map[string]string
func (x *ListenRequest) GetRemoveTarget() int32
func (m *ListenRequest) GetTargetChange() isListenRequest_TargetChange
func (*ListenRequest) ProtoMessage()
func (x *ListenRequest) ProtoReflect() protoreflect.Message
func (x *ListenRequest) Reset()
func (x *ListenRequest) String() string
type ListenRequest_AddTarget struct {
// A target to add to this stream.
AddTarget *Target `protobuf:"bytes,2,opt,name=add_target,json=addTarget,proto3,oneof"`
}
type ListenRequest_RemoveTarget struct {
// The ID of a target to remove from this stream.
RemoveTarget int32 `protobuf:"varint,3,opt,name=remove_target,json=removeTarget,proto3,oneof"`
}
The response for [Firestore.Listen][google.firestore.v1beta1.Firestore.Listen].
type ListenResponse struct {
// The supported responses.
//
// Types that are assignable to ResponseType:
// *ListenResponse_TargetChange
// *ListenResponse_DocumentChange
// *ListenResponse_DocumentDelete
// *ListenResponse_DocumentRemove
// *ListenResponse_Filter
ResponseType isListenResponse_ResponseType `protobuf_oneof:"response_type"`
// contains filtered or unexported fields
}
func (*ListenResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListenResponse.ProtoReflect.Descriptor instead.
func (x *ListenResponse) GetDocumentChange() *DocumentChange
func (x *ListenResponse) GetDocumentDelete() *DocumentDelete
func (x *ListenResponse) GetDocumentRemove() *DocumentRemove
func (x *ListenResponse) GetFilter() *ExistenceFilter
func (m *ListenResponse) GetResponseType() isListenResponse_ResponseType
func (x *ListenResponse) GetTargetChange() *TargetChange
func (*ListenResponse) ProtoMessage()
func (x *ListenResponse) ProtoReflect() protoreflect.Message
func (x *ListenResponse) Reset()
func (x *ListenResponse) String() string
type ListenResponse_DocumentChange struct {
// A [Document][google.firestore.v1beta1.Document] has changed.
DocumentChange *DocumentChange `protobuf:"bytes,3,opt,name=document_change,json=documentChange,proto3,oneof"`
}
type ListenResponse_DocumentDelete struct {
// A [Document][google.firestore.v1beta1.Document] has been deleted.
DocumentDelete *DocumentDelete `protobuf:"bytes,4,opt,name=document_delete,json=documentDelete,proto3,oneof"`
}
type ListenResponse_DocumentRemove struct {
// A [Document][google.firestore.v1beta1.Document] has been removed from a target (because it is no longer
// relevant to that target).
DocumentRemove *DocumentRemove `protobuf:"bytes,6,opt,name=document_remove,json=documentRemove,proto3,oneof"`
}
type ListenResponse_Filter struct {
// A filter to apply to the set of documents previously returned for the
// given target.
//
// Returned when documents may have been removed from the given target, but
// the exact documents are unknown.
Filter *ExistenceFilter `protobuf:"bytes,5,opt,name=filter,proto3,oneof"`
}
type ListenResponse_TargetChange struct {
// Targets have changed.
TargetChange *TargetChange `protobuf:"bytes,2,opt,name=target_change,json=targetChange,proto3,oneof"`
}
A map value.
type MapValue struct {
// The map's fields.
//
// The map keys represent field names. Field names matching the regular
// expression `__.*__` are reserved. Reserved field names are forbidden except
// in certain documented contexts. The map keys, represented as UTF-8, must
// not exceed 1,500 bytes and cannot be empty.
Fields map[string]*Value `protobuf:"bytes,1,rep,name=fields,proto3" json:"fields,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// contains filtered or unexported fields
}
func (*MapValue) Descriptor() ([]byte, []int)
Deprecated: Use MapValue.ProtoReflect.Descriptor instead.
func (x *MapValue) GetFields() map[string]*Value
func (*MapValue) ProtoMessage()
func (x *MapValue) ProtoReflect() protoreflect.Message
func (x *MapValue) Reset()
func (x *MapValue) String() string
The request for [Firestore.PartitionQuery][google.firestore.v1beta1.Firestore.PartitionQuery].
type PartitionQueryRequest struct {
// Required. The parent resource name. In the format:
// `projects/{project_id}/databases/{database_id}/documents`.
// Document resource names are not supported; only database resource names
// can be specified.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// The query to partition.
//
// Types that are assignable to QueryType:
// *PartitionQueryRequest_StructuredQuery
QueryType isPartitionQueryRequest_QueryType `protobuf_oneof:"query_type"`
// The desired maximum number of partition points.
// The partitions may be returned across multiple pages of results.
// The number must be positive. The actual number of partitions
// returned may be fewer.
//
// For example, this may be set to one fewer than the number of parallel
// queries to be run, or in running a data pipeline job, one fewer than the
// number of workers or compute instances available.
PartitionCount int64 `protobuf:"varint,3,opt,name=partition_count,json=partitionCount,proto3" json:"partition_count,omitempty"`
// The `next_page_token` value returned from a previous call to
// PartitionQuery that may be used to get an additional set of results.
// There are no ordering guarantees between sets of results. Thus, using
// multiple sets of results will require merging the different result sets.
//
// For example, two subsequent calls using a page_token may return:
//
// * cursor B, cursor M, cursor Q
// * cursor A, cursor U, cursor W
//
// To obtain a complete result set ordered with respect to the results of the
// query supplied to PartitionQuery, the results sets should be merged:
// cursor A, cursor B, cursor M, cursor Q, cursor U, cursor W
PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// The maximum number of partitions to return in this call, subject to
// `partition_count`.
//
// For example, if `partition_count` = 10 and `page_size` = 8, the first call
// to PartitionQuery will return up to 8 partitions and a `next_page_token`
// if more results exist. A second call to PartitionQuery will return up to
// 2 partitions, to complete the total of 10 specified in `partition_count`.
PageSize int32 `protobuf:"varint,5,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// contains filtered or unexported fields
}
func (*PartitionQueryRequest) Descriptor() ([]byte, []int)
Deprecated: Use PartitionQueryRequest.ProtoReflect.Descriptor instead.
func (x *PartitionQueryRequest) GetPageSize() int32
func (x *PartitionQueryRequest) GetPageToken() string
func (x *PartitionQueryRequest) GetParent() string
func (x *PartitionQueryRequest) GetPartitionCount() int64
func (m *PartitionQueryRequest) GetQueryType() isPartitionQueryRequest_QueryType
func (x *PartitionQueryRequest) GetStructuredQuery() *StructuredQuery
func (*PartitionQueryRequest) ProtoMessage()
func (x *PartitionQueryRequest) ProtoReflect() protoreflect.Message
func (x *PartitionQueryRequest) Reset()
func (x *PartitionQueryRequest) String() string
type PartitionQueryRequest_StructuredQuery struct {
// A structured query.
// Query must specify collection with all descendants and be ordered by name
// ascending. Other filters, order bys, limits, offsets, and start/end
// cursors are not supported.
StructuredQuery *StructuredQuery `protobuf:"bytes,2,opt,name=structured_query,json=structuredQuery,proto3,oneof"`
}
The response for [Firestore.PartitionQuery][google.firestore.v1beta1.Firestore.PartitionQuery].
type PartitionQueryResponse struct {
// Partition results.
// Each partition is a split point that can be used by RunQuery as a starting
// or end point for the query results. The RunQuery requests must be made with
// the same query supplied to this PartitionQuery request. The partition
// cursors will be ordered according to same ordering as the results of the
// query supplied to PartitionQuery.
//
// For example, if a PartitionQuery request returns partition cursors A and B,
// running the following three queries will return the entire result set of
// the original query:
//
// * query, end_at A
// * query, start_at A, end_at B
// * query, start_at B
//
// An empty result may indicate that the query has too few results to be
// partitioned.
Partitions []*Cursor `protobuf:"bytes,1,rep,name=partitions,proto3" json:"partitions,omitempty"`
// A page token that may be used to request an additional set of results, up
// to the number specified by `partition_count` in the PartitionQuery request.
// If blank, there are no more results.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}
func (*PartitionQueryResponse) Descriptor() ([]byte, []int)
Deprecated: Use PartitionQueryResponse.ProtoReflect.Descriptor instead.
func (x *PartitionQueryResponse) GetNextPageToken() string
func (x *PartitionQueryResponse) GetPartitions() []*Cursor
func (*PartitionQueryResponse) ProtoMessage()
func (x *PartitionQueryResponse) ProtoReflect() protoreflect.Message
func (x *PartitionQueryResponse) Reset()
func (x *PartitionQueryResponse) String() string
A precondition on a document, used for conditional operations.
type Precondition struct {
// The type of precondition.
//
// Types that are assignable to ConditionType:
//
// *Precondition_Exists
// *Precondition_UpdateTime
ConditionType isPrecondition_ConditionType `protobuf_oneof:"condition_type"`
// contains filtered or unexported fields
}
func (*Precondition) Descriptor() ([]byte, []int)
Deprecated: Use Precondition.ProtoReflect.Descriptor instead.
func (m *Precondition) GetConditionType() isPrecondition_ConditionType
func (x *Precondition) GetExists() bool
func (x *Precondition) GetUpdateTime() *timestamppb.Timestamp
func (*Precondition) ProtoMessage()
func (x *Precondition) ProtoReflect() protoreflect.Message
func (x *Precondition) Reset()
func (x *Precondition) String() string
type Precondition_Exists struct {
// When set to `true`, the target document must exist.
// When set to `false`, the target document must not exist.
Exists bool `protobuf:"varint,1,opt,name=exists,proto3,oneof"`
}
type Precondition_UpdateTime struct {
// When set, the target document must exist and have been last updated at
// that time.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=update_time,json=updateTime,proto3,oneof"`
}
The request for [Firestore.Rollback][google.firestore.v1beta1.Firestore.Rollback].
type RollbackRequest struct {
// Required. The database name. In the format:
// `projects/{project_id}/databases/{database_id}`.
Database string `protobuf:"bytes,1,opt,name=database,proto3" json:"database,omitempty"`
// Required. The transaction to roll back.
Transaction []byte `protobuf:"bytes,2,opt,name=transaction,proto3" json:"transaction,omitempty"`
// contains filtered or unexported fields
}
func (*RollbackRequest) Descriptor() ([]byte, []int)
Deprecated: Use RollbackRequest.ProtoReflect.Descriptor instead.
func (x *RollbackRequest) GetDatabase() string
func (x *RollbackRequest) GetTransaction() []byte
func (*RollbackRequest) ProtoMessage()
func (x *RollbackRequest) ProtoReflect() protoreflect.Message
func (x *RollbackRequest) Reset()
func (x *RollbackRequest) String() string
The request for [Firestore.RunQuery][google.firestore.v1beta1.Firestore.RunQuery].
type RunQueryRequest struct {
// Required. The parent resource name. In the format:
// `projects/{project_id}/databases/{database_id}/documents` or
// `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
// For example:
// `projects/my-project/databases/my-database/documents` or
// `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// The query to run.
//
// Types that are assignable to QueryType:
// *RunQueryRequest_StructuredQuery
QueryType isRunQueryRequest_QueryType `protobuf_oneof:"query_type"`
// The consistency mode for this transaction.
// If not set, defaults to strong consistency.
//
// Types that are assignable to ConsistencySelector:
// *RunQueryRequest_Transaction
// *RunQueryRequest_NewTransaction
// *RunQueryRequest_ReadTime
ConsistencySelector isRunQueryRequest_ConsistencySelector `protobuf_oneof:"consistency_selector"`
// contains filtered or unexported fields
}
func (*RunQueryRequest) Descriptor() ([]byte, []int)
Deprecated: Use RunQueryRequest.ProtoReflect.Descriptor instead.
func (m *RunQueryRequest) GetConsistencySelector() isRunQueryRequest_ConsistencySelector
func (x *RunQueryRequest) GetNewTransaction() *TransactionOptions
func (x *RunQueryRequest) GetParent() string
func (m *RunQueryRequest) GetQueryType() isRunQueryRequest_QueryType
func (x *RunQueryRequest) GetReadTime() *timestamppb.Timestamp
func (x *RunQueryRequest) GetStructuredQuery() *StructuredQuery
func (x *RunQueryRequest) GetTransaction() []byte
func (*RunQueryRequest) ProtoMessage()
func (x *RunQueryRequest) ProtoReflect() protoreflect.Message
func (x *RunQueryRequest) Reset()
func (x *RunQueryRequest) String() string
type RunQueryRequest_NewTransaction struct {
// Starts a new transaction and reads the documents.
// Defaults to a read-only transaction.
// The new transaction ID will be returned as the first response in the
// stream.
NewTransaction *TransactionOptions `protobuf:"bytes,6,opt,name=new_transaction,json=newTransaction,proto3,oneof"`
}
type RunQueryRequest_ReadTime struct {
// Reads documents as they were at the given time.
// This may not be older than 270 seconds.
ReadTime *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=read_time,json=readTime,proto3,oneof"`
}
type RunQueryRequest_StructuredQuery struct {
// A structured query.
StructuredQuery *StructuredQuery `protobuf:"bytes,2,opt,name=structured_query,json=structuredQuery,proto3,oneof"`
}
type RunQueryRequest_Transaction struct {
// Reads documents in a transaction.
Transaction []byte `protobuf:"bytes,5,opt,name=transaction,proto3,oneof"`
}
The response for [Firestore.RunQuery][google.firestore.v1beta1.Firestore.RunQuery].
type RunQueryResponse struct {
// The transaction that was started as part of this request.
// Can only be set in the first response, and only if
// [RunQueryRequest.new_transaction][google.firestore.v1beta1.RunQueryRequest.new_transaction] was set in the request.
// If set, no other fields will be set in this response.
Transaction []byte `protobuf:"bytes,2,opt,name=transaction,proto3" json:"transaction,omitempty"`
// A query result.
// Not set when reporting partial progress.
Document *Document `protobuf:"bytes,1,opt,name=document,proto3" json:"document,omitempty"`
// The time at which the document was read. This may be monotonically
// increasing; in this case, the previous documents in the result stream are
// guaranteed not to have changed between their `read_time` and this one.
//
// If the query returns no results, a response with `read_time` and no
// `document` will be sent, and this represents the time at which the query
// was run.
ReadTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=read_time,json=readTime,proto3" json:"read_time,omitempty"`
// The number of results that have been skipped due to an offset between
// the last response and the current response.
SkippedResults int32 `protobuf:"varint,4,opt,name=skipped_results,json=skippedResults,proto3" json:"skipped_results,omitempty"`
// contains filtered or unexported fields
}
func (*RunQueryResponse) Descriptor() ([]byte, []int)
Deprecated: Use RunQueryResponse.ProtoReflect.Descriptor instead.
func (x *RunQueryResponse) GetDocument() *Document
func (x *RunQueryResponse) GetReadTime() *timestamppb.Timestamp
func (x *RunQueryResponse) GetSkippedResults() int32
func (x *RunQueryResponse) GetTransaction() []byte
func (*RunQueryResponse) ProtoMessage()
func (x *RunQueryResponse) ProtoReflect() protoreflect.Message
func (x *RunQueryResponse) Reset()
func (x *RunQueryResponse) String() string
A Firestore query.
type StructuredQuery struct {
// The projection to return.
Select *StructuredQuery_Projection `protobuf:"bytes,1,opt,name=select,proto3" json:"select,omitempty"`
// The collections to query.
From []*StructuredQuery_CollectionSelector `protobuf:"bytes,2,rep,name=from,proto3" json:"from,omitempty"`
// The filter to apply.
Where *StructuredQuery_Filter `protobuf:"bytes,3,opt,name=where,proto3" json:"where,omitempty"`
// The order to apply to the query results.
//
// Firestore guarantees a stable ordering through the following rules:
//
// - Any field required to appear in `order_by`, that is not already
// specified in `order_by`, is appended to the order in field name order
// by default.
// - If an order on `__name__` is not specified, it is appended by default.
//
// Fields are appended with the same sort direction as the last order
// specified, or 'ASCENDING' if no order was specified. For example:
//
// - `SELECT * FROM Foo ORDER BY A` becomes
// `SELECT * FROM Foo ORDER BY A, __name__`
// - `SELECT * FROM Foo ORDER BY A DESC` becomes
// `SELECT * FROM Foo ORDER BY A DESC, __name__ DESC`
// - `SELECT * FROM Foo WHERE A > 1` becomes
// `SELECT * FROM Foo WHERE A > 1 ORDER BY A, __name__`
OrderBy []*StructuredQuery_Order `protobuf:"bytes,4,rep,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
// A starting point for the query results.
StartAt *Cursor `protobuf:"bytes,7,opt,name=start_at,json=startAt,proto3" json:"start_at,omitempty"`
// A end point for the query results.
EndAt *Cursor `protobuf:"bytes,8,opt,name=end_at,json=endAt,proto3" json:"end_at,omitempty"`
// The number of results to skip.
//
// Applies before limit, but after all other constraints. Must be >= 0 if
// specified.
Offset int32 `protobuf:"varint,6,opt,name=offset,proto3" json:"offset,omitempty"`
// The maximum number of results to return.
//
// Applies after all other constraints.
// Must be >= 0 if specified.
Limit *wrapperspb.Int32Value `protobuf:"bytes,5,opt,name=limit,proto3" json:"limit,omitempty"`
// contains filtered or unexported fields
}
func (*StructuredQuery) Descriptor() ([]byte, []int)
Deprecated: Use StructuredQuery.ProtoReflect.Descriptor instead.
func (x *StructuredQuery) GetEndAt() *Cursor
func (x *StructuredQuery) GetFrom() []*StructuredQuery_CollectionSelector
func (x *StructuredQuery) GetLimit() *wrapperspb.Int32Value
func (x *StructuredQuery) GetOffset() int32
func (x *StructuredQuery) GetOrderBy() []*StructuredQuery_Order
func (x *StructuredQuery) GetSelect() *StructuredQuery_Projection
func (x *StructuredQuery) GetStartAt() *Cursor
func (x *StructuredQuery) GetWhere() *StructuredQuery_Filter
func (*StructuredQuery) ProtoMessage()
func (x *StructuredQuery) ProtoReflect() protoreflect.Message
func (x *StructuredQuery) Reset()
func (x *StructuredQuery) String() string
A selection of a collection, such as `messages as m1`.
type StructuredQuery_CollectionSelector struct {
// The collection ID.
// When set, selects only collections with this ID.
CollectionId string `protobuf:"bytes,2,opt,name=collection_id,json=collectionId,proto3" json:"collection_id,omitempty"`
// When false, selects only collections that are immediate children of
// the `parent` specified in the containing `RunQueryRequest`.
// When true, selects all descendant collections.
AllDescendants bool `protobuf:"varint,3,opt,name=all_descendants,json=allDescendants,proto3" json:"all_descendants,omitempty"`
// contains filtered or unexported fields
}
func (*StructuredQuery_CollectionSelector) Descriptor() ([]byte, []int)
Deprecated: Use StructuredQuery_CollectionSelector.ProtoReflect.Descriptor instead.
func (x *StructuredQuery_CollectionSelector) GetAllDescendants() bool
func (x *StructuredQuery_CollectionSelector) GetCollectionId() string
func (*StructuredQuery_CollectionSelector) ProtoMessage()
func (x *StructuredQuery_CollectionSelector) ProtoReflect() protoreflect.Message
func (x *StructuredQuery_CollectionSelector) Reset()
func (x *StructuredQuery_CollectionSelector) String() string
A filter that merges multiple other filters using the given operator.
type StructuredQuery_CompositeFilter struct {
// The operator for combining multiple filters.
Op StructuredQuery_CompositeFilter_Operator `protobuf:"varint,1,opt,name=op,proto3,enum=google.firestore.v1beta1.StructuredQuery_CompositeFilter_Operator" json:"op,omitempty"`
// The list of filters to combine.
// Must contain at least one filter.
Filters []*StructuredQuery_Filter `protobuf:"bytes,2,rep,name=filters,proto3" json:"filters,omitempty"`
// contains filtered or unexported fields
}
func (*StructuredQuery_CompositeFilter) Descriptor() ([]byte, []int)
Deprecated: Use StructuredQuery_CompositeFilter.ProtoReflect.Descriptor instead.
func (x *StructuredQuery_CompositeFilter) GetFilters() []*StructuredQuery_Filter
func (x *StructuredQuery_CompositeFilter) GetOp() StructuredQuery_CompositeFilter_Operator
func (*StructuredQuery_CompositeFilter) ProtoMessage()
func (x *StructuredQuery_CompositeFilter) ProtoReflect() protoreflect.Message
func (x *StructuredQuery_CompositeFilter) Reset()
func (x *StructuredQuery_CompositeFilter) String() string
A composite filter operator.
type StructuredQuery_CompositeFilter_Operator int32
const (
// Unspecified. This value must not be used.
StructuredQuery_CompositeFilter_OPERATOR_UNSPECIFIED StructuredQuery_CompositeFilter_Operator = 0
// The results are required to satisfy each of the combined filters.
StructuredQuery_CompositeFilter_AND StructuredQuery_CompositeFilter_Operator = 1
)
func (StructuredQuery_CompositeFilter_Operator) Descriptor() protoreflect.EnumDescriptor
func (x StructuredQuery_CompositeFilter_Operator) Enum() *StructuredQuery_CompositeFilter_Operator
func (StructuredQuery_CompositeFilter_Operator) EnumDescriptor() ([]byte, []int)
Deprecated: Use StructuredQuery_CompositeFilter_Operator.Descriptor instead.
func (x StructuredQuery_CompositeFilter_Operator) Number() protoreflect.EnumNumber
func (x StructuredQuery_CompositeFilter_Operator) String() string
func (StructuredQuery_CompositeFilter_Operator) Type() protoreflect.EnumType
A sort direction.
type StructuredQuery_Direction int32
const (
// Unspecified.
StructuredQuery_DIRECTION_UNSPECIFIED StructuredQuery_Direction = 0
// Ascending.
StructuredQuery_ASCENDING StructuredQuery_Direction = 1
// Descending.
StructuredQuery_DESCENDING StructuredQuery_Direction = 2
)
func (StructuredQuery_Direction) Descriptor() protoreflect.EnumDescriptor
func (x StructuredQuery_Direction) Enum() *StructuredQuery_Direction
func (StructuredQuery_Direction) EnumDescriptor() ([]byte, []int)
Deprecated: Use StructuredQuery_Direction.Descriptor instead.
func (x StructuredQuery_Direction) Number() protoreflect.EnumNumber
func (x StructuredQuery_Direction) String() string
func (StructuredQuery_Direction) Type() protoreflect.EnumType
A filter on a specific field.
type StructuredQuery_FieldFilter struct {
// The field to filter by.
Field *StructuredQuery_FieldReference `protobuf:"bytes,1,opt,name=field,proto3" json:"field,omitempty"`
// The operator to filter by.
Op StructuredQuery_FieldFilter_Operator `protobuf:"varint,2,opt,name=op,proto3,enum=google.firestore.v1beta1.StructuredQuery_FieldFilter_Operator" json:"op,omitempty"`
// The value to compare to.
Value *Value `protobuf:"bytes,3,opt,name=value,proto3" json:"value,omitempty"`
// contains filtered or unexported fields
}
func (*StructuredQuery_FieldFilter) Descriptor() ([]byte, []int)
Deprecated: Use StructuredQuery_FieldFilter.ProtoReflect.Descriptor instead.
func (x *StructuredQuery_FieldFilter) GetField() *StructuredQuery_FieldReference
func (x *StructuredQuery_FieldFilter) GetOp() StructuredQuery_FieldFilter_Operator
func (x *StructuredQuery_FieldFilter) GetValue() *Value
func (*StructuredQuery_FieldFilter) ProtoMessage()
func (x *StructuredQuery_FieldFilter) ProtoReflect() protoreflect.Message
func (x *StructuredQuery_FieldFilter) Reset()
func (x *StructuredQuery_FieldFilter) String() string
A field filter operator.
type StructuredQuery_FieldFilter_Operator int32
const (
// Unspecified. This value must not be used.
StructuredQuery_FieldFilter_OPERATOR_UNSPECIFIED StructuredQuery_FieldFilter_Operator = 0
// The given `field` is less than the given `value`.
//
// Requires:
//
// * That `field` come first in `order_by`.
StructuredQuery_FieldFilter_LESS_THAN StructuredQuery_FieldFilter_Operator = 1
// The given `field` is less than or equal to the given `value`.
//
// Requires:
//
// * That `field` come first in `order_by`.
StructuredQuery_FieldFilter_LESS_THAN_OR_EQUAL StructuredQuery_FieldFilter_Operator = 2
// The given `field` is greater than the given `value`.
//
// Requires:
//
// * That `field` come first in `order_by`.
StructuredQuery_FieldFilter_GREATER_THAN StructuredQuery_FieldFilter_Operator = 3
// The given `field` is greater than or equal to the given `value`.
//
// Requires:
//
// * That `field` come first in `order_by`.
StructuredQuery_FieldFilter_GREATER_THAN_OR_EQUAL StructuredQuery_FieldFilter_Operator = 4
// The given `field` is equal to the given `value`.
StructuredQuery_FieldFilter_EQUAL StructuredQuery_FieldFilter_Operator = 5
// The given `field` is not equal to the given `value`.
//
// Requires:
//
// * No other `NOT_EQUAL`, `NOT_IN`, `IS_NOT_NULL`, or `IS_NOT_NAN`.
// * That `field` comes first in the `order_by`.
StructuredQuery_FieldFilter_NOT_EQUAL StructuredQuery_FieldFilter_Operator = 6
// The given `field` is an array that contains the given `value`.
StructuredQuery_FieldFilter_ARRAY_CONTAINS StructuredQuery_FieldFilter_Operator = 7
// The given `field` is equal to at least one value in the given array.
//
// Requires:
//
// * That `value` is a non-empty `ArrayValue` with at most 10 values.
// * No other `IN` or `ARRAY_CONTAINS_ANY` or `NOT_IN`.
StructuredQuery_FieldFilter_IN StructuredQuery_FieldFilter_Operator = 8
// The given `field` is an array that contains any of the values in the
// given array.
//
// Requires:
//
// * That `value` is a non-empty `ArrayValue` with at most 10 values.
// * No other `IN` or `ARRAY_CONTAINS_ANY` or `NOT_IN`.
StructuredQuery_FieldFilter_ARRAY_CONTAINS_ANY StructuredQuery_FieldFilter_Operator = 9
// The value of the `field` is not in the given array.
//
// Requires:
//
// - That `value` is a non-empty `ArrayValue` with at most 10 values.
// - No other `IN`, `ARRAY_CONTAINS_ANY`, `NOT_IN`, `NOT_EQUAL`,
// `IS_NOT_NULL`, or `IS_NOT_NAN`.
// - That `field` comes first in the `order_by`.
StructuredQuery_FieldFilter_NOT_IN StructuredQuery_FieldFilter_Operator = 10
)
func (StructuredQuery_FieldFilter_Operator) Descriptor() protoreflect.EnumDescriptor
func (x StructuredQuery_FieldFilter_Operator) Enum() *StructuredQuery_FieldFilter_Operator
func (StructuredQuery_FieldFilter_Operator) EnumDescriptor() ([]byte, []int)
Deprecated: Use StructuredQuery_FieldFilter_Operator.Descriptor instead.
func (x StructuredQuery_FieldFilter_Operator) Number() protoreflect.EnumNumber
func (x StructuredQuery_FieldFilter_Operator) String() string
func (StructuredQuery_FieldFilter_Operator) Type() protoreflect.EnumType
A reference to a field, such as `max(messages.time) as max_time`.
type StructuredQuery_FieldReference struct {
FieldPath string `protobuf:"bytes,2,opt,name=field_path,json=fieldPath,proto3" json:"field_path,omitempty"`
// contains filtered or unexported fields
}
func (*StructuredQuery_FieldReference) Descriptor() ([]byte, []int)
Deprecated: Use StructuredQuery_FieldReference.ProtoReflect.Descriptor instead.
func (x *StructuredQuery_FieldReference) GetFieldPath() string
func (*StructuredQuery_FieldReference) ProtoMessage()
func (x *StructuredQuery_FieldReference) ProtoReflect() protoreflect.Message
func (x *StructuredQuery_FieldReference) Reset()
func (x *StructuredQuery_FieldReference) String() string
A filter.
type StructuredQuery_Filter struct {
// The type of filter.
//
// Types that are assignable to FilterType:
//
// *StructuredQuery_Filter_CompositeFilter
// *StructuredQuery_Filter_FieldFilter
// *StructuredQuery_Filter_UnaryFilter
FilterType isStructuredQuery_Filter_FilterType `protobuf_oneof:"filter_type"`
// contains filtered or unexported fields
}
func (*StructuredQuery_Filter) Descriptor() ([]byte, []int)
Deprecated: Use StructuredQuery_Filter.ProtoReflect.Descriptor instead.
func (x *StructuredQuery_Filter) GetCompositeFilter() *StructuredQuery_CompositeFilter
func (x *StructuredQuery_Filter) GetFieldFilter() *StructuredQuery_FieldFilter
func (m *StructuredQuery_Filter) GetFilterType() isStructuredQuery_Filter_FilterType
func (x *StructuredQuery_Filter) GetUnaryFilter() *StructuredQuery_UnaryFilter
func (*StructuredQuery_Filter) ProtoMessage()
func (x *StructuredQuery_Filter) ProtoReflect() protoreflect.Message
func (x *StructuredQuery_Filter) Reset()
func (x *StructuredQuery_Filter) String() string
type StructuredQuery_Filter_CompositeFilter struct {
// A composite filter.
CompositeFilter *StructuredQuery_CompositeFilter `protobuf:"bytes,1,opt,name=composite_filter,json=compositeFilter,proto3,oneof"`
}
type StructuredQuery_Filter_FieldFilter struct {
// A filter on a document field.
FieldFilter *StructuredQuery_FieldFilter `protobuf:"bytes,2,opt,name=field_filter,json=fieldFilter,proto3,oneof"`
}
type StructuredQuery_Filter_UnaryFilter struct {
// A filter that takes exactly one argument.
UnaryFilter *StructuredQuery_UnaryFilter `protobuf:"bytes,3,opt,name=unary_filter,json=unaryFilter,proto3,oneof"`
}
An order on a field.
type StructuredQuery_Order struct {
// The field to order by.
Field *StructuredQuery_FieldReference `protobuf:"bytes,1,opt,name=field,proto3" json:"field,omitempty"`
// The direction to order by. Defaults to `ASCENDING`.
Direction StructuredQuery_Direction `protobuf:"varint,2,opt,name=direction,proto3,enum=google.firestore.v1beta1.StructuredQuery_Direction" json:"direction,omitempty"`
// contains filtered or unexported fields
}
func (*StructuredQuery_Order) Descriptor() ([]byte, []int)
Deprecated: Use StructuredQuery_Order.ProtoReflect.Descriptor instead.
func (x *StructuredQuery_Order) GetDirection() StructuredQuery_Direction
func (x *StructuredQuery_Order) GetField() *StructuredQuery_FieldReference
func (*StructuredQuery_Order) ProtoMessage()
func (x *StructuredQuery_Order) ProtoReflect() protoreflect.Message
func (x *StructuredQuery_Order) Reset()
func (x *StructuredQuery_Order) String() string
The projection of document's fields to return.
type StructuredQuery_Projection struct {
// The fields to return.
//
// If empty, all fields are returned. To only return the name
// of the document, use `['__name__']`.
Fields []*StructuredQuery_FieldReference `protobuf:"bytes,2,rep,name=fields,proto3" json:"fields,omitempty"`
// contains filtered or unexported fields
}
func (*StructuredQuery_Projection) Descriptor() ([]byte, []int)
Deprecated: Use StructuredQuery_Projection.ProtoReflect.Descriptor instead.
func (x *StructuredQuery_Projection) GetFields() []*StructuredQuery_FieldReference
func (*StructuredQuery_Projection) ProtoMessage()
func (x *StructuredQuery_Projection) ProtoReflect() protoreflect.Message
func (x *StructuredQuery_Projection) Reset()
func (x *StructuredQuery_Projection) String() string
A filter with a single operand.
type StructuredQuery_UnaryFilter struct {
// The unary operator to apply.
Op StructuredQuery_UnaryFilter_Operator `protobuf:"varint,1,opt,name=op,proto3,enum=google.firestore.v1beta1.StructuredQuery_UnaryFilter_Operator" json:"op,omitempty"`
// The argument to the filter.
//
// Types that are assignable to OperandType:
//
// *StructuredQuery_UnaryFilter_Field
OperandType isStructuredQuery_UnaryFilter_OperandType `protobuf_oneof:"operand_type"`
// contains filtered or unexported fields
}
func (*StructuredQuery_UnaryFilter) Descriptor() ([]byte, []int)
Deprecated: Use StructuredQuery_UnaryFilter.ProtoReflect.Descriptor instead.
func (x *StructuredQuery_UnaryFilter) GetField() *StructuredQuery_FieldReference
func (x *StructuredQuery_UnaryFilter) GetOp() StructuredQuery_UnaryFilter_Operator
func (m *StructuredQuery_UnaryFilter) GetOperandType() isStructuredQuery_UnaryFilter_OperandType
func (*StructuredQuery_UnaryFilter) ProtoMessage()
func (x *StructuredQuery_UnaryFilter) ProtoReflect() protoreflect.Message
func (x *StructuredQuery_UnaryFilter) Reset()
func (x *StructuredQuery_UnaryFilter) String() string
type StructuredQuery_UnaryFilter_Field struct {
// The field to which to apply the operator.
Field *StructuredQuery_FieldReference `protobuf:"bytes,2,opt,name=field,proto3,oneof"`
}
A unary operator.
type StructuredQuery_UnaryFilter_Operator int32
const (
// Unspecified. This value must not be used.
StructuredQuery_UnaryFilter_OPERATOR_UNSPECIFIED StructuredQuery_UnaryFilter_Operator = 0
// The given `field` is equal to `NaN`.
StructuredQuery_UnaryFilter_IS_NAN StructuredQuery_UnaryFilter_Operator = 2
// The given `field` is equal to `NULL`.
StructuredQuery_UnaryFilter_IS_NULL StructuredQuery_UnaryFilter_Operator = 3
// The given `field` is not equal to `NaN`.
//
// Requires:
//
// * No other `NOT_EQUAL`, `NOT_IN`, `IS_NOT_NULL`, or `IS_NOT_NAN`.
// * That `field` comes first in the `order_by`.
StructuredQuery_UnaryFilter_IS_NOT_NAN StructuredQuery_UnaryFilter_Operator = 4
// The given `field` is not equal to `NULL`.
//
// Requires:
//
// * A single `NOT_EQUAL`, `NOT_IN`, `IS_NOT_NULL`, or `IS_NOT_NAN`.
// * That `field` comes first in the `order_by`.
StructuredQuery_UnaryFilter_IS_NOT_NULL StructuredQuery_UnaryFilter_Operator = 5
)
func (StructuredQuery_UnaryFilter_Operator) Descriptor() protoreflect.EnumDescriptor
func (x StructuredQuery_UnaryFilter_Operator) Enum() *StructuredQuery_UnaryFilter_Operator
func (StructuredQuery_UnaryFilter_Operator) EnumDescriptor() ([]byte, []int)
Deprecated: Use StructuredQuery_UnaryFilter_Operator.Descriptor instead.
func (x StructuredQuery_UnaryFilter_Operator) Number() protoreflect.EnumNumber
func (x StructuredQuery_UnaryFilter_Operator) String() string
func (StructuredQuery_UnaryFilter_Operator) Type() protoreflect.EnumType
A specification of a set of documents to listen to.
type Target struct {
// The type of target to listen to.
//
// Types that are assignable to TargetType:
// *Target_Query
// *Target_Documents
TargetType isTarget_TargetType `protobuf_oneof:"target_type"`
// When to start listening.
//
// If not specified, all matching Documents are returned before any
// subsequent changes.
//
// Types that are assignable to ResumeType:
// *Target_ResumeToken
// *Target_ReadTime
ResumeType isTarget_ResumeType `protobuf_oneof:"resume_type"`
// The target ID that identifies the target on the stream. Must be a positive
// number and non-zero.
TargetId int32 `protobuf:"varint,5,opt,name=target_id,json=targetId,proto3" json:"target_id,omitempty"`
// If the target should be removed once it is current and consistent.
Once bool `protobuf:"varint,6,opt,name=once,proto3" json:"once,omitempty"`
// contains filtered or unexported fields
}
func (*Target) Descriptor() ([]byte, []int)
Deprecated: Use Target.ProtoReflect.Descriptor instead.
func (x *Target) GetDocuments() *Target_DocumentsTarget
func (x *Target) GetOnce() bool
func (x *Target) GetQuery() *Target_QueryTarget
func (x *Target) GetReadTime() *timestamppb.Timestamp
func (x *Target) GetResumeToken() []byte
func (m *Target) GetResumeType() isTarget_ResumeType
func (x *Target) GetTargetId() int32
func (m *Target) GetTargetType() isTarget_TargetType
func (*Target) ProtoMessage()
func (x *Target) ProtoReflect() protoreflect.Message
func (x *Target) Reset()
func (x *Target) String() string
Targets being watched have changed.
type TargetChange struct {
// The type of change that occurred.
TargetChangeType TargetChange_TargetChangeType `protobuf:"varint,1,opt,name=target_change_type,json=targetChangeType,proto3,enum=google.firestore.v1beta1.TargetChange_TargetChangeType" json:"target_change_type,omitempty"`
// The target IDs of targets that have changed.
//
// If empty, the change applies to all targets.
//
// The order of the target IDs is not defined.
TargetIds []int32 `protobuf:"varint,2,rep,packed,name=target_ids,json=targetIds,proto3" json:"target_ids,omitempty"`
// The error that resulted in this change, if applicable.
Cause *status.Status `protobuf:"bytes,3,opt,name=cause,proto3" json:"cause,omitempty"`
// A token that can be used to resume the stream for the given `target_ids`,
// or all targets if `target_ids` is empty.
//
// Not set on every target change.
ResumeToken []byte `protobuf:"bytes,4,opt,name=resume_token,json=resumeToken,proto3" json:"resume_token,omitempty"`
// The consistent `read_time` for the given `target_ids` (omitted when the
// target_ids are not at a consistent snapshot).
//
// The stream is guaranteed to send a `read_time` with `target_ids` empty
// whenever the entire stream reaches a new consistent snapshot. ADD,
// CURRENT, and RESET messages are guaranteed to (eventually) result in a
// new consistent snapshot (while NO_CHANGE and REMOVE messages are not).
//
// For a given stream, `read_time` is guaranteed to be monotonically
// increasing.
ReadTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=read_time,json=readTime,proto3" json:"read_time,omitempty"`
// contains filtered or unexported fields
}
func (*TargetChange) Descriptor() ([]byte, []int)
Deprecated: Use TargetChange.ProtoReflect.Descriptor instead.
func (x *TargetChange) GetCause() *status.Status
func (x *TargetChange) GetReadTime() *timestamppb.Timestamp
func (x *TargetChange) GetResumeToken() []byte
func (x *TargetChange) GetTargetChangeType() TargetChange_TargetChangeType
func (x *TargetChange) GetTargetIds() []int32
func (*TargetChange) ProtoMessage()
func (x *TargetChange) ProtoReflect() protoreflect.Message
func (x *TargetChange) Reset()
func (x *TargetChange) String() string
The type of change.
type TargetChange_TargetChangeType int32
const (
// No change has occurred. Used only to send an updated `resume_token`.
TargetChange_NO_CHANGE TargetChange_TargetChangeType = 0
// The targets have been added.
TargetChange_ADD TargetChange_TargetChangeType = 1
// The targets have been removed.
TargetChange_REMOVE TargetChange_TargetChangeType = 2
// The targets reflect all changes committed before the targets were added
// to the stream.
//
// This will be sent after or with a `read_time` that is greater than or
// equal to the time at which the targets were added.
//
// Listeners can wait for this change if read-after-write semantics
// are desired.
TargetChange_CURRENT TargetChange_TargetChangeType = 3
// The targets have been reset, and a new initial state for the targets
// will be returned in subsequent changes.
//
// After the initial state is complete, `CURRENT` will be returned even
// if the target was previously indicated to be `CURRENT`.
TargetChange_RESET TargetChange_TargetChangeType = 4
)
func (TargetChange_TargetChangeType) Descriptor() protoreflect.EnumDescriptor
func (x TargetChange_TargetChangeType) Enum() *TargetChange_TargetChangeType
func (TargetChange_TargetChangeType) EnumDescriptor() ([]byte, []int)
Deprecated: Use TargetChange_TargetChangeType.Descriptor instead.
func (x TargetChange_TargetChangeType) Number() protoreflect.EnumNumber
func (x TargetChange_TargetChangeType) String() string
func (TargetChange_TargetChangeType) Type() protoreflect.EnumType
type Target_Documents struct {
// A target specified by a set of document names.
Documents *Target_DocumentsTarget `protobuf:"bytes,3,opt,name=documents,proto3,oneof"`
}
A target specified by a set of documents names.
type Target_DocumentsTarget struct {
// The names of the documents to retrieve. In the format:
// `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
// The request will fail if any of the document is not a child resource of
// the given `database`. Duplicate names will be elided.
Documents []string `protobuf:"bytes,2,rep,name=documents,proto3" json:"documents,omitempty"`
// contains filtered or unexported fields
}
func (*Target_DocumentsTarget) Descriptor() ([]byte, []int)
Deprecated: Use Target_DocumentsTarget.ProtoReflect.Descriptor instead.
func (x *Target_DocumentsTarget) GetDocuments() []string
func (*Target_DocumentsTarget) ProtoMessage()
func (x *Target_DocumentsTarget) ProtoReflect() protoreflect.Message
func (x *Target_DocumentsTarget) Reset()
func (x *Target_DocumentsTarget) String() string
type Target_Query struct {
// A target specified by a query.
Query *Target_QueryTarget `protobuf:"bytes,2,opt,name=query,proto3,oneof"`
}
A target specified by a query.
type Target_QueryTarget struct {
// The parent resource name. In the format:
// `projects/{project_id}/databases/{database_id}/documents` or
// `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
// For example:
// `projects/my-project/databases/my-database/documents` or
// `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// The query to run.
//
// Types that are assignable to QueryType:
// *Target_QueryTarget_StructuredQuery
QueryType isTarget_QueryTarget_QueryType `protobuf_oneof:"query_type"`
// contains filtered or unexported fields
}
func (*Target_QueryTarget) Descriptor() ([]byte, []int)
Deprecated: Use Target_QueryTarget.ProtoReflect.Descriptor instead.
func (x *Target_QueryTarget) GetParent() string
func (m *Target_QueryTarget) GetQueryType() isTarget_QueryTarget_QueryType
func (x *Target_QueryTarget) GetStructuredQuery() *StructuredQuery
func (*Target_QueryTarget) ProtoMessage()
func (x *Target_QueryTarget) ProtoReflect() protoreflect.Message
func (x *Target_QueryTarget) Reset()
func (x *Target_QueryTarget) String() string
type Target_QueryTarget_StructuredQuery struct {
// A structured query.
StructuredQuery *StructuredQuery `protobuf:"bytes,2,opt,name=structured_query,json=structuredQuery,proto3,oneof"`
}
type Target_ReadTime struct {
// Start listening after a specific `read_time`.
//
// The client must know the state of matching documents at this time.
ReadTime *timestamppb.Timestamp `protobuf:"bytes,11,opt,name=read_time,json=readTime,proto3,oneof"`
}
type Target_ResumeToken struct {
// A resume token from a prior [TargetChange][google.firestore.v1beta1.TargetChange] for an identical target.
//
// Using a resume token with a different target is unsupported and may fail.
ResumeToken []byte `protobuf:"bytes,4,opt,name=resume_token,json=resumeToken,proto3,oneof"`
}
Options for creating a new transaction.
type TransactionOptions struct {
// The mode of the transaction.
//
// Types that are assignable to Mode:
//
// *TransactionOptions_ReadOnly_
// *TransactionOptions_ReadWrite_
Mode isTransactionOptions_Mode `protobuf_oneof:"mode"`
// contains filtered or unexported fields
}
func (*TransactionOptions) Descriptor() ([]byte, []int)
Deprecated: Use TransactionOptions.ProtoReflect.Descriptor instead.
func (m *TransactionOptions) GetMode() isTransactionOptions_Mode
func (x *TransactionOptions) GetReadOnly() *TransactionOptions_ReadOnly
func (x *TransactionOptions) GetReadWrite() *TransactionOptions_ReadWrite
func (*TransactionOptions) ProtoMessage()
func (x *TransactionOptions) ProtoReflect() protoreflect.Message
func (x *TransactionOptions) Reset()
func (x *TransactionOptions) String() string
Options for a transaction that can only be used to read documents.
type TransactionOptions_ReadOnly struct {
// The consistency mode for this transaction. If not set, defaults to strong
// consistency.
//
// Types that are assignable to ConsistencySelector:
//
// *TransactionOptions_ReadOnly_ReadTime
ConsistencySelector isTransactionOptions_ReadOnly_ConsistencySelector `protobuf_oneof:"consistency_selector"`
// contains filtered or unexported fields
}
func (*TransactionOptions_ReadOnly) Descriptor() ([]byte, []int)
Deprecated: Use TransactionOptions_ReadOnly.ProtoReflect.Descriptor instead.
func (m *TransactionOptions_ReadOnly) GetConsistencySelector() isTransactionOptions_ReadOnly_ConsistencySelector
func (x *TransactionOptions_ReadOnly) GetReadTime() *timestamppb.Timestamp
func (*TransactionOptions_ReadOnly) ProtoMessage()
func (x *TransactionOptions_ReadOnly) ProtoReflect() protoreflect.Message
func (x *TransactionOptions_ReadOnly) Reset()
func (x *TransactionOptions_ReadOnly) String() string
type TransactionOptions_ReadOnly_ struct {
// The transaction can only be used for read operations.
ReadOnly *TransactionOptions_ReadOnly `protobuf:"bytes,2,opt,name=read_only,json=readOnly,proto3,oneof"`
}
type TransactionOptions_ReadOnly_ReadTime struct {
// Reads documents at the given time.
// This may not be older than 60 seconds.
ReadTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=read_time,json=readTime,proto3,oneof"`
}
Options for a transaction that can be used to read and write documents.
type TransactionOptions_ReadWrite struct {
// An optional transaction to retry.
RetryTransaction []byte `protobuf:"bytes,1,opt,name=retry_transaction,json=retryTransaction,proto3" json:"retry_transaction,omitempty"`
// contains filtered or unexported fields
}
func (*TransactionOptions_ReadWrite) Descriptor() ([]byte, []int)
Deprecated: Use TransactionOptions_ReadWrite.ProtoReflect.Descriptor instead.
func (x *TransactionOptions_ReadWrite) GetRetryTransaction() []byte
func (*TransactionOptions_ReadWrite) ProtoMessage()
func (x *TransactionOptions_ReadWrite) ProtoReflect() protoreflect.Message
func (x *TransactionOptions_ReadWrite) Reset()
func (x *TransactionOptions_ReadWrite) String() string
type TransactionOptions_ReadWrite_ struct {
// The transaction can be used for both read and write operations.
ReadWrite *TransactionOptions_ReadWrite `protobuf:"bytes,3,opt,name=read_write,json=readWrite,proto3,oneof"`
}
UnimplementedFirestoreServer can be embedded to have forward compatible implementations.
type UnimplementedFirestoreServer struct {
}
func (*UnimplementedFirestoreServer) BatchGetDocuments(*BatchGetDocumentsRequest, Firestore_BatchGetDocumentsServer) error
func (*UnimplementedFirestoreServer) BatchWrite(context.Context, *BatchWriteRequest) (*BatchWriteResponse, error)
func (*UnimplementedFirestoreServer) BeginTransaction(context.Context, *BeginTransactionRequest) (*BeginTransactionResponse, error)
func (*UnimplementedFirestoreServer) Commit(context.Context, *CommitRequest) (*CommitResponse, error)
func (*UnimplementedFirestoreServer) CreateDocument(context.Context, *CreateDocumentRequest) (*Document, error)
func (*UnimplementedFirestoreServer) DeleteDocument(context.Context, *DeleteDocumentRequest) (*emptypb.Empty, error)
func (*UnimplementedFirestoreServer) GetDocument(context.Context, *GetDocumentRequest) (*Document, error)
func (*UnimplementedFirestoreServer) ListCollectionIds(context.Context, *ListCollectionIdsRequest) (*ListCollectionIdsResponse, error)
func (*UnimplementedFirestoreServer) ListDocuments(context.Context, *ListDocumentsRequest) (*ListDocumentsResponse, error)
func (*UnimplementedFirestoreServer) Listen(Firestore_ListenServer) error
func (*UnimplementedFirestoreServer) PartitionQuery(context.Context, *PartitionQueryRequest) (*PartitionQueryResponse, error)
func (*UnimplementedFirestoreServer) Rollback(context.Context, *RollbackRequest) (*emptypb.Empty, error)
func (*UnimplementedFirestoreServer) RunQuery(*RunQueryRequest, Firestore_RunQueryServer) error
func (*UnimplementedFirestoreServer) UpdateDocument(context.Context, *UpdateDocumentRequest) (*Document, error)
func (*UnimplementedFirestoreServer) Write(Firestore_WriteServer) error
The request for [Firestore.UpdateDocument][google.firestore.v1beta1.Firestore.UpdateDocument].
type UpdateDocumentRequest struct {
// Required. The updated document.
// Creates the document if it does not already exist.
Document *Document `protobuf:"bytes,1,opt,name=document,proto3" json:"document,omitempty"`
// The fields to update.
// None of the field paths in the mask may contain a reserved name.
//
// If the document exists on the server and has fields not referenced in the
// mask, they are left unchanged.
// Fields referenced in the mask, but not present in the input document, are
// deleted from the document on the server.
UpdateMask *DocumentMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// The fields to return. If not set, returns all fields.
//
// If the document has a field that is not present in this mask, that field
// will not be returned in the response.
Mask *DocumentMask `protobuf:"bytes,3,opt,name=mask,proto3" json:"mask,omitempty"`
// An optional precondition on the document.
// The request will fail if this is set and not met by the target document.
CurrentDocument *Precondition `protobuf:"bytes,4,opt,name=current_document,json=currentDocument,proto3" json:"current_document,omitempty"`
// contains filtered or unexported fields
}
func (*UpdateDocumentRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateDocumentRequest.ProtoReflect.Descriptor instead.
func (x *UpdateDocumentRequest) GetCurrentDocument() *Precondition
func (x *UpdateDocumentRequest) GetDocument() *Document
func (x *UpdateDocumentRequest) GetMask() *DocumentMask
func (x *UpdateDocumentRequest) GetUpdateMask() *DocumentMask
func (*UpdateDocumentRequest) ProtoMessage()
func (x *UpdateDocumentRequest) ProtoReflect() protoreflect.Message
func (x *UpdateDocumentRequest) Reset()
func (x *UpdateDocumentRequest) String() string
A message that can hold any of the supported value types.
type Value struct {
// Must have a value set.
//
// Types that are assignable to ValueType:
//
// *Value_NullValue
// *Value_BooleanValue
// *Value_IntegerValue
// *Value_DoubleValue
// *Value_TimestampValue
// *Value_StringValue
// *Value_BytesValue
// *Value_ReferenceValue
// *Value_GeoPointValue
// *Value_ArrayValue
// *Value_MapValue
ValueType isValue_ValueType `protobuf_oneof:"value_type"`
// contains filtered or unexported fields
}
func (*Value) Descriptor() ([]byte, []int)
Deprecated: Use Value.ProtoReflect.Descriptor instead.
func (x *Value) GetArrayValue() *ArrayValue
func (x *Value) GetBooleanValue() bool
func (x *Value) GetBytesValue() []byte
func (x *Value) GetDoubleValue() float64
func (x *Value) GetGeoPointValue() *latlng.LatLng
func (x *Value) GetIntegerValue() int64
func (x *Value) GetMapValue() *MapValue
func (x *Value) GetNullValue() structpb.NullValue
func (x *Value) GetReferenceValue() string
func (x *Value) GetStringValue() string
func (x *Value) GetTimestampValue() *timestamppb.Timestamp
func (m *Value) GetValueType() isValue_ValueType
func (*Value) ProtoMessage()
func (x *Value) ProtoReflect() protoreflect.Message
func (x *Value) Reset()
func (x *Value) String() string
type Value_ArrayValue struct {
// An array value.
//
// Cannot directly contain another array value, though can contain an
// map which contains another array.
ArrayValue *ArrayValue `protobuf:"bytes,9,opt,name=array_value,json=arrayValue,proto3,oneof"`
}
type Value_BooleanValue struct {
// A boolean value.
BooleanValue bool `protobuf:"varint,1,opt,name=boolean_value,json=booleanValue,proto3,oneof"`
}
type Value_BytesValue struct {
// A bytes value.
//
// Must not exceed 1 MiB - 89 bytes.
// Only the first 1,500 bytes are considered by queries.
BytesValue []byte `protobuf:"bytes,18,opt,name=bytes_value,json=bytesValue,proto3,oneof"`
}
type Value_DoubleValue struct {
// A double value.
DoubleValue float64 `protobuf:"fixed64,3,opt,name=double_value,json=doubleValue,proto3,oneof"`
}
type Value_GeoPointValue struct {
// A geo point value representing a point on the surface of Earth.
GeoPointValue *latlng.LatLng `protobuf:"bytes,8,opt,name=geo_point_value,json=geoPointValue,proto3,oneof"`
}
type Value_IntegerValue struct {
// An integer value.
IntegerValue int64 `protobuf:"varint,2,opt,name=integer_value,json=integerValue,proto3,oneof"`
}
type Value_MapValue struct {
// A map value.
MapValue *MapValue `protobuf:"bytes,6,opt,name=map_value,json=mapValue,proto3,oneof"`
}
type Value_NullValue struct {
// A null value.
NullValue structpb.NullValue `protobuf:"varint,11,opt,name=null_value,json=nullValue,proto3,enum=google.protobuf.NullValue,oneof"`
}
type Value_ReferenceValue struct {
// A reference to a document. For example:
// `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
ReferenceValue string `protobuf:"bytes,5,opt,name=reference_value,json=referenceValue,proto3,oneof"`
}
type Value_StringValue struct {
// A string value.
//
// The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes.
// Only the first 1,500 bytes of the UTF-8 representation are considered by
// queries.
StringValue string `protobuf:"bytes,17,opt,name=string_value,json=stringValue,proto3,oneof"`
}
type Value_TimestampValue struct {
// A timestamp value.
//
// Precise only to microseconds. When stored, any additional precision is
// rounded down.
TimestampValue *timestamppb.Timestamp `protobuf:"bytes,10,opt,name=timestamp_value,json=timestampValue,proto3,oneof"`
}
A write on a document.
type Write struct {
// The operation to execute.
//
// Types that are assignable to Operation:
//
// *Write_Update
// *Write_Delete
// *Write_Transform
Operation isWrite_Operation `protobuf_oneof:"operation"`
// The fields to update in this write.
//
// This field can be set only when the operation is `update`.
// If the mask is not set for an `update` and the document exists, any
// existing data will be overwritten.
// If the mask is set and the document on the server has fields not covered by
// the mask, they are left unchanged.
// Fields referenced in the mask, but not present in the input document, are
// deleted from the document on the server.
// The field paths in this mask must not contain a reserved field name.
UpdateMask *DocumentMask `protobuf:"bytes,3,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// The transforms to perform after update.
//
// This field can be set only when the operation is `update`. If present, this
// write is equivalent to performing `update` and `transform` to the same
// document atomically and in order.
UpdateTransforms []*DocumentTransform_FieldTransform `protobuf:"bytes,7,rep,name=update_transforms,json=updateTransforms,proto3" json:"update_transforms,omitempty"`
// An optional precondition on the document.
//
// The write will fail if this is set and not met by the target document.
CurrentDocument *Precondition `protobuf:"bytes,4,opt,name=current_document,json=currentDocument,proto3" json:"current_document,omitempty"`
// contains filtered or unexported fields
}
func (*Write) Descriptor() ([]byte, []int)
Deprecated: Use Write.ProtoReflect.Descriptor instead.
func (x *Write) GetCurrentDocument() *Precondition
func (x *Write) GetDelete() string
func (m *Write) GetOperation() isWrite_Operation
func (x *Write) GetTransform() *DocumentTransform
func (x *Write) GetUpdate() *Document
func (x *Write) GetUpdateMask() *DocumentMask
func (x *Write) GetUpdateTransforms() []*DocumentTransform_FieldTransform
func (*Write) ProtoMessage()
func (x *Write) ProtoReflect() protoreflect.Message
func (x *Write) Reset()
func (x *Write) String() string
The request for [Firestore.Write][google.firestore.v1beta1.Firestore.Write].
The first request creates a stream, or resumes an existing one from a token.
When creating a new stream, the server replies with a response containing only an ID and a token, to use in the next request.
When resuming a stream, the server first streams any responses later than the given token, then a response containing only an up-to-date token, to use in the next request.
type WriteRequest struct {
// Required. The database name. In the format:
// `projects/{project_id}/databases/{database_id}`.
// This is only required in the first message.
Database string `protobuf:"bytes,1,opt,name=database,proto3" json:"database,omitempty"`
// The ID of the write stream to resume.
// This may only be set in the first message. When left empty, a new write
// stream will be created.
StreamId string `protobuf:"bytes,2,opt,name=stream_id,json=streamId,proto3" json:"stream_id,omitempty"`
// The writes to apply.
//
// Always executed atomically and in order.
// This must be empty on the first request.
// This may be empty on the last request.
// This must not be empty on all other requests.
Writes []*Write `protobuf:"bytes,3,rep,name=writes,proto3" json:"writes,omitempty"`
// A stream token that was previously sent by the server.
//
// The client should set this field to the token from the most recent
// [WriteResponse][google.firestore.v1beta1.WriteResponse] it has received. This acknowledges that the client has
// received responses up to this token. After sending this token, earlier
// tokens may not be used anymore.
//
// The server may close the stream if there are too many unacknowledged
// responses.
//
// Leave this field unset when creating a new stream. To resume a stream at
// a specific point, set this field and the `stream_id` field.
//
// Leave this field unset when creating a new stream.
StreamToken []byte `protobuf:"bytes,4,opt,name=stream_token,json=streamToken,proto3" json:"stream_token,omitempty"`
// Labels associated with this write request.
Labels map[string]string `protobuf:"bytes,5,rep,name=labels,proto3" json:"labels,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// contains filtered or unexported fields
}
func (*WriteRequest) Descriptor() ([]byte, []int)
Deprecated: Use WriteRequest.ProtoReflect.Descriptor instead.
func (x *WriteRequest) GetDatabase() string
func (x *WriteRequest) GetLabels() map[string]string
func (x *WriteRequest) GetStreamId() string
func (x *WriteRequest) GetStreamToken() []byte
func (x *WriteRequest) GetWrites() []*Write
func (*WriteRequest) ProtoMessage()
func (x *WriteRequest) ProtoReflect() protoreflect.Message
func (x *WriteRequest) Reset()
func (x *WriteRequest) String() string
The response for [Firestore.Write][google.firestore.v1beta1.Firestore.Write].
type WriteResponse struct {
// The ID of the stream.
// Only set on the first message, when a new stream was created.
StreamId string `protobuf:"bytes,1,opt,name=stream_id,json=streamId,proto3" json:"stream_id,omitempty"`
// A token that represents the position of this response in the stream.
// This can be used by a client to resume the stream at this point.
//
// This field is always set.
StreamToken []byte `protobuf:"bytes,2,opt,name=stream_token,json=streamToken,proto3" json:"stream_token,omitempty"`
// The result of applying the writes.
//
// This i-th write result corresponds to the i-th write in the
// request.
WriteResults []*WriteResult `protobuf:"bytes,3,rep,name=write_results,json=writeResults,proto3" json:"write_results,omitempty"`
// The time at which the commit occurred. Any read with an equal or greater
// `read_time` is guaranteed to see the effects of the write.
CommitTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=commit_time,json=commitTime,proto3" json:"commit_time,omitempty"`
// contains filtered or unexported fields
}
func (*WriteResponse) Descriptor() ([]byte, []int)
Deprecated: Use WriteResponse.ProtoReflect.Descriptor instead.
func (x *WriteResponse) GetCommitTime() *timestamppb.Timestamp
func (x *WriteResponse) GetStreamId() string
func (x *WriteResponse) GetStreamToken() []byte
func (x *WriteResponse) GetWriteResults() []*WriteResult
func (*WriteResponse) ProtoMessage()
func (x *WriteResponse) ProtoReflect() protoreflect.Message
func (x *WriteResponse) Reset()
func (x *WriteResponse) String() string
The result of applying a write.
type WriteResult struct {
// The last update time of the document after applying the write. Not set
// after a `delete`.
//
// If the write did not actually change the document, this will be the
// previous update_time.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// The results of applying each [DocumentTransform.FieldTransform][google.firestore.v1beta1.DocumentTransform.FieldTransform], in the
// same order.
TransformResults []*Value `protobuf:"bytes,2,rep,name=transform_results,json=transformResults,proto3" json:"transform_results,omitempty"`
// contains filtered or unexported fields
}
func (*WriteResult) Descriptor() ([]byte, []int)
Deprecated: Use WriteResult.ProtoReflect.Descriptor instead.
func (x *WriteResult) GetTransformResults() []*Value
func (x *WriteResult) GetUpdateTime() *timestamppb.Timestamp
func (*WriteResult) ProtoMessage()
func (x *WriteResult) ProtoReflect() protoreflect.Message
func (x *WriteResult) Reset()
func (x *WriteResult) String() string
type Write_Delete struct {
// A document name to delete. In the format:
// `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
Delete string `protobuf:"bytes,2,opt,name=delete,proto3,oneof"`
}
type Write_Transform struct {
// Applies a transformation to a document.
Transform *DocumentTransform `protobuf:"bytes,6,opt,name=transform,proto3,oneof"`
}
type Write_Update struct {
// A document to write.
Update *Document `protobuf:"bytes,1,opt,name=update,proto3,oneof"`
}