firestore

package
v0.0.0-...-2824937 Latest Latest
Warning

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

 Go to latest Published: Nov 2, 2020 License: MIT, Apache-2.0 Imports: 12 Imported by: 0

Documentation

Overview

Package firestore is a generated protocol buffer package.

It is generated from these files: 

google/firestore/v1beta1/common.proto
google/firestore/v1beta1/document.proto
google/firestore/v1beta1/firestore.proto
google/firestore/v1beta1/query.proto
google/firestore/v1beta1/write.proto

It has these top-level messages: 

DocumentMask
Precondition
TransactionOptions
Document
Value
ArrayValue
MapValue
GetDocumentRequest
ListDocumentsRequest
ListDocumentsResponse
CreateDocumentRequest
UpdateDocumentRequest
DeleteDocumentRequest
BatchGetDocumentsRequest
BatchGetDocumentsResponse
BeginTransactionRequest
BeginTransactionResponse
CommitRequest
CommitResponse
RollbackRequest
RunQueryRequest
RunQueryResponse
WriteRequest
WriteResponse
ListenRequest
ListenResponse
Target
TargetChange
ListCollectionIdsRequest
ListCollectionIdsResponse
StructuredQuery
Cursor
Write
DocumentTransform
WriteResult
DocumentChange
DocumentDelete
DocumentRemove
ExistenceFilter

Index

Constants

This section is empty.

Variables

View Source 
var DocumentTransform_FieldTransform_ServerValue_name = map[int32]string{
	0: "SERVER_VALUE_UNSPECIFIED",
	1: "REQUEST_TIME",
}
View Source 
var DocumentTransform_FieldTransform_ServerValue_value = map[string]int32{
	"SERVER_VALUE_UNSPECIFIED": 0,
	"REQUEST_TIME":             1,
}
View Source 
var StructuredQuery_CompositeFilter_Operator_name = map[int32]string{
	0: "OPERATOR_UNSPECIFIED",
	1: "AND",
}
View Source 
var StructuredQuery_CompositeFilter_Operator_value = map[string]int32{
	"OPERATOR_UNSPECIFIED": 0,
	"AND":                  1,
}
View Source 
var StructuredQuery_Direction_name = map[int32]string{
	0: "DIRECTION_UNSPECIFIED",
	1: "ASCENDING",
	2: "DESCENDING",
}
View Source 
var StructuredQuery_Direction_value = map[string]int32{
	"DIRECTION_UNSPECIFIED": 0,
	"ASCENDING":             1,
	"DESCENDING":            2,
}
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",
}
View Source 
var 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,
}
View Source 
var StructuredQuery_UnaryFilter_Operator_name = map[int32]string{
	0: "OPERATOR_UNSPECIFIED",
	2: "IS_NAN",
	3: "IS_NULL",
}
View Source 
var StructuredQuery_UnaryFilter_Operator_value = map[string]int32{
	"OPERATOR_UNSPECIFIED": 0,
	"IS_NAN":               2,
	"IS_NULL":              3,
}
View Source 
var TargetChange_TargetChangeType_name = map[int32]string{
	0: "NO_CHANGE",
	1: "ADD",
	2: "REMOVE",
	3: "CURRENT",
	4: "RESET",
}
View Source 
var TargetChange_TargetChangeType_value = map[string]int32{
	"NO_CHANGE": 0,
	"ADD":       1,
	"REMOVE":    2,
	"CURRENT":   3,
	"RESET":     4,
}

Functions

func RegisterFirestoreServer 

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

Types

type ArrayValue 

type ArrayValue struct {
	// Values in the array.
	Values []*Value `protobuf:"bytes,1,rep,name=values" json:"values,omitempty"`
}

An array value.

func (*ArrayValue) Descriptor 

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

func (*ArrayValue) GetValues 

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

func (*ArrayValue) ProtoMessage 

func (*ArrayValue) ProtoMessage()

func (*ArrayValue) Reset 

func (m *ArrayValue) Reset()

func (*ArrayValue) String 

func (m *ArrayValue) String() string

type BatchGetDocumentsRequest 

type BatchGetDocumentsRequest struct {
	// The database name. In the format:
	// `projects/{project_id}/databases/{database_id}`.
	Database string `protobuf:"bytes,1,opt,name=database" 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" 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" json:"mask,omitempty"`
	// The consistency mode for this transaction.
	// If not set, defaults to strong consistency.
	//
	// Types that are valid to be assigned to ConsistencySelector:
	//	*BatchGetDocumentsRequest_Transaction
	//	*BatchGetDocumentsRequest_NewTransaction
	//	*BatchGetDocumentsRequest_ReadTime
	ConsistencySelector isBatchGetDocumentsRequest_ConsistencySelector `protobuf_oneof:"consistency_selector"`
}

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

func (*BatchGetDocumentsRequest) Descriptor 

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

func (*BatchGetDocumentsRequest) GetConsistencySelector 

func (m *BatchGetDocumentsRequest) GetConsistencySelector() isBatchGetDocumentsRequest_ConsistencySelector

func (*BatchGetDocumentsRequest) GetDatabase 

func (m *BatchGetDocumentsRequest) GetDatabase() string

func (*BatchGetDocumentsRequest) GetDocuments 

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

func (*BatchGetDocumentsRequest) GetMask 

func (m *BatchGetDocumentsRequest) GetMask() *DocumentMask

func (*BatchGetDocumentsRequest) GetNewTransaction 

func (m *BatchGetDocumentsRequest) GetNewTransaction() *TransactionOptions

func (*BatchGetDocumentsRequest) GetReadTime 

func (m *BatchGetDocumentsRequest) GetReadTime() *google_protobuf1.Timestamp

func (*BatchGetDocumentsRequest) GetTransaction 

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

func (*BatchGetDocumentsRequest) ProtoMessage 

func (*BatchGetDocumentsRequest) ProtoMessage()

func (*BatchGetDocumentsRequest) Reset 

func (m *BatchGetDocumentsRequest) Reset()

func (*BatchGetDocumentsRequest) String 

func (m *BatchGetDocumentsRequest) String() string

func (*BatchGetDocumentsRequest) XXX_OneofFuncs 

func (*BatchGetDocumentsRequest) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, func(msg proto.Message, tag, wire int, b *proto.Buffer) (bool, error), func(msg proto.Message) (n int), []interface{})

XXX_OneofFuncs is for the internal use of the proto package.

type BatchGetDocumentsRequest_NewTransaction 

type BatchGetDocumentsRequest_NewTransaction struct {
	NewTransaction *TransactionOptions `protobuf:"bytes,5,opt,name=new_transaction,json=newTransaction,oneof"`
}

type BatchGetDocumentsRequest_ReadTime 

type BatchGetDocumentsRequest_ReadTime struct {
	ReadTime *google_protobuf1.Timestamp `protobuf:"bytes,7,opt,name=read_time,json=readTime,oneof"`
}

type BatchGetDocumentsRequest_Transaction 

type BatchGetDocumentsRequest_Transaction struct {
	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 valid to be assigned to Result:
	//	*BatchGetDocumentsResponse_Found
	//	*BatchGetDocumentsResponse_Missing
	Result isBatchGetDocumentsResponse_Result `protobuf_oneof:"result"`
	// The transaction that was started as part of this request.
	// Will only be set in the first response, and only if
	// [BatchGetDocumentsRequest.new_transaction][google.firestore.v1beta1.BatchGetDocumentsRequest.new_transaction] was set in the request.
	Transaction []byte `protobuf:"bytes,3,opt,name=transaction,proto3" json:"transaction,omitempty"`
	// The time at which the document was read.
	// This may be monotically increasing, in this case the previous documents in
	// the result stream are guaranteed not to have changed between their
	// read_time and this one.
	ReadTime *google_protobuf1.Timestamp `protobuf:"bytes,4,opt,name=read_time,json=readTime" json:"read_time,omitempty"`
}

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

func (*BatchGetDocumentsResponse) Descriptor 

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

func (*BatchGetDocumentsResponse) GetFound 

func (m *BatchGetDocumentsResponse) GetFound() *Document

func (*BatchGetDocumentsResponse) GetMissing 

func (m *BatchGetDocumentsResponse) GetMissing() string

func (*BatchGetDocumentsResponse) GetReadTime 

func (m *BatchGetDocumentsResponse) GetReadTime() *google_protobuf1.Timestamp

func (*BatchGetDocumentsResponse) GetResult 

func (m *BatchGetDocumentsResponse) GetResult() isBatchGetDocumentsResponse_Result

func (*BatchGetDocumentsResponse) GetTransaction 

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

func (*BatchGetDocumentsResponse) ProtoMessage 

func (*BatchGetDocumentsResponse) ProtoMessage()

func (*BatchGetDocumentsResponse) Reset 

func (m *BatchGetDocumentsResponse) Reset()

func (*BatchGetDocumentsResponse) String 

func (m *BatchGetDocumentsResponse) String() string

func (*BatchGetDocumentsResponse) XXX_OneofFuncs 

func (*BatchGetDocumentsResponse) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, func(msg proto.Message, tag, wire int, b *proto.Buffer) (bool, error), func(msg proto.Message) (n int), []interface{})

XXX_OneofFuncs is for the internal use of the proto package.

type BatchGetDocumentsResponse_Found 

type BatchGetDocumentsResponse_Found struct {
	Found *Document `protobuf:"bytes,1,opt,name=found,oneof"`
}

type BatchGetDocumentsResponse_Missing 

type BatchGetDocumentsResponse_Missing struct {
	Missing string `protobuf:"bytes,2,opt,name=missing,oneof"`
}

type BeginTransactionRequest 

type BeginTransactionRequest struct {
	// The database name. In the format:
	// `projects/{project_id}/databases/{database_id}`.
	Database string `protobuf:"bytes,1,opt,name=database" json:"database,omitempty"`
	// The options for the transaction.
	// Defaults to a read-write transaction.
	Options *TransactionOptions `protobuf:"bytes,2,opt,name=options" json:"options,omitempty"`
}

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

func (*BeginTransactionRequest) Descriptor 

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

func (*BeginTransactionRequest) GetDatabase 

func (m *BeginTransactionRequest) GetDatabase() string

func (*BeginTransactionRequest) GetOptions 

func (m *BeginTransactionRequest) GetOptions() *TransactionOptions

func (*BeginTransactionRequest) ProtoMessage 

func (*BeginTransactionRequest) ProtoMessage()

func (*BeginTransactionRequest) Reset 

func (m *BeginTransactionRequest) Reset()

func (*BeginTransactionRequest) String 

func (m *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"`
}

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

func (*BeginTransactionResponse) Descriptor 

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

func (*BeginTransactionResponse) GetTransaction 

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

func (*BeginTransactionResponse) ProtoMessage 

func (*BeginTransactionResponse) ProtoMessage()

func (*BeginTransactionResponse) Reset 

func (m *BeginTransactionResponse) Reset()

func (*BeginTransactionResponse) String 

func (m *BeginTransactionResponse) String() string

type CommitRequest 

type CommitRequest struct {
	// The database name. In the format:
	// `projects/{project_id}/databases/{database_id}`.
	Database string `protobuf:"bytes,1,opt,name=database" json:"database,omitempty"`
	// The writes to apply.
	//
	// Always executed atomically and in order.
	Writes []*Write `protobuf:"bytes,2,rep,name=writes" 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"`
}

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

func (*CommitRequest) Descriptor 

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

func (*CommitRequest) GetDatabase 

func (m *CommitRequest) GetDatabase() string

func (*CommitRequest) GetTransaction 

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

func (*CommitRequest) GetWrites 

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

func (*CommitRequest) ProtoMessage 

func (*CommitRequest) ProtoMessage()

func (*CommitRequest) Reset 

func (m *CommitRequest) Reset()

func (*CommitRequest) String 

func (m *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" json:"write_results,omitempty"`
	// The time at which the commit occurred.
	CommitTime *google_protobuf1.Timestamp `protobuf:"bytes,2,opt,name=commit_time,json=commitTime" json:"commit_time,omitempty"`
}

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

func (*CommitResponse) Descriptor 

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

func (*CommitResponse) GetCommitTime 

func (m *CommitResponse) GetCommitTime() *google_protobuf1.Timestamp

func (*CommitResponse) GetWriteResults 

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

func (*CommitResponse) ProtoMessage 

func (*CommitResponse) ProtoMessage()

func (*CommitResponse) Reset 

func (m *CommitResponse) Reset()

func (*CommitResponse) String 

func (m *CommitResponse) String() string

type CreateDocumentRequest 

type CreateDocumentRequest struct {
	// 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" json:"parent,omitempty"`
	// The collection ID, relative to `parent`, to list. For example: `chatrooms`.
	CollectionId string `protobuf:"bytes,2,opt,name=collection_id,json=collectionId" 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" json:"document_id,omitempty"`
	// The document to create. `name` must not be set.
	Document *Document `protobuf:"bytes,4,opt,name=document" 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" json:"mask,omitempty"`
}

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

func (*CreateDocumentRequest) Descriptor 

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

func (*CreateDocumentRequest) GetCollectionId 

func (m *CreateDocumentRequest) GetCollectionId() string

func (*CreateDocumentRequest) GetDocument 

func (m *CreateDocumentRequest) GetDocument() *Document

func (*CreateDocumentRequest) GetDocumentId 

func (m *CreateDocumentRequest) GetDocumentId() string

func (*CreateDocumentRequest) GetMask 

func (m *CreateDocumentRequest) GetMask() *DocumentMask

func (*CreateDocumentRequest) GetParent 

func (m *CreateDocumentRequest) GetParent() string

func (*CreateDocumentRequest) ProtoMessage 

func (*CreateDocumentRequest) ProtoMessage()

func (*CreateDocumentRequest) Reset 

func (m *CreateDocumentRequest) Reset()

func (*CreateDocumentRequest) String 

func (m *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" 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" json:"before,omitempty"`
}

A position in a query result set.

func (*Cursor) Descriptor 

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

func (*Cursor) GetBefore 

func (m *Cursor) GetBefore() bool

func (*Cursor) GetValues 

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

func (*Cursor) ProtoMessage 

func (*Cursor) ProtoMessage()

func (*Cursor) Reset 

func (m *Cursor) Reset()

func (*Cursor) String 

func (m *Cursor) String() string

type DeleteDocumentRequest 

type DeleteDocumentRequest struct {
	// 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" 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" json:"current_document,omitempty"`
}

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

func (*DeleteDocumentRequest) Descriptor 

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

func (*DeleteDocumentRequest) GetCurrentDocument 

func (m *DeleteDocumentRequest) GetCurrentDocument() *Precondition

func (*DeleteDocumentRequest) GetName 

func (m *DeleteDocumentRequest) GetName() string

func (*DeleteDocumentRequest) ProtoMessage 

func (*DeleteDocumentRequest) ProtoMessage()

func (*DeleteDocumentRequest) Reset 

func (m *DeleteDocumentRequest) Reset()

func (*DeleteDocumentRequest) String 

func (m *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" json:"name,omitempty"`
	// The document's fields.
	//
	// The map keys represent field names.
	//
	// A simple field name contains only characters `a` to `z`, `A` to `Z`,
	// `0` to `9`, or `_`, and must not start with `0` to `9` or `_`. For example,
	// `foo_bar_17`.
	//
	// Field names matching the regular expression `__.*__` are reserved. Reserved
	// field names are forbidden except in certain documented contexts. The map
	// keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be
	// empty.
	//
	// Field paths may be used in other contexts to refer to structured fields
	// defined here. For `map_value`, the field path is represented by the simple
	// or quoted field names of the containing fields, delimited by `.`. For
	// example, the structured field
	// `"foo" : { map_value: { "x&y" : { string_value: "hello" }}}` would be
	// represented by the field path `foo.x&y`.
	//
	// Within a field path, a quoted field name starts and ends with “ ` “ and
	// may contain any character. Some characters, including “ ` “, must be
	// escaped using a `\`. For example, “ `x&y` “ represents `x&y` and
	// “ `bak\`tik` “ represents “ bak`tik “.
	Fields map[string]*Value `` /* 132-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 *google_protobuf1.Timestamp `protobuf:"bytes,3,opt,name=create_time,json=createTime" json:"create_time,omitempty"`
	// Output only. The time at which the document was last changed.
	//
	// This value is initally 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 *google_protobuf1.Timestamp `protobuf:"bytes,4,opt,name=update_time,json=updateTime" json:"update_time,omitempty"`
}

A Firestore document.

Must not exceed 1 MiB - 4 bytes.

func (*Document) Descriptor 

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

func (*Document) GetCreateTime 

func (m *Document) GetCreateTime() *google_protobuf1.Timestamp

func (*Document) GetFields 

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

func (*Document) GetName 

func (m *Document) GetName() string

func (*Document) GetUpdateTime 

func (m *Document) GetUpdateTime() *google_protobuf1.Timestamp

func (*Document) ProtoMessage 

func (*Document) ProtoMessage()

func (*Document) Reset 

func (m *Document) Reset()

func (*Document) String 

func (m *Document) String() string

type DocumentChange 

type DocumentChange struct {
	// The new state of the [Document][google.firestore.v1beta1.Document].
	//
	// If `mask` is set, contains only fields that were updated or added.
	Document *Document `protobuf:"bytes,1,opt,name=document" 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" 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" json:"removed_target_ids,omitempty"`
}

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

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

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

func (*DocumentChange) Descriptor 

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

func (*DocumentChange) GetDocument 

func (m *DocumentChange) GetDocument() *Document

func (*DocumentChange) GetRemovedTargetIds 

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

func (*DocumentChange) GetTargetIds 

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

func (*DocumentChange) ProtoMessage 

func (*DocumentChange) ProtoMessage()

func (*DocumentChange) Reset 

func (m *DocumentChange) Reset()

func (*DocumentChange) String 

func (m *DocumentChange) String() string

type DocumentDelete 

type DocumentDelete struct {
	// The resource name of the [Document][google.firestore.v1beta1.Document] that was deleted.
	Document string `protobuf:"bytes,1,opt,name=document" 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" 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 *google_protobuf1.Timestamp `protobuf:"bytes,4,opt,name=read_time,json=readTime" json:"read_time,omitempty"`
}

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

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

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

func (*DocumentDelete) Descriptor 

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

func (*DocumentDelete) GetDocument 

func (m *DocumentDelete) GetDocument() string

func (*DocumentDelete) GetReadTime 

func (m *DocumentDelete) GetReadTime() *google_protobuf1.Timestamp

func (*DocumentDelete) GetRemovedTargetIds 

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

func (*DocumentDelete) ProtoMessage 

func (*DocumentDelete) ProtoMessage()

func (*DocumentDelete) Reset 

func (m *DocumentDelete) Reset()

func (*DocumentDelete) String 

func (m *DocumentDelete) String() string

type DocumentMask 

type DocumentMask struct {
	// The list of field paths in the mask. See [Document.fields][google.firestore.v1beta1.Document.fields] for a field
	// path syntax reference.
	FieldPaths []string `protobuf:"bytes,1,rep,name=field_paths,json=fieldPaths" json:"field_paths,omitempty"`
}

A set of field paths on a document. Used to restrict a get or update operation on a document to a subset of its fields. This is different from standard field masks, as this is always scoped to a Document[google.firestore.v1beta1.Document], and takes in account the dynamic nature of Value[google.firestore.v1beta1.Value].

func (*DocumentMask) Descriptor 

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

func (*DocumentMask) GetFieldPaths 

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

func (*DocumentMask) ProtoMessage 

func (*DocumentMask) ProtoMessage()

func (*DocumentMask) Reset 

func (m *DocumentMask) Reset()

func (*DocumentMask) String 

func (m *DocumentMask) String() string

type DocumentRemove 

type DocumentRemove struct {
	// The resource name of the [Document][google.firestore.v1beta1.Document] that has gone out of view.
	Document string `protobuf:"bytes,1,opt,name=document" 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" 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 *google_protobuf1.Timestamp `protobuf:"bytes,4,opt,name=read_time,json=readTime" json:"read_time,omitempty"`
}

A Document[google.firestore.v1beta1.Document] has been removed from the view of the targets.

Sent if the document is no longer relevant to a target and is out of view. Can be sent instead of a DocumentDelete or a DocumentChange if the server can not send the new value of the document.

Multiple DocumentRemove[google.firestore.v1beta1.DocumentRemove] messages may be returned for the same logical write or delete, if multiple targets are affected.

func (*DocumentRemove) Descriptor 

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

func (*DocumentRemove) GetDocument 

func (m *DocumentRemove) GetDocument() string

func (*DocumentRemove) GetReadTime 

func (m *DocumentRemove) GetReadTime() *google_protobuf1.Timestamp

func (*DocumentRemove) GetRemovedTargetIds 

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

func (*DocumentRemove) ProtoMessage 

func (*DocumentRemove) ProtoMessage()

func (*DocumentRemove) Reset 

func (m *DocumentRemove) Reset()

func (*DocumentRemove) String 

func (m *DocumentRemove) String() string

type DocumentTransform 

type DocumentTransform struct {
	// The name of the document to transform.
	Document string `protobuf:"bytes,1,opt,name=document" 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" json:"field_transforms,omitempty"`
}

A transformation of a document.

func (*DocumentTransform) Descriptor 

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

func (*DocumentTransform) GetDocument 

func (m *DocumentTransform) GetDocument() string

func (*DocumentTransform) GetFieldTransforms 

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

func (*DocumentTransform) ProtoMessage 

func (*DocumentTransform) ProtoMessage()

func (*DocumentTransform) Reset 

func (m *DocumentTransform) Reset()

func (*DocumentTransform) String 

func (m *DocumentTransform) String() string

type DocumentTransform_FieldTransform 

type DocumentTransform_FieldTransform struct {
	// The path of the field. See [Document.fields][google.firestore.v1beta1.Document.fields] for the field path syntax
	// reference.
	FieldPath string `protobuf:"bytes,1,opt,name=field_path,json=fieldPath" json:"field_path,omitempty"`
	// The transformation to apply on the field.
	//
	// Types that are valid to be assigned to TransformType:
	//	*DocumentTransform_FieldTransform_SetToServerValue
	TransformType isDocumentTransform_FieldTransform_TransformType `protobuf_oneof:"transform_type"`
}

A transformation of a field of the document.

func (*DocumentTransform_FieldTransform) Descriptor 

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

func (*DocumentTransform_FieldTransform) GetFieldPath 

func (m *DocumentTransform_FieldTransform) GetFieldPath() string

func (*DocumentTransform_FieldTransform) GetSetToServerValue 

func (m *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) Reset 

func (m *DocumentTransform_FieldTransform) Reset()

func (*DocumentTransform_FieldTransform) String 

func (m *DocumentTransform_FieldTransform) String() string

func (*DocumentTransform_FieldTransform) XXX_OneofFuncs 

func (*DocumentTransform_FieldTransform) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, func(msg proto.Message, tag, wire int, b *proto.Buffer) (bool, error), func(msg proto.Message) (n int), []interface{})

XXX_OneofFuncs is for the internal use of the proto package.

type DocumentTransform_FieldTransform_ServerValue 

type DocumentTransform_FieldTransform_ServerValue int32

A value that is calculated by the server. 

const (
	// Unspecified. This value must not be used.
	DocumentTransform_FieldTransform_SERVER_VALUE_UNSPECIFIED DocumentTransform_FieldTransform_ServerValue = 0
	// The time at which the server processed the request, with millisecond
	// precision.
	DocumentTransform_FieldTransform_REQUEST_TIME DocumentTransform_FieldTransform_ServerValue = 1
)

func (DocumentTransform_FieldTransform_ServerValue) EnumDescriptor 

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

func (DocumentTransform_FieldTransform_ServerValue) String 

func (x DocumentTransform_FieldTransform_ServerValue) String() string

type DocumentTransform_FieldTransform_SetToServerValue 

type DocumentTransform_FieldTransform_SetToServerValue struct {
	SetToServerValue DocumentTransform_FieldTransform_ServerValue `` /* 151-byte string literal not displayed */
}

type ExistenceFilter 

type ExistenceFilter struct {
	// The target ID to which this filter applies.
	TargetId int32 `protobuf:"varint,1,opt,name=target_id,json=targetId" json:"target_id,omitempty"`
	// The total count of documents that match [target_id][google.firestore.v1beta1.ExistenceFilter.target_id].
	//
	// If different from the count of documents in the client that match, the
	// client must manually determine which documents no longer match the target.
	Count int32 `protobuf:"varint,2,opt,name=count" json:"count,omitempty"`
}

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

func (*ExistenceFilter) Descriptor 

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

func (*ExistenceFilter) GetCount 

func (m *ExistenceFilter) GetCount() int32

func (*ExistenceFilter) GetTargetId 

func (m *ExistenceFilter) GetTargetId() int32

func (*ExistenceFilter) ProtoMessage 

func (*ExistenceFilter) ProtoMessage()

func (*ExistenceFilter) Reset 

func (m *ExistenceFilter) Reset()

func (*ExistenceFilter) String 

func (m *ExistenceFilter) String() string

type FirestoreClient 

type FirestoreClient interface {
	// Gets a single document.
	GetDocument(ctx context.Context, in *GetDocumentRequest, opts ...grpc.CallOption) (*Document, error)
	// Lists documents.
	ListDocuments(ctx context.Context, in *ListDocumentsRequest, opts ...grpc.CallOption) (*ListDocumentsResponse, error)
	// Creates a new document.
	CreateDocument(ctx context.Context, in *CreateDocumentRequest, opts ...grpc.CallOption) (*Document, 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) (*google_protobuf4.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) (*google_protobuf4.Empty, error)
	// Runs a query.
	RunQuery(ctx context.Context, in *RunQueryRequest, opts ...grpc.CallOption) (Firestore_RunQueryClient, error)
	// Streams batches of document updates and deletes, in order.
	Write(ctx context.Context, opts ...grpc.CallOption) (Firestore_WriteClient, error)
	// Listens to changes.
	Listen(ctx context.Context, opts ...grpc.CallOption) (Firestore_ListenClient, error)
	// Lists all the collection IDs underneath a document.
	ListCollectionIds(ctx context.Context, in *ListCollectionIdsRequest, opts ...grpc.CallOption) (*ListCollectionIdsResponse, error)
}

func NewFirestoreClient 

func NewFirestoreClient(cc *grpc.ClientConn) FirestoreClient

type FirestoreServer 

type FirestoreServer interface {
	// Gets a single document.
	GetDocument(context.Context, *GetDocumentRequest) (*Document, error)
	// Lists documents.
	ListDocuments(context.Context, *ListDocumentsRequest) (*ListDocumentsResponse, error)
	// Creates a new document.
	CreateDocument(context.Context, *CreateDocumentRequest) (*Document, error)
	// Updates or inserts a document.
	UpdateDocument(context.Context, *UpdateDocumentRequest) (*Document, error)
	// Deletes a document.
	DeleteDocument(context.Context, *DeleteDocumentRequest) (*google_protobuf4.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) (*google_protobuf4.Empty, error)
	// Runs a query.
	RunQuery(*RunQueryRequest, Firestore_RunQueryServer) error
	// Streams batches of document updates and deletes, in order.
	Write(Firestore_WriteServer) error
	// Listens to changes.
	Listen(Firestore_ListenServer) error
	// Lists all the collection IDs underneath a document.
	ListCollectionIds(context.Context, *ListCollectionIdsRequest) (*ListCollectionIdsResponse, error)
}

type Firestore_BatchGetDocumentsClient 

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

type Firestore_BatchGetDocumentsServer 

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

type Firestore_ListenClient 

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

type Firestore_ListenServer 

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

type Firestore_RunQueryClient 

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

type Firestore_RunQueryServer 

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

type Firestore_WriteClient 

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

type Firestore_WriteServer 

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

type GetDocumentRequest 

type GetDocumentRequest struct {
	// 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" 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" json:"mask,omitempty"`
	// The consistency mode for this transaction.
	// If not set, defaults to strong consistency.
	//
	// Types that are valid to be assigned to ConsistencySelector:
	//	*GetDocumentRequest_Transaction
	//	*GetDocumentRequest_ReadTime
	ConsistencySelector isGetDocumentRequest_ConsistencySelector `protobuf_oneof:"consistency_selector"`
}

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

func (*GetDocumentRequest) Descriptor 

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

func (*GetDocumentRequest) GetConsistencySelector 

func (m *GetDocumentRequest) GetConsistencySelector() isGetDocumentRequest_ConsistencySelector

func (*GetDocumentRequest) GetMask 

func (m *GetDocumentRequest) GetMask() *DocumentMask

func (*GetDocumentRequest) GetName 

func (m *GetDocumentRequest) GetName() string

func (*GetDocumentRequest) GetReadTime 

func (m *GetDocumentRequest) GetReadTime() *google_protobuf1.Timestamp

func (*GetDocumentRequest) GetTransaction 

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

func (*GetDocumentRequest) ProtoMessage 

func (*GetDocumentRequest) ProtoMessage()

func (*GetDocumentRequest) Reset 

func (m *GetDocumentRequest) Reset()

func (*GetDocumentRequest) String 

func (m *GetDocumentRequest) String() string

func (*GetDocumentRequest) XXX_OneofFuncs 

func (*GetDocumentRequest) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, func(msg proto.Message, tag, wire int, b *proto.Buffer) (bool, error), func(msg proto.Message) (n int), []interface{})

XXX_OneofFuncs is for the internal use of the proto package.

type GetDocumentRequest_ReadTime 

type GetDocumentRequest_ReadTime struct {
	ReadTime *google_protobuf1.Timestamp `protobuf:"bytes,5,opt,name=read_time,json=readTime,oneof"`
}

type GetDocumentRequest_Transaction 

type GetDocumentRequest_Transaction struct {
	Transaction []byte `protobuf:"bytes,3,opt,name=transaction,proto3,oneof"`
}

type ListCollectionIdsRequest 

type ListCollectionIdsRequest struct {
	// 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" json:"parent,omitempty"`
	// The maximum number of results to return.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize" json:"page_size,omitempty"`
	// A page token. Must be a value from
	// [ListCollectionIdsResponse][google.firestore.v1beta1.ListCollectionIdsResponse].
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken" json:"page_token,omitempty"`
}

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

func (*ListCollectionIdsRequest) Descriptor 

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

func (*ListCollectionIdsRequest) GetPageSize 

func (m *ListCollectionIdsRequest) GetPageSize() int32

func (*ListCollectionIdsRequest) GetPageToken 

func (m *ListCollectionIdsRequest) GetPageToken() string

func (*ListCollectionIdsRequest) GetParent 

func (m *ListCollectionIdsRequest) GetParent() string

func (*ListCollectionIdsRequest) ProtoMessage 

func (*ListCollectionIdsRequest) ProtoMessage()

func (*ListCollectionIdsRequest) Reset 

func (m *ListCollectionIdsRequest) Reset()

func (*ListCollectionIdsRequest) String 

func (m *ListCollectionIdsRequest) String() string

type ListCollectionIdsResponse 

type ListCollectionIdsResponse struct {
	// The collection ids.
	CollectionIds []string `protobuf:"bytes,1,rep,name=collection_ids,json=collectionIds" 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" json:"next_page_token,omitempty"`
}

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

func (*ListCollectionIdsResponse) Descriptor 

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

func (*ListCollectionIdsResponse) GetCollectionIds 

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

func (*ListCollectionIdsResponse) GetNextPageToken 

func (m *ListCollectionIdsResponse) GetNextPageToken() string

func (*ListCollectionIdsResponse) ProtoMessage 

func (*ListCollectionIdsResponse) ProtoMessage()

func (*ListCollectionIdsResponse) Reset 

func (m *ListCollectionIdsResponse) Reset()

func (*ListCollectionIdsResponse) String 

func (m *ListCollectionIdsResponse) String() string

type ListDocumentsRequest 

type ListDocumentsRequest struct {
	// The parent resource name. In the format:
	// `projects/{project_id}/databases/{database_id}/documents` or
	// `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
	// For example:
	// `projects/my-project/databases/my-database/documents` or
	// `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`
	Parent string `protobuf:"bytes,1,opt,name=parent" json:"parent,omitempty"`
	// The collection ID, relative to `parent`, to list. For example: `chatrooms`
	// or `messages`.
	CollectionId string `protobuf:"bytes,2,opt,name=collection_id,json=collectionId" json:"collection_id,omitempty"`
	// The maximum number of documents to return.
	PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize" json:"page_size,omitempty"`
	// The `next_page_token` value returned from a previous List request, if any.
	PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken" json:"page_token,omitempty"`
	// The order to sort results by. For example: `priority desc, name`.
	OrderBy string `protobuf:"bytes,6,opt,name=order_by,json=orderBy" json:"order_by,omitempty"`
	// The fields to return. If not set, returns all fields.
	//
	// If a document has a field that is not present in this mask, that field
	// will not be returned in the response.
	Mask *DocumentMask `protobuf:"bytes,7,opt,name=mask" json:"mask,omitempty"`
	// The consistency mode for this transaction.
	// If not set, defaults to strong consistency.
	//
	// Types that are valid to be assigned to ConsistencySelector:
	//	*ListDocumentsRequest_Transaction
	//	*ListDocumentsRequest_ReadTime
	ConsistencySelector isListDocumentsRequest_ConsistencySelector `protobuf_oneof:"consistency_selector"`
	// If the list should show missing documents. A missing document is a
	// document that does not exist but has sub-documents. These documents will
	// be returned with a key but will not have fields, [Document.create_time][google.firestore.v1beta1.Document.create_time],
	// or [Document.update_time][google.firestore.v1beta1.Document.update_time] set.
	//
	// Requests with `show_missing` may not specify `where` or
	// `order_by`.
	ShowMissing bool `protobuf:"varint,12,opt,name=show_missing,json=showMissing" json:"show_missing,omitempty"`
}

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

func (*ListDocumentsRequest) Descriptor 

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

func (*ListDocumentsRequest) GetCollectionId 

func (m *ListDocumentsRequest) GetCollectionId() string

func (*ListDocumentsRequest) GetConsistencySelector 

func (m *ListDocumentsRequest) GetConsistencySelector() isListDocumentsRequest_ConsistencySelector

func (*ListDocumentsRequest) GetMask 

func (m *ListDocumentsRequest) GetMask() *DocumentMask

func (*ListDocumentsRequest) GetOrderBy 

func (m *ListDocumentsRequest) GetOrderBy() string

func (*ListDocumentsRequest) GetPageSize 

func (m *ListDocumentsRequest) GetPageSize() int32

func (*ListDocumentsRequest) GetPageToken 

func (m *ListDocumentsRequest) GetPageToken() string

func (*ListDocumentsRequest) GetParent 

func (m *ListDocumentsRequest) GetParent() string

func (*ListDocumentsRequest) GetReadTime 

func (m *ListDocumentsRequest) GetReadTime() *google_protobuf1.Timestamp

func (*ListDocumentsRequest) GetShowMissing 

func (m *ListDocumentsRequest) GetShowMissing() bool

func (*ListDocumentsRequest) GetTransaction 

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

func (*ListDocumentsRequest) ProtoMessage 

func (*ListDocumentsRequest) ProtoMessage()

func (*ListDocumentsRequest) Reset 

func (m *ListDocumentsRequest) Reset()

func (*ListDocumentsRequest) String 

func (m *ListDocumentsRequest) String() string

func (*ListDocumentsRequest) XXX_OneofFuncs 

func (*ListDocumentsRequest) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, func(msg proto.Message, tag, wire int, b *proto.Buffer) (bool, error), func(msg proto.Message) (n int), []interface{})

XXX_OneofFuncs is for the internal use of the proto package.

type ListDocumentsRequest_ReadTime 

type ListDocumentsRequest_ReadTime struct {
	ReadTime *google_protobuf1.Timestamp `protobuf:"bytes,10,opt,name=read_time,json=readTime,oneof"`
}

type ListDocumentsRequest_Transaction 

type ListDocumentsRequest_Transaction struct {
	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" json:"documents,omitempty"`
	// The next page token.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken" json:"next_page_token,omitempty"`
}

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

func (*ListDocumentsResponse) Descriptor 

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

func (*ListDocumentsResponse) GetDocuments 

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

func (*ListDocumentsResponse) GetNextPageToken 

func (m *ListDocumentsResponse) GetNextPageToken() string

func (*ListDocumentsResponse) ProtoMessage 

func (*ListDocumentsResponse) ProtoMessage()

func (*ListDocumentsResponse) Reset 

func (m *ListDocumentsResponse) Reset()

func (*ListDocumentsResponse) String 

func (m *ListDocumentsResponse) String() string

type ListenRequest 

type ListenRequest struct {
	// The database name. In the format:
	// `projects/{project_id}/databases/{database_id}`.
	Database string `protobuf:"bytes,1,opt,name=database" json:"database,omitempty"`
	// The supported target changes.
	//
	// Types that are valid to be assigned to TargetChange:
	//	*ListenRequest_AddTarget
	//	*ListenRequest_RemoveTarget
	TargetChange isListenRequest_TargetChange `protobuf_oneof:"target_change"`
	// Labels associated with this target change.
	Labels map[string]string `` /* 132-byte string literal not displayed */
}

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

func (*ListenRequest) Descriptor 

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

func (*ListenRequest) GetAddTarget 

func (m *ListenRequest) GetAddTarget() *Target

func (*ListenRequest) GetDatabase 

func (m *ListenRequest) GetDatabase() string

func (*ListenRequest) GetLabels 

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

func (*ListenRequest) GetRemoveTarget 

func (m *ListenRequest) GetRemoveTarget() int32

func (*ListenRequest) GetTargetChange 

func (m *ListenRequest) GetTargetChange() isListenRequest_TargetChange

func (*ListenRequest) ProtoMessage 

func (*ListenRequest) ProtoMessage()

func (*ListenRequest) Reset 

func (m *ListenRequest) Reset()

func (*ListenRequest) String 

func (m *ListenRequest) String() string

func (*ListenRequest) XXX_OneofFuncs 

func (*ListenRequest) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, func(msg proto.Message, tag, wire int, b *proto.Buffer) (bool, error), func(msg proto.Message) (n int), []interface{})

XXX_OneofFuncs is for the internal use of the proto package.

type ListenRequest_AddTarget 

type ListenRequest_AddTarget struct {
	AddTarget *Target `protobuf:"bytes,2,opt,name=add_target,json=addTarget,oneof"`
}

type ListenRequest_RemoveTarget 

type ListenRequest_RemoveTarget struct {
	RemoveTarget int32 `protobuf:"varint,3,opt,name=remove_target,json=removeTarget,oneof"`
}

type ListenResponse 

type ListenResponse struct {
	// The supported responses.
	//
	// Types that are valid to be assigned to ResponseType:
	//	*ListenResponse_TargetChange
	//	*ListenResponse_DocumentChange
	//	*ListenResponse_DocumentDelete
	//	*ListenResponse_DocumentRemove
	//	*ListenResponse_Filter
	ResponseType isListenResponse_ResponseType `protobuf_oneof:"response_type"`
}

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

func (*ListenResponse) Descriptor 

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

func (*ListenResponse) GetDocumentChange 

func (m *ListenResponse) GetDocumentChange() *DocumentChange

func (*ListenResponse) GetDocumentDelete 

func (m *ListenResponse) GetDocumentDelete() *DocumentDelete

func (*ListenResponse) GetDocumentRemove 

func (m *ListenResponse) GetDocumentRemove() *DocumentRemove

func (*ListenResponse) GetFilter 

func (m *ListenResponse) GetFilter() *ExistenceFilter

func (*ListenResponse) GetResponseType 

func (m *ListenResponse) GetResponseType() isListenResponse_ResponseType

func (*ListenResponse) GetTargetChange 

func (m *ListenResponse) GetTargetChange() *TargetChange

func (*ListenResponse) ProtoMessage 

func (*ListenResponse) ProtoMessage()

func (*ListenResponse) Reset 

func (m *ListenResponse) Reset()

func (*ListenResponse) String 

func (m *ListenResponse) String() string

func (*ListenResponse) XXX_OneofFuncs 

func (*ListenResponse) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, func(msg proto.Message, tag, wire int, b *proto.Buffer) (bool, error), func(msg proto.Message) (n int), []interface{})

XXX_OneofFuncs is for the internal use of the proto package.

type ListenResponse_DocumentChange 

type ListenResponse_DocumentChange struct {
	DocumentChange *DocumentChange `protobuf:"bytes,3,opt,name=document_change,json=documentChange,oneof"`
}

type ListenResponse_DocumentDelete 

type ListenResponse_DocumentDelete struct {
	DocumentDelete *DocumentDelete `protobuf:"bytes,4,opt,name=document_delete,json=documentDelete,oneof"`
}

type ListenResponse_DocumentRemove 

type ListenResponse_DocumentRemove struct {
	DocumentRemove *DocumentRemove `protobuf:"bytes,6,opt,name=document_remove,json=documentRemove,oneof"`
}

type ListenResponse_Filter 

type ListenResponse_Filter struct {
	Filter *ExistenceFilter `protobuf:"bytes,5,opt,name=filter,oneof"`
}

type ListenResponse_TargetChange 

type ListenResponse_TargetChange struct {
	TargetChange *TargetChange `protobuf:"bytes,2,opt,name=target_change,json=targetChange,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 `` /* 132-byte string literal not displayed */
}

A map value.

func (*MapValue) Descriptor 

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

func (*MapValue) GetFields 

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

func (*MapValue) ProtoMessage 

func (*MapValue) ProtoMessage()

func (*MapValue) Reset 

func (m *MapValue) Reset()

func (*MapValue) String 

func (m *MapValue) String() string

type Precondition 

type Precondition struct {
	// The type of precondition.
	//
	// Types that are valid to be assigned to ConditionType:
	//	*Precondition_Exists
	//	*Precondition_UpdateTime
	ConditionType isPrecondition_ConditionType `protobuf_oneof:"condition_type"`
}

A precondition on a document, used for conditional operations.

func (*Precondition) Descriptor 

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

func (*Precondition) GetConditionType 

func (m *Precondition) GetConditionType() isPrecondition_ConditionType

func (*Precondition) GetExists 

func (m *Precondition) GetExists() bool

func (*Precondition) GetUpdateTime 

func (m *Precondition) GetUpdateTime() *google_protobuf1.Timestamp

func (*Precondition) ProtoMessage 

func (*Precondition) ProtoMessage()

func (*Precondition) Reset 

func (m *Precondition) Reset()

func (*Precondition) String 

func (m *Precondition) String() string

func (*Precondition) XXX_OneofFuncs 

func (*Precondition) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, func(msg proto.Message, tag, wire int, b *proto.Buffer) (bool, error), func(msg proto.Message) (n int), []interface{})

XXX_OneofFuncs is for the internal use of the proto package.

type Precondition_Exists 

type Precondition_Exists struct {
	Exists bool `protobuf:"varint,1,opt,name=exists,oneof"`
}

type Precondition_UpdateTime 

type Precondition_UpdateTime struct {
	UpdateTime *google_protobuf1.Timestamp `protobuf:"bytes,2,opt,name=update_time,json=updateTime,oneof"`
}

type RollbackRequest 

type RollbackRequest struct {
	// The database name. In the format:
	// `projects/{project_id}/databases/{database_id}`.
	Database string `protobuf:"bytes,1,opt,name=database" json:"database,omitempty"`
	// The transaction to roll back.
	Transaction []byte `protobuf:"bytes,2,opt,name=transaction,proto3" json:"transaction,omitempty"`
}

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

func (*RollbackRequest) Descriptor 

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

func (*RollbackRequest) GetDatabase 

func (m *RollbackRequest) GetDatabase() string

func (*RollbackRequest) GetTransaction 

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

func (*RollbackRequest) ProtoMessage 

func (*RollbackRequest) ProtoMessage()

func (*RollbackRequest) Reset 

func (m *RollbackRequest) Reset()

func (*RollbackRequest) String 

func (m *RollbackRequest) String() string

type RunQueryRequest 

type RunQueryRequest struct {
	// The parent resource name. In the format:
	// `projects/{project_id}/databases/{database_id}/documents` or
	// `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
	// For example:
	// `projects/my-project/databases/my-database/documents` or
	// `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`
	Parent string `protobuf:"bytes,1,opt,name=parent" json:"parent,omitempty"`
	// The query to run.
	//
	// Types that are valid to be assigned 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 valid to be assigned to ConsistencySelector:
	//	*RunQueryRequest_Transaction
	//	*RunQueryRequest_NewTransaction
	//	*RunQueryRequest_ReadTime
	ConsistencySelector isRunQueryRequest_ConsistencySelector `protobuf_oneof:"consistency_selector"`
}

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

func (*RunQueryRequest) Descriptor 

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

func (*RunQueryRequest) GetConsistencySelector 

func (m *RunQueryRequest) GetConsistencySelector() isRunQueryRequest_ConsistencySelector

func (*RunQueryRequest) GetNewTransaction 

func (m *RunQueryRequest) GetNewTransaction() *TransactionOptions

func (*RunQueryRequest) GetParent 

func (m *RunQueryRequest) GetParent() string

func (*RunQueryRequest) GetQueryType 

func (m *RunQueryRequest) GetQueryType() isRunQueryRequest_QueryType

func (*RunQueryRequest) GetReadTime 

func (m *RunQueryRequest) GetReadTime() *google_protobuf1.Timestamp

func (*RunQueryRequest) GetStructuredQuery 

func (m *RunQueryRequest) GetStructuredQuery() *StructuredQuery

func (*RunQueryRequest) GetTransaction 

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

func (*RunQueryRequest) ProtoMessage 

func (*RunQueryRequest) ProtoMessage()

func (*RunQueryRequest) Reset 

func (m *RunQueryRequest) Reset()

func (*RunQueryRequest) String 

func (m *RunQueryRequest) String() string

func (*RunQueryRequest) XXX_OneofFuncs 

func (*RunQueryRequest) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, func(msg proto.Message, tag, wire int, b *proto.Buffer) (bool, error), func(msg proto.Message) (n int), []interface{})

XXX_OneofFuncs is for the internal use of the proto package.

type RunQueryRequest_NewTransaction 

type RunQueryRequest_NewTransaction struct {
	NewTransaction *TransactionOptions `protobuf:"bytes,6,opt,name=new_transaction,json=newTransaction,oneof"`
}

type RunQueryRequest_ReadTime 

type RunQueryRequest_ReadTime struct {
	ReadTime *google_protobuf1.Timestamp `protobuf:"bytes,7,opt,name=read_time,json=readTime,oneof"`
}

type RunQueryRequest_StructuredQuery 

type RunQueryRequest_StructuredQuery struct {
	StructuredQuery *StructuredQuery `protobuf:"bytes,2,opt,name=structured_query,json=structuredQuery,oneof"`
}

type RunQueryRequest_Transaction 

type RunQueryRequest_Transaction struct {
	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.v1beta1.RunQueryRequest.new_transaction] was set in the request.
	// If set, no other fields will be set in this response.
	Transaction []byte `protobuf:"bytes,2,opt,name=transaction,proto3" json:"transaction,omitempty"`
	// A query result.
	// Not set when reporting partial progress.
	Document *Document `protobuf:"bytes,1,opt,name=document" 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 *google_protobuf1.Timestamp `protobuf:"bytes,3,opt,name=read_time,json=readTime" 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" json:"skipped_results,omitempty"`
}

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

func (*RunQueryResponse) Descriptor 

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

func (*RunQueryResponse) GetDocument 

func (m *RunQueryResponse) GetDocument() *Document

func (*RunQueryResponse) GetReadTime 

func (m *RunQueryResponse) GetReadTime() *google_protobuf1.Timestamp

func (*RunQueryResponse) GetSkippedResults 

func (m *RunQueryResponse) GetSkippedResults() int32

func (*RunQueryResponse) GetTransaction 

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

func (*RunQueryResponse) ProtoMessage 

func (*RunQueryResponse) ProtoMessage()

func (*RunQueryResponse) Reset 

func (m *RunQueryResponse) Reset()

func (*RunQueryResponse) String 

func (m *RunQueryResponse) String() string

type StructuredQuery 

type StructuredQuery struct {
	// The projection to return.
	Select *StructuredQuery_Projection `protobuf:"bytes,1,opt,name=select" json:"select,omitempty"`
	// The collections to query.
	From []*StructuredQuery_CollectionSelector `protobuf:"bytes,2,rep,name=from" json:"from,omitempty"`
	// The filter to apply.
	Where *StructuredQuery_Filter `protobuf:"bytes,3,opt,name=where" json:"where,omitempty"`
	// The order to apply to the query results.
	//
	// Firestore guarantees a stable ordering through the following rules:
	//
	//  * Any field required to appear in `order_by`, that is not already
	//    specified in `order_by`, is appended to the order in field name order
	//    by default.
	//  * If an order on `__name__` is not specified, it is appended by default.
	//
	// Fields are appended with the same sort direction as the last order
	// specified, or 'ASCENDING' if no order was specified. For example:
	//
	//  * `SELECT * FROM Foo ORDER BY A` becomes
	//    `SELECT * FROM Foo ORDER BY A, __name__`
	//  * `SELECT * FROM Foo ORDER BY A DESC` becomes
	//    `SELECT * FROM Foo ORDER BY A DESC, __name__ DESC`
	//  * `SELECT * FROM Foo WHERE A > 1` becomes
	//    `SELECT * FROM Foo WHERE A > 1 ORDER BY A, __name__`
	OrderBy []*StructuredQuery_Order `protobuf:"bytes,4,rep,name=order_by,json=orderBy" json:"order_by,omitempty"`
	// A starting point for the query results.
	StartAt *Cursor `protobuf:"bytes,7,opt,name=start_at,json=startAt" json:"start_at,omitempty"`
	// A end point for the query results.
	EndAt *Cursor `protobuf:"bytes,8,opt,name=end_at,json=endAt" json:"end_at,omitempty"`
	// The number of results to skip.
	//
	// Applies before limit, but after all other constraints. Must be >= 0 if
	// specified.
	Offset int32 `protobuf:"varint,6,opt,name=offset" json:"offset,omitempty"`
	// The maximum number of results to return.
	//
	// Applies after all other constraints.
	// Must be >= 0 if specified.
	Limit *google_protobuf3.Int32Value `protobuf:"bytes,5,opt,name=limit" json:"limit,omitempty"`
}

A Firestore query.

func (*StructuredQuery) Descriptor 

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

func (*StructuredQuery) GetEndAt 

func (m *StructuredQuery) GetEndAt() *Cursor

func (*StructuredQuery) GetFrom 

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

func (*StructuredQuery) GetLimit 

func (m *StructuredQuery) GetLimit() *google_protobuf3.Int32Value

func (*StructuredQuery) GetOffset 

func (m *StructuredQuery) GetOffset() int32

func (*StructuredQuery) GetOrderBy 

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

func (*StructuredQuery) GetSelect 

func (m *StructuredQuery) GetSelect() *StructuredQuery_Projection

func (*StructuredQuery) GetStartAt 

func (m *StructuredQuery) GetStartAt() *Cursor

func (*StructuredQuery) GetWhere 

func (m *StructuredQuery) GetWhere() *StructuredQuery_Filter

func (*StructuredQuery) ProtoMessage 

func (*StructuredQuery) ProtoMessage()

func (*StructuredQuery) Reset 

func (m *StructuredQuery) Reset()

func (*StructuredQuery) String 

func (m *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" 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" json:"all_descendants,omitempty"`
}

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

func (*StructuredQuery_CollectionSelector) Descriptor 

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

func (*StructuredQuery_CollectionSelector) GetAllDescendants 

func (m *StructuredQuery_CollectionSelector) GetAllDescendants() bool

func (*StructuredQuery_CollectionSelector) GetCollectionId 

func (m *StructuredQuery_CollectionSelector) GetCollectionId() string

func (*StructuredQuery_CollectionSelector) ProtoMessage 

func (*StructuredQuery_CollectionSelector) ProtoMessage()

func (*StructuredQuery_CollectionSelector) Reset 

func (m *StructuredQuery_CollectionSelector) Reset()

func (*StructuredQuery_CollectionSelector) String 

func (m *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,enum=google.firestore.v1beta1.StructuredQuery_CompositeFilter_Operator" json:"op,omitempty"`
	// The list of filters to combine.
	// Must contain at least one filter.
	Filters []*StructuredQuery_Filter `protobuf:"bytes,2,rep,name=filters" json:"filters,omitempty"`
}

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

func (*StructuredQuery_CompositeFilter) Descriptor 

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

func (*StructuredQuery_CompositeFilter) GetFilters 

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

func (*StructuredQuery_CompositeFilter) GetOp 

func (m *StructuredQuery_CompositeFilter) GetOp() StructuredQuery_CompositeFilter_Operator

func (*StructuredQuery_CompositeFilter) ProtoMessage 

func (*StructuredQuery_CompositeFilter) ProtoMessage()

func (*StructuredQuery_CompositeFilter) Reset 

func (m *StructuredQuery_CompositeFilter) Reset()

func (*StructuredQuery_CompositeFilter) String 

func (m *StructuredQuery_CompositeFilter) String() string

type StructuredQuery_CompositeFilter_Operator 

type StructuredQuery_CompositeFilter_Operator int32

A composite filter operator. 

const (
	// Unspecified. This value must not be used.
	StructuredQuery_CompositeFilter_OPERATOR_UNSPECIFIED StructuredQuery_CompositeFilter_Operator = 0
	// The results are required to satisfy each of the combined filters.
	StructuredQuery_CompositeFilter_AND StructuredQuery_CompositeFilter_Operator = 1
)

func (StructuredQuery_CompositeFilter_Operator) EnumDescriptor 

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

func (StructuredQuery_CompositeFilter_Operator) String 

func (x StructuredQuery_CompositeFilter_Operator) String() string

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

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

func (StructuredQuery_Direction) String 

func (x StructuredQuery_Direction) String() string

type StructuredQuery_FieldFilter 

type StructuredQuery_FieldFilter struct {
	// The field to filter by.
	Field *StructuredQuery_FieldReference `protobuf:"bytes,1,opt,name=field" json:"field,omitempty"`
	// The operator to filter by.
	Op StructuredQuery_FieldFilter_Operator `protobuf:"varint,2,opt,name=op,enum=google.firestore.v1beta1.StructuredQuery_FieldFilter_Operator" json:"op,omitempty"`
	// The value to compare to.
	Value *Value `protobuf:"bytes,3,opt,name=value" json:"value,omitempty"`
}

A filter on a specific field.

func (*StructuredQuery_FieldFilter) Descriptor 

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

func (*StructuredQuery_FieldFilter) GetField 

func (m *StructuredQuery_FieldFilter) GetField() *StructuredQuery_FieldReference

func (*StructuredQuery_FieldFilter) GetOp 

func (m *StructuredQuery_FieldFilter) GetOp() StructuredQuery_FieldFilter_Operator

func (*StructuredQuery_FieldFilter) GetValue 

func (m *StructuredQuery_FieldFilter) GetValue() *Value

func (*StructuredQuery_FieldFilter) ProtoMessage 

func (*StructuredQuery_FieldFilter) ProtoMessage()

func (*StructuredQuery_FieldFilter) Reset 

func (m *StructuredQuery_FieldFilter) Reset()

func (*StructuredQuery_FieldFilter) String 

func (m *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
	// Less than. Requires that the field come first in `order_by`.
	StructuredQuery_FieldFilter_LESS_THAN StructuredQuery_FieldFilter_Operator = 1
	// Less than or equal. Requires that the field come first in `order_by`.
	StructuredQuery_FieldFilter_LESS_THAN_OR_EQUAL StructuredQuery_FieldFilter_Operator = 2
	// Greater than. Requires that the field come first in `order_by`.
	StructuredQuery_FieldFilter_GREATER_THAN StructuredQuery_FieldFilter_Operator = 3
	// Greater than or equal. Requires that the field come first in
	// `order_by`.
	StructuredQuery_FieldFilter_GREATER_THAN_OR_EQUAL StructuredQuery_FieldFilter_Operator = 4
	// Equal.
	StructuredQuery_FieldFilter_EQUAL StructuredQuery_FieldFilter_Operator = 5
)

func (StructuredQuery_FieldFilter_Operator) EnumDescriptor 

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

func (StructuredQuery_FieldFilter_Operator) String 

func (x StructuredQuery_FieldFilter_Operator) String() string

type StructuredQuery_FieldReference 

type StructuredQuery_FieldReference struct {
	FieldPath string `protobuf:"bytes,2,opt,name=field_path,json=fieldPath" json:"field_path,omitempty"`
}

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

func (*StructuredQuery_FieldReference) Descriptor 

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

func (*StructuredQuery_FieldReference) GetFieldPath 

func (m *StructuredQuery_FieldReference) GetFieldPath() string

func (*StructuredQuery_FieldReference) ProtoMessage 

func (*StructuredQuery_FieldReference) ProtoMessage()

func (*StructuredQuery_FieldReference) Reset 

func (m *StructuredQuery_FieldReference) Reset()

func (*StructuredQuery_FieldReference) String 

func (m *StructuredQuery_FieldReference) String() string

type StructuredQuery_Filter 

type StructuredQuery_Filter struct {
	// The type of filter.
	//
	// Types that are valid to be assigned to FilterType:
	//	*StructuredQuery_Filter_CompositeFilter
	//	*StructuredQuery_Filter_FieldFilter
	//	*StructuredQuery_Filter_UnaryFilter
	FilterType isStructuredQuery_Filter_FilterType `protobuf_oneof:"filter_type"`
}

A filter.

func (*StructuredQuery_Filter) Descriptor 

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

func (*StructuredQuery_Filter) GetCompositeFilter 

func (m *StructuredQuery_Filter) GetCompositeFilter() *StructuredQuery_CompositeFilter

func (*StructuredQuery_Filter) GetFieldFilter 

func (m *StructuredQuery_Filter) GetFieldFilter() *StructuredQuery_FieldFilter

func (*StructuredQuery_Filter) GetFilterType 

func (m *StructuredQuery_Filter) GetFilterType() isStructuredQuery_Filter_FilterType

func (*StructuredQuery_Filter) GetUnaryFilter 

func (m *StructuredQuery_Filter) GetUnaryFilter() *StructuredQuery_UnaryFilter

func (*StructuredQuery_Filter) ProtoMessage 

func (*StructuredQuery_Filter) ProtoMessage()

func (*StructuredQuery_Filter) Reset 

func (m *StructuredQuery_Filter) Reset()

func (*StructuredQuery_Filter) String 

func (m *StructuredQuery_Filter) String() string

func (*StructuredQuery_Filter) XXX_OneofFuncs 

func (*StructuredQuery_Filter) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, func(msg proto.Message, tag, wire int, b *proto.Buffer) (bool, error), func(msg proto.Message) (n int), []interface{})

XXX_OneofFuncs is for the internal use of the proto package.

type StructuredQuery_Filter_CompositeFilter 

type StructuredQuery_Filter_CompositeFilter struct {
	CompositeFilter *StructuredQuery_CompositeFilter `protobuf:"bytes,1,opt,name=composite_filter,json=compositeFilter,oneof"`
}

type StructuredQuery_Filter_FieldFilter 

type StructuredQuery_Filter_FieldFilter struct {
	FieldFilter *StructuredQuery_FieldFilter `protobuf:"bytes,2,opt,name=field_filter,json=fieldFilter,oneof"`
}

type StructuredQuery_Filter_UnaryFilter 

type StructuredQuery_Filter_UnaryFilter struct {
	UnaryFilter *StructuredQuery_UnaryFilter `protobuf:"bytes,3,opt,name=unary_filter,json=unaryFilter,oneof"`
}

type StructuredQuery_Order 

type StructuredQuery_Order struct {
	// The field to order by.
	Field *StructuredQuery_FieldReference `protobuf:"bytes,1,opt,name=field" json:"field,omitempty"`
	// The direction to order by. Defaults to `ASCENDING`.
	Direction StructuredQuery_Direction `protobuf:"varint,2,opt,name=direction,enum=google.firestore.v1beta1.StructuredQuery_Direction" json:"direction,omitempty"`
}

An order on a field.

func (*StructuredQuery_Order) Descriptor 

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

func (*StructuredQuery_Order) GetDirection 

func (m *StructuredQuery_Order) GetDirection() StructuredQuery_Direction

func (*StructuredQuery_Order) GetField 

func (m *StructuredQuery_Order) GetField() *StructuredQuery_FieldReference

func (*StructuredQuery_Order) ProtoMessage 

func (*StructuredQuery_Order) ProtoMessage()

func (*StructuredQuery_Order) Reset 

func (m *StructuredQuery_Order) Reset()

func (*StructuredQuery_Order) String 

func (m *StructuredQuery_Order) String() string

type StructuredQuery_Projection 

type StructuredQuery_Projection struct {
	// The fields to return.
	//
	// If empty, all fields are returned. To only return the name
	// of the document, use `['__name__']`.
	Fields []*StructuredQuery_FieldReference `protobuf:"bytes,2,rep,name=fields" json:"fields,omitempty"`
}

The projection of document's fields to return.

func (*StructuredQuery_Projection) Descriptor 

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

func (*StructuredQuery_Projection) GetFields 

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

func (*StructuredQuery_Projection) ProtoMessage 

func (*StructuredQuery_Projection) ProtoMessage()

func (*StructuredQuery_Projection) Reset 

func (m *StructuredQuery_Projection) Reset()

func (*StructuredQuery_Projection) String 

func (m *StructuredQuery_Projection) String() string

type StructuredQuery_UnaryFilter 

type StructuredQuery_UnaryFilter struct {
	// The unary operator to apply.
	Op StructuredQuery_UnaryFilter_Operator `protobuf:"varint,1,opt,name=op,enum=google.firestore.v1beta1.StructuredQuery_UnaryFilter_Operator" json:"op,omitempty"`
	// The argument to the filter.
	//
	// Types that are valid to be assigned to OperandType:
	//	*StructuredQuery_UnaryFilter_Field
	OperandType isStructuredQuery_UnaryFilter_OperandType `protobuf_oneof:"operand_type"`
}

A filter with a single operand.

func (*StructuredQuery_UnaryFilter) Descriptor 

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

func (*StructuredQuery_UnaryFilter) GetField 

func (m *StructuredQuery_UnaryFilter) GetField() *StructuredQuery_FieldReference

func (*StructuredQuery_UnaryFilter) GetOp 

func (m *StructuredQuery_UnaryFilter) GetOp() StructuredQuery_UnaryFilter_Operator

func (*StructuredQuery_UnaryFilter) GetOperandType 

func (m *StructuredQuery_UnaryFilter) GetOperandType() isStructuredQuery_UnaryFilter_OperandType

func (*StructuredQuery_UnaryFilter) ProtoMessage 

func (*StructuredQuery_UnaryFilter) ProtoMessage()

func (*StructuredQuery_UnaryFilter) Reset 

func (m *StructuredQuery_UnaryFilter) Reset()

func (*StructuredQuery_UnaryFilter) String 

func (m *StructuredQuery_UnaryFilter) String() string

func (*StructuredQuery_UnaryFilter) XXX_OneofFuncs 

func (*StructuredQuery_UnaryFilter) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, func(msg proto.Message, tag, wire int, b *proto.Buffer) (bool, error), func(msg proto.Message) (n int), []interface{})

XXX_OneofFuncs is for the internal use of the proto package.

type StructuredQuery_UnaryFilter_Field 

type StructuredQuery_UnaryFilter_Field struct {
	Field *StructuredQuery_FieldReference `protobuf:"bytes,2,opt,name=field,oneof"`
}

type StructuredQuery_UnaryFilter_Operator 

type StructuredQuery_UnaryFilter_Operator int32

A unary operator. 

const (
	// Unspecified. This value must not be used.
	StructuredQuery_UnaryFilter_OPERATOR_UNSPECIFIED StructuredQuery_UnaryFilter_Operator = 0
	// Test if a field is equal to NaN.
	StructuredQuery_UnaryFilter_IS_NAN StructuredQuery_UnaryFilter_Operator = 2
	// Test if an exprestion evaluates to Null.
	StructuredQuery_UnaryFilter_IS_NULL StructuredQuery_UnaryFilter_Operator = 3
)

func (StructuredQuery_UnaryFilter_Operator) EnumDescriptor 

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

func (StructuredQuery_UnaryFilter_Operator) String 

func (x StructuredQuery_UnaryFilter_Operator) String() string

type Target 

type Target struct {
	// The type of target to listen to.
	//
	// Types that are valid to be assigned to TargetType:
	//	*Target_Query
	//	*Target_Documents
	TargetType isTarget_TargetType `protobuf_oneof:"target_type"`
	// When to start listening.
	//
	// If not specified, all matching Documents are returned before any
	// subsequent changes.
	//
	// Types that are valid to be assigned to ResumeType:
	//	*Target_ResumeToken
	//	*Target_ReadTime
	ResumeType isTarget_ResumeType `protobuf_oneof:"resume_type"`
	// A client provided target ID.
	//
	// If not set, the server will assign an ID for the target.
	//
	// Used for resuming a target without changing IDs. The IDs can either be
	// client-assigned or be server-assigned in a previous stream. All targets
	// with client provided IDs must be added before adding a target that needs
	// a server-assigned id.
	TargetId int32 `protobuf:"varint,5,opt,name=target_id,json=targetId" json:"target_id,omitempty"`
	// If the target should be removed once it is current and consistent.
	Once bool `protobuf:"varint,6,opt,name=once" json:"once,omitempty"`
}

A specification of a set of documents to listen to.

func (*Target) Descriptor 

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

func (*Target) GetDocuments 

func (m *Target) GetDocuments() *Target_DocumentsTarget

func (*Target) GetOnce 

func (m *Target) GetOnce() bool

func (*Target) GetQuery 

func (m *Target) GetQuery() *Target_QueryTarget

func (*Target) GetReadTime 

func (m *Target) GetReadTime() *google_protobuf1.Timestamp

func (*Target) GetResumeToken 

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

func (*Target) GetResumeType 

func (m *Target) GetResumeType() isTarget_ResumeType

func (*Target) GetTargetId 

func (m *Target) GetTargetId() int32

func (*Target) GetTargetType 

func (m *Target) GetTargetType() isTarget_TargetType

func (*Target) ProtoMessage 

func (*Target) ProtoMessage()

func (*Target) Reset 

func (m *Target) Reset()

func (*Target) String 

func (m *Target) String() string

func (*Target) XXX_OneofFuncs 

func (*Target) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, func(msg proto.Message, tag, wire int, b *proto.Buffer) (bool, error), func(msg proto.Message) (n int), []interface{})

XXX_OneofFuncs is for the internal use of the proto package.

type TargetChange 

type TargetChange struct {
	// The type of change that occurred.
	TargetChangeType TargetChange_TargetChangeType `` /* 165-byte string literal not displayed */
	// The target IDs of targets that have changed.
	//
	// If empty, the change applies to all targets.
	//
	// For `target_change_type=ADD`, the order of the target IDs matches the order
	// of the requests to add the targets. This allows clients to unambiguously
	// associate server-assigned target IDs with added targets.
	//
	// For other states, the order of the target IDs is not defined.
	TargetIds []int32 `protobuf:"varint,2,rep,packed,name=target_ids,json=targetIds" json:"target_ids,omitempty"`
	// The error that resulted in this change, if applicable.
	Cause *google_rpc.Status `protobuf:"bytes,3,opt,name=cause" json:"cause,omitempty"`
	// A token that can be used to resume the stream for the given `target_ids`,
	// or all targets if `target_ids` is empty.
	//
	// Not set on every target change.
	ResumeToken []byte `protobuf:"bytes,4,opt,name=resume_token,json=resumeToken,proto3" json:"resume_token,omitempty"`
	// The consistent `read_time` for the given `target_ids` (omitted when the
	// target_ids are not at a consistent snapshot).
	//
	// The stream is guaranteed to send a `read_time` with `target_ids` empty
	// whenever the entire stream reaches a new consistent snapshot. ADD,
	// CURRENT, and RESET messages are guaranteed to (eventually) result in a
	// new consistent snapshot (while NO_CHANGE and REMOVE messages are not).
	//
	// For a given stream, `read_time` is guaranteed to be monotonically
	// increasing.
	ReadTime *google_protobuf1.Timestamp `protobuf:"bytes,6,opt,name=read_time,json=readTime" json:"read_time,omitempty"`
}

Targets being watched have changed.

func (*TargetChange) Descriptor 

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

func (*TargetChange) GetCause 

func (m *TargetChange) GetCause() *google_rpc.Status

func (*TargetChange) GetReadTime 

func (m *TargetChange) GetReadTime() *google_protobuf1.Timestamp

func (*TargetChange) GetResumeToken 

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

func (*TargetChange) GetTargetChangeType 

func (m *TargetChange) GetTargetChangeType() TargetChange_TargetChangeType

func (*TargetChange) GetTargetIds 

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

func (*TargetChange) ProtoMessage 

func (*TargetChange) ProtoMessage()

func (*TargetChange) Reset 

func (m *TargetChange) Reset()

func (*TargetChange) String 

func (m *TargetChange) String() string

type TargetChange_TargetChangeType 

type TargetChange_TargetChangeType int32

The type of change. 

const (
	// No change has occurred. Used only to send an updated `resume_token`.
	TargetChange_NO_CHANGE TargetChange_TargetChangeType = 0
	// The targets have been added.
	TargetChange_ADD TargetChange_TargetChangeType = 1
	// The targets have been removed.
	TargetChange_REMOVE TargetChange_TargetChangeType = 2
	// The targets reflect all changes committed before the targets were added
	// to the stream.
	//
	// This will be sent after or with a `read_time` that is greater than or
	// equal to the time at which the targets were added.
	//
	// Listeners can wait for this change if read-after-write semantics
	// are desired.
	TargetChange_CURRENT TargetChange_TargetChangeType = 3
	// The targets have been reset, and a new initial state for the targets
	// will be returned in subsequent changes.
	//
	// After the initial state is complete, `CURRENT` will be returned even
	// if the target was previously indicated to be `CURRENT`.
	TargetChange_RESET TargetChange_TargetChangeType = 4
)

func (TargetChange_TargetChangeType) EnumDescriptor 

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

func (TargetChange_TargetChangeType) String 

func (x TargetChange_TargetChangeType) String() string

type Target_Documents 

type Target_Documents struct {
	Documents *Target_DocumentsTarget `protobuf:"bytes,3,opt,name=documents,oneof"`
}

type Target_DocumentsTarget 

type Target_DocumentsTarget struct {
	// The names of the documents to retrieve. In the format:
	// `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
	// The request will fail if any of the document is not a child resource of
	// the given `database`. Duplicate names will be elided.
	Documents []string `protobuf:"bytes,2,rep,name=documents" json:"documents,omitempty"`
}

A target specified by a set of documents names.

func (*Target_DocumentsTarget) Descriptor 

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

func (*Target_DocumentsTarget) GetDocuments 

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

func (*Target_DocumentsTarget) ProtoMessage 

func (*Target_DocumentsTarget) ProtoMessage()

func (*Target_DocumentsTarget) Reset 

func (m *Target_DocumentsTarget) Reset()

func (*Target_DocumentsTarget) String 

func (m *Target_DocumentsTarget) String() string

type Target_Query 

type Target_Query struct {
	Query *Target_QueryTarget `protobuf:"bytes,2,opt,name=query,oneof"`
}

type Target_QueryTarget 

type Target_QueryTarget struct {
	// The parent resource name. In the format:
	// `projects/{project_id}/databases/{database_id}/documents` or
	// `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
	// For example:
	// `projects/my-project/databases/my-database/documents` or
	// `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`
	Parent string `protobuf:"bytes,1,opt,name=parent" json:"parent,omitempty"`
	// The query to run.
	//
	// Types that are valid to be assigned to QueryType:
	//	*Target_QueryTarget_StructuredQuery
	QueryType isTarget_QueryTarget_QueryType `protobuf_oneof:"query_type"`
}

A target specified by a query.

func (*Target_QueryTarget) Descriptor 

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

func (*Target_QueryTarget) GetParent 

func (m *Target_QueryTarget) GetParent() string

func (*Target_QueryTarget) GetQueryType 

func (m *Target_QueryTarget) GetQueryType() isTarget_QueryTarget_QueryType

func (*Target_QueryTarget) GetStructuredQuery 

func (m *Target_QueryTarget) GetStructuredQuery() *StructuredQuery

func (*Target_QueryTarget) ProtoMessage 

func (*Target_QueryTarget) ProtoMessage()

func (*Target_QueryTarget) Reset 

func (m *Target_QueryTarget) Reset()

func (*Target_QueryTarget) String 

func (m *Target_QueryTarget) String() string

func (*Target_QueryTarget) XXX_OneofFuncs 

func (*Target_QueryTarget) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, func(msg proto.Message, tag, wire int, b *proto.Buffer) (bool, error), func(msg proto.Message) (n int), []interface{})

XXX_OneofFuncs is for the internal use of the proto package.

type Target_QueryTarget_StructuredQuery 

type Target_QueryTarget_StructuredQuery struct {
	StructuredQuery *StructuredQuery `protobuf:"bytes,2,opt,name=structured_query,json=structuredQuery,oneof"`
}

type Target_ReadTime 

type Target_ReadTime struct {
	ReadTime *google_protobuf1.Timestamp `protobuf:"bytes,11,opt,name=read_time,json=readTime,oneof"`
}

type Target_ResumeToken 

type Target_ResumeToken struct {
	ResumeToken []byte `protobuf:"bytes,4,opt,name=resume_token,json=resumeToken,proto3,oneof"`
}

type TransactionOptions 

type TransactionOptions struct {
	// The mode of the transaction.
	//
	// Types that are valid to be assigned to Mode:
	//	*TransactionOptions_ReadOnly_
	//	*TransactionOptions_ReadWrite_
	Mode isTransactionOptions_Mode `protobuf_oneof:"mode"`
}

Options for creating a new transaction.

func (*TransactionOptions) Descriptor 

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

func (*TransactionOptions) GetMode 

func (m *TransactionOptions) GetMode() isTransactionOptions_Mode

func (*TransactionOptions) GetReadOnly 

func (m *TransactionOptions) GetReadOnly() *TransactionOptions_ReadOnly

func (*TransactionOptions) GetReadWrite 

func (m *TransactionOptions) GetReadWrite() *TransactionOptions_ReadWrite

func (*TransactionOptions) ProtoMessage 

func (*TransactionOptions) ProtoMessage()

func (*TransactionOptions) Reset 

func (m *TransactionOptions) Reset()

func (*TransactionOptions) String 

func (m *TransactionOptions) String() string

func (*TransactionOptions) XXX_OneofFuncs 

func (*TransactionOptions) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, func(msg proto.Message, tag, wire int, b *proto.Buffer) (bool, error), func(msg proto.Message) (n int), []interface{})

XXX_OneofFuncs is for the internal use of the proto package.

type TransactionOptions_ReadOnly 

type TransactionOptions_ReadOnly struct {
	// The consistency mode for this transaction. If not set, defaults to strong
	// consistency.
	//
	// Types that are valid to be assigned to ConsistencySelector:
	//	*TransactionOptions_ReadOnly_ReadTime
	ConsistencySelector isTransactionOptions_ReadOnly_ConsistencySelector `protobuf_oneof:"consistency_selector"`
}

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

func (*TransactionOptions_ReadOnly) Descriptor 

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

func (*TransactionOptions_ReadOnly) GetConsistencySelector 

func (m *TransactionOptions_ReadOnly) GetConsistencySelector() isTransactionOptions_ReadOnly_ConsistencySelector

func (*TransactionOptions_ReadOnly) GetReadTime 

func (m *TransactionOptions_ReadOnly) GetReadTime() *google_protobuf1.Timestamp

func (*TransactionOptions_ReadOnly) ProtoMessage 

func (*TransactionOptions_ReadOnly) ProtoMessage()

func (*TransactionOptions_ReadOnly) Reset 

func (m *TransactionOptions_ReadOnly) Reset()

func (*TransactionOptions_ReadOnly) String 

func (m *TransactionOptions_ReadOnly) String() string

func (*TransactionOptions_ReadOnly) XXX_OneofFuncs 

func (*TransactionOptions_ReadOnly) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, func(msg proto.Message, tag, wire int, b *proto.Buffer) (bool, error), func(msg proto.Message) (n int), []interface{})

XXX_OneofFuncs is for the internal use of the proto package.

type TransactionOptions_ReadOnly_ 

type TransactionOptions_ReadOnly_ struct {
	ReadOnly *TransactionOptions_ReadOnly `protobuf:"bytes,2,opt,name=read_only,json=readOnly,oneof"`
}

type TransactionOptions_ReadOnly_ReadTime 

type TransactionOptions_ReadOnly_ReadTime struct {
	ReadTime *google_protobuf1.Timestamp `protobuf:"bytes,2,opt,name=read_time,json=readTime,oneof"`
}

type TransactionOptions_ReadWrite 

type TransactionOptions_ReadWrite struct {
	// An optional transaction to retry.
	RetryTransaction []byte `protobuf:"bytes,1,opt,name=retry_transaction,json=retryTransaction,proto3" json:"retry_transaction,omitempty"`
}

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

func (*TransactionOptions_ReadWrite) Descriptor 

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

func (*TransactionOptions_ReadWrite) GetRetryTransaction 

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

func (*TransactionOptions_ReadWrite) ProtoMessage 

func (*TransactionOptions_ReadWrite) ProtoMessage()

func (*TransactionOptions_ReadWrite) Reset 

func (m *TransactionOptions_ReadWrite) Reset()

func (*TransactionOptions_ReadWrite) String 

func (m *TransactionOptions_ReadWrite) String() string

type TransactionOptions_ReadWrite_ 

type TransactionOptions_ReadWrite_ struct {
	ReadWrite *TransactionOptions_ReadWrite `protobuf:"bytes,3,opt,name=read_write,json=readWrite,oneof"`
}

type UpdateDocumentRequest 

type UpdateDocumentRequest struct {
	// The updated document.
	// Creates the document if it does not already exist.
	Document *Document `protobuf:"bytes,1,opt,name=document" json:"document,omitempty"`
	// The fields to update.
	// None of the field paths in the mask may contain a reserved name.
	//
	// If the document exists on the server and has fields not referenced in the
	// mask, they are left unchanged.
	// Fields referenced in the mask, but not present in the input document, are
	// deleted from the document on the server.
	UpdateMask *DocumentMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask" json:"update_mask,omitempty"`
	// The fields to return. If not set, returns all fields.
	//
	// If the document has a field that is not present in this mask, that field
	// will not be returned in the response.
	Mask *DocumentMask `protobuf:"bytes,3,opt,name=mask" json:"mask,omitempty"`
	// An optional precondition on the document.
	// The request will fail if this is set and not met by the target document.
	CurrentDocument *Precondition `protobuf:"bytes,4,opt,name=current_document,json=currentDocument" json:"current_document,omitempty"`
}

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

func (*UpdateDocumentRequest) Descriptor 

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

func (*UpdateDocumentRequest) GetCurrentDocument 

func (m *UpdateDocumentRequest) GetCurrentDocument() *Precondition

func (*UpdateDocumentRequest) GetDocument 

func (m *UpdateDocumentRequest) GetDocument() *Document

func (*UpdateDocumentRequest) GetMask 

func (m *UpdateDocumentRequest) GetMask() *DocumentMask

func (*UpdateDocumentRequest) GetUpdateMask 

func (m *UpdateDocumentRequest) GetUpdateMask() *DocumentMask

func (*UpdateDocumentRequest) ProtoMessage 

func (*UpdateDocumentRequest) ProtoMessage()

func (*UpdateDocumentRequest) Reset 

func (m *UpdateDocumentRequest) Reset()

func (*UpdateDocumentRequest) String 

func (m *UpdateDocumentRequest) String() string

type Value 

type Value struct {
	// Must have a value set.
	//
	// Types that are valid to be assigned to ValueType:
	//	*Value_NullValue
	//	*Value_BooleanValue
	//	*Value_IntegerValue
	//	*Value_DoubleValue
	//	*Value_TimestampValue
	//	*Value_StringValue
	//	*Value_BytesValue
	//	*Value_ReferenceValue
	//	*Value_GeoPointValue
	//	*Value_ArrayValue
	//	*Value_MapValue
	ValueType isValue_ValueType `protobuf_oneof:"value_type"`
}

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

func (*Value) Descriptor 

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

func (*Value) GetArrayValue 

func (m *Value) GetArrayValue() *ArrayValue

func (*Value) GetBooleanValue 

func (m *Value) GetBooleanValue() bool

func (*Value) GetBytesValue 

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

func (*Value) GetDoubleValue 

func (m *Value) GetDoubleValue() float64

func (*Value) GetGeoPointValue 

func (m *Value) GetGeoPointValue() *google_type.LatLng

func (*Value) GetIntegerValue 

func (m *Value) GetIntegerValue() int64

func (*Value) GetMapValue 

func (m *Value) GetMapValue() *MapValue

func (*Value) GetNullValue 

func (m *Value) GetNullValue() google_protobuf2.NullValue

func (*Value) GetReferenceValue 

func (m *Value) GetReferenceValue() string

func (*Value) GetStringValue 

func (m *Value) GetStringValue() string

func (*Value) GetTimestampValue 

func (m *Value) GetTimestampValue() *google_protobuf1.Timestamp

func (*Value) GetValueType 

func (m *Value) GetValueType() isValue_ValueType

func (*Value) ProtoMessage 

func (*Value) ProtoMessage()

func (*Value) Reset 

func (m *Value) Reset()

func (*Value) String 

func (m *Value) String() string

func (*Value) XXX_OneofFuncs 

func (*Value) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, func(msg proto.Message, tag, wire int, b *proto.Buffer) (bool, error), func(msg proto.Message) (n int), []interface{})

XXX_OneofFuncs is for the internal use of the proto package.

type Value_ArrayValue 

type Value_ArrayValue struct {
	ArrayValue *ArrayValue `protobuf:"bytes,9,opt,name=array_value,json=arrayValue,oneof"`
}

type Value_BooleanValue 

type Value_BooleanValue struct {
	BooleanValue bool `protobuf:"varint,1,opt,name=boolean_value,json=booleanValue,oneof"`
}

type Value_BytesValue 

type Value_BytesValue struct {
	BytesValue []byte `protobuf:"bytes,18,opt,name=bytes_value,json=bytesValue,proto3,oneof"`
}

type Value_DoubleValue 

type Value_DoubleValue struct {
	DoubleValue float64 `protobuf:"fixed64,3,opt,name=double_value,json=doubleValue,oneof"`
}

type Value_GeoPointValue 

type Value_GeoPointValue struct {
	GeoPointValue *google_type.LatLng `protobuf:"bytes,8,opt,name=geo_point_value,json=geoPointValue,oneof"`
}

type Value_IntegerValue 

type Value_IntegerValue struct {
	IntegerValue int64 `protobuf:"varint,2,opt,name=integer_value,json=integerValue,oneof"`
}

type Value_MapValue 

type Value_MapValue struct {
	MapValue *MapValue `protobuf:"bytes,6,opt,name=map_value,json=mapValue,oneof"`
}

type Value_NullValue 

type Value_NullValue struct {
	NullValue google_protobuf2.NullValue `protobuf:"varint,11,opt,name=null_value,json=nullValue,enum=google.protobuf.NullValue,oneof"`
}

type Value_ReferenceValue 

type Value_ReferenceValue struct {
	ReferenceValue string `protobuf:"bytes,5,opt,name=reference_value,json=referenceValue,oneof"`
}

type Value_StringValue 

type Value_StringValue struct {
	StringValue string `protobuf:"bytes,17,opt,name=string_value,json=stringValue,oneof"`
}

type Value_TimestampValue 

type Value_TimestampValue struct {
	TimestampValue *google_protobuf1.Timestamp `protobuf:"bytes,10,opt,name=timestamp_value,json=timestampValue,oneof"`
}

type Write 

type Write struct {
	// The operation to execute.
	//
	// Types that are valid to be assigned to Operation:
	//	*Write_Update
	//	*Write_Delete
	//	*Write_Transform
	Operation isWrite_Operation `protobuf_oneof:"operation"`
	// The fields to update in this write.
	//
	// This field can be set only when the operation is `update`.
	// None of the field paths in the mask may contain a reserved name.
	// If the document exists on the server and has fields not referenced in the
	// mask, they are left unchanged.
	// Fields referenced in the mask, but not present in the input document, are
	// deleted from the document on the server.
	// The field paths in this mask must not contain a reserved field name.
	UpdateMask *DocumentMask `protobuf:"bytes,3,opt,name=update_mask,json=updateMask" json:"update_mask,omitempty"`
	// An optional precondition on the document.
	//
	// The write will fail if this is set and not met by the target document.
	CurrentDocument *Precondition `protobuf:"bytes,4,opt,name=current_document,json=currentDocument" json:"current_document,omitempty"`
}

A write on a document.

func (*Write) Descriptor 

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

func (*Write) GetCurrentDocument 

func (m *Write) GetCurrentDocument() *Precondition

func (*Write) GetDelete 

func (m *Write) GetDelete() string

func (*Write) GetOperation 

func (m *Write) GetOperation() isWrite_Operation

func (*Write) GetTransform 

func (m *Write) GetTransform() *DocumentTransform

func (*Write) GetUpdate 

func (m *Write) GetUpdate() *Document

func (*Write) GetUpdateMask 

func (m *Write) GetUpdateMask() *DocumentMask

func (*Write) ProtoMessage 

func (*Write) ProtoMessage()

func (*Write) Reset 

func (m *Write) Reset()

func (*Write) String 

func (m *Write) String() string

func (*Write) XXX_OneofFuncs 

func (*Write) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, func(msg proto.Message, tag, wire int, b *proto.Buffer) (bool, error), func(msg proto.Message) (n int), []interface{})

XXX_OneofFuncs is for the internal use of the proto package.

type WriteRequest 

type WriteRequest struct {
	// The database name. In the format:
	// `projects/{project_id}/databases/{database_id}`.
	// This is only required in the first message.
	Database string `protobuf:"bytes,1,opt,name=database" json:"database,omitempty"`
	// The ID of the write stream to resume.
	// This may only be set in the first message. When left empty, a new write
	// stream will be created.
	StreamId string `protobuf:"bytes,2,opt,name=stream_id,json=streamId" json:"stream_id,omitempty"`
	// The writes to apply.
	//
	// Always executed atomically and in order.
	// This must be empty on the first request.
	// This may be empty on the last request.
	// This must not be empty on all other requests.
	Writes []*Write `protobuf:"bytes,3,rep,name=writes" json:"writes,omitempty"`
	// A stream token that was previously sent by the server.
	//
	// The client should set this field to the token from the most recent
	// [WriteResponse][google.firestore.v1beta1.WriteResponse] it has received. This acknowledges that the client has
	// received responses up to this token. After sending this token, earlier
	// tokens may not be used anymore.
	//
	// The server may close the stream if there are too many unacknowledged
	// responses.
	//
	// Leave this field unset when creating a new stream. To resume a stream at
	// a specific point, set this field and the `stream_id` field.
	//
	// Leave this field unset when creating a new stream.
	StreamToken []byte `protobuf:"bytes,4,opt,name=stream_token,json=streamToken,proto3" json:"stream_token,omitempty"`
	// Labels associated with this write request.
	Labels map[string]string `` /* 132-byte string literal not displayed */
}

The request for [Firestore.Write][google.firestore.v1beta1.Firestore.Write].

The first request creates a stream, or resumes an existing one from a token.

When creating a new stream, the server replies with a response containing only an ID and a token, to use in the next request.

When resuming a stream, the server first streams any responses later than the given token, then a response containing only an up-to-date token, to use in the next request.

func (*WriteRequest) Descriptor 

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

func (*WriteRequest) GetDatabase 

func (m *WriteRequest) GetDatabase() string

func (*WriteRequest) GetLabels 

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

func (*WriteRequest) GetStreamId 

func (m *WriteRequest) GetStreamId() string

func (*WriteRequest) GetStreamToken 

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

func (*WriteRequest) GetWrites 

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

func (*WriteRequest) ProtoMessage 

func (*WriteRequest) ProtoMessage()

func (*WriteRequest) Reset 

func (m *WriteRequest) Reset()

func (*WriteRequest) String 

func (m *WriteRequest) String() string

type WriteResponse 

type WriteResponse struct {
	// The ID of the stream.
	// Only set on the first message, when a new stream was created.
	StreamId string `protobuf:"bytes,1,opt,name=stream_id,json=streamId" json:"stream_id,omitempty"`
	// A token that represents the position of this response in the stream.
	// This can be used by a client to resume the stream at this point.
	//
	// This field is always set.
	StreamToken []byte `protobuf:"bytes,2,opt,name=stream_token,json=streamToken,proto3" json:"stream_token,omitempty"`
	// The result of applying the writes.
	//
	// This i-th write result corresponds to the i-th write in the
	// request.
	WriteResults []*WriteResult `protobuf:"bytes,3,rep,name=write_results,json=writeResults" json:"write_results,omitempty"`
	// The time at which the commit occurred.
	CommitTime *google_protobuf1.Timestamp `protobuf:"bytes,4,opt,name=commit_time,json=commitTime" json:"commit_time,omitempty"`
}

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

func (*WriteResponse) Descriptor 

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

func (*WriteResponse) GetCommitTime 

func (m *WriteResponse) GetCommitTime() *google_protobuf1.Timestamp

func (*WriteResponse) GetStreamId 

func (m *WriteResponse) GetStreamId() string

func (*WriteResponse) GetStreamToken 

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

func (*WriteResponse) GetWriteResults 

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

func (*WriteResponse) ProtoMessage 

func (*WriteResponse) ProtoMessage()

func (*WriteResponse) Reset 

func (m *WriteResponse) Reset()

func (*WriteResponse) String 

func (m *WriteResponse) String() string

type WriteResult 

type WriteResult struct {
	// The last update time of the document after applying the write. Not set
	// after a `delete`.
	//
	// If the write did not actually change the document, this will be the
	// previous update_time.
	UpdateTime *google_protobuf1.Timestamp `protobuf:"bytes,1,opt,name=update_time,json=updateTime" json:"update_time,omitempty"`
	// The results of applying each [DocumentTransform.FieldTransform][google.firestore.v1beta1.DocumentTransform.FieldTransform], in the
	// same order.
	TransformResults []*Value `protobuf:"bytes,2,rep,name=transform_results,json=transformResults" json:"transform_results,omitempty"`
}

The result of applying a write.

func (*WriteResult) Descriptor 

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

func (*WriteResult) GetTransformResults 

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

func (*WriteResult) GetUpdateTime 

func (m *WriteResult) GetUpdateTime() *google_protobuf1.Timestamp

func (*WriteResult) ProtoMessage 

func (*WriteResult) ProtoMessage()

func (*WriteResult) Reset 

func (m *WriteResult) Reset()

func (*WriteResult) String 

func (m *WriteResult) String() string

type Write_Delete 

type Write_Delete struct {
	Delete string `protobuf:"bytes,2,opt,name=delete,oneof"`
}

type Write_Transform 

type Write_Transform struct {
	Transform *DocumentTransform `protobuf:"bytes,6,opt,name=transform,oneof"`
}

type Write_Update 

type Write_Update struct {
	Update *Document `protobuf:"bytes,1,opt,name=update,oneof"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.