Back to godoc.org

Package firestore

v0.0.0 (2e714ab)
Latest Go to latest
Published: today | License: Apache-2.0 | Module: google.golang.org/genproto

Index

Package Files

Variables

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 TargetChange_TargetChangeType.

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_Direction.

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_CompositeFilter_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",
		7: "ARRAY_CONTAINS",
		8: "IN",
		9: "ARRAY_CONTAINS_ANY",
	}
	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,
		"ARRAY_CONTAINS":        7,
		"IN":                    8,
		"ARRAY_CONTAINS_ANY":    9,
	}
)

Enum value maps for StructuredQuery_FieldFilter_Operator.

var (
	StructuredQuery_UnaryFilter_Operator_name = map[int32]string{
		0: "OPERATOR_UNSPECIFIED",
		2: "IS_NAN",
		3: "IS_NULL",
	}
	StructuredQuery_UnaryFilter_Operator_value = map[string]int32{
		"OPERATOR_UNSPECIFIED": 0,
		"IS_NAN":               2,
		"IS_NULL":              3,
	}
)

Enum value maps for StructuredQuery_UnaryFilter_Operator.

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,
	}
)

Enum value maps for DocumentTransform_FieldTransform_ServerValue.

var File_google_firestore_v1_common_proto protoreflect.FileDescriptor
var File_google_firestore_v1_document_proto protoreflect.FileDescriptor
var File_google_firestore_v1_firestore_proto protoreflect.FileDescriptor
var File_google_firestore_v1_query_proto protoreflect.FileDescriptor
var File_google_firestore_v1_write_proto protoreflect.FileDescriptor

func RegisterFirestoreServer

func RegisterFirestoreServer(s *grpc.Server, srv FirestoreServer)

type ArrayValue

type ArrayValue struct {

	// Values in the array.
	Values []*Value `protobuf:"bytes,1,rep,name=values,proto3" json:"values,omitempty"`
	// contains filtered or unexported fields
}

An array value.

func (*ArrayValue) Descriptor

func (*ArrayValue) Descriptor() ([]byte, []int)

Deprecated: Use ArrayValue.ProtoReflect.Descriptor instead.

func (*ArrayValue) GetValues

func (x *ArrayValue) GetValues() []*Value

func (*ArrayValue) ProtoMessage

func (*ArrayValue) ProtoMessage()

func (*ArrayValue) ProtoReflect

func (x *ArrayValue) ProtoReflect() protoreflect.Message

func (*ArrayValue) Reset

func (x *ArrayValue) Reset()

func (*ArrayValue) String

func (x *ArrayValue) String() string

type BatchGetDocumentsRequest

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
}

The request for [Firestore.BatchGetDocuments][google.firestore.v1.Firestore.BatchGetDocuments].

func (*BatchGetDocumentsRequest) Descriptor

func (*BatchGetDocumentsRequest) Descriptor() ([]byte, []int)

Deprecated: Use BatchGetDocumentsRequest.ProtoReflect.Descriptor instead.

func (*BatchGetDocumentsRequest) GetConsistencySelector

func (m *BatchGetDocumentsRequest) GetConsistencySelector() isBatchGetDocumentsRequest_ConsistencySelector

func (*BatchGetDocumentsRequest) GetDatabase

func (x *BatchGetDocumentsRequest) GetDatabase() string

func (*BatchGetDocumentsRequest) GetDocuments

func (x *BatchGetDocumentsRequest) GetDocuments() []string

func (*BatchGetDocumentsRequest) GetMask

func (x *BatchGetDocumentsRequest) GetMask() *DocumentMask

func (*BatchGetDocumentsRequest) GetNewTransaction

func (x *BatchGetDocumentsRequest) GetNewTransaction() *TransactionOptions

func (*BatchGetDocumentsRequest) GetReadTime

func (x *BatchGetDocumentsRequest) GetReadTime() *timestamp.Timestamp

func (*BatchGetDocumentsRequest) GetTransaction

func (x *BatchGetDocumentsRequest) GetTransaction() []byte

func (*BatchGetDocumentsRequest) ProtoMessage

func (*BatchGetDocumentsRequest) ProtoMessage()

func (*BatchGetDocumentsRequest) ProtoReflect

func (x *BatchGetDocumentsRequest) ProtoReflect() protoreflect.Message

func (*BatchGetDocumentsRequest) Reset

func (x *BatchGetDocumentsRequest) Reset()

func (*BatchGetDocumentsRequest) String

func (x *BatchGetDocumentsRequest) String() string

type BatchGetDocumentsRequest_NewTransaction

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

type BatchGetDocumentsRequest_ReadTime struct {
	// Reads documents as they were at the given time.
	// This may not be older than 270 seconds.
	ReadTime *timestamp.Timestamp `protobuf:"bytes,7,opt,name=read_time,json=readTime,proto3,oneof"`
}

type BatchGetDocumentsRequest_Transaction

type BatchGetDocumentsRequest_Transaction struct {
	// Reads documents in a transaction.
	Transaction []byte `protobuf:"bytes,4,opt,name=transaction,proto3,oneof"`
}

type BatchGetDocumentsResponse

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.v1.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 *timestamp.Timestamp `protobuf:"bytes,4,opt,name=read_time,json=readTime,proto3" json:"read_time,omitempty"`
	// contains filtered or unexported fields
}

The streamed response for [Firestore.BatchGetDocuments][google.firestore.v1.Firestore.BatchGetDocuments].

func (*BatchGetDocumentsResponse) Descriptor

func (*BatchGetDocumentsResponse) Descriptor() ([]byte, []int)

Deprecated: Use BatchGetDocumentsResponse.ProtoReflect.Descriptor instead.

func (*BatchGetDocumentsResponse) GetFound

func (x *BatchGetDocumentsResponse) GetFound() *Document

func (*BatchGetDocumentsResponse) GetMissing

func (x *BatchGetDocumentsResponse) GetMissing() string

func (*BatchGetDocumentsResponse) GetReadTime

func (x *BatchGetDocumentsResponse) GetReadTime() *timestamp.Timestamp

func (*BatchGetDocumentsResponse) GetResult

func (m *BatchGetDocumentsResponse) GetResult() isBatchGetDocumentsResponse_Result

func (*BatchGetDocumentsResponse) GetTransaction

func (x *BatchGetDocumentsResponse) GetTransaction() []byte

func (*BatchGetDocumentsResponse) ProtoMessage

func (*BatchGetDocumentsResponse) ProtoMessage()

func (*BatchGetDocumentsResponse) ProtoReflect

func (x *BatchGetDocumentsResponse) ProtoReflect() protoreflect.Message

func (*BatchGetDocumentsResponse) Reset

func (x *BatchGetDocumentsResponse) Reset()

func (*BatchGetDocumentsResponse) String

func (x *BatchGetDocumentsResponse) String() string

type BatchGetDocumentsResponse_Found

type BatchGetDocumentsResponse_Found struct {
	// A document that was requested.
	Found *Document `protobuf:"bytes,1,opt,name=found,proto3,oneof"`
}

type BatchGetDocumentsResponse_Missing

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"`
}

type BatchWriteRequest

type BatchWriteRequest struct {
	Database string `protobuf:"bytes,1,opt,name=database,proto3" json:"database,omitempty"`

	Writes []*Write `protobuf:"bytes,2,rep,name=writes,proto3" json:"writes,omitempty"`

	Labels map[string]string "" /* 153 byte string literal not displayed */

}

The request for [Firestore.BatchWrite][google.firestore.v1.Firestore.BatchWrite].

func (*BatchWriteRequest) Descriptor

func (*BatchWriteRequest) Descriptor() ([]byte, []int)

Deprecated: Use BatchWriteRequest.ProtoReflect.Descriptor instead.

func (*BatchWriteRequest) GetDatabase

func (x *BatchWriteRequest) GetDatabase() string

func (*BatchWriteRequest) GetLabels

func (x *BatchWriteRequest) GetLabels() map[string]string

func (*BatchWriteRequest) GetWrites

func (x *BatchWriteRequest) GetWrites() []*Write

func (*BatchWriteRequest) ProtoMessage

func (*BatchWriteRequest) ProtoMessage()

func (*BatchWriteRequest) ProtoReflect

func (x *BatchWriteRequest) ProtoReflect() protoreflect.Message

func (*BatchWriteRequest) Reset

func (x *BatchWriteRequest) Reset()

func (*BatchWriteRequest) String

func (x *BatchWriteRequest) String() string

type BatchWriteResponse

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
}

The response from [Firestore.BatchWrite][google.firestore.v1.Firestore.BatchWrite].

func (*BatchWriteResponse) Descriptor

func (*BatchWriteResponse) Descriptor() ([]byte, []int)

Deprecated: Use BatchWriteResponse.ProtoReflect.Descriptor instead.

func (*BatchWriteResponse) GetStatus

func (x *BatchWriteResponse) GetStatus() []*status.Status

func (*BatchWriteResponse) GetWriteResults

func (x *BatchWriteResponse) GetWriteResults() []*WriteResult

func (*BatchWriteResponse) ProtoMessage

func (*BatchWriteResponse) ProtoMessage()

func (*BatchWriteResponse) ProtoReflect

func (x *BatchWriteResponse) ProtoReflect() protoreflect.Message

func (*BatchWriteResponse) Reset

func (x *BatchWriteResponse) Reset()

func (*BatchWriteResponse) String

func (x *BatchWriteResponse) String() string

type BeginTransactionRequest

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
}

The request for [Firestore.BeginTransaction][google.firestore.v1.Firestore.BeginTransaction].

func (*BeginTransactionRequest) Descriptor

func (*BeginTransactionRequest) Descriptor() ([]byte, []int)

Deprecated: Use BeginTransactionRequest.ProtoReflect.Descriptor instead.

func (*BeginTransactionRequest) GetDatabase

func (x *BeginTransactionRequest) GetDatabase() string

func (*BeginTransactionRequest) GetOptions

func (x *BeginTransactionRequest) GetOptions() *TransactionOptions

func (*BeginTransactionRequest) ProtoMessage

func (*BeginTransactionRequest) ProtoMessage()

func (*BeginTransactionRequest) ProtoReflect

func (x *BeginTransactionRequest) ProtoReflect() protoreflect.Message

func (*BeginTransactionRequest) Reset

func (x *BeginTransactionRequest) Reset()

func (*BeginTransactionRequest) String

func (x *BeginTransactionRequest) String() string

type BeginTransactionResponse

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
}

The response for [Firestore.BeginTransaction][google.firestore.v1.Firestore.BeginTransaction].

func (*BeginTransactionResponse) Descriptor

func (*BeginTransactionResponse) Descriptor() ([]byte, []int)

Deprecated: Use BeginTransactionResponse.ProtoReflect.Descriptor instead.

func (*BeginTransactionResponse) GetTransaction

func (x *BeginTransactionResponse) GetTransaction() []byte

func (*BeginTransactionResponse) ProtoMessage

func (*BeginTransactionResponse) ProtoMessage()

func (*BeginTransactionResponse) ProtoReflect

func (x *BeginTransactionResponse) ProtoReflect() protoreflect.Message

func (*BeginTransactionResponse) Reset

func (x *BeginTransactionResponse) Reset()

func (*BeginTransactionResponse) String

func (x *BeginTransactionResponse) String() string

type CommitRequest

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
}

The request for [Firestore.Commit][google.firestore.v1.Firestore.Commit].

func (*CommitRequest) Descriptor

func (*CommitRequest) Descriptor() ([]byte, []int)

Deprecated: Use CommitRequest.ProtoReflect.Descriptor instead.

func (*CommitRequest) GetDatabase

func (x *CommitRequest) GetDatabase() string

func (*CommitRequest) GetTransaction

func (x *CommitRequest) GetTransaction() []byte

func (*CommitRequest) GetWrites

func (x *CommitRequest) GetWrites() []*Write

func (*CommitRequest) ProtoMessage

func (*CommitRequest) ProtoMessage()

func (*CommitRequest) ProtoReflect

func (x *CommitRequest) ProtoReflect() protoreflect.Message

func (*CommitRequest) Reset

func (x *CommitRequest) Reset()

func (*CommitRequest) String

func (x *CommitRequest) String() string

type CommitResponse

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 *timestamp.Timestamp `protobuf:"bytes,2,opt,name=commit_time,json=commitTime,proto3" json:"commit_time,omitempty"`
	// contains filtered or unexported fields
}

The response for [Firestore.Commit][google.firestore.v1.Firestore.Commit].

func (*CommitResponse) Descriptor

func (*CommitResponse) Descriptor() ([]byte, []int)

Deprecated: Use CommitResponse.ProtoReflect.Descriptor instead.

func (*CommitResponse) GetCommitTime

func (x *CommitResponse) GetCommitTime() *timestamp.Timestamp

func (*CommitResponse) GetWriteResults

func (x *CommitResponse) GetWriteResults() []*WriteResult

func (*CommitResponse) ProtoMessage

func (*CommitResponse) ProtoMessage()

func (*CommitResponse) ProtoReflect

func (x *CommitResponse) ProtoReflect() protoreflect.Message

func (*CommitResponse) Reset

func (x *CommitResponse) Reset()

func (*CommitResponse) String

func (x *CommitResponse) String() string

type CreateDocumentRequest

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
}

The request for [Firestore.CreateDocument][google.firestore.v1.Firestore.CreateDocument].

func (*CreateDocumentRequest) Descriptor

func (*CreateDocumentRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateDocumentRequest.ProtoReflect.Descriptor instead.

func (*CreateDocumentRequest) GetCollectionId

func (x *CreateDocumentRequest) GetCollectionId() string

func (*CreateDocumentRequest) GetDocument

func (x *CreateDocumentRequest) GetDocument() *Document

func (*CreateDocumentRequest) GetDocumentId

func (x *CreateDocumentRequest) GetDocumentId() string

func (*CreateDocumentRequest) GetMask

func (x *CreateDocumentRequest) GetMask() *DocumentMask

func (*CreateDocumentRequest) GetParent

func (x *CreateDocumentRequest) GetParent() string

func (*CreateDocumentRequest) ProtoMessage

func (*CreateDocumentRequest) ProtoMessage()

func (*CreateDocumentRequest) ProtoReflect

func (x *CreateDocumentRequest) ProtoReflect() protoreflect.Message

func (*CreateDocumentRequest) Reset

func (x *CreateDocumentRequest) Reset()

func (*CreateDocumentRequest) String

func (x *CreateDocumentRequest) String() string

type Cursor

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
}

A position in a query result set.

func (*Cursor) Descriptor

func (*Cursor) Descriptor() ([]byte, []int)

Deprecated: Use Cursor.ProtoReflect.Descriptor instead.

func (*Cursor) GetBefore

func (x *Cursor) GetBefore() bool

func (*Cursor) GetValues

func (x *Cursor) GetValues() []*Value

func (*Cursor) ProtoMessage

func (*Cursor) ProtoMessage()

func (*Cursor) ProtoReflect

func (x *Cursor) ProtoReflect() protoreflect.Message

func (*Cursor) Reset

func (x *Cursor) Reset()

func (*Cursor) String

func (x *Cursor) String() string

type DeleteDocumentRequest

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
}

The request for [Firestore.DeleteDocument][google.firestore.v1.Firestore.DeleteDocument].

func (*DeleteDocumentRequest) Descriptor

func (*DeleteDocumentRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteDocumentRequest.ProtoReflect.Descriptor instead.

func (*DeleteDocumentRequest) GetCurrentDocument

func (x *DeleteDocumentRequest) GetCurrentDocument() *Precondition

func (*DeleteDocumentRequest) GetName

func (x *DeleteDocumentRequest) GetName() string

func (*DeleteDocumentRequest) ProtoMessage

func (*DeleteDocumentRequest) ProtoMessage()

func (*DeleteDocumentRequest) ProtoReflect

func (x *DeleteDocumentRequest) ProtoReflect() protoreflect.Message

func (*DeleteDocumentRequest) Reset

func (x *DeleteDocumentRequest) Reset()

func (*DeleteDocumentRequest) String

func (x *DeleteDocumentRequest) String() string

type Document

type Document struct {
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`

	Fields map[string]*Value "" /* 153 byte string literal not displayed */

	CreateTime *timestamp.Timestamp `protobuf:"bytes,3,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`

	UpdateTime *timestamp.Timestamp `protobuf:"bytes,4,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`

}

A Firestore document.

Must not exceed 1 MiB - 4 bytes.

func (*Document) Descriptor

func (*Document) Descriptor() ([]byte, []int)

Deprecated: Use Document.ProtoReflect.Descriptor instead.

func (*Document) GetCreateTime

func (x *Document) GetCreateTime() *timestamp.Timestamp

func (*Document) GetFields

func (x *Document) GetFields() map[string]*Value

func (*Document) GetName

func (x *Document) GetName() string

func (*Document) GetUpdateTime

func (x *Document) GetUpdateTime() *timestamp.Timestamp

func (*Document) ProtoMessage

func (*Document) ProtoMessage()

func (*Document) ProtoReflect

func (x *Document) ProtoReflect() protoreflect.Message

func (*Document) Reset

func (x *Document) Reset()

func (*Document) String

func (x *Document) String() string

type DocumentChange

type DocumentChange struct {

	// The new state of the [Document][google.firestore.v1.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
}

A [Document][google.firestore.v1.Document] has changed.

May be the result of multiple [writes][google.firestore.v1.Write], including deletes, that ultimately resulted in a new value for the [Document][google.firestore.v1.Document].

Multiple [DocumentChange][google.firestore.v1.DocumentChange] messages may be returned for the same logical change, if multiple targets are affected.

func (*DocumentChange) Descriptor

func (*DocumentChange) Descriptor() ([]byte, []int)

Deprecated: Use DocumentChange.ProtoReflect.Descriptor instead.

func (*DocumentChange) GetDocument

func (x *DocumentChange) GetDocument() *Document

func (*DocumentChange) GetRemovedTargetIds

func (x *DocumentChange) GetRemovedTargetIds() []int32

func (*DocumentChange) GetTargetIds

func (x *DocumentChange) GetTargetIds() []int32

func (*DocumentChange) ProtoMessage

func (*DocumentChange) ProtoMessage()

func (*DocumentChange) ProtoReflect

func (x *DocumentChange) ProtoReflect() protoreflect.Message

func (*DocumentChange) Reset

func (x *DocumentChange) Reset()

func (*DocumentChange) String

func (x *DocumentChange) String() string

type DocumentDelete

type DocumentDelete struct {

	// The resource name of the [Document][google.firestore.v1.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 *timestamp.Timestamp `protobuf:"bytes,4,opt,name=read_time,json=readTime,proto3" json:"read_time,omitempty"`
	// contains filtered or unexported fields
}

A [Document][google.firestore.v1.Document] has been deleted.

May be the result of multiple [writes][google.firestore.v1.Write], including updates, the last of which deleted the [Document][google.firestore.v1.Document].

Multiple [DocumentDelete][google.firestore.v1.DocumentDelete] messages may be returned for the same logical delete, if multiple targets are affected.

func (*DocumentDelete) Descriptor

func (*DocumentDelete) Descriptor() ([]byte, []int)

Deprecated: Use DocumentDelete.ProtoReflect.Descriptor instead.

func (*DocumentDelete) GetDocument

func (x *DocumentDelete) GetDocument() string

func (*DocumentDelete) GetReadTime

func (x *DocumentDelete) GetReadTime() *timestamp.Timestamp

func (*DocumentDelete) GetRemovedTargetIds

func (x *DocumentDelete) GetRemovedTargetIds() []int32

func (*DocumentDelete) ProtoMessage

func (*DocumentDelete) ProtoMessage()

func (*DocumentDelete) ProtoReflect

func (x *DocumentDelete) ProtoReflect() protoreflect.Message

func (*DocumentDelete) Reset

func (x *DocumentDelete) Reset()

func (*DocumentDelete) String

func (x *DocumentDelete) String() string

type DocumentMask

type DocumentMask struct {

	// The list of field paths in the mask. See [Document.fields][google.firestore.v1.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
}

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.v1.Document], and takes in account the dynamic nature of [Value][google.firestore.v1.Value].

func (*DocumentMask) Descriptor

func (*DocumentMask) Descriptor() ([]byte, []int)

Deprecated: Use DocumentMask.ProtoReflect.Descriptor instead.

func (*DocumentMask) GetFieldPaths

func (x *DocumentMask) GetFieldPaths() []string

func (*DocumentMask) ProtoMessage

func (*DocumentMask) ProtoMessage()

func (*DocumentMask) ProtoReflect

func (x *DocumentMask) ProtoReflect() protoreflect.Message

func (*DocumentMask) Reset

func (x *DocumentMask) Reset()

func (*DocumentMask) String

func (x *DocumentMask) String() string

type DocumentRemove

type DocumentRemove struct {

	// The resource name of the [Document][google.firestore.v1.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 *timestamp.Timestamp `protobuf:"bytes,4,opt,name=read_time,json=readTime,proto3" json:"read_time,omitempty"`
	// contains filtered or unexported fields
}

A [Document][google.firestore.v1.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.v1.DocumentRemove] messages may be returned for the same logical write or delete, if multiple targets are affected.

func (*DocumentRemove) Descriptor

func (*DocumentRemove) Descriptor() ([]byte, []int)

Deprecated: Use DocumentRemove.ProtoReflect.Descriptor instead.

func (*DocumentRemove) GetDocument

func (x *DocumentRemove) GetDocument() string

func (*DocumentRemove) GetReadTime

func (x *DocumentRemove) GetReadTime() *timestamp.Timestamp

func (*DocumentRemove) GetRemovedTargetIds

func (x *DocumentRemove) GetRemovedTargetIds() []int32

func (*DocumentRemove) ProtoMessage

func (*DocumentRemove) ProtoMessage()

func (*DocumentRemove) ProtoReflect

func (x *DocumentRemove) ProtoReflect() protoreflect.Message

func (*DocumentRemove) Reset

func (x *DocumentRemove) Reset()

func (*DocumentRemove) String

func (x *DocumentRemove) String() string

type DocumentTransform

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
}

A transformation of a document.

func (*DocumentTransform) Descriptor

func (*DocumentTransform) Descriptor() ([]byte, []int)

Deprecated: Use DocumentTransform.ProtoReflect.Descriptor instead.

func (*DocumentTransform) GetDocument

func (x *DocumentTransform) GetDocument() string

func (*DocumentTransform) GetFieldTransforms

func (x *DocumentTransform) GetFieldTransforms() []*DocumentTransform_FieldTransform

func (*DocumentTransform) ProtoMessage

func (*DocumentTransform) ProtoMessage()

func (*DocumentTransform) ProtoReflect

func (x *DocumentTransform) ProtoReflect() protoreflect.Message

func (*DocumentTransform) Reset

func (x *DocumentTransform) Reset()

func (*DocumentTransform) String

func (x *DocumentTransform) String() string

type DocumentTransform_FieldTransform

type DocumentTransform_FieldTransform struct {

	// The path of the field. See [Document.fields][google.firestore.v1.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
}

A transformation of a field of the document.

func (*DocumentTransform_FieldTransform) Descriptor

func (*DocumentTransform_FieldTransform) Descriptor() ([]byte, []int)

Deprecated: Use DocumentTransform_FieldTransform.ProtoReflect.Descriptor instead.

func (*DocumentTransform_FieldTransform) GetAppendMissingElements

func (x *DocumentTransform_FieldTransform) GetAppendMissingElements() *ArrayValue

func (*DocumentTransform_FieldTransform) GetFieldPath

func (x *DocumentTransform_FieldTransform) GetFieldPath() string

func (*DocumentTransform_FieldTransform) GetIncrement

func (x *DocumentTransform_FieldTransform) GetIncrement() *Value

func (*DocumentTransform_FieldTransform) GetMaximum

func (x *DocumentTransform_FieldTransform) GetMaximum() *Value

func (*DocumentTransform_FieldTransform) GetMinimum

func (x *DocumentTransform_FieldTransform) GetMinimum() *Value

func (*DocumentTransform_FieldTransform) GetRemoveAllFromArray

func (x *DocumentTransform_FieldTransform) GetRemoveAllFromArray() *ArrayValue

func (*DocumentTransform_FieldTransform) GetSetToServerValue

func (x *DocumentTransform_FieldTransform) GetSetToServerValue() DocumentTransform_FieldTransform_ServerValue

func (*DocumentTransform_FieldTransform) GetTransformType

func (m *DocumentTransform_FieldTransform) GetTransformType() isDocumentTransform_FieldTransform_TransformType

func (*DocumentTransform_FieldTransform) ProtoMessage

func (*DocumentTransform_FieldTransform) ProtoMessage()

func (*DocumentTransform_FieldTransform) ProtoReflect

func (x *DocumentTransform_FieldTransform) ProtoReflect() protoreflect.Message

func (*DocumentTransform_FieldTransform) Reset

func (x *DocumentTransform_FieldTransform) Reset()

func (*DocumentTransform_FieldTransform) String

func (x *DocumentTransform_FieldTransform) String() string

type DocumentTransform_FieldTransform_AppendMissingElements

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

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

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

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

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"`
}

type DocumentTransform_FieldTransform_ServerValue

type DocumentTransform_FieldTransform_ServerValue int32

A value that is calculated by the server.

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.
	DocumentTransform_FieldTransform_REQUEST_TIME DocumentTransform_FieldTransform_ServerValue = 1
)

func (DocumentTransform_FieldTransform_ServerValue) Descriptor

func (DocumentTransform_FieldTransform_ServerValue) Descriptor() protoreflect.EnumDescriptor

func (DocumentTransform_FieldTransform_ServerValue) Enum

func (x DocumentTransform_FieldTransform_ServerValue) Enum() *DocumentTransform_FieldTransform_ServerValue

func (DocumentTransform_FieldTransform_ServerValue) EnumDescriptor

func (DocumentTransform_FieldTransform_ServerValue) EnumDescriptor() ([]byte, []int)

Deprecated: Use DocumentTransform_FieldTransform_ServerValue.Descriptor instead.

func (DocumentTransform_FieldTransform_ServerValue) Number

func (x DocumentTransform_FieldTransform_ServerValue) Number() protoreflect.EnumNumber

func (DocumentTransform_FieldTransform_ServerValue) String

func (x DocumentTransform_FieldTransform_ServerValue) String() string

func (DocumentTransform_FieldTransform_ServerValue) Type

func (DocumentTransform_FieldTransform_ServerValue) Type() protoreflect.EnumType

type DocumentTransform_FieldTransform_SetToServerValue

type DocumentTransform_FieldTransform_SetToServerValue struct {
	SetToServerValue DocumentTransform_FieldTransform_ServerValue "" /* 153 byte string literal not displayed */
}

type ExistenceFilter

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.v1.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
}

A digest of all the documents that match a given target.

func (*ExistenceFilter) Descriptor

func (*ExistenceFilter) Descriptor() ([]byte, []int)

Deprecated: Use ExistenceFilter.ProtoReflect.Descriptor instead.

func (*ExistenceFilter) GetCount

func (x *ExistenceFilter) GetCount() int32

func (*ExistenceFilter) GetTargetId

func (x *ExistenceFilter) GetTargetId() int32

func (*ExistenceFilter) ProtoMessage

func (*ExistenceFilter) ProtoMessage()

func (*ExistenceFilter) ProtoReflect

func (x *ExistenceFilter) ProtoReflect() protoreflect.Message

func (*ExistenceFilter) Reset

func (x *ExistenceFilter) Reset()

func (*ExistenceFilter) String

func (x *ExistenceFilter) String() string

type FirestoreClient

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) (*empty.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) (*empty.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.v1.BatchWriteResponse] for the success status of each write.
	//
	// If you require an atomically applied set of writes, use
	// [Commit][google.firestore.v1.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)
}

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 FirestoreServer

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) (*empty.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) (*empty.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.v1.BatchWriteResponse] for the success status of each write.
	//
	// If you require an atomically applied set of writes, use
	// [Commit][google.firestore.v1.Firestore.Commit] instead.
	BatchWrite(context.Context, *BatchWriteRequest) (*BatchWriteResponse, error)
	// Creates a new document.
	CreateDocument(context.Context, *CreateDocumentRequest) (*Document, error)
}

FirestoreServer is the server API for Firestore service.

type Firestore_BatchGetDocumentsClient

type Firestore_BatchGetDocumentsClient interface {
	Recv() (*BatchGetDocumentsResponse, error)
	grpc.ClientStream
}

type Firestore_BatchGetDocumentsServer

type Firestore_BatchGetDocumentsServer interface {
	Send(*BatchGetDocumentsResponse) error
	grpc.ServerStream
}

type Firestore_ListenClient

type Firestore_ListenClient interface {
	Send(*ListenRequest) error
	Recv() (*ListenResponse, error)
	grpc.ClientStream
}

type Firestore_ListenServer

type Firestore_ListenServer interface {
	Send(*ListenResponse) error
	Recv() (*ListenRequest, error)
	grpc.ServerStream
}

type Firestore_RunQueryClient

type Firestore_RunQueryClient interface {
	Recv() (*RunQueryResponse, error)
	grpc.ClientStream
}

type Firestore_RunQueryServer

type Firestore_RunQueryServer interface {
	Send(*RunQueryResponse) error
	grpc.ServerStream
}

type Firestore_WriteClient

type Firestore_WriteClient interface {
	Send(*WriteRequest) error
	Recv() (*WriteResponse, error)
	grpc.ClientStream
}

type Firestore_WriteServer

type Firestore_WriteServer interface {
	Send(*WriteResponse) error
	Recv() (*WriteRequest, error)
	grpc.ServerStream
}

type GetDocumentRequest

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
}

The request for [Firestore.GetDocument][google.firestore.v1.Firestore.GetDocument].

func (*GetDocumentRequest) Descriptor

func (*GetDocumentRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetDocumentRequest.ProtoReflect.Descriptor instead.

func (*GetDocumentRequest) GetConsistencySelector

func (m *GetDocumentRequest) GetConsistencySelector() isGetDocumentRequest_ConsistencySelector

func (*GetDocumentRequest) GetMask

func (x *GetDocumentRequest) GetMask() *DocumentMask

func (*GetDocumentRequest) GetName

func (x *GetDocumentRequest) GetName() string

func (*GetDocumentRequest) GetReadTime

func (x *GetDocumentRequest) GetReadTime() *timestamp.Timestamp

func (*GetDocumentRequest) GetTransaction

func (x *GetDocumentRequest) GetTransaction() []byte

func (*GetDocumentRequest) ProtoMessage

func (*GetDocumentRequest) ProtoMessage()

func (*GetDocumentRequest) ProtoReflect

func (x *GetDocumentRequest) ProtoReflect() protoreflect.Message

func (*GetDocumentRequest) Reset

func (x *GetDocumentRequest) Reset()

func (*GetDocumentRequest) String

func (x *GetDocumentRequest) String() string

type GetDocumentRequest_ReadTime

type GetDocumentRequest_ReadTime struct {
	// Reads the version of the document at the given time.
	// This may not be older than 270 seconds.
	ReadTime *timestamp.Timestamp `protobuf:"bytes,5,opt,name=read_time,json=readTime,proto3,oneof"`
}

type GetDocumentRequest_Transaction

type GetDocumentRequest_Transaction struct {
	// Reads the document in a transaction.
	Transaction []byte `protobuf:"bytes,3,opt,name=transaction,proto3,oneof"`
}

type ListCollectionIdsRequest

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.v1.ListCollectionIdsResponse].
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

The request for [Firestore.ListCollectionIds][google.firestore.v1.Firestore.ListCollectionIds].

func (*ListCollectionIdsRequest) Descriptor

func (*ListCollectionIdsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListCollectionIdsRequest.ProtoReflect.Descriptor instead.

func (*ListCollectionIdsRequest) GetPageSize

func (x *ListCollectionIdsRequest) GetPageSize() int32

func (*ListCollectionIdsRequest) GetPageToken

func (x *ListCollectionIdsRequest) GetPageToken() string

func (*ListCollectionIdsRequest) GetParent

func (x *ListCollectionIdsRequest) GetParent() string

func (*ListCollectionIdsRequest) ProtoMessage

func (*ListCollectionIdsRequest) ProtoMessage()

func (*ListCollectionIdsRequest) ProtoReflect

func (x *ListCollectionIdsRequest) ProtoReflect() protoreflect.Message

func (*ListCollectionIdsRequest) Reset

func (x *ListCollectionIdsRequest) Reset()

func (*ListCollectionIdsRequest) String

func (x *ListCollectionIdsRequest) String() string

type ListCollectionIdsResponse

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
}

The response from [Firestore.ListCollectionIds][google.firestore.v1.Firestore.ListCollectionIds].

func (*ListCollectionIdsResponse) Descriptor

func (*ListCollectionIdsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListCollectionIdsResponse.ProtoReflect.Descriptor instead.

func (*ListCollectionIdsResponse) GetCollectionIds

func (x *ListCollectionIdsResponse) GetCollectionIds() []string

func (*ListCollectionIdsResponse) GetNextPageToken

func (x *ListCollectionIdsResponse) GetNextPageToken() string

func (*ListCollectionIdsResponse) ProtoMessage

func (*ListCollectionIdsResponse) ProtoMessage()

func (*ListCollectionIdsResponse) ProtoReflect

func (x *ListCollectionIdsResponse) ProtoReflect() protoreflect.Message

func (*ListCollectionIdsResponse) Reset

func (x *ListCollectionIdsResponse) Reset()

func (*ListCollectionIdsResponse) String

func (x *ListCollectionIdsResponse) String() string

type ListDocumentsRequest

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.v1.Document.create_time],
	// or [Document.update_time][google.firestore.v1.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
}

The request for [Firestore.ListDocuments][google.firestore.v1.Firestore.ListDocuments].

func (*ListDocumentsRequest) Descriptor

func (*ListDocumentsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListDocumentsRequest.ProtoReflect.Descriptor instead.

func (*ListDocumentsRequest) GetCollectionId

func (x *ListDocumentsRequest) GetCollectionId() string

func (*ListDocumentsRequest) GetConsistencySelector

func (m *ListDocumentsRequest) GetConsistencySelector() isListDocumentsRequest_ConsistencySelector

func (*ListDocumentsRequest) GetMask

func (x *ListDocumentsRequest) GetMask() *DocumentMask

func (*ListDocumentsRequest) GetOrderBy

func (x *ListDocumentsRequest) GetOrderBy() string

func (*ListDocumentsRequest) GetPageSize

func (x *ListDocumentsRequest) GetPageSize() int32

func (*ListDocumentsRequest) GetPageToken

func (x *ListDocumentsRequest) GetPageToken() string

func (*ListDocumentsRequest) GetParent

func (x *ListDocumentsRequest) GetParent() string

func (*ListDocumentsRequest) GetReadTime

func (x *ListDocumentsRequest) GetReadTime() *timestamp.Timestamp

func (*ListDocumentsRequest) GetShowMissing

func (x *ListDocumentsRequest) GetShowMissing() bool

func (*ListDocumentsRequest) GetTransaction

func (x *ListDocumentsRequest) GetTransaction() []byte

func (*ListDocumentsRequest) ProtoMessage

func (*ListDocumentsRequest) ProtoMessage()

func (*ListDocumentsRequest) ProtoReflect

func (x *ListDocumentsRequest) ProtoReflect() protoreflect.Message

func (*ListDocumentsRequest) Reset

func (x *ListDocumentsRequest) Reset()

func (*ListDocumentsRequest) String

func (x *ListDocumentsRequest) String() string

type ListDocumentsRequest_ReadTime

type ListDocumentsRequest_ReadTime struct {
	// Reads documents as they were at the given time.
	// This may not be older than 270 seconds.
	ReadTime *timestamp.Timestamp `protobuf:"bytes,10,opt,name=read_time,json=readTime,proto3,oneof"`
}

type ListDocumentsRequest_Transaction

type ListDocumentsRequest_Transaction struct {
	// Reads documents in a transaction.
	Transaction []byte `protobuf:"bytes,8,opt,name=transaction,proto3,oneof"`
}

type ListDocumentsResponse

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
}

The response for [Firestore.ListDocuments][google.firestore.v1.Firestore.ListDocuments].

func (*ListDocumentsResponse) Descriptor

func (*ListDocumentsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListDocumentsResponse.ProtoReflect.Descriptor instead.

func (*ListDocumentsResponse) GetDocuments

func (x *ListDocumentsResponse) GetDocuments() []*Document

func (*ListDocumentsResponse) GetNextPageToken

func (x *ListDocumentsResponse) GetNextPageToken() string

func (*ListDocumentsResponse) ProtoMessage

func (*ListDocumentsResponse) ProtoMessage()

func (*ListDocumentsResponse) ProtoReflect

func (x *ListDocumentsResponse) ProtoReflect() protoreflect.Message

func (*ListDocumentsResponse) Reset

func (x *ListDocumentsResponse) Reset()

func (*ListDocumentsResponse) String

func (x *ListDocumentsResponse) String() string

type ListenRequest

type ListenRequest struct {
	Database string `protobuf:"bytes,1,opt,name=database,proto3" json:"database,omitempty"`

	TargetChange isListenRequest_TargetChange `protobuf_oneof:"target_change"`

	Labels map[string]string "" /* 153 byte string literal not displayed */

}

A request for [Firestore.Listen][google.firestore.v1.Firestore.Listen]

func (*ListenRequest) Descriptor

func (*ListenRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListenRequest.ProtoReflect.Descriptor instead.

func (*ListenRequest) GetAddTarget

func (x *ListenRequest) GetAddTarget() *Target

func (*ListenRequest) GetDatabase

func (x *ListenRequest) GetDatabase() string

func (*ListenRequest) GetLabels

func (x *ListenRequest) GetLabels() map[string]string

func (*ListenRequest) GetRemoveTarget

func (x *ListenRequest) GetRemoveTarget() int32

func (*ListenRequest) GetTargetChange

func (m *ListenRequest) GetTargetChange() isListenRequest_TargetChange

func (*ListenRequest) ProtoMessage

func (*ListenRequest) ProtoMessage()

func (*ListenRequest) ProtoReflect

func (x *ListenRequest) ProtoReflect() protoreflect.Message

func (*ListenRequest) Reset

func (x *ListenRequest) Reset()

func (*ListenRequest) String

func (x *ListenRequest) String() string

type ListenRequest_AddTarget

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

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"`
}

type ListenResponse

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
}

The response for [Firestore.Listen][google.firestore.v1.Firestore.Listen].

func (*ListenResponse) Descriptor

func (*ListenResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListenResponse.ProtoReflect.Descriptor instead.

func (*ListenResponse) GetDocumentChange

func (x *ListenResponse) GetDocumentChange() *DocumentChange

func (*ListenResponse) GetDocumentDelete

func (x *ListenResponse) GetDocumentDelete() *DocumentDelete

func (*ListenResponse) GetDocumentRemove

func (x *ListenResponse) GetDocumentRemove() *DocumentRemove

func (*ListenResponse) GetFilter

func (x *ListenResponse) GetFilter() *ExistenceFilter

func (*ListenResponse) GetResponseType

func (m *ListenResponse) GetResponseType() isListenResponse_ResponseType

func (*ListenResponse) GetTargetChange

func (x *ListenResponse) GetTargetChange() *TargetChange

func (*ListenResponse) ProtoMessage

func (*ListenResponse) ProtoMessage()

func (*ListenResponse) ProtoReflect

func (x *ListenResponse) ProtoReflect() protoreflect.Message

func (*ListenResponse) Reset

func (x *ListenResponse) Reset()

func (*ListenResponse) String

func (x *ListenResponse) String() string

type ListenResponse_DocumentChange

type ListenResponse_DocumentChange struct {
	// A [Document][google.firestore.v1.Document] has changed.
	DocumentChange *DocumentChange `protobuf:"bytes,3,opt,name=document_change,json=documentChange,proto3,oneof"`
}

type ListenResponse_DocumentDelete

type ListenResponse_DocumentDelete struct {
	// A [Document][google.firestore.v1.Document] has been deleted.
	DocumentDelete *DocumentDelete `protobuf:"bytes,4,opt,name=document_delete,json=documentDelete,proto3,oneof"`
}

type ListenResponse_DocumentRemove

type ListenResponse_DocumentRemove struct {
	// A [Document][google.firestore.v1.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

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

type ListenResponse_TargetChange struct {
	// Targets have changed.
	TargetChange *TargetChange `protobuf:"bytes,2,opt,name=target_change,json=targetChange,proto3,oneof"`
}

type MapValue

type MapValue struct {
	Fields map[string]*Value "" /* 153 byte string literal not displayed */

}

A map value.

func (*MapValue) Descriptor

func (*MapValue) Descriptor() ([]byte, []int)

Deprecated: Use MapValue.ProtoReflect.Descriptor instead.

func (*MapValue) GetFields

func (x *MapValue) GetFields() map[string]*Value

func (*MapValue) ProtoMessage

func (*MapValue) ProtoMessage()

func (*MapValue) ProtoReflect

func (x *MapValue) ProtoReflect() protoreflect.Message

func (*MapValue) Reset

func (x *MapValue) Reset()

func (*MapValue) String

func (x *MapValue) String() string

type PartitionQueryRequest

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 strictly 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
}

The request for [Firestore.PartitionQuery][google.firestore.v1.Firestore.PartitionQuery].

func (*PartitionQueryRequest) Descriptor

func (*PartitionQueryRequest) Descriptor() ([]byte, []int)

Deprecated: Use PartitionQueryRequest.ProtoReflect.Descriptor instead.

func (*PartitionQueryRequest) GetPageSize

func (x *PartitionQueryRequest) GetPageSize() int32

func (*PartitionQueryRequest) GetPageToken

func (x *PartitionQueryRequest) GetPageToken() string

func (*PartitionQueryRequest) GetParent

func (x *PartitionQueryRequest) GetParent() string

func (*PartitionQueryRequest) GetPartitionCount

func (x *PartitionQueryRequest) GetPartitionCount() int64

func (*PartitionQueryRequest) GetQueryType

func (m *PartitionQueryRequest) GetQueryType() isPartitionQueryRequest_QueryType

func (*PartitionQueryRequest) GetStructuredQuery

func (x *PartitionQueryRequest) GetStructuredQuery() *StructuredQuery

func (*PartitionQueryRequest) ProtoMessage

func (*PartitionQueryRequest) ProtoMessage()

func (*PartitionQueryRequest) ProtoReflect

func (x *PartitionQueryRequest) ProtoReflect() protoreflect.Message

func (*PartitionQueryRequest) Reset

func (x *PartitionQueryRequest) Reset()

func (*PartitionQueryRequest) String

func (x *PartitionQueryRequest) String() string

type PartitionQueryRequest_StructuredQuery

type PartitionQueryRequest_StructuredQuery struct {
	// A structured query.
	// 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"`
}

type PartitionQueryResponse

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
	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
}

The response for [Firestore.PartitionQuery][google.firestore.v1.Firestore.PartitionQuery].

func (*PartitionQueryResponse) Descriptor

func (*PartitionQueryResponse) Descriptor() ([]byte, []int)

Deprecated: Use PartitionQueryResponse.ProtoReflect.Descriptor instead.

func (*PartitionQueryResponse) GetNextPageToken

func (x *PartitionQueryResponse) GetNextPageToken() string

func (*PartitionQueryResponse) GetPartitions

func (x *PartitionQueryResponse) GetPartitions() []*Cursor

func (*PartitionQueryResponse) ProtoMessage

func (*PartitionQueryResponse) ProtoMessage()

func (*PartitionQueryResponse) ProtoReflect

func (x *PartitionQueryResponse) ProtoReflect() protoreflect.Message

func (*PartitionQueryResponse) Reset

func (x *PartitionQueryResponse) Reset()

func (*PartitionQueryResponse) String

func (x *PartitionQueryResponse) String() string

type Precondition

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
}

A precondition on a document, used for conditional operations.

func (*Precondition) Descriptor

func (*Precondition) Descriptor() ([]byte, []int)

Deprecated: Use Precondition.ProtoReflect.Descriptor instead.

func (*Precondition) GetConditionType

func (m *Precondition) GetConditionType() isPrecondition_ConditionType

func (*Precondition) GetExists

func (x *Precondition) GetExists() bool

func (*Precondition) GetUpdateTime

func (x *Precondition) GetUpdateTime() *timestamp.Timestamp

func (*Precondition) ProtoMessage

func (*Precondition) ProtoMessage()

func (*Precondition) ProtoReflect

func (x *Precondition) ProtoReflect() protoreflect.Message

func (*Precondition) Reset

func (x *Precondition) Reset()

func (*Precondition) String

func (x *Precondition) String() string

type Precondition_Exists

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

type Precondition_UpdateTime struct {
	// When set, the target document must exist and have been last updated at
	// that time.
	UpdateTime *timestamp.Timestamp `protobuf:"bytes,2,opt,name=update_time,json=updateTime,proto3,oneof"`
}

type RollbackRequest

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
}

The request for [Firestore.Rollback][google.firestore.v1.Firestore.Rollback].

func (*RollbackRequest) Descriptor

func (*RollbackRequest) Descriptor() ([]byte, []int)

Deprecated: Use RollbackRequest.ProtoReflect.Descriptor instead.

func (*RollbackRequest) GetDatabase

func (x *RollbackRequest) GetDatabase() string

func (*RollbackRequest) GetTransaction

func (x *RollbackRequest) GetTransaction() []byte

func (*RollbackRequest) ProtoMessage

func (*RollbackRequest) ProtoMessage()

func (*RollbackRequest) ProtoReflect

func (x *RollbackRequest) ProtoReflect() protoreflect.Message

func (*RollbackRequest) Reset

func (x *RollbackRequest) Reset()

func (*RollbackRequest) String

func (x *RollbackRequest) String() string

type RunQueryRequest

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
}

The request for [Firestore.RunQuery][google.firestore.v1.Firestore.RunQuery].

func (*RunQueryRequest) Descriptor

func (*RunQueryRequest) Descriptor() ([]byte, []int)

Deprecated: Use RunQueryRequest.ProtoReflect.Descriptor instead.

func (*RunQueryRequest) GetConsistencySelector

func (m *RunQueryRequest) GetConsistencySelector() isRunQueryRequest_ConsistencySelector

func (*RunQueryRequest) GetNewTransaction

func (x *RunQueryRequest) GetNewTransaction() *TransactionOptions

func (*RunQueryRequest) GetParent

func (x *RunQueryRequest) GetParent() string

func (*RunQueryRequest) GetQueryType

func (m *RunQueryRequest) GetQueryType() isRunQueryRequest_QueryType

func (*RunQueryRequest) GetReadTime

func (x *RunQueryRequest) GetReadTime() *timestamp.Timestamp

func (*RunQueryRequest) GetStructuredQuery

func (x *RunQueryRequest) GetStructuredQuery() *StructuredQuery

func (*RunQueryRequest) GetTransaction

func (x *RunQueryRequest) GetTransaction() []byte

func (*RunQueryRequest) ProtoMessage

func (*RunQueryRequest) ProtoMessage()

func (*RunQueryRequest) ProtoReflect

func (x *RunQueryRequest) ProtoReflect() protoreflect.Message

func (*RunQueryRequest) Reset

func (x *RunQueryRequest) Reset()

func (*RunQueryRequest) String

func (x *RunQueryRequest) String() string

type RunQueryRequest_NewTransaction

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

type RunQueryRequest_ReadTime struct {
	// Reads documents as they were at the given time.
	// This may not be older than 270 seconds.
	ReadTime *timestamp.Timestamp `protobuf:"bytes,7,opt,name=read_time,json=readTime,proto3,oneof"`
}

type RunQueryRequest_StructuredQuery

type RunQueryRequest_StructuredQuery struct {
	// A structured query.
	StructuredQuery *StructuredQuery `protobuf:"bytes,2,opt,name=structured_query,json=structuredQuery,proto3,oneof"`
}

type RunQueryRequest_Transaction

type RunQueryRequest_Transaction struct {
	// Reads documents in a transaction.
	Transaction []byte `protobuf:"bytes,5,opt,name=transaction,proto3,oneof"`
}

type RunQueryResponse

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.v1.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 *timestamp.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
}

The response for [Firestore.RunQuery][google.firestore.v1.Firestore.RunQuery].

func (*RunQueryResponse) Descriptor

func (*RunQueryResponse) Descriptor() ([]byte, []int)

Deprecated: Use RunQueryResponse.ProtoReflect.Descriptor instead.

func (*RunQueryResponse) GetDocument

func (x *RunQueryResponse) GetDocument() *Document

func (*RunQueryResponse) GetReadTime

func (x *RunQueryResponse) GetReadTime() *timestamp.Timestamp

func (*RunQueryResponse) GetSkippedResults

func (x *RunQueryResponse) GetSkippedResults() int32

func (*RunQueryResponse) GetTransaction

func (x *RunQueryResponse) GetTransaction() []byte

func (*RunQueryResponse) ProtoMessage

func (*RunQueryResponse) ProtoMessage()

func (*RunQueryResponse) ProtoReflect

func (x *RunQueryResponse) ProtoReflect() protoreflect.Message

func (*RunQueryResponse) Reset

func (x *RunQueryResponse) Reset()

func (*RunQueryResponse) String

func (x *RunQueryResponse) String() string

type StructuredQuery

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 *wrappers.Int32Value `protobuf:"bytes,5,opt,name=limit,proto3" json:"limit,omitempty"`
	// contains filtered or unexported fields
}

A Firestore query.

func (*StructuredQuery) Descriptor

func (*StructuredQuery) Descriptor() ([]byte, []int)

Deprecated: Use StructuredQuery.ProtoReflect.Descriptor instead.

func (*StructuredQuery) GetEndAt

func (x *StructuredQuery) GetEndAt() *Cursor

func (*StructuredQuery) GetFrom

func (x *StructuredQuery) GetFrom() []*StructuredQuery_CollectionSelector

func (*StructuredQuery) GetLimit

func (x *StructuredQuery) GetLimit() *wrappers.Int32Value

func (*StructuredQuery) GetOffset

func (x *StructuredQuery) GetOffset() int32

func (*StructuredQuery) GetOrderBy

func (x *StructuredQuery) GetOrderBy() []*StructuredQuery_Order

func (*StructuredQuery) GetSelect

func (x *StructuredQuery) GetSelect() *StructuredQuery_Projection

func (*StructuredQuery) GetStartAt

func (x *StructuredQuery) GetStartAt() *Cursor

func (*StructuredQuery) GetWhere

func (x *StructuredQuery) GetWhere() *StructuredQuery_Filter

func (*StructuredQuery) ProtoMessage

func (*StructuredQuery) ProtoMessage()

func (*StructuredQuery) ProtoReflect

func (x *StructuredQuery) ProtoReflect() protoreflect.Message

func (*StructuredQuery) Reset

func (x *StructuredQuery) Reset()

func (*StructuredQuery) String

func (x *StructuredQuery) String() string

type StructuredQuery_CollectionSelector

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
}

A selection of a collection, such as `messages as m1`.

func (*StructuredQuery_CollectionSelector) Descriptor

func (*StructuredQuery_CollectionSelector) Descriptor() ([]byte, []int)

Deprecated: Use StructuredQuery_CollectionSelector.ProtoReflect.Descriptor instead.

func (*StructuredQuery_CollectionSelector) GetAllDescendants

func (x *StructuredQuery_CollectionSelector) GetAllDescendants() bool

func (*StructuredQuery_CollectionSelector) GetCollectionId

func (x *StructuredQuery_CollectionSelector) GetCollectionId() string

func (*StructuredQuery_CollectionSelector) ProtoMessage

func (*StructuredQuery_CollectionSelector) ProtoMessage()

func (*StructuredQuery_CollectionSelector) ProtoReflect

func (x *StructuredQuery_CollectionSelector) ProtoReflect() protoreflect.Message

func (*StructuredQuery_CollectionSelector) Reset

func (x *StructuredQuery_CollectionSelector) Reset()

func (*StructuredQuery_CollectionSelector) String

func (x *StructuredQuery_CollectionSelector) String() string

type StructuredQuery_CompositeFilter

type StructuredQuery_CompositeFilter struct {

	// The operator for combining multiple filters.
	Op StructuredQuery_CompositeFilter_Operator `protobuf:"varint,1,opt,name=op,proto3,enum=google.firestore.v1.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
}

A filter that merges multiple other filters using the given operator.

func (*StructuredQuery_CompositeFilter) Descriptor

func (*StructuredQuery_CompositeFilter) Descriptor() ([]byte, []int)

Deprecated: Use StructuredQuery_CompositeFilter.ProtoReflect.Descriptor instead.

func (*StructuredQuery_CompositeFilter) GetFilters

func (x *StructuredQuery_CompositeFilter) GetFilters() []*StructuredQuery_Filter

func (*StructuredQuery_CompositeFilter) GetOp

func (x *StructuredQuery_CompositeFilter) GetOp() StructuredQuery_CompositeFilter_Operator

func (*StructuredQuery_CompositeFilter) ProtoMessage

func (*StructuredQuery_CompositeFilter) ProtoMessage()

func (*StructuredQuery_CompositeFilter) ProtoReflect

func (x *StructuredQuery_CompositeFilter) ProtoReflect() protoreflect.Message

func (*StructuredQuery_CompositeFilter) Reset

func (x *StructuredQuery_CompositeFilter) Reset()

func (*StructuredQuery_CompositeFilter) String

func (x *StructuredQuery_CompositeFilter) String() string

type StructuredQuery_CompositeFilter_Operator

type StructuredQuery_CompositeFilter_Operator int32

A composite filter operator.

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

func (StructuredQuery_CompositeFilter_Operator) Descriptor() protoreflect.EnumDescriptor

func (StructuredQuery_CompositeFilter_Operator) Enum

func (x StructuredQuery_CompositeFilter_Operator) Enum() *StructuredQuery_CompositeFilter_Operator

func (StructuredQuery_CompositeFilter_Operator) EnumDescriptor

func (StructuredQuery_CompositeFilter_Operator) EnumDescriptor() ([]byte, []int)

Deprecated: Use StructuredQuery_CompositeFilter_Operator.Descriptor instead.

func (StructuredQuery_CompositeFilter_Operator) Number

func (x StructuredQuery_CompositeFilter_Operator) Number() protoreflect.EnumNumber

func (StructuredQuery_CompositeFilter_Operator) String

func (x StructuredQuery_CompositeFilter_Operator) String() string

func (StructuredQuery_CompositeFilter_Operator) Type

func (StructuredQuery_CompositeFilter_Operator) Type() protoreflect.EnumType

type StructuredQuery_Direction

type StructuredQuery_Direction int32

A sort direction.

const (
	// Unspecified.
	StructuredQuery_DIRECTION_UNSPECIFIED StructuredQuery_Direction = 0
	// Ascending.
	StructuredQuery_ASCENDING StructuredQuery_Direction = 1
	// Descending.
	StructuredQuery_DESCENDING StructuredQuery_Direction = 2
)

func (StructuredQuery_Direction) Descriptor

func (StructuredQuery_Direction) Descriptor() protoreflect.EnumDescriptor

func (StructuredQuery_Direction) Enum

func (x StructuredQuery_Direction) Enum() *StructuredQuery_Direction

func (StructuredQuery_Direction) EnumDescriptor

func (StructuredQuery_Direction) EnumDescriptor() ([]byte, []int)

Deprecated: Use StructuredQuery_Direction.Descriptor instead.

func (StructuredQuery_Direction) Number

func (x StructuredQuery_Direction) Number() protoreflect.EnumNumber

func (StructuredQuery_Direction) String

func (x StructuredQuery_Direction) String() string

func (StructuredQuery_Direction) Type

func (StructuredQuery_Direction) Type() protoreflect.EnumType

type StructuredQuery_FieldFilter

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.v1.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
}

A filter on a specific field.

func (*StructuredQuery_FieldFilter) Descriptor

func (*StructuredQuery_FieldFilter) Descriptor() ([]byte, []int)

Deprecated: Use StructuredQuery_FieldFilter.ProtoReflect.Descriptor instead.

func (*StructuredQuery_FieldFilter) GetField

func (x *StructuredQuery_FieldFilter) GetField() *StructuredQuery_FieldReference

func (*StructuredQuery_FieldFilter) GetOp

func (x *StructuredQuery_FieldFilter) GetOp() StructuredQuery_FieldFilter_Operator

func (*StructuredQuery_FieldFilter) GetValue

func (x *StructuredQuery_FieldFilter) GetValue() *Value

func (*StructuredQuery_FieldFilter) ProtoMessage

func (*StructuredQuery_FieldFilter) ProtoMessage()

func (*StructuredQuery_FieldFilter) ProtoReflect

func (x *StructuredQuery_FieldFilter) ProtoReflect() protoreflect.Message

func (*StructuredQuery_FieldFilter) Reset

func (x *StructuredQuery_FieldFilter) Reset()

func (*StructuredQuery_FieldFilter) String

func (x *StructuredQuery_FieldFilter) String() string

type StructuredQuery_FieldFilter_Operator

type StructuredQuery_FieldFilter_Operator int32

A field filter operator.

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 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`, `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`, `ARRAY_CONTAINS_ANY`, or `NOT_IN`.
	StructuredQuery_FieldFilter_ARRAY_CONTAINS_ANY StructuredQuery_FieldFilter_Operator = 9
)

func (StructuredQuery_FieldFilter_Operator) Descriptor

func (StructuredQuery_FieldFilter_Operator) Descriptor() protoreflect.EnumDescriptor

func (StructuredQuery_FieldFilter_Operator) Enum

func (x StructuredQuery_FieldFilter_Operator) Enum() *StructuredQuery_FieldFilter_Operator

func (StructuredQuery_FieldFilter_Operator) EnumDescriptor

func (StructuredQuery_FieldFilter_Operator) EnumDescriptor() ([]byte, []int)

Deprecated: Use StructuredQuery_FieldFilter_Operator.Descriptor instead.

func (StructuredQuery_FieldFilter_Operator) Number

func (x StructuredQuery_FieldFilter_Operator) Number() protoreflect.EnumNumber

func (StructuredQuery_FieldFilter_Operator) String

func (x StructuredQuery_FieldFilter_Operator) String() string

func (StructuredQuery_FieldFilter_Operator) Type

func (StructuredQuery_FieldFilter_Operator) Type() protoreflect.EnumType

type StructuredQuery_FieldReference

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
}

A reference to a field, such as `max(messages.time) as max_time`.

func (*StructuredQuery_FieldReference) Descriptor

func (*StructuredQuery_FieldReference) Descriptor() ([]byte, []int)

Deprecated: Use StructuredQuery_FieldReference.ProtoReflect.Descriptor instead.

func (*StructuredQuery_FieldReference) GetFieldPath

func (x *StructuredQuery_FieldReference) GetFieldPath() string

func (*StructuredQuery_FieldReference) ProtoMessage

func (*StructuredQuery_FieldReference) ProtoMessage()

func (*StructuredQuery_FieldReference) ProtoReflect

func (x *StructuredQuery_FieldReference) ProtoReflect() protoreflect.Message

func (*StructuredQuery_FieldReference) Reset

func (x *StructuredQuery_FieldReference) Reset()

func (*StructuredQuery_FieldReference) String

func (x *StructuredQuery_FieldReference) String() string

type StructuredQuery_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
}

A filter.

func (*StructuredQuery_Filter) Descriptor

func (*StructuredQuery_Filter) Descriptor() ([]byte, []int)

Deprecated: Use StructuredQuery_Filter.ProtoReflect.Descriptor instead.

func (*StructuredQuery_Filter) GetCompositeFilter

func (x *StructuredQuery_Filter) GetCompositeFilter() *StructuredQuery_CompositeFilter

func (*StructuredQuery_Filter) GetFieldFilter

func (x *StructuredQuery_Filter) GetFieldFilter() *StructuredQuery_FieldFilter

func (*StructuredQuery_Filter) GetFilterType

func (m *StructuredQuery_Filter) GetFilterType() isStructuredQuery_Filter_FilterType

func (*StructuredQuery_Filter) GetUnaryFilter

func (x *StructuredQuery_Filter) GetUnaryFilter() *StructuredQuery_UnaryFilter

func (*StructuredQuery_Filter) ProtoMessage

func (*StructuredQuery_Filter) ProtoMessage()

func (*StructuredQuery_Filter) ProtoReflect

func (x *StructuredQuery_Filter) ProtoReflect() protoreflect.Message

func (*StructuredQuery_Filter) Reset

func (x *StructuredQuery_Filter) Reset()

func (*StructuredQuery_Filter) String

func (x *StructuredQuery_Filter) String() string

type StructuredQuery_Filter_CompositeFilter

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

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

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"`
}

type StructuredQuery_Order

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.v1.StructuredQuery_Direction" json:"direction,omitempty"`
	// contains filtered or unexported fields
}

An order on a field.

func (*StructuredQuery_Order) Descriptor

func (*StructuredQuery_Order) Descriptor() ([]byte, []int)

Deprecated: Use StructuredQuery_Order.ProtoReflect.Descriptor instead.

func (*StructuredQuery_Order) GetDirection

func (x *StructuredQuery_Order) GetDirection() StructuredQuery_Direction

func (*StructuredQuery_Order) GetField

func (x *StructuredQuery_Order) GetField() *StructuredQuery_FieldReference

func (*StructuredQuery_Order) ProtoMessage

func (*StructuredQuery_Order) ProtoMessage()

func (*StructuredQuery_Order) ProtoReflect

func (x *StructuredQuery_Order) ProtoReflect() protoreflect.Message

func (*StructuredQuery_Order) Reset

func (x *StructuredQuery_Order) Reset()

func (*StructuredQuery_Order) String

func (x *StructuredQuery_Order) String() string

type StructuredQuery_Projection

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
}

The projection of document's fields to return.

func (*StructuredQuery_Projection) Descriptor

func (*StructuredQuery_Projection) Descriptor() ([]byte, []int)

Deprecated: Use StructuredQuery_Projection.ProtoReflect.Descriptor instead.

func (*StructuredQuery_Projection) GetFields

func (x *StructuredQuery_Projection) GetFields() []*StructuredQuery_FieldReference

func (*StructuredQuery_Projection) ProtoMessage

func (*StructuredQuery_Projection) ProtoMessage()

func (*StructuredQuery_Projection) ProtoReflect

func (x *StructuredQuery_Projection) ProtoReflect() protoreflect.Message

func (*StructuredQuery_Projection) Reset

func (x *StructuredQuery_Projection) Reset()

func (*StructuredQuery_Projection) String

func (x *StructuredQuery_Projection) String() string

type StructuredQuery_UnaryFilter

type StructuredQuery_UnaryFilter struct {

	// The unary operator to apply.
	Op StructuredQuery_UnaryFilter_Operator `protobuf:"varint,1,opt,name=op,proto3,enum=google.firestore.v1.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
}

A filter with a single operand.

func (*StructuredQuery_UnaryFilter) Descriptor

func (*StructuredQuery_UnaryFilter) Descriptor() ([]byte, []int)

Deprecated: Use StructuredQuery_UnaryFilter.ProtoReflect.Descriptor instead.

func (*StructuredQuery_UnaryFilter) GetField

func (x *StructuredQuery_UnaryFilter) GetField() *StructuredQuery_FieldReference

func (*StructuredQuery_UnaryFilter) GetOp

func (x *StructuredQuery_UnaryFilter) GetOp() StructuredQuery_UnaryFilter_Operator

func (*StructuredQuery_UnaryFilter) GetOperandType

func (m *StructuredQuery_UnaryFilter) GetOperandType() isStructuredQuery_UnaryFilter_OperandType

func (*StructuredQuery_UnaryFilter) ProtoMessage

func (*StructuredQuery_UnaryFilter) ProtoMessage()

func (*StructuredQuery_UnaryFilter) ProtoReflect

func (x *StructuredQuery_UnaryFilter) ProtoReflect() protoreflect.Message

func (*StructuredQuery_UnaryFilter) Reset

func (x *StructuredQuery_UnaryFilter) Reset()

func (*StructuredQuery_UnaryFilter) String

func (x *StructuredQuery_UnaryFilter) String() string

type StructuredQuery_UnaryFilter_Field

type StructuredQuery_UnaryFilter_Field struct {
	// The field to which to apply the operator.
	Field *StructuredQuery_FieldReference `protobuf:"bytes,2,opt,name=field,proto3,oneof"`
}

type StructuredQuery_UnaryFilter_Operator

type StructuredQuery_UnaryFilter_Operator int32

A unary operator.

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
)

func (StructuredQuery_UnaryFilter_Operator) Descriptor

func (StructuredQuery_UnaryFilter_Operator) Descriptor() protoreflect.EnumDescriptor

func (StructuredQuery_UnaryFilter_Operator) Enum

func (x StructuredQuery_UnaryFilter_Operator) Enum() *StructuredQuery_UnaryFilter_Operator

func (StructuredQuery_UnaryFilter_Operator) EnumDescriptor

func (StructuredQuery_UnaryFilter_Operator) EnumDescriptor() ([]byte, []int)

Deprecated: Use StructuredQuery_UnaryFilter_Operator.Descriptor instead.

func (StructuredQuery_UnaryFilter_Operator) Number

func (x StructuredQuery_UnaryFilter_Operator) Number() protoreflect.EnumNumber

func (StructuredQuery_UnaryFilter_Operator) String

func (x StructuredQuery_UnaryFilter_Operator) String() string

func (StructuredQuery_UnaryFilter_Operator) Type

func (StructuredQuery_UnaryFilter_Operator) Type() protoreflect.EnumType

type Target

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
}

A specification of a set of documents to listen to.

func (*Target) Descriptor

func (*Target) Descriptor() ([]byte, []int)

Deprecated: Use Target.ProtoReflect.Descriptor instead.

func (*Target) GetDocuments

func (x *Target) GetDocuments() *Target_DocumentsTarget

func (*Target) GetOnce

func (x *Target) GetOnce() bool

func (*Target) GetQuery

func (x *Target) GetQuery() *Target_QueryTarget

func (*Target) GetReadTime

func (x *Target) GetReadTime() *timestamp.Timestamp

func (*Target) GetResumeToken

func (x *Target) GetResumeToken() []byte

func (*Target) GetResumeType

func (m *Target) GetResumeType() isTarget_ResumeType

func (*Target) GetTargetId

func (x *Target) GetTargetId() int32

func (*Target) GetTargetType

func (m *Target) GetTargetType() isTarget_TargetType

func (*Target) ProtoMessage

func (*Target) ProtoMessage()

func (*Target) ProtoReflect

func (x *Target) ProtoReflect() protoreflect.Message

func (*Target) Reset

func (x *Target) Reset()

func (*Target) String

func (x *Target) String() string

type TargetChange

type TargetChange struct {
	TargetChangeType TargetChange_TargetChangeType "" /* 167 byte string literal not displayed */

	TargetIds []int32 `protobuf:"varint,2,rep,packed,name=target_ids,json=targetIds,proto3" json:"target_ids,omitempty"`

	Cause *status.Status `protobuf:"bytes,3,opt,name=cause,proto3" json:"cause,omitempty"`

	ResumeToken []byte `protobuf:"bytes,4,opt,name=resume_token,json=resumeToken,proto3" json:"resume_token,omitempty"`

	ReadTime *timestamp.Timestamp `protobuf:"bytes,6,opt,name=read_time,json=readTime,proto3" json:"read_time,omitempty"`

}

Targets being watched have changed.

func (*TargetChange) Descriptor

func (*TargetChange) Descriptor() ([]byte, []int)

Deprecated: Use TargetChange.ProtoReflect.Descriptor instead.

func (*TargetChange) GetCause

func (x *TargetChange) GetCause() *status.Status

func (*TargetChange) GetReadTime

func (x *TargetChange) GetReadTime() *timestamp.Timestamp

func (*TargetChange) GetResumeToken

func (x *TargetChange) GetResumeToken() []byte

func (*TargetChange) GetTargetChangeType

func (x *TargetChange) GetTargetChangeType() TargetChange_TargetChangeType

func (*TargetChange) GetTargetIds

func (x *TargetChange) GetTargetIds() []int32

func (*TargetChange) ProtoMessage

func (*TargetChange) ProtoMessage()

func (*TargetChange) ProtoReflect

func (x *TargetChange) ProtoReflect() protoreflect.Message

func (*TargetChange) Reset

func (x *TargetChange) Reset()

func (*TargetChange) String

func (x *TargetChange) String() string

type TargetChange_TargetChangeType

type TargetChange_TargetChangeType int32

The type of change.

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

func (TargetChange_TargetChangeType) Descriptor() protoreflect.EnumDescriptor

func (TargetChange_TargetChangeType) Enum

func (x TargetChange_TargetChangeType) Enum() *TargetChange_TargetChangeType

func (TargetChange_TargetChangeType) EnumDescriptor

func (TargetChange_TargetChangeType) EnumDescriptor() ([]byte, []int)

Deprecated: Use TargetChange_TargetChangeType.Descriptor instead.

func (TargetChange_TargetChangeType) Number

func (x TargetChange_TargetChangeType) Number() protoreflect.EnumNumber

func (TargetChange_TargetChangeType) String

func (x TargetChange_TargetChangeType) String() string

func (TargetChange_TargetChangeType) Type

func (TargetChange_TargetChangeType) Type() protoreflect.EnumType

type Target_Documents

type Target_Documents struct {
	// A target specified by a set of document names.
	Documents *Target_DocumentsTarget `protobuf:"bytes,3,opt,name=documents,proto3,oneof"`
}

type Target_DocumentsTarget

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
}

A target specified by a set of documents names.

func (*Target_DocumentsTarget) Descriptor

func (*Target_DocumentsTarget) Descriptor() ([]byte, []int)

Deprecated: Use Target_DocumentsTarget.ProtoReflect.Descriptor instead.

func (*Target_DocumentsTarget) GetDocuments

func (x *Target_DocumentsTarget) GetDocuments() []string

func (*Target_DocumentsTarget) ProtoMessage

func (*Target_DocumentsTarget) ProtoMessage()

func (*Target_DocumentsTarget) ProtoReflect

func (x *Target_DocumentsTarget) ProtoReflect() protoreflect.Message

func (*Target_DocumentsTarget) Reset

func (x *Target_DocumentsTarget) Reset()

func (*Target_DocumentsTarget) String

func (x *Target_DocumentsTarget) String() string

type Target_Query

type Target_Query struct {
	// A target specified by a query.
	Query *Target_QueryTarget `protobuf:"bytes,2,opt,name=query,proto3,oneof"`
}

type Target_QueryTarget

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
}

A target specified by a query.

func (*Target_QueryTarget) Descriptor

func (*Target_QueryTarget) Descriptor() ([]byte, []int)

Deprecated: Use Target_QueryTarget.ProtoReflect.Descriptor instead.

func (*Target_QueryTarget) GetParent

func (x *Target_QueryTarget) GetParent() string

func (*Target_QueryTarget) GetQueryType

func (m *Target_QueryTarget) GetQueryType() isTarget_QueryTarget_QueryType

func (*Target_QueryTarget) GetStructuredQuery

func (x *Target_QueryTarget) GetStructuredQuery() *StructuredQuery

func (*Target_QueryTarget) ProtoMessage

func (*Target_QueryTarget) ProtoMessage()

func (*Target_QueryTarget) ProtoReflect

func (x *Target_QueryTarget) ProtoReflect() protoreflect.Message

func (*Target_QueryTarget) Reset

func (x *Target_QueryTarget) Reset()

func (*Target_QueryTarget) String

func (x *Target_QueryTarget) String() string

type Target_QueryTarget_StructuredQuery

type Target_QueryTarget_StructuredQuery struct {
	// A structured query.
	StructuredQuery *StructuredQuery `protobuf:"bytes,2,opt,name=structured_query,json=structuredQuery,proto3,oneof"`
}

type Target_ReadTime

type Target_ReadTime struct {
	// Start listening after a specific `read_time`.
	//
	// The client must know the state of matching documents at this time.
	ReadTime *timestamp.Timestamp `protobuf:"bytes,11,opt,name=read_time,json=readTime,proto3,oneof"`
}

type Target_ResumeToken

type Target_ResumeToken struct {
	// A resume token from a prior [TargetChange][google.firestore.v1.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"`
}

type TransactionOptions

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
}

Options for creating a new transaction.

func (*TransactionOptions) Descriptor

func (*TransactionOptions) Descriptor() ([]byte, []int)

Deprecated: Use TransactionOptions.ProtoReflect.Descriptor instead.

func (*TransactionOptions) GetMode

func (m *TransactionOptions) GetMode() isTransactionOptions_Mode

func (*TransactionOptions) GetReadOnly

func (x *TransactionOptions) GetReadOnly() *TransactionOptions_ReadOnly

func (*TransactionOptions) GetReadWrite

func (x *TransactionOptions) GetReadWrite() *TransactionOptions_ReadWrite

func (*TransactionOptions) ProtoMessage

func (*TransactionOptions) ProtoMessage()

func (*TransactionOptions) ProtoReflect

func (x *TransactionOptions) ProtoReflect() protoreflect.Message

func (*TransactionOptions) Reset

func (x *TransactionOptions) Reset()

func (*TransactionOptions) String

func (x *TransactionOptions) String() string

type TransactionOptions_ReadOnly

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
}

Options for a transaction that can only be used to read documents.

func (*TransactionOptions_ReadOnly) Descriptor

func (*TransactionOptions_ReadOnly) Descriptor() ([]byte, []int)

Deprecated: Use TransactionOptions_ReadOnly.ProtoReflect.Descriptor instead.

func (*TransactionOptions_ReadOnly) GetConsistencySelector

func (m *TransactionOptions_ReadOnly) GetConsistencySelector() isTransactionOptions_ReadOnly_ConsistencySelector

func (*TransactionOptions_ReadOnly) GetReadTime

func (x *TransactionOptions_ReadOnly) GetReadTime() *timestamp.Timestamp

func (*TransactionOptions_ReadOnly) ProtoMessage

func (*TransactionOptions_ReadOnly) ProtoMessage()

func (*TransactionOptions_ReadOnly) ProtoReflect

func (x *TransactionOptions_ReadOnly) ProtoReflect() protoreflect.Message

func (*TransactionOptions_ReadOnly) Reset

func (x *TransactionOptions_ReadOnly) Reset()

func (*TransactionOptions_ReadOnly) String

func (x *TransactionOptions_ReadOnly) String() string

type TransactionOptions_ReadOnly_

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

type TransactionOptions_ReadOnly_ReadTime struct {
	// Reads documents at the given time.
	// This may not be older than 60 seconds.
	ReadTime *timestamp.Timestamp `protobuf:"bytes,2,opt,name=read_time,json=readTime,proto3,oneof"`
}

type TransactionOptions_ReadWrite

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
}

Options for a transaction that can be used to read and write documents.

func (*TransactionOptions_ReadWrite) Descriptor

func (*TransactionOptions_ReadWrite) Descriptor() ([]byte, []int)

Deprecated: Use TransactionOptions_ReadWrite.ProtoReflect.Descriptor instead.

func (*TransactionOptions_ReadWrite) GetRetryTransaction

func (x *TransactionOptions_ReadWrite) GetRetryTransaction() []byte

func (*TransactionOptions_ReadWrite) ProtoMessage

func (*TransactionOptions_ReadWrite) ProtoMessage()

func (*TransactionOptions_ReadWrite) ProtoReflect

func (x *TransactionOptions_ReadWrite) ProtoReflect() protoreflect.Message

func (*TransactionOptions_ReadWrite) Reset

func (x *TransactionOptions_ReadWrite) Reset()

func (*TransactionOptions_ReadWrite) String

func (x *TransactionOptions_ReadWrite) String() string

type TransactionOptions_ReadWrite_

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"`
}

type UnimplementedFirestoreServer

type UnimplementedFirestoreServer struct {
}

UnimplementedFirestoreServer can be embedded to have forward compatible implementations.

func (*UnimplementedFirestoreServer) BatchWrite

func (*UnimplementedFirestoreServer) BatchWrite(context.Context, *BatchWriteRequest) (*BatchWriteResponse, error)

func (*UnimplementedFirestoreServer) BeginTransaction

func (*UnimplementedFirestoreServer) BeginTransaction(context.Context, *BeginTransactionRequest) (*BeginTransactionResponse, error)

func (*UnimplementedFirestoreServer) Commit

func (*UnimplementedFirestoreServer) Commit(context.Context, *CommitRequest) (*CommitResponse, error)

func (*UnimplementedFirestoreServer) CreateDocument

func (*UnimplementedFirestoreServer) CreateDocument(context.Context, *CreateDocumentRequest) (*Document, error)

func (*UnimplementedFirestoreServer) DeleteDocument

func (*UnimplementedFirestoreServer) DeleteDocument(context.Context, *DeleteDocumentRequest) (*empty.Empty, error)

func (*UnimplementedFirestoreServer) GetDocument

func (*UnimplementedFirestoreServer) GetDocument(context.Context, *GetDocumentRequest) (*Document, error)

func (*UnimplementedFirestoreServer) ListCollectionIds

func (*UnimplementedFirestoreServer) ListCollectionIds(context.Context, *ListCollectionIdsRequest) (*ListCollectionIdsResponse, error)

func (*UnimplementedFirestoreServer) ListDocuments

func (*UnimplementedFirestoreServer) ListDocuments(context.Context, *ListDocumentsRequest) (*ListDocumentsResponse, error)

func (*UnimplementedFirestoreServer) Listen

func (*UnimplementedFirestoreServer) Listen(Firestore_ListenServer) error

func (*UnimplementedFirestoreServer) PartitionQuery

func (*UnimplementedFirestoreServer) PartitionQuery(context.Context, *PartitionQueryRequest) (*PartitionQueryResponse, error)

func (*UnimplementedFirestoreServer) Rollback

func (*UnimplementedFirestoreServer) Rollback(context.Context, *RollbackRequest) (*empty.Empty, error)

func (*UnimplementedFirestoreServer) RunQuery

func (*UnimplementedFirestoreServer) RunQuery(*RunQueryRequest, Firestore_RunQueryServer) error

func (*UnimplementedFirestoreServer) UpdateDocument

func (*UnimplementedFirestoreServer) UpdateDocument(context.Context, *UpdateDocumentRequest) (*Document, error)

func (*UnimplementedFirestoreServer) Write

func (*UnimplementedFirestoreServer) Write(Firestore_WriteServer) error

type UpdateDocumentRequest

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
}

The request for [Firestore.UpdateDocument][google.firestore.v1.Firestore.UpdateDocument].

func (*UpdateDocumentRequest) Descriptor

func (*UpdateDocumentRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateDocumentRequest.ProtoReflect.Descriptor instead.

func (*UpdateDocumentRequest) GetCurrentDocument

func (x *UpdateDocumentRequest) GetCurrentDocument() *Precondition

func (*UpdateDocumentRequest) GetDocument

func (x *UpdateDocumentRequest) GetDocument() *Document

func (*UpdateDocumentRequest) GetMask

func (x *UpdateDocumentRequest) GetMask() *DocumentMask

func (*UpdateDocumentRequest) GetUpdateMask

func (x *UpdateDocumentRequest) GetUpdateMask() *DocumentMask

func (*UpdateDocumentRequest) ProtoMessage

func (*UpdateDocumentRequest) ProtoMessage()

func (*UpdateDocumentRequest) ProtoReflect

func (x *UpdateDocumentRequest) ProtoReflect() protoreflect.Message

func (*UpdateDocumentRequest) Reset

func (x *UpdateDocumentRequest) Reset()

func (*UpdateDocumentRequest) String

func (x *UpdateDocumentRequest) String() string

type Value

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
}

A message that can hold any of the supported value types.

func (*Value) Descriptor

func (*Value) Descriptor() ([]byte, []int)

Deprecated: Use Value.ProtoReflect.Descriptor instead.

func (*Value) GetArrayValue

func (x *Value) GetArrayValue() *ArrayValue

func (*Value) GetBooleanValue

func (x *Value) GetBooleanValue() bool

func (*Value) GetBytesValue

func (x *Value) GetBytesValue() []byte

func (*Value) GetDoubleValue

func (x *Value) GetDoubleValue() float64

func (*Value) GetGeoPointValue

func (x *Value) GetGeoPointValue() *latlng.LatLng

func (*Value) GetIntegerValue

func (x *Value) GetIntegerValue() int64

func (*Value) GetMapValue

func (x *Value) GetMapValue() *MapValue

func (*Value) GetNullValue

func (x *Value) GetNullValue() _struct.NullValue

func (*Value) GetReferenceValue

func (x *Value) GetReferenceValue() string

func (*Value) GetStringValue

func (x *Value) GetStringValue() string

func (*Value) GetTimestampValue

func (x *Value) GetTimestampValue() *timestamp.Timestamp

func (*Value) GetValueType

func (m *Value) GetValueType() isValue_ValueType

func (*Value) ProtoMessage

func (*Value) ProtoMessage()

func (*Value) ProtoReflect

func (x *Value) ProtoReflect() protoreflect.Message

func (*Value) Reset

func (x *Value) Reset()

func (*Value) String

func (x *Value) String() string

type Value_ArrayValue

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

type Value_BooleanValue struct {
	// A boolean value.
	BooleanValue bool `protobuf:"varint,1,opt,name=boolean_value,json=booleanValue,proto3,oneof"`
}

type Value_BytesValue

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

type Value_DoubleValue struct {
	// A double value.
	DoubleValue float64 `protobuf:"fixed64,3,opt,name=double_value,json=doubleValue,proto3,oneof"`
}

type Value_GeoPointValue

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

type Value_IntegerValue struct {
	// An integer value.
	IntegerValue int64 `protobuf:"varint,2,opt,name=integer_value,json=integerValue,proto3,oneof"`
}

type Value_MapValue

type Value_MapValue struct {
	// A map value.
	MapValue *MapValue `protobuf:"bytes,6,opt,name=map_value,json=mapValue,proto3,oneof"`
}

type Value_NullValue

type Value_NullValue struct {
	// A null value.
	NullValue _struct.NullValue `protobuf:"varint,11,opt,name=null_value,json=nullValue,proto3,enum=google.protobuf.NullValue,oneof"`
}

type Value_ReferenceValue

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

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

type Value_TimestampValue struct {
	// A timestamp value.
	//
	// Precise only to microseconds. When stored, any additional precision is
	// rounded down.
	TimestampValue *timestamp.Timestamp `protobuf:"bytes,10,opt,name=timestamp_value,json=timestampValue,proto3,oneof"`
}

type Write

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
}

A write on a document.

func (*Write) Descriptor

func (*Write) Descriptor() ([]byte, []int)

Deprecated: Use Write.ProtoReflect.Descriptor instead.

func (*Write) GetCurrentDocument

func (x *Write) GetCurrentDocument() *Precondition

func (*Write) GetDelete

func (x *Write) GetDelete() string

func (*Write) GetOperation

func (m *Write) GetOperation() isWrite_Operation

func (*Write) GetTransform

func (x *Write) GetTransform() *DocumentTransform

func (*Write) GetUpdate

func (x *Write) GetUpdate() *Document

func (*Write) GetUpdateMask

func (x *Write) GetUpdateMask() *DocumentMask

func (*Write) GetUpdateTransforms

func (x *Write) GetUpdateTransforms() []*DocumentTransform_FieldTransform

func (*Write) ProtoMessage

func (*Write) ProtoMessage()

func (*Write) ProtoReflect

func (x *Write) ProtoReflect() protoreflect.Message

func (*Write) Reset

func (x *Write) Reset()

func (*Write) String

func (x *Write) String() string

type WriteRequest

type WriteRequest struct {
	Database string `protobuf:"bytes,1,opt,name=database,proto3" json:"database,omitempty"`

	StreamId string `protobuf:"bytes,2,opt,name=stream_id,json=streamId,proto3" json:"stream_id,omitempty"`

	Writes []*Write `protobuf:"bytes,3,rep,name=writes,proto3" json:"writes,omitempty"`

	StreamToken []byte `protobuf:"bytes,4,opt,name=stream_token,json=streamToken,proto3" json:"stream_token,omitempty"`

	Labels map[string]string "" /* 153 byte string literal not displayed */

}

The request for [Firestore.Write][google.firestore.v1.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.

func (*WriteRequest) Descriptor

func (*WriteRequest) Descriptor() ([]byte, []int)

Deprecated: Use WriteRequest.ProtoReflect.Descriptor instead.

func (*WriteRequest) GetDatabase

func (x *WriteRequest) GetDatabase() string

func (*WriteRequest) GetLabels

func (x *WriteRequest) GetLabels() map[string]string

func (*WriteRequest) GetStreamId

func (x *WriteRequest) GetStreamId() string

func (*WriteRequest) GetStreamToken

func (x *WriteRequest) GetStreamToken() []byte

func (*WriteRequest) GetWrites

func (x *WriteRequest) GetWrites() []*Write

func (*WriteRequest) ProtoMessage

func (*WriteRequest) ProtoMessage()

func (*WriteRequest) ProtoReflect

func (x *WriteRequest) ProtoReflect() protoreflect.Message

func (*WriteRequest) Reset

func (x *WriteRequest) Reset()

func (*WriteRequest) String

func (x *WriteRequest) String() string

type WriteResponse

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 *timestamp.Timestamp `protobuf:"bytes,4,opt,name=commit_time,json=commitTime,proto3" json:"commit_time,omitempty"`
	// contains filtered or unexported fields
}

The response for [Firestore.Write][google.firestore.v1.Firestore.Write].

func (*WriteResponse) Descriptor

func (*WriteResponse) Descriptor() ([]byte, []int)

Deprecated: Use WriteResponse.ProtoReflect.Descriptor instead.

func (*WriteResponse) GetCommitTime

func (x *WriteResponse) GetCommitTime() *timestamp.Timestamp

func (*WriteResponse) GetStreamId

func (x *WriteResponse) GetStreamId() string

func (*WriteResponse) GetStreamToken

func (x *WriteResponse) GetStreamToken() []byte

func (*WriteResponse) GetWriteResults

func (x *WriteResponse) GetWriteResults() []*WriteResult

func (*WriteResponse) ProtoMessage

func (*WriteResponse) ProtoMessage()

func (*WriteResponse) ProtoReflect

func (x *WriteResponse) ProtoReflect() protoreflect.Message

func (*WriteResponse) Reset

func (x *WriteResponse) Reset()

func (*WriteResponse) String

func (x *WriteResponse) String() string

type WriteResult

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 *timestamp.Timestamp `protobuf:"bytes,1,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// The results of applying each [DocumentTransform.FieldTransform][google.firestore.v1.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
}

The result of applying a write.

func (*WriteResult) Descriptor

func (*WriteResult) Descriptor() ([]byte, []int)

Deprecated: Use WriteResult.ProtoReflect.Descriptor instead.

func (*WriteResult) GetTransformResults

func (x *WriteResult) GetTransformResults() []*Value

func (*WriteResult) GetUpdateTime

func (x *WriteResult) GetUpdateTime() *timestamp.Timestamp

func (*WriteResult) ProtoMessage

func (*WriteResult) ProtoMessage()

func (*WriteResult) ProtoReflect

func (x *WriteResult) ProtoReflect() protoreflect.Message

func (*WriteResult) Reset

func (x *WriteResult) Reset()

func (*WriteResult) String

func (x *WriteResult) String() string

type Write_Delete

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

type Write_Transform struct {
	// Applies a transformation to a document.
	Transform *DocumentTransform `protobuf:"bytes,6,opt,name=transform,proto3,oneof"`
}

type Write_Update

type Write_Update struct {
	// A document to write.
	Update *Document `protobuf:"bytes,1,opt,name=update,proto3,oneof"`
}
Documentation was rendered with GOOS=linux and GOARCH=amd64.

Jump to identifier

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to identifier