firestorepb

package
v1.16.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 24, 2024 License: Apache-2.0 Imports: 16 Imported by: 13

Documentation

Index

Constants

This section is empty.

Variables

View Source 
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.

View Source 
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.

View Source 
var (
	StructuredQuery_CompositeFilter_Operator_name = map[int32]string{
		0: "OPERATOR_UNSPECIFIED",
		1: "AND",
		2: "OR",
	}
	StructuredQuery_CompositeFilter_Operator_value = map[string]int32{
		"OPERATOR_UNSPECIFIED": 0,
		"AND":                  1,
		"OR":                   2,
	}
)

Enum value maps for StructuredQuery_CompositeFilter_Operator.

View Source 
var (
	StructuredQuery_FieldFilter_Operator_name = map[int32]string{
		0:  "OPERATOR_UNSPECIFIED",
		1:  "LESS_THAN",
		2:  "LESS_THAN_OR_EQUAL",
		3:  "GREATER_THAN",
		4:  "GREATER_THAN_OR_EQUAL",
		5:  "EQUAL",
		6:  "NOT_EQUAL",
		7:  "ARRAY_CONTAINS",
		8:  "IN",
		9:  "ARRAY_CONTAINS_ANY",
		10: "NOT_IN",
	}
	StructuredQuery_FieldFilter_Operator_value = map[string]int32{
		"OPERATOR_UNSPECIFIED":  0,
		"LESS_THAN":             1,
		"LESS_THAN_OR_EQUAL":    2,
		"GREATER_THAN":          3,
		"GREATER_THAN_OR_EQUAL": 4,
		"EQUAL":                 5,
		"NOT_EQUAL":             6,
		"ARRAY_CONTAINS":        7,
		"IN":                    8,
		"ARRAY_CONTAINS_ANY":    9,
		"NOT_IN":                10,
	}
)

Enum value maps for StructuredQuery_FieldFilter_Operator.

View Source 
var (
	StructuredQuery_UnaryFilter_Operator_name = map[int32]string{
		0: "OPERATOR_UNSPECIFIED",
		2: "IS_NAN",
		3: "IS_NULL",
		4: "IS_NOT_NAN",
		5: "IS_NOT_NULL",
	}
	StructuredQuery_UnaryFilter_Operator_value = map[string]int32{
		"OPERATOR_UNSPECIFIED": 0,
		"IS_NAN":               2,
		"IS_NULL":              3,
		"IS_NOT_NAN":           4,
		"IS_NOT_NULL":          5,
	}
)

Enum value maps for StructuredQuery_UnaryFilter_Operator.

View Source 
var (
	StructuredQuery_FindNearest_DistanceMeasure_name = map[int32]string{
		0: "DISTANCE_MEASURE_UNSPECIFIED",
		1: "EUCLIDEAN",
		2: "COSINE",
		3: "DOT_PRODUCT",
	}
	StructuredQuery_FindNearest_DistanceMeasure_value = map[string]int32{
		"DISTANCE_MEASURE_UNSPECIFIED": 0,
		"EUCLIDEAN":                    1,
		"COSINE":                       2,
		"DOT_PRODUCT":                  3,
	}
)

Enum value maps for StructuredQuery_FindNearest_DistanceMeasure.

View Source 
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.

View Source 
var File_google_firestore_v1_aggregation_result_proto protoreflect.FileDescriptor
View Source 
var File_google_firestore_v1_bloom_filter_proto protoreflect.FileDescriptor
View Source 
var File_google_firestore_v1_common_proto protoreflect.FileDescriptor
View Source 
var File_google_firestore_v1_document_proto protoreflect.FileDescriptor
View Source 
var File_google_firestore_v1_firestore_proto protoreflect.FileDescriptor
View Source 
var File_google_firestore_v1_query_profile_proto protoreflect.FileDescriptor
View Source 
var File_google_firestore_v1_query_proto protoreflect.FileDescriptor
View Source 
var File_google_firestore_v1_write_proto protoreflect.FileDescriptor

Functions

func RegisterFirestoreServer 

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

Types

type AggregationResult 

type AggregationResult struct {

	// The result of the aggregation functions, ex: `COUNT(*) AS total_docs`.
	//
	// The key is the
	// [alias][google.firestore.v1.StructuredAggregationQuery.Aggregation.alias]
	// assigned to the aggregation function on input and the size of this map
	// equals the number of aggregation functions in the query.
	AggregateFields map[string]*Value `` /* 194-byte string literal not displayed */
	// contains filtered or unexported fields
}

The result of a single bucket from a Firestore aggregation query.

The keys of `aggregate_fields` are the same for all results in an aggregation query, unlike document queries which can have different fields present for each result.

func (*AggregationResult) Descriptor deprecated 

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

Deprecated: Use AggregationResult.ProtoReflect.Descriptor instead.

func (*AggregationResult) GetAggregateFields 

func (x *AggregationResult) GetAggregateFields() map[string]*Value

func (*AggregationResult) ProtoMessage 

func (*AggregationResult) ProtoMessage()

func (*AggregationResult) ProtoReflect 

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

func (*AggregationResult) Reset 

func (x *AggregationResult) Reset()

func (*AggregationResult) String 

func (x *AggregationResult) String() string

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 deprecated 

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 deprecated 

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() *timestamppb.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 must be a microsecond precision timestamp within the past one hour,
	// or if Point-in-Time Recovery is enabled, can additionally be a whole
	// minute timestamp within the past 7 days.
	ReadTime *timestamppb.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 *timestamppb.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 deprecated 

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() *timestamppb.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 {

	// Required. The database name. In the format:
	// `projects/{project_id}/databases/{database_id}`.
	Database string `protobuf:"bytes,1,opt,name=database,proto3" json:"database,omitempty"`
	// The writes to apply.
	//
	// Method does not apply writes atomically and does not guarantee ordering.
	// Each write succeeds or fails independently. You cannot write to the same
	// document more than once per request.
	Writes []*Write `protobuf:"bytes,2,rep,name=writes,proto3" json:"writes,omitempty"`
	// Labels associated with this batch write.
	Labels map[string]string `` /* 153-byte string literal not displayed */
	// contains filtered or unexported fields
}

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

func (*BatchWriteRequest) Descriptor deprecated 

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 deprecated 

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 deprecated 

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 deprecated 

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 BitSequence added in v1.10.0 

type BitSequence struct {

	// The bytes that encode the bit sequence.
	// May have a length of zero.
	Bitmap []byte `protobuf:"bytes,1,opt,name=bitmap,proto3" json:"bitmap,omitempty"`
	// The number of bits of the last byte in `bitmap` to ignore as "padding".
	// If the length of `bitmap` is zero, then this value must be `0`.
	// Otherwise, this value must be between 0 and 7, inclusive.
	Padding int32 `protobuf:"varint,2,opt,name=padding,proto3" json:"padding,omitempty"`
	// contains filtered or unexported fields
}

A sequence of bits, encoded in a byte array.

Each byte in the `bitmap` byte array stores 8 bits of the sequence. The only exception is the last byte, which may store 8 _or fewer_ bits. The `padding` defines the number of bits of the last byte to be ignored as "padding". The values of these "padding" bits are unspecified and must be ignored.

To retrieve the first bit, bit 0, calculate: `(bitmap[0] & 0x01) != 0`. To retrieve the second bit, bit 1, calculate: `(bitmap[0] & 0x02) != 0`. To retrieve the third bit, bit 2, calculate: `(bitmap[0] & 0x04) != 0`. To retrieve the fourth bit, bit 3, calculate: `(bitmap[0] & 0x08) != 0`. To retrieve bit n, calculate: `(bitmap[n / 8] & (0x01 << (n % 8))) != 0`.

The "size" of a `BitSequence` (the number of bits it contains) is calculated by this formula: `(bitmap.length * 8) - padding`.

func (*BitSequence) Descriptor deprecated added in v1.10.0 

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

Deprecated: Use BitSequence.ProtoReflect.Descriptor instead.

func (*BitSequence) GetBitmap added in v1.10.0 

func (x *BitSequence) GetBitmap() []byte

func (*BitSequence) GetPadding added in v1.10.0 

func (x *BitSequence) GetPadding() int32

func (*BitSequence) ProtoMessage added in v1.10.0 

func (*BitSequence) ProtoMessage()

func (*BitSequence) ProtoReflect added in v1.10.0 

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

func (*BitSequence) Reset added in v1.10.0 

func (x *BitSequence) Reset()

func (*BitSequence) String added in v1.10.0 

func (x *BitSequence) String() string

type BloomFilter added in v1.10.0 

type BloomFilter struct {

	// The bloom filter data.
	Bits *BitSequence `protobuf:"bytes,1,opt,name=bits,proto3" json:"bits,omitempty"`
	// The number of hashes used by the algorithm.
	HashCount int32 `protobuf:"varint,2,opt,name=hash_count,json=hashCount,proto3" json:"hash_count,omitempty"`
	// contains filtered or unexported fields
}

A bloom filter (https://en.wikipedia.org/wiki/Bloom_filter).

The bloom filter hashes the entries with MD5 and treats the resulting 128-bit hash as 2 distinct 64-bit hash values, interpreted as unsigned integers using 2's complement encoding.

These two hash values, named `h1` and `h2`, are then used to compute the `hash_count` hash values using the formula, starting at `i=0`: 

h(i) = h1 + (i * h2)

These resulting values are then taken modulo the number of bits in the bloom filter to get the bits of the bloom filter to test for the given entry.

func (*BloomFilter) Descriptor deprecated added in v1.10.0 

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

Deprecated: Use BloomFilter.ProtoReflect.Descriptor instead.

func (*BloomFilter) GetBits added in v1.10.0 

func (x *BloomFilter) GetBits() *BitSequence

func (*BloomFilter) GetHashCount added in v1.10.0 

func (x *BloomFilter) GetHashCount() int32

func (*BloomFilter) ProtoMessage added in v1.10.0 

func (*BloomFilter) ProtoMessage()

func (*BloomFilter) ProtoReflect added in v1.10.0 

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

func (*BloomFilter) Reset added in v1.10.0 

func (x *BloomFilter) Reset()

func (*BloomFilter) String added in v1.10.0 

func (x *BloomFilter) 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 deprecated 

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 *timestamppb.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 deprecated 

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

Deprecated: Use CommitResponse.ProtoReflect.Descriptor instead.

func (*CommitResponse) GetCommitTime 

func (x *CommitResponse) GetCommitTime() *timestamppb.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 deprecated 

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 deprecated 

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 deprecated 

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 {

	// The resource name of the document, for example
	// `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The document's fields.
	//
	// The map keys represent field names.
	//
	// Field names matching the regular expression `__.*__` are reserved. Reserved
	// field names are forbidden except in certain documented contexts. The field
	// names, represented as UTF-8, must not exceed 1,500 bytes and cannot be
	// empty.
	//
	// Field paths may be used in other contexts to refer to structured fields
	// defined here. For `map_value`, the field path is represented by a
	// dot-delimited (`.`) string of segments. Each segment is either a simple
	// field name (defined below) or a quoted field name. For example, the
	// structured field `"foo" : { map_value: { "x&y" : { string_value: "hello"
	// }}}` would be represented by the field path “ foo.`x&y` “.
	//
	// A simple field name contains only characters `a` to `z`, `A` to `Z`,
	// `0` to `9`, or `_`, and must not start with `0` to `9`. For example,
	// `foo_bar_17`.
	//
	// A quoted field name starts and ends with “ ` “ and
	// may contain any character. Some characters, including “ ` “, must be
	// escaped using a `\`. For example, “ `x&y` “ represents `x&y` and
	// “ `bak\`tik` “ represents “ bak`tik “.
	Fields map[string]*Value `` /* 153-byte string literal not displayed */
	// Output only. The time at which the document was created.
	//
	// This value increases monotonically when a document is deleted then
	// recreated. It can also be compared to values from other documents and
	// the `read_time` of a query.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. The time at which the document was last changed.
	//
	// This value is initially set to the `create_time` then increases
	// monotonically with each change to the document. It can also be
	// compared to values from other documents and the `read_time` of a query.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// contains filtered or unexported fields
}

A Firestore document.

Must not exceed 1 MiB - 4 bytes.

func (*Document) Descriptor deprecated 

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

Deprecated: Use Document.ProtoReflect.Descriptor instead.

func (*Document) GetCreateTime 

func (x *Document) GetCreateTime() *timestamppb.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() *timestamppb.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 deprecated 

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 *timestamppb.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 deprecated 

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() *timestamppb.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 deprecated 

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 *timestamppb.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 deprecated 

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() *timestamppb.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 deprecated 

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 deprecated 

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. If used on multiple fields (same or different documents) in
	// a transaction, all the fields will get the same server timestamp.
	DocumentTransform_FieldTransform_REQUEST_TIME DocumentTransform_FieldTransform_ServerValue = 1
)

func (DocumentTransform_FieldTransform_ServerValue) Descriptor 

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 deprecated 

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 {
	// Sets the field to the given server value.
	SetToServerValue DocumentTransform_FieldTransform_ServerValue `` /* 153-byte string literal not displayed */
}

type ExecutionStats added in v1.16.0 

type ExecutionStats struct {

	// Total number of results returned, including documents, projections,
	// aggregation results, keys.
	ResultsReturned int64 `protobuf:"varint,1,opt,name=results_returned,json=resultsReturned,proto3" json:"results_returned,omitempty"`
	// Total time to execute the query in the backend.
	ExecutionDuration *durationpb.Duration `protobuf:"bytes,3,opt,name=execution_duration,json=executionDuration,proto3" json:"execution_duration,omitempty"`
	// Total billable read operations.
	ReadOperations int64 `protobuf:"varint,4,opt,name=read_operations,json=readOperations,proto3" json:"read_operations,omitempty"`
	// Debugging statistics from the execution of the query. Note that the
	// debugging stats are subject to change as Firestore evolves. It could
	// include:
	//
	//	{
	//	  "indexes_entries_scanned": "1000",
	//	  "documents_scanned": "20",
	//	  "billing_details" : {
	//	     "documents_billable": "20",
	//	     "index_entries_billable": "1000",
	//	     "min_query_cost": "0"
	//	  }
	//	}
	DebugStats *structpb.Struct `protobuf:"bytes,5,opt,name=debug_stats,json=debugStats,proto3" json:"debug_stats,omitempty"`
	// contains filtered or unexported fields
}

Execution statistics for the query.

func (*ExecutionStats) Descriptor deprecated added in v1.16.0 

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

Deprecated: Use ExecutionStats.ProtoReflect.Descriptor instead.

func (*ExecutionStats) GetDebugStats added in v1.16.0 

func (x *ExecutionStats) GetDebugStats() *structpb.Struct

func (*ExecutionStats) GetExecutionDuration added in v1.16.0 

func (x *ExecutionStats) GetExecutionDuration() *durationpb.Duration

func (*ExecutionStats) GetReadOperations added in v1.16.0 

func (x *ExecutionStats) GetReadOperations() int64

func (*ExecutionStats) GetResultsReturned added in v1.16.0 

func (x *ExecutionStats) GetResultsReturned() int64

func (*ExecutionStats) ProtoMessage added in v1.16.0 

func (*ExecutionStats) ProtoMessage()

func (*ExecutionStats) ProtoReflect added in v1.16.0 

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

func (*ExecutionStats) Reset added in v1.16.0 

func (x *ExecutionStats) Reset()

func (*ExecutionStats) String added in v1.16.0 

func (x *ExecutionStats) String() string

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.
	//
	// The client can use the `unchanged_names` bloom filter to assist with
	// this determination by testing ALL the document names against the filter;
	// if the document name is NOT in the filter, it means the document no
	// longer matches the target.
	Count int32 `protobuf:"varint,2,opt,name=count,proto3" json:"count,omitempty"`
	// A bloom filter that, despite its name, contains the UTF-8 byte encodings of
	// the resource names of ALL the documents that match
	// [target_id][google.firestore.v1.ExistenceFilter.target_id], in the form
	// `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
	//
	// This bloom filter may be omitted at the server's discretion, such as if it
	// is deemed that the client will not make use of it or if it is too
	// computationally expensive to calculate or transmit. Clients must gracefully
	// handle this field being absent by falling back to the logic used before
	// this field existed; that is, re-add the target without a resume token to
	// figure out which documents in the client's cache are out of sync.
	UnchangedNames *BloomFilter `protobuf:"bytes,3,opt,name=unchanged_names,json=unchangedNames,proto3" json:"unchanged_names,omitempty"`
	// contains filtered or unexported fields
}

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

func (*ExistenceFilter) Descriptor deprecated 

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) GetUnchangedNames added in v1.10.0 

func (x *ExistenceFilter) GetUnchangedNames() *BloomFilter

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 ExplainMetrics added in v1.16.0 

type ExplainMetrics struct {

	// Planning phase information for the query.
	PlanSummary *PlanSummary `protobuf:"bytes,1,opt,name=plan_summary,json=planSummary,proto3" json:"plan_summary,omitempty"`
	// Aggregated stats from the execution of the query. Only present when
	// [ExplainOptions.analyze][google.firestore.v1.ExplainOptions.analyze] is set
	// to true.
	ExecutionStats *ExecutionStats `protobuf:"bytes,2,opt,name=execution_stats,json=executionStats,proto3" json:"execution_stats,omitempty"`
	// contains filtered or unexported fields
}

Explain metrics for the query.

func (*ExplainMetrics) Descriptor deprecated added in v1.16.0 

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

Deprecated: Use ExplainMetrics.ProtoReflect.Descriptor instead.

func (*ExplainMetrics) GetExecutionStats added in v1.16.0 

func (x *ExplainMetrics) GetExecutionStats() *ExecutionStats

func (*ExplainMetrics) GetPlanSummary added in v1.16.0 

func (x *ExplainMetrics) GetPlanSummary() *PlanSummary

func (*ExplainMetrics) ProtoMessage added in v1.16.0 

func (*ExplainMetrics) ProtoMessage()

func (*ExplainMetrics) ProtoReflect added in v1.16.0 

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

func (*ExplainMetrics) Reset added in v1.16.0 

func (x *ExplainMetrics) Reset()

func (*ExplainMetrics) String added in v1.16.0 

func (x *ExplainMetrics) String() string

type ExplainOptions added in v1.16.0 

type ExplainOptions struct {

	// Optional. Whether to execute this query.
	//
	// When false (the default), the query will be planned, returning only
	// metrics from the planning stages.
	//
	// When true, the query will be planned and executed, returning the full
	// query results along with both planning and execution stage metrics.
	Analyze bool `protobuf:"varint,1,opt,name=analyze,proto3" json:"analyze,omitempty"`
	// contains filtered or unexported fields
}

Explain options for the query.

func (*ExplainOptions) Descriptor deprecated added in v1.16.0 

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

Deprecated: Use ExplainOptions.ProtoReflect.Descriptor instead.

func (*ExplainOptions) GetAnalyze added in v1.16.0 

func (x *ExplainOptions) GetAnalyze() bool

func (*ExplainOptions) ProtoMessage added in v1.16.0 

func (*ExplainOptions) ProtoMessage()

func (*ExplainOptions) ProtoReflect added in v1.16.0 

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

func (*ExplainOptions) Reset added in v1.16.0 

func (x *ExplainOptions) Reset()

func (*ExplainOptions) String added in v1.16.0 

func (x *ExplainOptions) 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) (*emptypb.Empty, error)
	// Gets multiple documents.
	//
	// Documents returned by this method are not guaranteed to be returned in the
	// same order that they were requested.
	BatchGetDocuments(ctx context.Context, in *BatchGetDocumentsRequest, opts ...grpc.CallOption) (Firestore_BatchGetDocumentsClient, error)
	// Starts a new transaction.
	BeginTransaction(ctx context.Context, in *BeginTransactionRequest, opts ...grpc.CallOption) (*BeginTransactionResponse, error)
	// Commits a transaction, while optionally updating documents.
	Commit(ctx context.Context, in *CommitRequest, opts ...grpc.CallOption) (*CommitResponse, error)
	// Rolls back a transaction.
	Rollback(ctx context.Context, in *RollbackRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Runs a query.
	RunQuery(ctx context.Context, in *RunQueryRequest, opts ...grpc.CallOption) (Firestore_RunQueryClient, error)
	// Runs an aggregation query.
	//
	// Rather than producing [Document][google.firestore.v1.Document] results like
	// [Firestore.RunQuery][google.firestore.v1.Firestore.RunQuery], this API
	// allows running an aggregation to produce a series of
	// [AggregationResult][google.firestore.v1.AggregationResult] server-side.
	//
	// High-Level Example:
	//
	// “`
	// -- Return the number of documents in table given a filter.
	// SELECT COUNT(*) FROM ( SELECT * FROM k where a = true );
	// “`
	RunAggregationQuery(ctx context.Context, in *RunAggregationQueryRequest, opts ...grpc.CallOption) (Firestore_RunAggregationQueryClient, 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. This method is
	// only available via gRPC or WebChannel (not REST).
	Write(ctx context.Context, opts ...grpc.CallOption) (Firestore_WriteClient, error)
	// Listens to changes. This method is only available via gRPC or WebChannel
	// (not REST).
	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.

func NewFirestoreClient 

func NewFirestoreClient(cc grpc.ClientConnInterface) FirestoreClient

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) (*emptypb.Empty, error)
	// Gets multiple documents.
	//
	// Documents returned by this method are not guaranteed to be returned in the
	// same order that they were requested.
	BatchGetDocuments(*BatchGetDocumentsRequest, Firestore_BatchGetDocumentsServer) error
	// Starts a new transaction.
	BeginTransaction(context.Context, *BeginTransactionRequest) (*BeginTransactionResponse, error)
	// Commits a transaction, while optionally updating documents.
	Commit(context.Context, *CommitRequest) (*CommitResponse, error)
	// Rolls back a transaction.
	Rollback(context.Context, *RollbackRequest) (*emptypb.Empty, error)
	// Runs a query.
	RunQuery(*RunQueryRequest, Firestore_RunQueryServer) error
	// Runs an aggregation query.
	//
	// Rather than producing [Document][google.firestore.v1.Document] results like
	// [Firestore.RunQuery][google.firestore.v1.Firestore.RunQuery], this API
	// allows running an aggregation to produce a series of
	// [AggregationResult][google.firestore.v1.AggregationResult] server-side.
	//
	// High-Level Example:
	//
	// “`
	// -- Return the number of documents in table given a filter.
	// SELECT COUNT(*) FROM ( SELECT * FROM k where a = true );
	// “`
	RunAggregationQuery(*RunAggregationQueryRequest, Firestore_RunAggregationQueryServer) 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. This method is
	// only available via gRPC or WebChannel (not REST).
	Write(Firestore_WriteServer) error
	// Listens to changes. This method is only available via gRPC or WebChannel
	// (not REST).
	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_RunAggregationQueryClient 

type Firestore_RunAggregationQueryClient interface {
	Recv() (*RunAggregationQueryResponse, error)
	grpc.ClientStream
}

type Firestore_RunAggregationQueryServer 

type Firestore_RunAggregationQueryServer interface {
	Send(*RunAggregationQueryResponse) 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 deprecated 

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() *timestamppb.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 must be a microsecond precision timestamp within the past one hour,
	// or if Point-in-Time Recovery is enabled, can additionally be a whole
	// minute timestamp within the past 7 days.
	ReadTime *timestamppb.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"`
	// The consistency mode for this request.
	// If not set, defaults to strong consistency.
	//
	// Types that are assignable to ConsistencySelector:
	//
	//	*ListCollectionIdsRequest_ReadTime
	ConsistencySelector isListCollectionIdsRequest_ConsistencySelector `protobuf_oneof:"consistency_selector"`
	// contains filtered or unexported fields
}

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

func (*ListCollectionIdsRequest) Descriptor deprecated 

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

Deprecated: Use ListCollectionIdsRequest.ProtoReflect.Descriptor instead.

func (*ListCollectionIdsRequest) GetConsistencySelector 

func (m *ListCollectionIdsRequest) GetConsistencySelector() isListCollectionIdsRequest_ConsistencySelector

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) GetReadTime 

func (x *ListCollectionIdsRequest) GetReadTime() *timestamppb.Timestamp

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 ListCollectionIdsRequest_ReadTime 

type ListCollectionIdsRequest_ReadTime struct {
	// Reads documents as they were at the given time.
	//
	// This must be a microsecond precision timestamp within the past one hour,
	// or if Point-in-Time Recovery is enabled, can additionally be a whole
	// minute timestamp within the past 7 days.
	ReadTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=read_time,json=readTime,proto3,oneof"`
}

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 deprecated 

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"`
	// Optional. The collection ID, relative to `parent`, to list.
	//
	// For example: `chatrooms` or `messages`.
	//
	// This is optional, and when not provided, Firestore will list documents
	// from all collections under the provided `parent`.
	CollectionId string `protobuf:"bytes,2,opt,name=collection_id,json=collectionId,proto3" json:"collection_id,omitempty"`
	// Optional. The maximum number of documents to return in a single response.
	//
	// Firestore may return fewer than this value.
	PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Optional. A page token, received from a previous `ListDocuments` response.
	//
	// Provide this to retrieve the subsequent page. When paginating, all other
	// parameters (with the exception of `page_size`) must match the values set
	// in the request that generated the page token.
	PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// Optional. The optional ordering of the documents to return.
	//
	// For example: `priority desc, __name__ desc`.
	//
	// This mirrors the [`ORDER BY`][google.firestore.v1.StructuredQuery.order_by]
	// used in Firestore queries but in a string representation. When absent,
	// documents are ordered based on `__name__ ASC`.
	OrderBy string `protobuf:"bytes,6,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
	// Optional. 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 document is missing if it does not exist, but there are sub-documents
	// nested underneath it. When true, such missing documents will be returned
	// with a key but will not have fields,
	// [`create_time`][google.firestore.v1.Document.create_time], or
	// [`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 deprecated 

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() *timestamppb.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 {
	// Perform the read at the provided time.
	//
	// This must be a microsecond precision timestamp within the past one hour,
	// or if Point-in-Time Recovery is enabled, can additionally be a whole
	// minute timestamp within the past 7 days.
	ReadTime *timestamppb.Timestamp `protobuf:"bytes,10,opt,name=read_time,json=readTime,proto3,oneof"`
}

type ListDocumentsRequest_Transaction 

type ListDocumentsRequest_Transaction struct {
	// Perform the read as part of an already active 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"`
	// A token to retrieve the next page of documents.
	//
	// If this field is omitted, there are no subsequent pages.
	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 deprecated 

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 {

	// Required. The database name. In the format:
	// `projects/{project_id}/databases/{database_id}`.
	Database string `protobuf:"bytes,1,opt,name=database,proto3" json:"database,omitempty"`
	// The supported target changes.
	//
	// Types that are assignable to TargetChange:
	//
	//	*ListenRequest_AddTarget
	//	*ListenRequest_RemoveTarget
	TargetChange isListenRequest_TargetChange `protobuf_oneof:"target_change"`
	// Labels associated with this target change.
	Labels map[string]string `` /* 153-byte string literal not displayed */
	// contains filtered or unexported fields
}

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

func (*ListenRequest) Descriptor deprecated 

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 deprecated 

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 {

	// The map's fields.
	//
	// The map keys represent field names. Field names matching the regular
	// expression `__.*__` are reserved. Reserved field names are forbidden except
	// in certain documented contexts. The map keys, represented as UTF-8, must
	// not exceed 1,500 bytes and cannot be empty.
	Fields map[string]*Value `` /* 153-byte string literal not displayed */
	// contains filtered or unexported fields
}

A map value.

func (*MapValue) Descriptor deprecated 

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 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"`
	// The consistency mode for this request.
	// If not set, defaults to strong consistency.
	//
	// Types that are assignable to ConsistencySelector:
	//
	//	*PartitionQueryRequest_ReadTime
	ConsistencySelector isPartitionQueryRequest_ConsistencySelector `protobuf_oneof:"consistency_selector"`
	// contains filtered or unexported fields
}

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

func (*PartitionQueryRequest) Descriptor deprecated 

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

Deprecated: Use PartitionQueryRequest.ProtoReflect.Descriptor instead.

func (*PartitionQueryRequest) GetConsistencySelector 

func (m *PartitionQueryRequest) GetConsistencySelector() isPartitionQueryRequest_ConsistencySelector

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) GetReadTime 

func (x *PartitionQueryRequest) GetReadTime() *timestamppb.Timestamp

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_ReadTime 

type PartitionQueryRequest_ReadTime struct {
	// Reads documents as they were at the given time.
	//
	// This must be a microsecond precision timestamp within the past one hour,
	// or if Point-in-Time Recovery is enabled, can additionally be a whole
	// minute timestamp within the past 7 days.
	ReadTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=read_time,json=readTime,proto3,oneof"`
}

type PartitionQueryRequest_StructuredQuery 

type PartitionQueryRequest_StructuredQuery struct {
	// A structured query.
	// Query must specify collection with all descendants and be ordered by name
	// ascending. Other filters, order bys, limits, offsets, and start/end
	// cursors are not supported.
	StructuredQuery *StructuredQuery `protobuf:"bytes,2,opt,name=structured_query,json=structuredQuery,proto3,oneof"`
}

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
	//
	// An empty result may indicate that the query has too few results to be
	// partitioned, or that the query is not yet supported for partitioning.
	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 deprecated 

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 PlanSummary added in v1.16.0 

type PlanSummary struct {

	// The indexes selected for the query. For example:
	//
	//	[
	//	  {"query_scope": "Collection", "properties": "(foo ASC, __name__ ASC)"},
	//	  {"query_scope": "Collection", "properties": "(bar ASC, __name__ ASC)"}
	//	]
	IndexesUsed []*structpb.Struct `protobuf:"bytes,1,rep,name=indexes_used,json=indexesUsed,proto3" json:"indexes_used,omitempty"`
	// contains filtered or unexported fields
}

Planning phase information for the query.

func (*PlanSummary) Descriptor deprecated added in v1.16.0 

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

Deprecated: Use PlanSummary.ProtoReflect.Descriptor instead.

func (*PlanSummary) GetIndexesUsed added in v1.16.0 

func (x *PlanSummary) GetIndexesUsed() []*structpb.Struct

func (*PlanSummary) ProtoMessage added in v1.16.0 

func (*PlanSummary) ProtoMessage()

func (*PlanSummary) ProtoReflect added in v1.16.0 

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

func (*PlanSummary) Reset added in v1.16.0 

func (x *PlanSummary) Reset()

func (*PlanSummary) String added in v1.16.0 

func (x *PlanSummary) 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 deprecated 

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() *timestamppb.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. Timestamp must be microsecond aligned.
	UpdateTime *timestamppb.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 deprecated 

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 RunAggregationQueryRequest 

type RunAggregationQueryRequest 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:
	//
	//	*RunAggregationQueryRequest_StructuredAggregationQuery
	QueryType isRunAggregationQueryRequest_QueryType `protobuf_oneof:"query_type"`
	// The consistency mode for the query, defaults to strong consistency.
	//
	// Types that are assignable to ConsistencySelector:
	//
	//	*RunAggregationQueryRequest_Transaction
	//	*RunAggregationQueryRequest_NewTransaction
	//	*RunAggregationQueryRequest_ReadTime
	ConsistencySelector isRunAggregationQueryRequest_ConsistencySelector `protobuf_oneof:"consistency_selector"`
	// Optional. Explain options for the query. If set, additional query
	// statistics will be returned. If not, only query results will be returned.
	ExplainOptions *ExplainOptions `protobuf:"bytes,8,opt,name=explain_options,json=explainOptions,proto3" json:"explain_options,omitempty"`
	// contains filtered or unexported fields
}

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

func (*RunAggregationQueryRequest) Descriptor deprecated 

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

Deprecated: Use RunAggregationQueryRequest.ProtoReflect.Descriptor instead.

func (*RunAggregationQueryRequest) GetConsistencySelector 

func (m *RunAggregationQueryRequest) GetConsistencySelector() isRunAggregationQueryRequest_ConsistencySelector

func (*RunAggregationQueryRequest) GetExplainOptions added in v1.16.0 

func (x *RunAggregationQueryRequest) GetExplainOptions() *ExplainOptions

func (*RunAggregationQueryRequest) GetNewTransaction 

func (x *RunAggregationQueryRequest) GetNewTransaction() *TransactionOptions

func (*RunAggregationQueryRequest) GetParent 

func (x *RunAggregationQueryRequest) GetParent() string

func (*RunAggregationQueryRequest) GetQueryType 

func (m *RunAggregationQueryRequest) GetQueryType() isRunAggregationQueryRequest_QueryType

func (*RunAggregationQueryRequest) GetReadTime 

func (x *RunAggregationQueryRequest) GetReadTime() *timestamppb.Timestamp

func (*RunAggregationQueryRequest) GetStructuredAggregationQuery 

func (x *RunAggregationQueryRequest) GetStructuredAggregationQuery() *StructuredAggregationQuery

func (*RunAggregationQueryRequest) GetTransaction 

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

func (*RunAggregationQueryRequest) ProtoMessage 

func (*RunAggregationQueryRequest) ProtoMessage()

func (*RunAggregationQueryRequest) ProtoReflect 

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

func (*RunAggregationQueryRequest) Reset 

func (x *RunAggregationQueryRequest) Reset()

func (*RunAggregationQueryRequest) String 

func (x *RunAggregationQueryRequest) String() string

type RunAggregationQueryRequest_NewTransaction 

type RunAggregationQueryRequest_NewTransaction struct {
	// Starts a new transaction as part of the query, defaulting to read-only.
	//
	// 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 RunAggregationQueryRequest_ReadTime 

type RunAggregationQueryRequest_ReadTime struct {
	// Executes the query at the given timestamp.
	//
	// This must be a microsecond precision timestamp within the past one hour,
	// or if Point-in-Time Recovery is enabled, can additionally be a whole
	// minute timestamp within the past 7 days.
	ReadTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=read_time,json=readTime,proto3,oneof"`
}

type RunAggregationQueryRequest_StructuredAggregationQuery 

type RunAggregationQueryRequest_StructuredAggregationQuery struct {
	// An aggregation query.
	StructuredAggregationQuery *StructuredAggregationQuery `protobuf:"bytes,2,opt,name=structured_aggregation_query,json=structuredAggregationQuery,proto3,oneof"`
}

type RunAggregationQueryRequest_Transaction 

type RunAggregationQueryRequest_Transaction struct {
	// Run the aggregation within an already active transaction.
	//
	// The value here is the opaque transaction ID to execute the query in.
	Transaction []byte `protobuf:"bytes,4,opt,name=transaction,proto3,oneof"`
}

type RunAggregationQueryResponse 

type RunAggregationQueryResponse struct {

	// A single aggregation result.
	//
	// Not present when reporting partial progress.
	Result *AggregationResult `protobuf:"bytes,1,opt,name=result,proto3" json:"result,omitempty"`
	// The transaction that was started as part of this request.
	//
	// Only present on the first response when the request requested to start
	// a new transaction.
	Transaction []byte `protobuf:"bytes,2,opt,name=transaction,proto3" json:"transaction,omitempty"`
	// The time at which the aggregate result was computed. This is always
	// monotonically increasing; in this case, the previous AggregationResult 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
	// `result` will be sent, and this represents the time at which the query
	// was run.
	ReadTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=read_time,json=readTime,proto3" json:"read_time,omitempty"`
	// Query explain metrics. This is only present when the
	// [RunAggregationQueryRequest.explain_options][google.firestore.v1.RunAggregationQueryRequest.explain_options]
	// is provided, and it is sent only once with the last response in the stream.
	ExplainMetrics *ExplainMetrics `protobuf:"bytes,10,opt,name=explain_metrics,json=explainMetrics,proto3" json:"explain_metrics,omitempty"`
	// contains filtered or unexported fields
}

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

func (*RunAggregationQueryResponse) Descriptor deprecated 

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

Deprecated: Use RunAggregationQueryResponse.ProtoReflect.Descriptor instead.

func (*RunAggregationQueryResponse) GetExplainMetrics added in v1.16.0 

func (x *RunAggregationQueryResponse) GetExplainMetrics() *ExplainMetrics

func (*RunAggregationQueryResponse) GetReadTime 

func (x *RunAggregationQueryResponse) GetReadTime() *timestamppb.Timestamp

func (*RunAggregationQueryResponse) GetResult 

func (x *RunAggregationQueryResponse) GetResult() *AggregationResult

func (*RunAggregationQueryResponse) GetTransaction 

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

func (*RunAggregationQueryResponse) ProtoMessage 

func (*RunAggregationQueryResponse) ProtoMessage()

func (*RunAggregationQueryResponse) ProtoReflect 

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

func (*RunAggregationQueryResponse) Reset 

func (x *RunAggregationQueryResponse) Reset()

func (*RunAggregationQueryResponse) String 

func (x *RunAggregationQueryResponse) 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"`
	// Optional. Explain options for the query. If set, additional query
	// statistics will be returned. If not, only query results will be returned.
	ExplainOptions *ExplainOptions `protobuf:"bytes,10,opt,name=explain_options,json=explainOptions,proto3" json:"explain_options,omitempty"`
	// contains filtered or unexported fields
}

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

func (*RunQueryRequest) Descriptor deprecated 

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

Deprecated: Use RunQueryRequest.ProtoReflect.Descriptor instead.

func (*RunQueryRequest) GetConsistencySelector 

func (m *RunQueryRequest) GetConsistencySelector() isRunQueryRequest_ConsistencySelector

func (*RunQueryRequest) GetExplainOptions added in v1.16.0 

func (x *RunQueryRequest) GetExplainOptions() *ExplainOptions

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() *timestamppb.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 must be a microsecond precision timestamp within the past one hour,
	// or if Point-in-Time Recovery is enabled, can additionally be a whole
	// minute timestamp within the past 7 days.
	ReadTime *timestamppb.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 {
	// Run the query within an already active transaction.
	//
	// The value here is the opaque transaction ID to execute the query in.
	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 *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=read_time,json=readTime,proto3" json:"read_time,omitempty"`
	// The number of results that have been skipped due to an offset between
	// the last response and the current response.
	SkippedResults int32 `protobuf:"varint,4,opt,name=skipped_results,json=skippedResults,proto3" json:"skipped_results,omitempty"`
	// The continuation mode for the query. If present, it indicates the current
	// query response stream has finished. This can be set with or without a
	// `document` present, but when set, no more results are returned.
	//
	// Types that are assignable to ContinuationSelector:
	//
	//	*RunQueryResponse_Done
	ContinuationSelector isRunQueryResponse_ContinuationSelector `protobuf_oneof:"continuation_selector"`
	// Query explain metrics. This is only present when the
	// [RunQueryRequest.explain_options][google.firestore.v1.RunQueryRequest.explain_options]
	// is provided, and it is sent only once with the last response in the stream.
	ExplainMetrics *ExplainMetrics `protobuf:"bytes,11,opt,name=explain_metrics,json=explainMetrics,proto3" json:"explain_metrics,omitempty"`
	// contains filtered or unexported fields
}

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

func (*RunQueryResponse) Descriptor deprecated 

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

Deprecated: Use RunQueryResponse.ProtoReflect.Descriptor instead.

func (*RunQueryResponse) GetContinuationSelector 

func (m *RunQueryResponse) GetContinuationSelector() isRunQueryResponse_ContinuationSelector

func (*RunQueryResponse) GetDocument 

func (x *RunQueryResponse) GetDocument() *Document

func (*RunQueryResponse) GetDone 

func (x *RunQueryResponse) GetDone() bool

func (*RunQueryResponse) GetExplainMetrics added in v1.16.0 

func (x *RunQueryResponse) GetExplainMetrics() *ExplainMetrics

func (*RunQueryResponse) GetReadTime 

func (x *RunQueryResponse) GetReadTime() *timestamppb.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 RunQueryResponse_Done 

type RunQueryResponse_Done struct {
	// If present, Firestore has completely finished the request and no more
	// documents will be returned.
	Done bool `protobuf:"varint,6,opt,name=done,proto3,oneof"`
}

type StructuredAggregationQuery 

type StructuredAggregationQuery struct {

	// The base query to aggregate over.
	//
	// Types that are assignable to QueryType:
	//
	//	*StructuredAggregationQuery_StructuredQuery
	QueryType isStructuredAggregationQuery_QueryType `protobuf_oneof:"query_type"`
	// Optional. Series of aggregations to apply over the results of the
	// `structured_query`.
	//
	// Requires:
	//
	// * A minimum of one and maximum of five aggregations per query.
	Aggregations []*StructuredAggregationQuery_Aggregation `protobuf:"bytes,3,rep,name=aggregations,proto3" json:"aggregations,omitempty"`
	// contains filtered or unexported fields
}

Firestore query for running an aggregation over a StructuredQuery[google.firestore.v1.StructuredQuery].

func (*StructuredAggregationQuery) Descriptor deprecated 

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

Deprecated: Use StructuredAggregationQuery.ProtoReflect.Descriptor instead.

func (*StructuredAggregationQuery) GetAggregations 

func (x *StructuredAggregationQuery) GetAggregations() []*StructuredAggregationQuery_Aggregation

func (*StructuredAggregationQuery) GetQueryType 

func (m *StructuredAggregationQuery) GetQueryType() isStructuredAggregationQuery_QueryType

func (*StructuredAggregationQuery) GetStructuredQuery 

func (x *StructuredAggregationQuery) GetStructuredQuery() *StructuredQuery

func (*StructuredAggregationQuery) ProtoMessage 

func (*StructuredAggregationQuery) ProtoMessage()

func (*StructuredAggregationQuery) ProtoReflect 

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

func (*StructuredAggregationQuery) Reset 

func (x *StructuredAggregationQuery) Reset()

func (*StructuredAggregationQuery) String 

func (x *StructuredAggregationQuery) String() string

type StructuredAggregationQuery_Aggregation 

type StructuredAggregationQuery_Aggregation struct {

	// The type of aggregation to perform, required.
	//
	// Types that are assignable to Operator:
	//
	//	*StructuredAggregationQuery_Aggregation_Count_
	//	*StructuredAggregationQuery_Aggregation_Sum_
	//	*StructuredAggregationQuery_Aggregation_Avg_
	Operator isStructuredAggregationQuery_Aggregation_Operator `protobuf_oneof:"operator"`
	// Optional. Optional name of the field to store the result of the
	// aggregation into.
	//
	// If not provided, Firestore will pick a default name following the format
	// `field_<incremental_id++>`. For example:
	//
	// “`
	// AGGREGATE
	//
	//	COUNT_UP_TO(1) AS count_up_to_1,
	//	COUNT_UP_TO(2),
	//	COUNT_UP_TO(3) AS count_up_to_3,
	//	COUNT(*)
	//
	// OVER (
	//
	//	...
	//
	// );
	// “`
	//
	// becomes:
	//
	// “`
	// AGGREGATE
	//
	//	COUNT_UP_TO(1) AS count_up_to_1,
	//	COUNT_UP_TO(2) AS field_1,
	//	COUNT_UP_TO(3) AS count_up_to_3,
	//	COUNT(*) AS field_2
	//
	// OVER (
	//
	//	...
	//
	// );
	// “`
	//
	// Requires:
	//
	// * Must be unique across all aggregation aliases.
	// * Conform to [document field name][google.firestore.v1.Document.fields]
	// limitations.
	Alias string `protobuf:"bytes,7,opt,name=alias,proto3" json:"alias,omitempty"`
	// contains filtered or unexported fields
}

Defines an aggregation that produces a single result.

func (*StructuredAggregationQuery_Aggregation) Descriptor deprecated 

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

Deprecated: Use StructuredAggregationQuery_Aggregation.ProtoReflect.Descriptor instead.

func (*StructuredAggregationQuery_Aggregation) GetAlias 

func (x *StructuredAggregationQuery_Aggregation) GetAlias() string

func (*StructuredAggregationQuery_Aggregation) GetAvg added in v1.12.0 

func (x *StructuredAggregationQuery_Aggregation) GetAvg() *StructuredAggregationQuery_Aggregation_Avg

func (*StructuredAggregationQuery_Aggregation) GetCount 

func (x *StructuredAggregationQuery_Aggregation) GetCount() *StructuredAggregationQuery_Aggregation_Count

func (*StructuredAggregationQuery_Aggregation) GetOperator 

func (m *StructuredAggregationQuery_Aggregation) GetOperator() isStructuredAggregationQuery_Aggregation_Operator

func (*StructuredAggregationQuery_Aggregation) GetSum added in v1.12.0 

func (x *StructuredAggregationQuery_Aggregation) GetSum() *StructuredAggregationQuery_Aggregation_Sum

func (*StructuredAggregationQuery_Aggregation) ProtoMessage 

func (*StructuredAggregationQuery_Aggregation) ProtoMessage()

func (*StructuredAggregationQuery_Aggregation) ProtoReflect 

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

func (*StructuredAggregationQuery_Aggregation) Reset 

func (x *StructuredAggregationQuery_Aggregation) Reset()

func (*StructuredAggregationQuery_Aggregation) String 

func (x *StructuredAggregationQuery_Aggregation) String() string

type StructuredAggregationQuery_Aggregation_Avg added in v1.12.0 

type StructuredAggregationQuery_Aggregation_Avg struct {

	// The field to aggregate on.
	Field *StructuredQuery_FieldReference `protobuf:"bytes,1,opt,name=field,proto3" json:"field,omitempty"`
	// contains filtered or unexported fields
}

Average of the values of the requested field.

* Only numeric values will be aggregated. All non-numeric values including `NULL` are skipped.

* If the aggregated values contain `NaN`, returns `NaN`. Infinity math follows IEEE-754 standards.

* If the aggregated value set is empty, returns `NULL`.

* Always returns the result as a double.

func (*StructuredAggregationQuery_Aggregation_Avg) Descriptor deprecated added in v1.12.0 

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

Deprecated: Use StructuredAggregationQuery_Aggregation_Avg.ProtoReflect.Descriptor instead.

func (*StructuredAggregationQuery_Aggregation_Avg) GetField added in v1.12.0 

func (x *StructuredAggregationQuery_Aggregation_Avg) GetField() *StructuredQuery_FieldReference

func (*StructuredAggregationQuery_Aggregation_Avg) ProtoMessage added in v1.12.0 

func (*StructuredAggregationQuery_Aggregation_Avg) ProtoMessage()

func (*StructuredAggregationQuery_Aggregation_Avg) ProtoReflect added in v1.12.0 

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

func (*StructuredAggregationQuery_Aggregation_Avg) Reset added in v1.12.0 

func (x *StructuredAggregationQuery_Aggregation_Avg) Reset()

func (*StructuredAggregationQuery_Aggregation_Avg) String added in v1.12.0 

func (x *StructuredAggregationQuery_Aggregation_Avg) String() string

type StructuredAggregationQuery_Aggregation_Avg_ added in v1.12.0 

type StructuredAggregationQuery_Aggregation_Avg_ struct {
	// Average aggregator.
	Avg *StructuredAggregationQuery_Aggregation_Avg `protobuf:"bytes,3,opt,name=avg,proto3,oneof"`
}

type StructuredAggregationQuery_Aggregation_Count 

type StructuredAggregationQuery_Aggregation_Count struct {

	// Optional. Optional constraint on the maximum number of documents to
	// count.
	//
	// This provides a way to set an upper bound on the number of documents
	// to scan, limiting latency, and cost.
	//
	// Unspecified is interpreted as no bound.
	//
	// High-Level Example:
	//
	// “`
	// AGGREGATE COUNT_UP_TO(1000) OVER ( SELECT * FROM k );
	// “`
	//
	// Requires:
	//
	// * Must be greater than zero when present.
	UpTo *wrapperspb.Int64Value `protobuf:"bytes,1,opt,name=up_to,json=upTo,proto3" json:"up_to,omitempty"`
	// contains filtered or unexported fields
}

Count of documents that match the query.

The `COUNT(*)` aggregation function operates on the entire document so it does not require a field reference.

func (*StructuredAggregationQuery_Aggregation_Count) Descriptor deprecated 

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

Deprecated: Use StructuredAggregationQuery_Aggregation_Count.ProtoReflect.Descriptor instead.

func (*StructuredAggregationQuery_Aggregation_Count) GetUpTo 

func (x *StructuredAggregationQuery_Aggregation_Count) GetUpTo() *wrapperspb.Int64Value

func (*StructuredAggregationQuery_Aggregation_Count) ProtoMessage 

func (*StructuredAggregationQuery_Aggregation_Count) ProtoMessage()

func (*StructuredAggregationQuery_Aggregation_Count) ProtoReflect 

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

func (*StructuredAggregationQuery_Aggregation_Count) Reset 

func (x *StructuredAggregationQuery_Aggregation_Count) Reset()

func (*StructuredAggregationQuery_Aggregation_Count) String 

func (x *StructuredAggregationQuery_Aggregation_Count) String() string

type StructuredAggregationQuery_Aggregation_Count_ 

type StructuredAggregationQuery_Aggregation_Count_ struct {
	// Count aggregator.
	Count *StructuredAggregationQuery_Aggregation_Count `protobuf:"bytes,1,opt,name=count,proto3,oneof"`
}

type StructuredAggregationQuery_Aggregation_Sum added in v1.12.0 

type StructuredAggregationQuery_Aggregation_Sum struct {

	// The field to aggregate on.
	Field *StructuredQuery_FieldReference `protobuf:"bytes,1,opt,name=field,proto3" json:"field,omitempty"`
	// contains filtered or unexported fields
}

Sum of the values of the requested field.

* Only numeric values will be aggregated. All non-numeric values including `NULL` are skipped.

* If the aggregated values contain `NaN`, returns `NaN`. Infinity math follows IEEE-754 standards.

* If the aggregated value set is empty, returns 0.

* Returns a 64-bit integer if all aggregated numbers are integers and the sum result does not overflow. Otherwise, the result is returned as a double. Note that even if all the aggregated values are integers, the result is returned as a double if it cannot fit within a 64-bit signed integer. When this occurs, the returned value will lose precision.

* When underflow occurs, floating-point aggregation is non-deterministic. This means that running the same query repeatedly without any changes to the underlying values could produce slightly different results each time. In those cases, values should be stored as integers over floating-point numbers.

func (*StructuredAggregationQuery_Aggregation_Sum) Descriptor deprecated added in v1.12.0 

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

Deprecated: Use StructuredAggregationQuery_Aggregation_Sum.ProtoReflect.Descriptor instead.

func (*StructuredAggregationQuery_Aggregation_Sum) GetField added in v1.12.0 

func (x *StructuredAggregationQuery_Aggregation_Sum) GetField() *StructuredQuery_FieldReference

func (*StructuredAggregationQuery_Aggregation_Sum) ProtoMessage added in v1.12.0 

func (*StructuredAggregationQuery_Aggregation_Sum) ProtoMessage()

func (*StructuredAggregationQuery_Aggregation_Sum) ProtoReflect added in v1.12.0 

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

func (*StructuredAggregationQuery_Aggregation_Sum) Reset added in v1.12.0 

func (x *StructuredAggregationQuery_Aggregation_Sum) Reset()

func (*StructuredAggregationQuery_Aggregation_Sum) String added in v1.12.0 

func (x *StructuredAggregationQuery_Aggregation_Sum) String() string

type StructuredAggregationQuery_Aggregation_Sum_ added in v1.12.0 

type StructuredAggregationQuery_Aggregation_Sum_ struct {
	// Sum aggregator.
	Sum *StructuredAggregationQuery_Aggregation_Sum `protobuf:"bytes,2,opt,name=sum,proto3,oneof"`
}

type StructuredAggregationQuery_StructuredQuery 

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

type StructuredQuery 

type StructuredQuery struct {

	// Optional sub-set of the fields to return.
	//
	// This acts as a [DocumentMask][google.firestore.v1.DocumentMask] over the
	// documents returned from a query. When not set, assumes that the caller
	// wants all fields returned.
	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 allows callers to provide a full ordering, a partial ordering, or
	// no ordering at all. In all cases, Firestore guarantees a stable ordering
	// through the following rules:
	//
	//   - The `order_by` is required to reference all fields used with an
	//     inequality filter.
	//   - All fields that are required to be in the `order_by` but are not already
	//     present are appended in lexicographical ordering of the field name.
	//   - 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:
	//
	//   - `ORDER BY a` becomes `ORDER BY a ASC, __name__ ASC`
	//   - `ORDER BY a DESC` becomes `ORDER BY a DESC, __name__ DESC`
	//   - `WHERE a > 1` becomes `WHERE a > 1 ORDER BY a ASC, __name__ ASC`
	//   - `WHERE __name__ > ... AND a > 1` becomes
	//     `WHERE __name__ > ... AND a > 1 ORDER BY a ASC, __name__ ASC`
	OrderBy []*StructuredQuery_Order `protobuf:"bytes,4,rep,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
	// A potential prefix of a position in the result set to start the query at.
	//
	// The ordering of the result set is based on the `ORDER BY` clause of the
	// original query.
	//
	// “`
	// SELECT * FROM k WHERE a = 1 AND b > 2 ORDER BY b ASC, __name__ ASC;
	// “`
	//
	// This query's results are ordered by `(b ASC, __name__ ASC)`.
	//
	// Cursors can reference either the full ordering or a prefix of the location,
	// though it cannot reference more fields than what are in the provided
	// `ORDER BY`.
	//
	// Continuing off the example above, attaching the following start cursors
	// will have varying impact:
	//
	//   - `START BEFORE (2, /k/123)`: start the query right before `a = 1 AND
	//     b > 2 AND __name__ > /k/123`.
	//   - `START AFTER (10)`: start the query right after `a = 1 AND b > 10`.
	//
	// Unlike `OFFSET` which requires scanning over the first N results to skip,
	// a start cursor allows the query to begin at a logical position. This
	// position is not required to match an actual result, it will scan forward
	// from this position to find the next document.
	//
	// Requires:
	//
	//   - The number of values cannot be greater than the number of fields
	//     specified in the `ORDER BY` clause.
	StartAt *Cursor `protobuf:"bytes,7,opt,name=start_at,json=startAt,proto3" json:"start_at,omitempty"`
	// A potential prefix of a position in the result set to end the query at.
	//
	// This is similar to `START_AT` but with it controlling the end position
	// rather than the start position.
	//
	// Requires:
	//
	//   - The number of values cannot be greater than the number of fields
	//     specified in the `ORDER BY` clause.
	EndAt *Cursor `protobuf:"bytes,8,opt,name=end_at,json=endAt,proto3" json:"end_at,omitempty"`
	// The number of documents to skip before returning the first result.
	//
	// This applies after the constraints specified by the `WHERE`, `START AT`, &
	// `END AT` but before the `LIMIT` clause.
	//
	// Requires:
	//
	// * The value must be greater than or equal to zero 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.
	//
	// Requires:
	//
	// * The value must be greater than or equal to zero if specified.
	Limit *wrapperspb.Int32Value `protobuf:"bytes,5,opt,name=limit,proto3" json:"limit,omitempty"`
	// Optional. A potential Nearest Neighbors Search.
	//
	// Applies after all other filters and ordering.
	//
	// Finds the closest vector embeddings to the given query vector.
	FindNearest *StructuredQuery_FindNearest `protobuf:"bytes,9,opt,name=find_nearest,json=findNearest,proto3" json:"find_nearest,omitempty"`
	// contains filtered or unexported fields
}

A Firestore query.

The query stages are executed in the following order: 1. from 2. where 3. select 4. order_by + start_at + end_at 5. offset 6. limit

func (*StructuredQuery) Descriptor deprecated 

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

Deprecated: Use StructuredQuery.ProtoReflect.Descriptor instead.

func (*StructuredQuery) GetEndAt 

func (x *StructuredQuery) GetEndAt() *Cursor

func (*StructuredQuery) GetFindNearest added in v1.16.0 

func (x *StructuredQuery) GetFindNearest() *StructuredQuery_FindNearest

func (*StructuredQuery) GetFrom 

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

func (*StructuredQuery) GetLimit 

func (x *StructuredQuery) GetLimit() *wrapperspb.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 deprecated 

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.
	//
	// Requires:
	//
	// * At least one filter is present.
	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 deprecated 

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
	// Documents are required to satisfy all of the combined filters.
	StructuredQuery_CompositeFilter_AND StructuredQuery_CompositeFilter_Operator = 1
	// Documents are required to satisfy at least one of the combined filters.
	StructuredQuery_CompositeFilter_OR StructuredQuery_CompositeFilter_Operator = 2
)

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 deprecated 

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 deprecated 

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 deprecated 

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 not equal to the given `value`.
	//
	// Requires:
	//
	// * No other `NOT_EQUAL`, `NOT_IN`, `IS_NOT_NULL`, or `IS_NOT_NAN`.
	// * That `field` comes first in the `order_by`.
	StructuredQuery_FieldFilter_NOT_EQUAL StructuredQuery_FieldFilter_Operator = 6
	// The given `field` is an array that contains the given `value`.
	StructuredQuery_FieldFilter_ARRAY_CONTAINS StructuredQuery_FieldFilter_Operator = 7
	// The given `field` is equal to at least one value in the given array.
	//
	// Requires:
	//
	//   - That `value` is a non-empty `ArrayValue`, subject to disjunction
	//     limits.
	//   - No `NOT_IN` filters in the same query.
	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`, subject to disjunction
	//     limits.
	//   - No other `ARRAY_CONTAINS_ANY` filters within the same disjunction.
	//   - No `NOT_IN` filters in the same query.
	StructuredQuery_FieldFilter_ARRAY_CONTAINS_ANY StructuredQuery_FieldFilter_Operator = 9
	// The value of the `field` is not in the given array.
	//
	// Requires:
	//
	//   - That `value` is a non-empty `ArrayValue` with at most 10 values.
	//   - No other `OR`, `IN`, `ARRAY_CONTAINS_ANY`, `NOT_IN`, `NOT_EQUAL`,
	//     `IS_NOT_NULL`, or `IS_NOT_NAN`.
	//   - That `field` comes first in the `order_by`.
	StructuredQuery_FieldFilter_NOT_IN StructuredQuery_FieldFilter_Operator = 10
)

func (StructuredQuery_FieldFilter_Operator) Descriptor 

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 deprecated 

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 {

	// A reference to a field in a document.
	//
	// Requires:
	//
	// * MUST be a dot-delimited (`.`) string of segments, where each segment
	// conforms to [document field name][google.firestore.v1.Document.fields]
	// limitations.
	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 in a document, ex: `stats.operations`.

func (*StructuredQuery_FieldReference) Descriptor deprecated 

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 deprecated 

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_FindNearest added in v1.16.0 

type StructuredQuery_FindNearest struct {

	// Required. An indexed vector field to search upon. Only documents which
	// contain vectors whose dimensionality match the query_vector can be
	// returned.
	VectorField *StructuredQuery_FieldReference `protobuf:"bytes,1,opt,name=vector_field,json=vectorField,proto3" json:"vector_field,omitempty"`
	// Required. The query vector that we are searching on. Must be a vector of
	// no more than 2048 dimensions.
	QueryVector *Value `protobuf:"bytes,2,opt,name=query_vector,json=queryVector,proto3" json:"query_vector,omitempty"`
	// Required. The Distance Measure to use, required.
	DistanceMeasure StructuredQuery_FindNearest_DistanceMeasure `` /* 176-byte string literal not displayed */
	// Required. The number of nearest neighbors to return. Must be a positive
	// integer of no more than 1000.
	Limit *wrapperspb.Int32Value `protobuf:"bytes,4,opt,name=limit,proto3" json:"limit,omitempty"`
	// contains filtered or unexported fields
}

Nearest Neighbors search config.

func (*StructuredQuery_FindNearest) Descriptor deprecated added in v1.16.0 

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

Deprecated: Use StructuredQuery_FindNearest.ProtoReflect.Descriptor instead.

func (*StructuredQuery_FindNearest) GetDistanceMeasure added in v1.16.0 

func (x *StructuredQuery_FindNearest) GetDistanceMeasure() StructuredQuery_FindNearest_DistanceMeasure

func (*StructuredQuery_FindNearest) GetLimit added in v1.16.0 

func (x *StructuredQuery_FindNearest) GetLimit() *wrapperspb.Int32Value

func (*StructuredQuery_FindNearest) GetQueryVector added in v1.16.0 

func (x *StructuredQuery_FindNearest) GetQueryVector() *Value

func (*StructuredQuery_FindNearest) GetVectorField added in v1.16.