genproto: google.golang.org/genproto/googleapis/firestore/v1 Index | Files

package firestore

import "google.golang.org/genproto/googleapis/firestore/v1"

Index

Package Files

common.pb.go document.pb.go firestore.pb.go query.pb.go write.pb.go

Variables

var DocumentTransform_FieldTransform_ServerValue_name = map[int32]string{
    0:  "SERVER_VALUE_UNSPECIFIED",
    1:  "REQUEST_TIME",
}
var DocumentTransform_FieldTransform_ServerValue_value = map[string]int32{
    "SERVER_VALUE_UNSPECIFIED": 0,
    "REQUEST_TIME":             1,
}
var StructuredQuery_CompositeFilter_Operator_name = map[int32]string{
    0:  "OPERATOR_UNSPECIFIED",
    1:  "AND",
}
var StructuredQuery_CompositeFilter_Operator_value = map[string]int32{
    "OPERATOR_UNSPECIFIED": 0,
    "AND":                  1,
}
var StructuredQuery_Direction_name = map[int32]string{
    0:  "DIRECTION_UNSPECIFIED",
    1:  "ASCENDING",
    2:  "DESCENDING",
}
var StructuredQuery_Direction_value = map[string]int32{
    "DIRECTION_UNSPECIFIED": 0,
    "ASCENDING":             1,
    "DESCENDING":            2,
}
var StructuredQuery_FieldFilter_Operator_name = map[int32]string{
    0:  "OPERATOR_UNSPECIFIED",
    1:  "LESS_THAN",
    2:  "LESS_THAN_OR_EQUAL",
    3:  "GREATER_THAN",
    4:  "GREATER_THAN_OR_EQUAL",
    5:  "EQUAL",
    7:  "ARRAY_CONTAINS",
    8:  "IN",
    9:  "ARRAY_CONTAINS_ANY",
}
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,
    "ARRAY_CONTAINS":        7,
    "IN":                    8,
    "ARRAY_CONTAINS_ANY":    9,
}
var StructuredQuery_UnaryFilter_Operator_name = map[int32]string{
    0:  "OPERATOR_UNSPECIFIED",
    2:  "IS_NAN",
    3:  "IS_NULL",
}
var StructuredQuery_UnaryFilter_Operator_value = map[string]int32{
    "OPERATOR_UNSPECIFIED": 0,
    "IS_NAN":               2,
    "IS_NULL":              3,
}
var TargetChange_TargetChangeType_name = map[int32]string{
    0:  "NO_CHANGE",
    1:  "ADD",
    2:  "REMOVE",
    3:  "CURRENT",
    4:  "RESET",
}
var TargetChange_TargetChangeType_value = map[string]int32{
    "NO_CHANGE": 0,
    "ADD":       1,
    "REMOVE":    2,
    "CURRENT":   3,
    "RESET":     4,
}

func RegisterFirestoreServer Uses

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

type ArrayValue Uses

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

An array value.

func (*ArrayValue) Descriptor Uses

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

func (*ArrayValue) GetValues Uses

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

func (*ArrayValue) ProtoMessage Uses

func (*ArrayValue) ProtoMessage()

func (*ArrayValue) Reset Uses

func (m *ArrayValue) Reset()

func (*ArrayValue) String Uses

func (m *ArrayValue) String() string

func (*ArrayValue) XXX_DiscardUnknown Uses

func (m *ArrayValue) XXX_DiscardUnknown()

func (*ArrayValue) XXX_Marshal Uses

func (m *ArrayValue) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ArrayValue) XXX_Merge Uses

func (m *ArrayValue) XXX_Merge(src proto.Message)

func (*ArrayValue) XXX_Size Uses

func (m *ArrayValue) XXX_Size() int

func (*ArrayValue) XXX_Unmarshal Uses

func (m *ArrayValue) XXX_Unmarshal(b []byte) error

type BatchGetDocumentsRequest Uses

type BatchGetDocumentsRequest struct {
    // Required. The database name. In the format:
    // `projects/{project_id}/databases/{database_id}`.
    Database string `protobuf:"bytes,1,opt,name=database,proto3" json:"database,omitempty"`
    // The names of the documents to retrieve. In the format:
    // `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
    // The request will fail if any of the document is not a child resource of the
    // given `database`. Duplicate names will be elided.
    Documents []string `protobuf:"bytes,2,rep,name=documents,proto3" json:"documents,omitempty"`
    // The fields to return. If not set, returns all fields.
    //
    // If a document has a field that is not present in this mask, that field will
    // not be returned in the response.
    Mask *DocumentMask `protobuf:"bytes,3,opt,name=mask,proto3" json:"mask,omitempty"`
    // The consistency mode for this transaction.
    // If not set, defaults to strong consistency.
    //
    // Types that are valid to be assigned to ConsistencySelector:
    //	*BatchGetDocumentsRequest_Transaction
    //	*BatchGetDocumentsRequest_NewTransaction
    //	*BatchGetDocumentsRequest_ReadTime
    ConsistencySelector  isBatchGetDocumentsRequest_ConsistencySelector `protobuf_oneof:"consistency_selector"`
    XXX_NoUnkeyedLiteral struct{}                                       `json:"-"`
    XXX_unrecognized     []byte                                         `json:"-"`
    XXX_sizecache        int32                                          `json:"-"`
}

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

func (*BatchGetDocumentsRequest) Descriptor Uses

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

func (*BatchGetDocumentsRequest) GetConsistencySelector Uses

func (m *BatchGetDocumentsRequest) GetConsistencySelector() isBatchGetDocumentsRequest_ConsistencySelector

func (*BatchGetDocumentsRequest) GetDatabase Uses

func (m *BatchGetDocumentsRequest) GetDatabase() string

func (*BatchGetDocumentsRequest) GetDocuments Uses

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

func (*BatchGetDocumentsRequest) GetMask Uses

func (m *BatchGetDocumentsRequest) GetMask() *DocumentMask

func (*BatchGetDocumentsRequest) GetNewTransaction Uses

func (m *BatchGetDocumentsRequest) GetNewTransaction() *TransactionOptions

func (*BatchGetDocumentsRequest) GetReadTime Uses

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

func (*BatchGetDocumentsRequest) GetTransaction Uses

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

func (*BatchGetDocumentsRequest) ProtoMessage Uses

func (*BatchGetDocumentsRequest) ProtoMessage()

func (*BatchGetDocumentsRequest) Reset Uses

func (m *BatchGetDocumentsRequest) Reset()

func (*BatchGetDocumentsRequest) String Uses

func (m *BatchGetDocumentsRequest) String() string

func (*BatchGetDocumentsRequest) XXX_DiscardUnknown Uses

func (m *BatchGetDocumentsRequest) XXX_DiscardUnknown()

func (*BatchGetDocumentsRequest) XXX_Marshal Uses

func (m *BatchGetDocumentsRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*BatchGetDocumentsRequest) XXX_Merge Uses

func (m *BatchGetDocumentsRequest) XXX_Merge(src proto.Message)

func (*BatchGetDocumentsRequest) XXX_OneofWrappers Uses

func (*BatchGetDocumentsRequest) XXX_OneofWrappers() []interface{}

XXX_OneofWrappers is for the internal use of the proto package.

func (*BatchGetDocumentsRequest) XXX_Size Uses

func (m *BatchGetDocumentsRequest) XXX_Size() int

func (*BatchGetDocumentsRequest) XXX_Unmarshal Uses

func (m *BatchGetDocumentsRequest) XXX_Unmarshal(b []byte) error

type BatchGetDocumentsRequest_NewTransaction Uses

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

type BatchGetDocumentsRequest_ReadTime Uses

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

type BatchGetDocumentsRequest_Transaction Uses

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

type BatchGetDocumentsResponse Uses

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.v1.BatchGetDocumentsRequest.new_transaction] was set in the request.
    Transaction []byte `protobuf:"bytes,3,opt,name=transaction,proto3" json:"transaction,omitempty"`
    // The time at which the document was read.
    // This may be monotically increasing, in this case the previous documents in
    // the result stream are guaranteed not to have changed between their
    // read_time and this one.
    ReadTime             *timestamp.Timestamp `protobuf:"bytes,4,opt,name=read_time,json=readTime,proto3" json:"read_time,omitempty"`
    XXX_NoUnkeyedLiteral struct{}             `json:"-"`
    XXX_unrecognized     []byte               `json:"-"`
    XXX_sizecache        int32                `json:"-"`
}

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

func (*BatchGetDocumentsResponse) Descriptor Uses

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

func (*BatchGetDocumentsResponse) GetFound Uses

func (m *BatchGetDocumentsResponse) GetFound() *Document

func (*BatchGetDocumentsResponse) GetMissing Uses

func (m *BatchGetDocumentsResponse) GetMissing() string

func (*BatchGetDocumentsResponse) GetReadTime Uses

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

func (*BatchGetDocumentsResponse) GetResult Uses

func (m *BatchGetDocumentsResponse) GetResult() isBatchGetDocumentsResponse_Result

func (*BatchGetDocumentsResponse) GetTransaction Uses

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

func (*BatchGetDocumentsResponse) ProtoMessage Uses

func (*BatchGetDocumentsResponse) ProtoMessage()

func (*BatchGetDocumentsResponse) Reset Uses

func (m *BatchGetDocumentsResponse) Reset()

func (*BatchGetDocumentsResponse) String Uses

func (m *BatchGetDocumentsResponse) String() string

func (*BatchGetDocumentsResponse) XXX_DiscardUnknown Uses

func (m *BatchGetDocumentsResponse) XXX_DiscardUnknown()

func (*BatchGetDocumentsResponse) XXX_Marshal Uses

func (m *BatchGetDocumentsResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*BatchGetDocumentsResponse) XXX_Merge Uses

func (m *BatchGetDocumentsResponse) XXX_Merge(src proto.Message)

func (*BatchGetDocumentsResponse) XXX_OneofWrappers Uses

func (*BatchGetDocumentsResponse) XXX_OneofWrappers() []interface{}

XXX_OneofWrappers is for the internal use of the proto package.

func (*BatchGetDocumentsResponse) XXX_Size Uses

func (m *BatchGetDocumentsResponse) XXX_Size() int

func (*BatchGetDocumentsResponse) XXX_Unmarshal Uses

func (m *BatchGetDocumentsResponse) XXX_Unmarshal(b []byte) error

type BatchGetDocumentsResponse_Found Uses

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

type BatchGetDocumentsResponse_Missing Uses

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

type BeginTransactionRequest Uses

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

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

func (*BeginTransactionRequest) Descriptor Uses

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

func (*BeginTransactionRequest) GetDatabase Uses

func (m *BeginTransactionRequest) GetDatabase() string

func (*BeginTransactionRequest) GetOptions Uses

func (m *BeginTransactionRequest) GetOptions() *TransactionOptions

func (*BeginTransactionRequest) ProtoMessage Uses

func (*BeginTransactionRequest) ProtoMessage()

func (*BeginTransactionRequest) Reset Uses

func (m *BeginTransactionRequest) Reset()

func (*BeginTransactionRequest) String Uses

func (m *BeginTransactionRequest) String() string

func (*BeginTransactionRequest) XXX_DiscardUnknown Uses

func (m *BeginTransactionRequest) XXX_DiscardUnknown()

func (*BeginTransactionRequest) XXX_Marshal Uses

func (m *BeginTransactionRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*BeginTransactionRequest) XXX_Merge Uses

func (m *BeginTransactionRequest) XXX_Merge(src proto.Message)

func (*BeginTransactionRequest) XXX_Size Uses

func (m *BeginTransactionRequest) XXX_Size() int

func (*BeginTransactionRequest) XXX_Unmarshal Uses

func (m *BeginTransactionRequest) XXX_Unmarshal(b []byte) error

type BeginTransactionResponse Uses

type BeginTransactionResponse struct {
    // The transaction that was started.
    Transaction          []byte   `protobuf:"bytes,1,opt,name=transaction,proto3" json:"transaction,omitempty"`
    XXX_NoUnkeyedLiteral struct{} `json:"-"`
    XXX_unrecognized     []byte   `json:"-"`
    XXX_sizecache        int32    `json:"-"`
}

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

func (*BeginTransactionResponse) Descriptor Uses

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

func (*BeginTransactionResponse) GetTransaction Uses

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

func (*BeginTransactionResponse) ProtoMessage Uses

func (*BeginTransactionResponse) ProtoMessage()

func (*BeginTransactionResponse) Reset Uses

func (m *BeginTransactionResponse) Reset()

func (*BeginTransactionResponse) String Uses

func (m *BeginTransactionResponse) String() string

func (*BeginTransactionResponse) XXX_DiscardUnknown Uses

func (m *BeginTransactionResponse) XXX_DiscardUnknown()

func (*BeginTransactionResponse) XXX_Marshal Uses

func (m *BeginTransactionResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*BeginTransactionResponse) XXX_Merge Uses

func (m *BeginTransactionResponse) XXX_Merge(src proto.Message)

func (*BeginTransactionResponse) XXX_Size Uses

func (m *BeginTransactionResponse) XXX_Size() int

func (*BeginTransactionResponse) XXX_Unmarshal Uses

func (m *BeginTransactionResponse) XXX_Unmarshal(b []byte) error

type CommitRequest Uses

type CommitRequest struct {
    // Required. The database name. In the format:
    // `projects/{project_id}/databases/{database_id}`.
    Database string `protobuf:"bytes,1,opt,name=database,proto3" json:"database,omitempty"`
    // The writes to apply.
    //
    // Always executed atomically and in order.
    Writes []*Write `protobuf:"bytes,2,rep,name=writes,proto3" json:"writes,omitempty"`
    // If set, applies all writes in this transaction, and commits it.
    Transaction          []byte   `protobuf:"bytes,3,opt,name=transaction,proto3" json:"transaction,omitempty"`
    XXX_NoUnkeyedLiteral struct{} `json:"-"`
    XXX_unrecognized     []byte   `json:"-"`
    XXX_sizecache        int32    `json:"-"`
}

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

func (*CommitRequest) Descriptor Uses

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

func (*CommitRequest) GetDatabase Uses

func (m *CommitRequest) GetDatabase() string

func (*CommitRequest) GetTransaction Uses

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

func (*CommitRequest) GetWrites Uses

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

func (*CommitRequest) ProtoMessage Uses

func (*CommitRequest) ProtoMessage()

func (*CommitRequest) Reset Uses

func (m *CommitRequest) Reset()

func (*CommitRequest) String Uses

func (m *CommitRequest) String() string

func (*CommitRequest) XXX_DiscardUnknown Uses

func (m *CommitRequest) XXX_DiscardUnknown()

func (*CommitRequest) XXX_Marshal Uses

func (m *CommitRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*CommitRequest) XXX_Merge Uses

func (m *CommitRequest) XXX_Merge(src proto.Message)

func (*CommitRequest) XXX_Size Uses

func (m *CommitRequest) XXX_Size() int

func (*CommitRequest) XXX_Unmarshal Uses

func (m *CommitRequest) XXX_Unmarshal(b []byte) error

type CommitResponse Uses

type CommitResponse struct {
    // The result of applying the writes.
    //
    // This i-th write result corresponds to the i-th write in the
    // request.
    WriteResults []*WriteResult `protobuf:"bytes,1,rep,name=write_results,json=writeResults,proto3" json:"write_results,omitempty"`
    // The time at which the commit occurred.
    CommitTime           *timestamp.Timestamp `protobuf:"bytes,2,opt,name=commit_time,json=commitTime,proto3" json:"commit_time,omitempty"`
    XXX_NoUnkeyedLiteral struct{}             `json:"-"`
    XXX_unrecognized     []byte               `json:"-"`
    XXX_sizecache        int32                `json:"-"`
}

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

func (*CommitResponse) Descriptor Uses

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

func (*CommitResponse) GetCommitTime Uses

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

func (*CommitResponse) GetWriteResults Uses

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

func (*CommitResponse) ProtoMessage Uses

func (*CommitResponse) ProtoMessage()

func (*CommitResponse) Reset Uses

func (m *CommitResponse) Reset()

func (*CommitResponse) String Uses

func (m *CommitResponse) String() string

func (*CommitResponse) XXX_DiscardUnknown Uses

func (m *CommitResponse) XXX_DiscardUnknown()

func (*CommitResponse) XXX_Marshal Uses

func (m *CommitResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*CommitResponse) XXX_Merge Uses

func (m *CommitResponse) XXX_Merge(src proto.Message)

func (*CommitResponse) XXX_Size Uses

func (m *CommitResponse) XXX_Size() int

func (*CommitResponse) XXX_Unmarshal Uses

func (m *CommitResponse) XXX_Unmarshal(b []byte) error

type CreateDocumentRequest Uses

type CreateDocumentRequest struct {
    // Required. The parent resource. For example:
    // `projects/{project_id}/databases/{database_id}/documents` or
    // `projects/{project_id}/databases/{database_id}/documents/chatrooms/{chatroom_id}`
    Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
    // Required. The collection ID, relative to `parent`, to list. For example: `chatrooms`.
    CollectionId string `protobuf:"bytes,2,opt,name=collection_id,json=collectionId,proto3" json:"collection_id,omitempty"`
    // The client-assigned document ID to use for this document.
    //
    // Optional. If not specified, an ID will be assigned by the service.
    DocumentId string `protobuf:"bytes,3,opt,name=document_id,json=documentId,proto3" json:"document_id,omitempty"`
    // Required. The document to create. `name` must not be set.
    Document *Document `protobuf:"bytes,4,opt,name=document,proto3" json:"document,omitempty"`
    // The fields to return. If not set, returns all fields.
    //
    // If the document has a field that is not present in this mask, that field
    // will not be returned in the response.
    Mask                 *DocumentMask `protobuf:"bytes,5,opt,name=mask,proto3" json:"mask,omitempty"`
    XXX_NoUnkeyedLiteral struct{}      `json:"-"`
    XXX_unrecognized     []byte        `json:"-"`
    XXX_sizecache        int32         `json:"-"`
}

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

func (*CreateDocumentRequest) Descriptor Uses

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

func (*CreateDocumentRequest) GetCollectionId Uses

func (m *CreateDocumentRequest) GetCollectionId() string

func (*CreateDocumentRequest) GetDocument Uses

func (m *CreateDocumentRequest) GetDocument() *Document

func (*CreateDocumentRequest) GetDocumentId Uses

func (m *CreateDocumentRequest) GetDocumentId() string

func (*CreateDocumentRequest) GetMask Uses

func (m *CreateDocumentRequest) GetMask() *DocumentMask

func (*CreateDocumentRequest) GetParent Uses

func (m *CreateDocumentRequest) GetParent() string

func (*CreateDocumentRequest) ProtoMessage Uses

func (*CreateDocumentRequest) ProtoMessage()

func (*CreateDocumentRequest) Reset Uses

func (m *CreateDocumentRequest) Reset()

func (*CreateDocumentRequest) String Uses

func (m *CreateDocumentRequest) String() string

func (*CreateDocumentRequest) XXX_DiscardUnknown Uses

func (m *CreateDocumentRequest) XXX_DiscardUnknown()

func (*CreateDocumentRequest) XXX_Marshal Uses

func (m *CreateDocumentRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*CreateDocumentRequest) XXX_Merge Uses

func (m *CreateDocumentRequest) XXX_Merge(src proto.Message)

func (*CreateDocumentRequest) XXX_Size Uses

func (m *CreateDocumentRequest) XXX_Size() int

func (*CreateDocumentRequest) XXX_Unmarshal Uses

func (m *CreateDocumentRequest) XXX_Unmarshal(b []byte) error

type Cursor Uses

type Cursor struct {
    // The values that represent a position, in the order they appear in
    // the order by clause of a query.
    //
    // Can contain fewer values than specified in the order by clause.
    Values []*Value `protobuf:"bytes,1,rep,name=values,proto3" json:"values,omitempty"`
    // If the position is just before or just after the given values, relative
    // to the sort order defined by the query.
    Before               bool     `protobuf:"varint,2,opt,name=before,proto3" json:"before,omitempty"`
    XXX_NoUnkeyedLiteral struct{} `json:"-"`
    XXX_unrecognized     []byte   `json:"-"`
    XXX_sizecache        int32    `json:"-"`
}

A position in a query result set.

func (*Cursor) Descriptor Uses

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

func (*Cursor) GetBefore Uses

func (m *Cursor) GetBefore() bool

func (*Cursor) GetValues Uses

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

func (*Cursor) ProtoMessage Uses

func (*Cursor) ProtoMessage()

func (*Cursor) Reset Uses

func (m *Cursor) Reset()

func (*Cursor) String Uses

func (m *Cursor) String() string

func (*Cursor) XXX_DiscardUnknown Uses

func (m *Cursor) XXX_DiscardUnknown()

func (*Cursor) XXX_Marshal Uses

func (m *Cursor) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Cursor) XXX_Merge Uses

func (m *Cursor) XXX_Merge(src proto.Message)

func (*Cursor) XXX_Size Uses

func (m *Cursor) XXX_Size() int

func (*Cursor) XXX_Unmarshal Uses

func (m *Cursor) XXX_Unmarshal(b []byte) error

type DeleteDocumentRequest Uses

type DeleteDocumentRequest struct {
    // Required. The resource name of the Document to delete. In the format:
    // `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
    Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
    // An optional precondition on the document.
    // The request will fail if this is set and not met by the target document.
    CurrentDocument      *Precondition `protobuf:"bytes,2,opt,name=current_document,json=currentDocument,proto3" json:"current_document,omitempty"`
    XXX_NoUnkeyedLiteral struct{}      `json:"-"`
    XXX_unrecognized     []byte        `json:"-"`
    XXX_sizecache        int32         `json:"-"`
}

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

func (*DeleteDocumentRequest) Descriptor Uses

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

func (*DeleteDocumentRequest) GetCurrentDocument Uses

func (m *DeleteDocumentRequest) GetCurrentDocument() *Precondition

func (*DeleteDocumentRequest) GetName Uses

func (m *DeleteDocumentRequest) GetName() string

func (*DeleteDocumentRequest) ProtoMessage Uses

func (*DeleteDocumentRequest) ProtoMessage()

func (*DeleteDocumentRequest) Reset Uses

func (m *DeleteDocumentRequest) Reset()

func (*DeleteDocumentRequest) String Uses

func (m *DeleteDocumentRequest) String() string

func (*DeleteDocumentRequest) XXX_DiscardUnknown Uses

func (m *DeleteDocumentRequest) XXX_DiscardUnknown()

func (*DeleteDocumentRequest) XXX_Marshal Uses

func (m *DeleteDocumentRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*DeleteDocumentRequest) XXX_Merge Uses

func (m *DeleteDocumentRequest) XXX_Merge(src proto.Message)

func (*DeleteDocumentRequest) XXX_Size Uses

func (m *DeleteDocumentRequest) XXX_Size() int

func (*DeleteDocumentRequest) XXX_Unmarshal Uses

func (m *DeleteDocumentRequest) XXX_Unmarshal(b []byte) error

type Document Uses

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

A Firestore document.

Must not exceed 1 MiB - 4 bytes.

func (*Document) Descriptor Uses

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

func (*Document) GetCreateTime Uses

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

func (*Document) GetFields Uses

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

func (*Document) GetName Uses

func (m *Document) GetName() string

func (*Document) GetUpdateTime Uses

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

func (*Document) ProtoMessage Uses

func (*Document) ProtoMessage()

func (*Document) Reset Uses

func (m *Document) Reset()

func (*Document) String Uses

func (m *Document) String() string

func (*Document) XXX_DiscardUnknown Uses

func (m *Document) XXX_DiscardUnknown()

func (*Document) XXX_Marshal Uses

func (m *Document) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Document) XXX_Merge Uses

func (m *Document) XXX_Merge(src proto.Message)

func (*Document) XXX_Size Uses

func (m *Document) XXX_Size() int

func (*Document) XXX_Unmarshal Uses

func (m *Document) XXX_Unmarshal(b []byte) error

type DocumentChange Uses

type DocumentChange struct {
    // The new state of the [Document][google.firestore.v1.Document].
    //
    // If `mask` is set, contains only fields that were updated or added.
    Document *Document `protobuf:"bytes,1,opt,name=document,proto3" json:"document,omitempty"`
    // A set of target IDs of targets that match this document.
    TargetIds []int32 `protobuf:"varint,5,rep,packed,name=target_ids,json=targetIds,proto3" json:"target_ids,omitempty"`
    // A set of target IDs for targets that no longer match this document.
    RemovedTargetIds     []int32  `protobuf:"varint,6,rep,packed,name=removed_target_ids,json=removedTargetIds,proto3" json:"removed_target_ids,omitempty"`
    XXX_NoUnkeyedLiteral struct{} `json:"-"`
    XXX_unrecognized     []byte   `json:"-"`
    XXX_sizecache        int32    `json:"-"`
}

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

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

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

func (*DocumentChange) Descriptor Uses

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

func (*DocumentChange) GetDocument Uses

func (m *DocumentChange) GetDocument() *Document

func (*DocumentChange) GetRemovedTargetIds Uses

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

func (*DocumentChange) GetTargetIds Uses

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

func (*DocumentChange) ProtoMessage Uses

func (*DocumentChange) ProtoMessage()

func (*DocumentChange) Reset Uses

func (m *DocumentChange) Reset()

func (*DocumentChange) String Uses

func (m *DocumentChange) String() string

func (*DocumentChange) XXX_DiscardUnknown Uses

func (m *DocumentChange) XXX_DiscardUnknown()

func (*DocumentChange) XXX_Marshal Uses

func (m *DocumentChange) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*DocumentChange) XXX_Merge Uses

func (m *DocumentChange) XXX_Merge(src proto.Message)

func (*DocumentChange) XXX_Size Uses

func (m *DocumentChange) XXX_Size() int

func (*DocumentChange) XXX_Unmarshal Uses

func (m *DocumentChange) XXX_Unmarshal(b []byte) error

type DocumentDelete Uses

type DocumentDelete struct {
    // The resource name of the [Document][google.firestore.v1.Document] that was deleted.
    Document string `protobuf:"bytes,1,opt,name=document,proto3" json:"document,omitempty"`
    // A set of target IDs for targets that previously matched this entity.
    RemovedTargetIds []int32 `protobuf:"varint,6,rep,packed,name=removed_target_ids,json=removedTargetIds,proto3" json:"removed_target_ids,omitempty"`
    // The read timestamp at which the delete was observed.
    //
    // Greater or equal to the `commit_time` of the delete.
    ReadTime             *timestamp.Timestamp `protobuf:"bytes,4,opt,name=read_time,json=readTime,proto3" json:"read_time,omitempty"`
    XXX_NoUnkeyedLiteral struct{}             `json:"-"`
    XXX_unrecognized     []byte               `json:"-"`
    XXX_sizecache        int32                `json:"-"`
}

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

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

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

func (*DocumentDelete) Descriptor Uses

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

func (*DocumentDelete) GetDocument Uses

func (m *DocumentDelete) GetDocument() string

func (*DocumentDelete) GetReadTime Uses

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

func (*DocumentDelete) GetRemovedTargetIds Uses

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

func (*DocumentDelete) ProtoMessage Uses

func (*DocumentDelete) ProtoMessage()

func (*DocumentDelete) Reset Uses

func (m *DocumentDelete) Reset()

func (*DocumentDelete) String Uses

func (m *DocumentDelete) String() string

func (*DocumentDelete) XXX_DiscardUnknown Uses

func (m *DocumentDelete) XXX_DiscardUnknown()

func (*DocumentDelete) XXX_Marshal Uses

func (m *DocumentDelete) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*DocumentDelete) XXX_Merge Uses

func (m *DocumentDelete) XXX_Merge(src proto.Message)

func (*DocumentDelete) XXX_Size Uses

func (m *DocumentDelete) XXX_Size() int

func (*DocumentDelete) XXX_Unmarshal Uses

func (m *DocumentDelete) XXX_Unmarshal(b []byte) error

type DocumentMask Uses

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

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

func (*DocumentMask) Descriptor Uses

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

func (*DocumentMask) GetFieldPaths Uses

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

func (*DocumentMask) ProtoMessage Uses

func (*DocumentMask) ProtoMessage()

func (*DocumentMask) Reset Uses

func (m *DocumentMask) Reset()

func (*DocumentMask) String Uses

func (m *DocumentMask) String() string

func (*DocumentMask) XXX_DiscardUnknown Uses

func (m *DocumentMask) XXX_DiscardUnknown()

func (*DocumentMask) XXX_Marshal Uses

func (m *DocumentMask) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*DocumentMask) XXX_Merge Uses

func (m *DocumentMask) XXX_Merge(src proto.Message)

func (*DocumentMask) XXX_Size Uses

func (m *DocumentMask) XXX_Size() int

func (*DocumentMask) XXX_Unmarshal Uses

func (m *DocumentMask) XXX_Unmarshal(b []byte) error

type DocumentRemove Uses

type DocumentRemove struct {
    // The resource name of the [Document][google.firestore.v1.Document] that has gone out of view.
    Document string `protobuf:"bytes,1,opt,name=document,proto3" json:"document,omitempty"`
    // A set of target IDs for targets that previously matched this document.
    RemovedTargetIds []int32 `protobuf:"varint,2,rep,packed,name=removed_target_ids,json=removedTargetIds,proto3" json:"removed_target_ids,omitempty"`
    // The read timestamp at which the remove was observed.
    //
    // Greater or equal to the `commit_time` of the change/delete/remove.
    ReadTime             *timestamp.Timestamp `protobuf:"bytes,4,opt,name=read_time,json=readTime,proto3" json:"read_time,omitempty"`
    XXX_NoUnkeyedLiteral struct{}             `json:"-"`
    XXX_unrecognized     []byte               `json:"-"`
    XXX_sizecache        int32                `json:"-"`
}

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

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

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

func (*DocumentRemove) Descriptor Uses

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

func (*DocumentRemove) GetDocument Uses

func (m *DocumentRemove) GetDocument() string

func (*DocumentRemove) GetReadTime Uses

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

func (*DocumentRemove) GetRemovedTargetIds Uses

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

func (*DocumentRemove) ProtoMessage Uses

func (*DocumentRemove) ProtoMessage()

func (*DocumentRemove) Reset Uses

func (m *DocumentRemove) Reset()

func (*DocumentRemove) String Uses

func (m *DocumentRemove) String() string

func (*DocumentRemove) XXX_DiscardUnknown Uses

func (m *DocumentRemove) XXX_DiscardUnknown()

func (*DocumentRemove) XXX_Marshal Uses

func (m *DocumentRemove) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*DocumentRemove) XXX_Merge Uses

func (m *DocumentRemove) XXX_Merge(src proto.Message)

func (*DocumentRemove) XXX_Size Uses

func (m *DocumentRemove) XXX_Size() int

func (*DocumentRemove) XXX_Unmarshal Uses

func (m *DocumentRemove) XXX_Unmarshal(b []byte) error

type DocumentTransform Uses

type DocumentTransform struct {
    // The name of the document to transform.
    Document string `protobuf:"bytes,1,opt,name=document,proto3" json:"document,omitempty"`
    // The list of transformations to apply to the fields of the document, in
    // order.
    // This must not be empty.
    FieldTransforms      []*DocumentTransform_FieldTransform `protobuf:"bytes,2,rep,name=field_transforms,json=fieldTransforms,proto3" json:"field_transforms,omitempty"`
    XXX_NoUnkeyedLiteral struct{}                            `json:"-"`
    XXX_unrecognized     []byte                              `json:"-"`
    XXX_sizecache        int32                               `json:"-"`
}

A transformation of a document.

func (*DocumentTransform) Descriptor Uses

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

func (*DocumentTransform) GetDocument Uses

func (m *DocumentTransform) GetDocument() string

func (*DocumentTransform) GetFieldTransforms Uses

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

func (*DocumentTransform) ProtoMessage Uses

func (*DocumentTransform) ProtoMessage()

func (*DocumentTransform) Reset Uses

func (m *DocumentTransform) Reset()

func (*DocumentTransform) String Uses

func (m *DocumentTransform) String() string

func (*DocumentTransform) XXX_DiscardUnknown Uses

func (m *DocumentTransform) XXX_DiscardUnknown()

func (*DocumentTransform) XXX_Marshal Uses

func (m *DocumentTransform) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*DocumentTransform) XXX_Merge Uses

func (m *DocumentTransform) XXX_Merge(src proto.Message)

func (*DocumentTransform) XXX_Size Uses

func (m *DocumentTransform) XXX_Size() int

func (*DocumentTransform) XXX_Unmarshal Uses

func (m *DocumentTransform) XXX_Unmarshal(b []byte) error

type DocumentTransform_FieldTransform Uses

type DocumentTransform_FieldTransform struct {
    // The path of the field. See [Document.fields][google.firestore.v1.Document.fields] for the field path syntax
    // reference.
    FieldPath string `protobuf:"bytes,1,opt,name=field_path,json=fieldPath,proto3" json:"field_path,omitempty"`
    // The transformation to apply on the field.
    //
    // Types that are valid to be assigned to TransformType:
    //	*DocumentTransform_FieldTransform_SetToServerValue
    //	*DocumentTransform_FieldTransform_Increment
    //	*DocumentTransform_FieldTransform_Maximum
    //	*DocumentTransform_FieldTransform_Minimum
    //	*DocumentTransform_FieldTransform_AppendMissingElements
    //	*DocumentTransform_FieldTransform_RemoveAllFromArray
    TransformType        isDocumentTransform_FieldTransform_TransformType `protobuf_oneof:"transform_type"`
    XXX_NoUnkeyedLiteral struct{}                                         `json:"-"`
    XXX_unrecognized     []byte                                           `json:"-"`
    XXX_sizecache        int32                                            `json:"-"`
}

A transformation of a field of the document.

func (*DocumentTransform_FieldTransform) Descriptor Uses

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

func (*DocumentTransform_FieldTransform) GetAppendMissingElements Uses

func (m *DocumentTransform_FieldTransform) GetAppendMissingElements() *ArrayValue

func (*DocumentTransform_FieldTransform) GetFieldPath Uses

func (m *DocumentTransform_FieldTransform) GetFieldPath() string

func (*DocumentTransform_FieldTransform) GetIncrement Uses

func (m *DocumentTransform_FieldTransform) GetIncrement() *Value

func (*DocumentTransform_FieldTransform) GetMaximum Uses

func (m *DocumentTransform_FieldTransform) GetMaximum() *Value

func (*DocumentTransform_FieldTransform) GetMinimum Uses

func (m *DocumentTransform_FieldTransform) GetMinimum() *Value

func (*DocumentTransform_FieldTransform) GetRemoveAllFromArray Uses

func (m *DocumentTransform_FieldTransform) GetRemoveAllFromArray() *ArrayValue

func (*DocumentTransform_FieldTransform) GetSetToServerValue Uses

func (m *DocumentTransform_FieldTransform) GetSetToServerValue() DocumentTransform_FieldTransform_ServerValue

func (*DocumentTransform_FieldTransform) GetTransformType Uses

func (m *DocumentTransform_FieldTransform) GetTransformType() isDocumentTransform_FieldTransform_TransformType

func (*DocumentTransform_FieldTransform) ProtoMessage Uses

func (*DocumentTransform_FieldTransform) ProtoMessage()

func (*DocumentTransform_FieldTransform) Reset Uses

func (m *DocumentTransform_FieldTransform) Reset()

func (*DocumentTransform_FieldTransform) String Uses

func (m *DocumentTransform_FieldTransform) String() string

func (*DocumentTransform_FieldTransform) XXX_DiscardUnknown Uses

func (m *DocumentTransform_FieldTransform) XXX_DiscardUnknown()

func (*DocumentTransform_FieldTransform) XXX_Marshal Uses

func (m *DocumentTransform_FieldTransform) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*DocumentTransform_FieldTransform) XXX_Merge Uses

func (m *DocumentTransform_FieldTransform) XXX_Merge(src proto.Message)

func (*DocumentTransform_FieldTransform) XXX_OneofWrappers Uses

func (*DocumentTransform_FieldTransform) XXX_OneofWrappers() []interface{}

XXX_OneofWrappers is for the internal use of the proto package.

func (*DocumentTransform_FieldTransform) XXX_Size Uses

func (m *DocumentTransform_FieldTransform) XXX_Size() int

func (*DocumentTransform_FieldTransform) XXX_Unmarshal Uses

func (m *DocumentTransform_FieldTransform) XXX_Unmarshal(b []byte) error

type DocumentTransform_FieldTransform_AppendMissingElements Uses

type DocumentTransform_FieldTransform_AppendMissingElements struct {
    AppendMissingElements *ArrayValue `protobuf:"bytes,6,opt,name=append_missing_elements,json=appendMissingElements,proto3,oneof"`
}

type DocumentTransform_FieldTransform_Increment Uses

type DocumentTransform_FieldTransform_Increment struct {
    Increment *Value `protobuf:"bytes,3,opt,name=increment,proto3,oneof"`
}

type DocumentTransform_FieldTransform_Maximum Uses

type DocumentTransform_FieldTransform_Maximum struct {
    Maximum *Value `protobuf:"bytes,4,opt,name=maximum,proto3,oneof"`
}

type DocumentTransform_FieldTransform_Minimum Uses

type DocumentTransform_FieldTransform_Minimum struct {
    Minimum *Value `protobuf:"bytes,5,opt,name=minimum,proto3,oneof"`
}

type DocumentTransform_FieldTransform_RemoveAllFromArray Uses

type DocumentTransform_FieldTransform_RemoveAllFromArray struct {
    RemoveAllFromArray *ArrayValue `protobuf:"bytes,7,opt,name=remove_all_from_array,json=removeAllFromArray,proto3,oneof"`
}

type DocumentTransform_FieldTransform_ServerValue Uses

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 Uses

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

func (DocumentTransform_FieldTransform_ServerValue) String Uses

func (x DocumentTransform_FieldTransform_ServerValue) String() string

type DocumentTransform_FieldTransform_SetToServerValue Uses

type DocumentTransform_FieldTransform_SetToServerValue struct {
    SetToServerValue DocumentTransform_FieldTransform_ServerValue `protobuf:"varint,2,opt,name=set_to_server_value,json=setToServerValue,proto3,enum=google.firestore.v1.DocumentTransform_FieldTransform_ServerValue,oneof"`
}

type ExistenceFilter Uses

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

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

func (*ExistenceFilter) Descriptor Uses

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

func (*ExistenceFilter) GetCount Uses

func (m *ExistenceFilter) GetCount() int32

func (*ExistenceFilter) GetTargetId Uses

func (m *ExistenceFilter) GetTargetId() int32

func (*ExistenceFilter) ProtoMessage Uses

func (*ExistenceFilter) ProtoMessage()

func (*ExistenceFilter) Reset Uses

func (m *ExistenceFilter) Reset()

func (*ExistenceFilter) String Uses

func (m *ExistenceFilter) String() string

func (*ExistenceFilter) XXX_DiscardUnknown Uses

func (m *ExistenceFilter) XXX_DiscardUnknown()

func (*ExistenceFilter) XXX_Marshal Uses

func (m *ExistenceFilter) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ExistenceFilter) XXX_Merge Uses

func (m *ExistenceFilter) XXX_Merge(src proto.Message)

func (*ExistenceFilter) XXX_Size Uses

func (m *ExistenceFilter) XXX_Size() int

func (*ExistenceFilter) XXX_Unmarshal Uses

func (m *ExistenceFilter) XXX_Unmarshal(b []byte) error

type FirestoreClient Uses

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) (*empty.Empty, error)
    // Gets multiple documents.
    //
    // Documents returned by this method are not guaranteed to be returned in the
    // same order that they were requested.
    BatchGetDocuments(ctx context.Context, in *BatchGetDocumentsRequest, opts ...grpc.CallOption) (Firestore_BatchGetDocumentsClient, error)
    // Starts a new transaction.
    BeginTransaction(ctx context.Context, in *BeginTransactionRequest, opts ...grpc.CallOption) (*BeginTransactionResponse, error)
    // Commits a transaction, while optionally updating documents.
    Commit(ctx context.Context, in *CommitRequest, opts ...grpc.CallOption) (*CommitResponse, error)
    // Rolls back a transaction.
    Rollback(ctx context.Context, in *RollbackRequest, opts ...grpc.CallOption) (*empty.Empty, error)
    // Runs a query.
    RunQuery(ctx context.Context, in *RunQueryRequest, opts ...grpc.CallOption) (Firestore_RunQueryClient, error)
    // 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)
}

FirestoreClient is the client API for Firestore service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewFirestoreClient Uses

func NewFirestoreClient(cc *grpc.ClientConn) FirestoreClient

type FirestoreServer Uses

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) (*empty.Empty, error)
    // Gets multiple documents.
    //
    // Documents returned by this method are not guaranteed to be returned in the
    // same order that they were requested.
    BatchGetDocuments(*BatchGetDocumentsRequest, Firestore_BatchGetDocumentsServer) error
    // Starts a new transaction.
    BeginTransaction(context.Context, *BeginTransactionRequest) (*BeginTransactionResponse, error)
    // Commits a transaction, while optionally updating documents.
    Commit(context.Context, *CommitRequest) (*CommitResponse, error)
    // Rolls back a transaction.
    Rollback(context.Context, *RollbackRequest) (*empty.Empty, error)
    // Runs a query.
    RunQuery(*RunQueryRequest, Firestore_RunQueryServer) error
    // 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)
}

FirestoreServer is the server API for Firestore service.

type Firestore_BatchGetDocumentsClient Uses

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

type Firestore_BatchGetDocumentsServer Uses

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

type Firestore_ListenClient Uses

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

type Firestore_ListenServer Uses

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

type Firestore_RunQueryClient Uses

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

type Firestore_RunQueryServer Uses

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

type Firestore_WriteClient Uses

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

type Firestore_WriteServer Uses

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

type GetDocumentRequest Uses

type GetDocumentRequest struct {
    // Required. The resource name of the Document to get. In the format:
    // `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
    Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
    // The fields to return. If not set, returns all fields.
    //
    // If the document has a field that is not present in this mask, that field
    // will not be returned in the response.
    Mask *DocumentMask `protobuf:"bytes,2,opt,name=mask,proto3" json:"mask,omitempty"`
    // The consistency mode for this transaction.
    // If not set, defaults to strong consistency.
    //
    // Types that are valid to be assigned to ConsistencySelector:
    //	*GetDocumentRequest_Transaction
    //	*GetDocumentRequest_ReadTime
    ConsistencySelector  isGetDocumentRequest_ConsistencySelector `protobuf_oneof:"consistency_selector"`
    XXX_NoUnkeyedLiteral struct{}                                 `json:"-"`
    XXX_unrecognized     []byte                                   `json:"-"`
    XXX_sizecache        int32                                    `json:"-"`
}

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

func (*GetDocumentRequest) Descriptor Uses

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

func (*GetDocumentRequest) GetConsistencySelector Uses

func (m *GetDocumentRequest) GetConsistencySelector() isGetDocumentRequest_ConsistencySelector

func (*GetDocumentRequest) GetMask Uses

func (m *GetDocumentRequest) GetMask() *DocumentMask

func (*GetDocumentRequest) GetName Uses

func (m *GetDocumentRequest) GetName() string

func (*GetDocumentRequest) GetReadTime Uses

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

func (*GetDocumentRequest) GetTransaction Uses

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

func (*GetDocumentRequest) ProtoMessage Uses

func (*GetDocumentRequest) ProtoMessage()

func (*GetDocumentRequest) Reset Uses

func (m *GetDocumentRequest) Reset()

func (*GetDocumentRequest) String Uses

func (m *GetDocumentRequest) String() string

func (*GetDocumentRequest) XXX_DiscardUnknown Uses

func (m *GetDocumentRequest) XXX_DiscardUnknown()

func (*GetDocumentRequest) XXX_Marshal Uses

func (m *GetDocumentRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*GetDocumentRequest) XXX_Merge Uses

func (m *GetDocumentRequest) XXX_Merge(src proto.Message)

func (*GetDocumentRequest) XXX_OneofWrappers Uses

func (*GetDocumentRequest) XXX_OneofWrappers() []interface{}

XXX_OneofWrappers is for the internal use of the proto package.

func (*GetDocumentRequest) XXX_Size Uses

func (m *GetDocumentRequest) XXX_Size() int

func (*GetDocumentRequest) XXX_Unmarshal Uses

func (m *GetDocumentRequest) XXX_Unmarshal(b []byte) error

type GetDocumentRequest_ReadTime Uses

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

type GetDocumentRequest_Transaction Uses

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

type ListCollectionIdsRequest Uses

type ListCollectionIdsRequest struct {
    // Required. The parent document. In the format:
    // `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
    // For example:
    // `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`
    Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
    // The maximum number of results to return.
    PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
    // A page token. Must be a value from
    // [ListCollectionIdsResponse][google.firestore.v1.ListCollectionIdsResponse].
    PageToken            string   `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
    XXX_NoUnkeyedLiteral struct{} `json:"-"`
    XXX_unrecognized     []byte   `json:"-"`
    XXX_sizecache        int32    `json:"-"`
}

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

func (*ListCollectionIdsRequest) Descriptor Uses

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

func (*ListCollectionIdsRequest) GetPageSize Uses

func (m *ListCollectionIdsRequest) GetPageSize() int32

func (*ListCollectionIdsRequest) GetPageToken Uses

func (m *ListCollectionIdsRequest) GetPageToken() string

func (*ListCollectionIdsRequest) GetParent Uses

func (m *ListCollectionIdsRequest) GetParent() string

func (*ListCollectionIdsRequest) ProtoMessage Uses

func (*ListCollectionIdsRequest) ProtoMessage()

func (*ListCollectionIdsRequest) Reset Uses

func (m *ListCollectionIdsRequest) Reset()

func (*ListCollectionIdsRequest) String Uses

func (m *ListCollectionIdsRequest) String() string

func (*ListCollectionIdsRequest) XXX_DiscardUnknown Uses

func (m *ListCollectionIdsRequest) XXX_DiscardUnknown()

func (*ListCollectionIdsRequest) XXX_Marshal Uses

func (m *ListCollectionIdsRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ListCollectionIdsRequest) XXX_Merge Uses

func (m *ListCollectionIdsRequest) XXX_Merge(src proto.Message)

func (*ListCollectionIdsRequest) XXX_Size Uses

func (m *ListCollectionIdsRequest) XXX_Size() int

func (*ListCollectionIdsRequest) XXX_Unmarshal Uses

func (m *ListCollectionIdsRequest) XXX_Unmarshal(b []byte) error

type ListCollectionIdsResponse Uses

type ListCollectionIdsResponse struct {
    // The collection ids.
    CollectionIds []string `protobuf:"bytes,1,rep,name=collection_ids,json=collectionIds,proto3" json:"collection_ids,omitempty"`
    // A page token that may be used to continue the list.
    NextPageToken        string   `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
    XXX_NoUnkeyedLiteral struct{} `json:"-"`
    XXX_unrecognized     []byte   `json:"-"`
    XXX_sizecache        int32    `json:"-"`
}

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

func (*ListCollectionIdsResponse) Descriptor Uses

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

func (*ListCollectionIdsResponse) GetCollectionIds Uses

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

func (*ListCollectionIdsResponse) GetNextPageToken Uses

func (m *ListCollectionIdsResponse) GetNextPageToken() string

func (*ListCollectionIdsResponse) ProtoMessage Uses

func (*ListCollectionIdsResponse) ProtoMessage()

func (*ListCollectionIdsResponse) Reset Uses

func (m *ListCollectionIdsResponse) Reset()

func (*ListCollectionIdsResponse) String Uses

func (m *ListCollectionIdsResponse) String() string

func (*ListCollectionIdsResponse) XXX_DiscardUnknown Uses

func (m *ListCollectionIdsResponse) XXX_DiscardUnknown()

func (*ListCollectionIdsResponse) XXX_Marshal Uses

func (m *ListCollectionIdsResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ListCollectionIdsResponse) XXX_Merge Uses

func (m *ListCollectionIdsResponse) XXX_Merge(src proto.Message)

func (*ListCollectionIdsResponse) XXX_Size Uses

func (m *ListCollectionIdsResponse) XXX_Size() int

func (*ListCollectionIdsResponse) XXX_Unmarshal Uses

func (m *ListCollectionIdsResponse) XXX_Unmarshal(b []byte) error

type ListDocumentsRequest Uses

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

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

func (*ListDocumentsRequest) Descriptor Uses

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

func (*ListDocumentsRequest) GetCollectionId Uses

func (m *ListDocumentsRequest) GetCollectionId() string

func (*ListDocumentsRequest) GetConsistencySelector Uses

func (m *ListDocumentsRequest) GetConsistencySelector() isListDocumentsRequest_ConsistencySelector

func (*ListDocumentsRequest) GetMask Uses

func (m *ListDocumentsRequest) GetMask() *DocumentMask

func (*ListDocumentsRequest) GetOrderBy Uses

func (m *ListDocumentsRequest) GetOrderBy() string

func (*ListDocumentsRequest) GetPageSize Uses

func (m *ListDocumentsRequest) GetPageSize() int32

func (*ListDocumentsRequest) GetPageToken Uses

func (m *ListDocumentsRequest) GetPageToken() string

func (*ListDocumentsRequest) GetParent Uses

func (m *ListDocumentsRequest) GetParent() string

func (*ListDocumentsRequest) GetReadTime Uses

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

func (*ListDocumentsRequest) GetShowMissing Uses

func (m *ListDocumentsRequest) GetShowMissing() bool

func (*ListDocumentsRequest) GetTransaction Uses

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

func (*ListDocumentsRequest) ProtoMessage Uses

func (*ListDocumentsRequest) ProtoMessage()

func (*ListDocumentsRequest) Reset Uses

func (m *ListDocumentsRequest) Reset()

func (*ListDocumentsRequest) String Uses

func (m *ListDocumentsRequest) String() string

func (*ListDocumentsRequest) XXX_DiscardUnknown Uses

func (m *ListDocumentsRequest) XXX_DiscardUnknown()

func (*ListDocumentsRequest) XXX_Marshal Uses

func (m *ListDocumentsRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ListDocumentsRequest) XXX_Merge Uses

func (m *ListDocumentsRequest) XXX_Merge(src proto.Message)

func (*ListDocumentsRequest) XXX_OneofWrappers Uses

func (*ListDocumentsRequest) XXX_OneofWrappers() []interface{}

XXX_OneofWrappers is for the internal use of the proto package.

func (*ListDocumentsRequest) XXX_Size Uses

func (m *ListDocumentsRequest) XXX_Size() int

func (*ListDocumentsRequest) XXX_Unmarshal Uses

func (m *ListDocumentsRequest) XXX_Unmarshal(b []byte) error

type ListDocumentsRequest_ReadTime Uses

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

type ListDocumentsRequest_Transaction Uses

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

type ListDocumentsResponse Uses

type ListDocumentsResponse struct {
    // The Documents found.
    Documents []*Document `protobuf:"bytes,1,rep,name=documents,proto3" json:"documents,omitempty"`
    // The next page token.
    NextPageToken        string   `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
    XXX_NoUnkeyedLiteral struct{} `json:"-"`
    XXX_unrecognized     []byte   `json:"-"`
    XXX_sizecache        int32    `json:"-"`
}

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

func (*ListDocumentsResponse) Descriptor Uses

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

func (*ListDocumentsResponse) GetDocuments Uses

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

func (*ListDocumentsResponse) GetNextPageToken Uses

func (m *ListDocumentsResponse) GetNextPageToken() string

func (*ListDocumentsResponse) ProtoMessage Uses

func (*ListDocumentsResponse) ProtoMessage()

func (*ListDocumentsResponse) Reset Uses

func (m *ListDocumentsResponse) Reset()

func (*ListDocumentsResponse) String Uses

func (m *ListDocumentsResponse) String() string

func (*ListDocumentsResponse) XXX_DiscardUnknown Uses

func (m *ListDocumentsResponse) XXX_DiscardUnknown()

func (*ListDocumentsResponse) XXX_Marshal Uses

func (m *ListDocumentsResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ListDocumentsResponse) XXX_Merge Uses

func (m *ListDocumentsResponse) XXX_Merge(src proto.Message)

func (*ListDocumentsResponse) XXX_Size Uses

func (m *ListDocumentsResponse) XXX_Size() int

func (*ListDocumentsResponse) XXX_Unmarshal Uses

func (m *ListDocumentsResponse) XXX_Unmarshal(b []byte) error

type ListenRequest Uses

type ListenRequest struct {
    // Required. The database name. In the format:
    // `projects/{project_id}/databases/{database_id}`.
    Database string `protobuf:"bytes,1,opt,name=database,proto3" json:"database,omitempty"`
    // The supported target changes.
    //
    // Types that are 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 `protobuf:"bytes,4,rep,name=labels,proto3" json:"labels,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
    XXX_NoUnkeyedLiteral struct{}          `json:"-"`
    XXX_unrecognized     []byte            `json:"-"`
    XXX_sizecache        int32             `json:"-"`
}

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

func (*ListenRequest) Descriptor Uses

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

func (*ListenRequest) GetAddTarget Uses

func (m *ListenRequest) GetAddTarget() *Target

func (*ListenRequest) GetDatabase Uses

func (m *ListenRequest) GetDatabase() string

func (*ListenRequest) GetLabels Uses

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

func (*ListenRequest) GetRemoveTarget Uses

func (m *ListenRequest) GetRemoveTarget() int32

func (*ListenRequest) GetTargetChange Uses

func (m *ListenRequest) GetTargetChange() isListenRequest_TargetChange

func (*ListenRequest) ProtoMessage Uses

func (*ListenRequest) ProtoMessage()

func (*ListenRequest) Reset Uses

func (m *ListenRequest) Reset()

func (*ListenRequest) String Uses

func (m *ListenRequest) String() string

func (*ListenRequest) XXX_DiscardUnknown Uses

func (m *ListenRequest) XXX_DiscardUnknown()

func (*ListenRequest) XXX_Marshal Uses

func (m *ListenRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ListenRequest) XXX_Merge Uses

func (m *ListenRequest) XXX_Merge(src proto.Message)

func (*ListenRequest) XXX_OneofWrappers Uses

func (*ListenRequest) XXX_OneofWrappers() []interface{}

XXX_OneofWrappers is for the internal use of the proto package.

func (*ListenRequest) XXX_Size Uses

func (m *ListenRequest) XXX_Size() int

func (*ListenRequest) XXX_Unmarshal Uses

func (m *ListenRequest) XXX_Unmarshal(b []byte) error

type ListenRequest_AddTarget Uses

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

type ListenRequest_RemoveTarget Uses

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

type ListenResponse Uses

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"`
    XXX_NoUnkeyedLiteral struct{}                      `json:"-"`
    XXX_unrecognized     []byte                        `json:"-"`
    XXX_sizecache        int32                         `json:"-"`
}

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

func (*ListenResponse) Descriptor Uses

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

func (*ListenResponse) GetDocumentChange Uses

func (m *ListenResponse) GetDocumentChange() *DocumentChange

func (*ListenResponse) GetDocumentDelete Uses

func (m *ListenResponse) GetDocumentDelete() *DocumentDelete

func (*ListenResponse) GetDocumentRemove Uses

func (m *ListenResponse) GetDocumentRemove() *DocumentRemove

func (*ListenResponse) GetFilter Uses

func (m *ListenResponse) GetFilter() *ExistenceFilter

func (*ListenResponse) GetResponseType Uses

func (m *ListenResponse) GetResponseType() isListenResponse_ResponseType

func (*ListenResponse) GetTargetChange Uses

func (m *ListenResponse) GetTargetChange() *TargetChange

func (*ListenResponse) ProtoMessage Uses

func (*ListenResponse) ProtoMessage()

func (*ListenResponse) Reset Uses

func (m *ListenResponse) Reset()

func (*ListenResponse) String Uses

func (m *ListenResponse) String() string

func (*ListenResponse) XXX_DiscardUnknown Uses

func (m *ListenResponse) XXX_DiscardUnknown()

func (*ListenResponse) XXX_Marshal Uses

func (m *ListenResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ListenResponse) XXX_Merge Uses

func (m *ListenResponse) XXX_Merge(src proto.Message)

func (*ListenResponse) XXX_OneofWrappers Uses

func (*ListenResponse) XXX_OneofWrappers() []interface{}

XXX_OneofWrappers is for the internal use of the proto package.

func (*ListenResponse) XXX_Size Uses

func (m *ListenResponse) XXX_Size() int

func (*ListenResponse) XXX_Unmarshal Uses

func (m *ListenResponse) XXX_Unmarshal(b []byte) error

type ListenResponse_DocumentChange Uses

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

type ListenResponse_DocumentDelete Uses

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

type ListenResponse_DocumentRemove Uses

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

type ListenResponse_Filter Uses

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

type ListenResponse_TargetChange Uses

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

type MapValue Uses

type MapValue struct {
    // The map's fields.
    //
    // The map keys represent field names. Field names matching the regular
    // expression `__.*__` are reserved. Reserved field names are forbidden except
    // in certain documented contexts. The map keys, represented as UTF-8, must
    // not exceed 1,500 bytes and cannot be empty.
    Fields               map[string]*Value `protobuf:"bytes,1,rep,name=fields,proto3" json:"fields,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
    XXX_NoUnkeyedLiteral struct{}          `json:"-"`
    XXX_unrecognized     []byte            `json:"-"`
    XXX_sizecache        int32             `json:"-"`
}

A map value.

func (*MapValue) Descriptor Uses

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

func (*MapValue) GetFields Uses

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

func (*MapValue) ProtoMessage Uses

func (*MapValue) ProtoMessage()

func (*MapValue) Reset Uses

func (m *MapValue) Reset()

func (*MapValue) String Uses

func (m *MapValue) String() string

func (*MapValue) XXX_DiscardUnknown Uses

func (m *MapValue) XXX_DiscardUnknown()

func (*MapValue) XXX_Marshal Uses

func (m *MapValue) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*MapValue) XXX_Merge Uses

func (m *MapValue) XXX_Merge(src proto.Message)

func (*MapValue) XXX_Size Uses

func (m *MapValue) XXX_Size() int

func (*MapValue) XXX_Unmarshal Uses

func (m *MapValue) XXX_Unmarshal(b []byte) error

type Precondition Uses

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"`
    XXX_NoUnkeyedLiteral struct{}                     `json:"-"`
    XXX_unrecognized     []byte                       `json:"-"`
    XXX_sizecache        int32                        `json:"-"`
}

A precondition on a document, used for conditional operations.

func (*Precondition) Descriptor Uses

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

func (*Precondition) GetConditionType Uses

func (m *Precondition) GetConditionType() isPrecondition_ConditionType

func (*Precondition) GetExists Uses

func (m *Precondition) GetExists() bool

func (*Precondition) GetUpdateTime Uses

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

func (*Precondition) ProtoMessage Uses

func (*Precondition) ProtoMessage()

func (*Precondition) Reset Uses

func (m *Precondition) Reset()

func (*Precondition) String Uses

func (m *Precondition) String() string

func (*Precondition) XXX_DiscardUnknown Uses

func (m *Precondition) XXX_DiscardUnknown()

func (*Precondition) XXX_Marshal Uses

func (m *Precondition) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Precondition) XXX_Merge Uses

func (m *Precondition) XXX_Merge(src proto.Message)

func (*Precondition) XXX_OneofWrappers Uses

func (*Precondition) XXX_OneofWrappers() []interface{}

XXX_OneofWrappers is for the internal use of the proto package.

func (*Precondition) XXX_Size Uses

func (m *Precondition) XXX_Size() int

func (*Precondition) XXX_Unmarshal Uses

func (m *Precondition) XXX_Unmarshal(b []byte) error

type Precondition_Exists Uses

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

type Precondition_UpdateTime Uses

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

type RollbackRequest Uses

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

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

func (*RollbackRequest) Descriptor Uses

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

func (*RollbackRequest) GetDatabase Uses

func (m *RollbackRequest) GetDatabase() string

func (*RollbackRequest) GetTransaction Uses

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

func (*RollbackRequest) ProtoMessage Uses

func (*RollbackRequest) ProtoMessage()

func (*RollbackRequest) Reset Uses

func (m *RollbackRequest) Reset()

func (*RollbackRequest) String Uses

func (m *RollbackRequest) String() string

func (*RollbackRequest) XXX_DiscardUnknown Uses

func (m *RollbackRequest) XXX_DiscardUnknown()

func (*RollbackRequest) XXX_Marshal Uses

func (m *RollbackRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*RollbackRequest) XXX_Merge Uses

func (m *RollbackRequest) XXX_Merge(src proto.Message)

func (*RollbackRequest) XXX_Size Uses

func (m *RollbackRequest) XXX_Size() int

func (*RollbackRequest) XXX_Unmarshal Uses

func (m *RollbackRequest) XXX_Unmarshal(b []byte) error

type RunQueryRequest Uses

type RunQueryRequest struct {
    // Required. The parent resource name. In the format:
    // `projects/{project_id}/databases/{database_id}/documents` or
    // `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
    // For example:
    // `projects/my-project/databases/my-database/documents` or
    // `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`
    Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
    // The query to run.
    //
    // Types that are 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"`
    XXX_NoUnkeyedLiteral struct{}                              `json:"-"`
    XXX_unrecognized     []byte                                `json:"-"`
    XXX_sizecache        int32                                 `json:"-"`
}

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

func (*RunQueryRequest) Descriptor Uses

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

func (*RunQueryRequest) GetConsistencySelector Uses

func (m *RunQueryRequest) GetConsistencySelector() isRunQueryRequest_ConsistencySelector

func (*RunQueryRequest) GetNewTransaction Uses

func (m *RunQueryRequest) GetNewTransaction() *TransactionOptions

func (*RunQueryRequest) GetParent Uses

func (m *RunQueryRequest) GetParent() string

func (*RunQueryRequest) GetQueryType Uses

func (m *RunQueryRequest) GetQueryType() isRunQueryRequest_QueryType

func (*RunQueryRequest) GetReadTime Uses

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

func (*RunQueryRequest) GetStructuredQuery Uses

func (m *RunQueryRequest) GetStructuredQuery() *StructuredQuery

func (*RunQueryRequest) GetTransaction Uses

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

func (*RunQueryRequest) ProtoMessage Uses

func (*RunQueryRequest) ProtoMessage()

func (*RunQueryRequest) Reset Uses

func (m *RunQueryRequest) Reset()

func (*RunQueryRequest) String Uses

func (m *RunQueryRequest) String() string

func (*RunQueryRequest) XXX_DiscardUnknown Uses

func (m *RunQueryRequest) XXX_DiscardUnknown()

func (*RunQueryRequest) XXX_Marshal Uses

func (m *RunQueryRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*RunQueryRequest) XXX_Merge Uses

func (m *RunQueryRequest) XXX_Merge(src proto.Message)

func (*RunQueryRequest) XXX_OneofWrappers Uses

func (*RunQueryRequest) XXX_OneofWrappers() []interface{}

XXX_OneofWrappers is for the internal use of the proto package.

func (*RunQueryRequest) XXX_Size Uses

func (m *RunQueryRequest) XXX_Size() int

func (*RunQueryRequest) XXX_Unmarshal Uses

func (m *RunQueryRequest) XXX_Unmarshal(b []byte) error

type RunQueryRequest_NewTransaction Uses

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

type RunQueryRequest_ReadTime Uses

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

type RunQueryRequest_StructuredQuery Uses

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

type RunQueryRequest_Transaction Uses

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

type RunQueryResponse Uses

type RunQueryResponse struct {
    // The transaction that was started as part of this request.
    // Can only be set in the first response, and only if
    // [RunQueryRequest.new_transaction][google.firestore.v1.RunQueryRequest.new_transaction] was set in the request.
    // If set, no other fields will be set in this response.
    Transaction []byte `protobuf:"bytes,2,opt,name=transaction,proto3" json:"transaction,omitempty"`
    // A query result.
    // Not set when reporting partial progress.
    Document *Document `protobuf:"bytes,1,opt,name=document,proto3" json:"document,omitempty"`
    // The time at which the document was read. This may be monotonically
    // increasing; in this case, the previous documents in the result stream are
    // guaranteed not to have changed between their `read_time` and this one.
    //
    // If the query returns no results, a response with `read_time` and no
    // `document` will be sent, and this represents the time at which the query
    // was run.
    ReadTime *timestamp.Timestamp `protobuf:"bytes,3,opt,name=read_time,json=readTime,proto3" json:"read_time,omitempty"`
    // The number of results that have been skipped due to an offset between
    // the last response and the current response.
    SkippedResults       int32    `protobuf:"varint,4,opt,name=skipped_results,json=skippedResults,proto3" json:"skipped_results,omitempty"`
    XXX_NoUnkeyedLiteral struct{} `json:"-"`
    XXX_unrecognized     []byte   `json:"-"`
    XXX_sizecache        int32    `json:"-"`
}

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

func (*RunQueryResponse) Descriptor Uses

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

func (*RunQueryResponse) GetDocument Uses

func (m *RunQueryResponse) GetDocument() *Document

func (*RunQueryResponse) GetReadTime Uses

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

func (*RunQueryResponse) GetSkippedResults Uses

func (m *RunQueryResponse) GetSkippedResults() int32

func (*RunQueryResponse) GetTransaction Uses

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

func (*RunQueryResponse) ProtoMessage Uses

func (*RunQueryResponse) ProtoMessage()

func (*RunQueryResponse) Reset Uses

func (m *RunQueryResponse) Reset()

func (*RunQueryResponse) String Uses

func (m *RunQueryResponse) String() string

func (*RunQueryResponse) XXX_DiscardUnknown Uses

func (m *RunQueryResponse) XXX_DiscardUnknown()

func (*RunQueryResponse) XXX_Marshal Uses

func (m *RunQueryResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*RunQueryResponse) XXX_Merge Uses

func (m *RunQueryResponse) XXX_Merge(src proto.Message)

func (*RunQueryResponse) XXX_Size Uses

func (m *RunQueryResponse) XXX_Size() int

func (*RunQueryResponse) XXX_Unmarshal Uses

func (m *RunQueryResponse) XXX_Unmarshal(b []byte) error

type StructuredQuery Uses

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

A Firestore query.

func (*StructuredQuery) Descriptor Uses

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

func (*StructuredQuery) GetEndAt Uses

func (m *StructuredQuery) GetEndAt() *Cursor

func (*StructuredQuery) GetFrom Uses

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

func (*StructuredQuery) GetLimit Uses

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

func (*StructuredQuery) GetOffset Uses

func (m *StructuredQuery) GetOffset() int32

func (*StructuredQuery) GetOrderBy Uses

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

func (*StructuredQuery) GetSelect Uses

func (m *StructuredQuery) GetSelect() *StructuredQuery_Projection

func (*StructuredQuery) GetStartAt Uses

func (m *StructuredQuery) GetStartAt() *Cursor

func (*StructuredQuery) GetWhere Uses

func (m *StructuredQuery) GetWhere() *StructuredQuery_Filter

func (*StructuredQuery) ProtoMessage Uses

func (*StructuredQuery) ProtoMessage()

func (*StructuredQuery) Reset Uses

func (m *StructuredQuery) Reset()

func (*StructuredQuery) String Uses

func (m *StructuredQuery) String() string

func (*StructuredQuery) XXX_DiscardUnknown Uses

func (m *StructuredQuery) XXX_DiscardUnknown()

func (*StructuredQuery) XXX_Marshal Uses

func (m *StructuredQuery) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*StructuredQuery) XXX_Merge Uses

func (m *StructuredQuery) XXX_Merge(src proto.Message)

func (*StructuredQuery) XXX_Size Uses

func (m *StructuredQuery) XXX_Size() int

func (*StructuredQuery) XXX_Unmarshal Uses

func (m *StructuredQuery) XXX_Unmarshal(b []byte) error

type StructuredQuery_CollectionSelector Uses

type StructuredQuery_CollectionSelector struct {
    // The collection ID.
    // When set, selects only collections with this ID.
    CollectionId string `protobuf:"bytes,2,opt,name=collection_id,json=collectionId,proto3" json:"collection_id,omitempty"`
    // When false, selects only collections that are immediate children of
    // the `parent` specified in the containing `RunQueryRequest`.
    // When true, selects all descendant collections.
    AllDescendants       bool     `protobuf:"varint,3,opt,name=all_descendants,json=allDescendants,proto3" json:"all_descendants,omitempty"`
    XXX_NoUnkeyedLiteral struct{} `json:"-"`
    XXX_unrecognized     []byte   `json:"-"`
    XXX_sizecache        int32    `json:"-"`
}

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

func (*StructuredQuery_CollectionSelector) Descriptor Uses

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

func (*StructuredQuery_CollectionSelector) GetAllDescendants Uses

func (m *StructuredQuery_CollectionSelector) GetAllDescendants() bool

func (*StructuredQuery_CollectionSelector) GetCollectionId Uses

func (m *StructuredQuery_CollectionSelector) GetCollectionId() string

func (*StructuredQuery_CollectionSelector) ProtoMessage Uses

func (*StructuredQuery_CollectionSelector) ProtoMessage()

func (*StructuredQuery_CollectionSelector) Reset Uses

func (m *StructuredQuery_CollectionSelector) Reset()

func (*StructuredQuery_CollectionSelector) String Uses

func (m *StructuredQuery_CollectionSelector) String() string

func (*StructuredQuery_CollectionSelector) XXX_DiscardUnknown Uses

func (m *StructuredQuery_CollectionSelector) XXX_DiscardUnknown()

func (*StructuredQuery_CollectionSelector) XXX_Marshal Uses

func (m *StructuredQuery_CollectionSelector) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*StructuredQuery_CollectionSelector) XXX_Merge Uses

func (m *StructuredQuery_CollectionSelector) XXX_Merge(src proto.Message)

func (*StructuredQuery_CollectionSelector) XXX_Size Uses

func (m *StructuredQuery_CollectionSelector) XXX_Size() int

func (*StructuredQuery_CollectionSelector) XXX_Unmarshal Uses

func (m *StructuredQuery_CollectionSelector) XXX_Unmarshal(b []byte) error

type StructuredQuery_CompositeFilter Uses

type StructuredQuery_CompositeFilter struct {
    // The operator for combining multiple filters.
    Op  StructuredQuery_CompositeFilter_Operator `protobuf:"varint,1,opt,name=op,proto3,enum=google.firestore.v1.StructuredQuery_CompositeFilter_Operator" json:"op,omitempty"`
    // The list of filters to combine.
    // Must contain at least one filter.
    Filters              []*StructuredQuery_Filter `protobuf:"bytes,2,rep,name=filters,proto3" json:"filters,omitempty"`
    XXX_NoUnkeyedLiteral struct{}                  `json:"-"`
    XXX_unrecognized     []byte                    `json:"-"`
    XXX_sizecache        int32                     `json:"-"`
}

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

func (*StructuredQuery_CompositeFilter) Descriptor Uses

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

func (*StructuredQuery_CompositeFilter) GetFilters Uses

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

func (*StructuredQuery_CompositeFilter) GetOp Uses

func (m *StructuredQuery_CompositeFilter) GetOp() StructuredQuery_CompositeFilter_Operator

func (*StructuredQuery_CompositeFilter) ProtoMessage Uses

func (*StructuredQuery_CompositeFilter) ProtoMessage()

func (*StructuredQuery_CompositeFilter) Reset Uses

func (m *StructuredQuery_CompositeFilter) Reset()

func (*StructuredQuery_CompositeFilter) String Uses

func (m *StructuredQuery_CompositeFilter) String() string

func (*StructuredQuery_CompositeFilter) XXX_DiscardUnknown Uses

func (m *StructuredQuery_CompositeFilter) XXX_DiscardUnknown()

func (*StructuredQuery_CompositeFilter) XXX_Marshal Uses

func (m *StructuredQuery_CompositeFilter) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*StructuredQuery_CompositeFilter) XXX_Merge Uses

func (m *StructuredQuery_CompositeFilter) XXX_Merge(src proto.Message)

func (*StructuredQuery_CompositeFilter) XXX_Size Uses

func (m *StructuredQuery_CompositeFilter) XXX_Size() int

func (*StructuredQuery_CompositeFilter) XXX_Unmarshal Uses

func (m *StructuredQuery_CompositeFilter) XXX_Unmarshal(b []byte) error

type StructuredQuery_CompositeFilter_Operator Uses

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 Uses

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

func (StructuredQuery_CompositeFilter_Operator) String Uses

func (x StructuredQuery_CompositeFilter_Operator) String() string

type StructuredQuery_Direction Uses

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 Uses

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

func (StructuredQuery_Direction) String Uses

func (x StructuredQuery_Direction) String() string

type StructuredQuery_FieldFilter Uses

type StructuredQuery_FieldFilter struct {
    // The field to filter by.
    Field *StructuredQuery_FieldReference `protobuf:"bytes,1,opt,name=field,proto3" json:"field,omitempty"`
    // The operator to filter by.
    Op  StructuredQuery_FieldFilter_Operator `protobuf:"varint,2,opt,name=op,proto3,enum=google.firestore.v1.StructuredQuery_FieldFilter_Operator" json:"op,omitempty"`
    // The value to compare to.
    Value                *Value   `protobuf:"bytes,3,opt,name=value,proto3" json:"value,omitempty"`
    XXX_NoUnkeyedLiteral struct{} `json:"-"`
    XXX_unrecognized     []byte   `json:"-"`
    XXX_sizecache        int32    `json:"-"`
}

A filter on a specific field.

func (*StructuredQuery_FieldFilter) Descriptor Uses

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

func (*StructuredQuery_FieldFilter) GetField Uses

func (m *StructuredQuery_FieldFilter) GetField() *StructuredQuery_FieldReference

func (*StructuredQuery_FieldFilter) GetOp Uses

func (m *StructuredQuery_FieldFilter) GetOp() StructuredQuery_FieldFilter_Operator

func (*StructuredQuery_FieldFilter) GetValue Uses

func (m *StructuredQuery_FieldFilter) GetValue() *Value

func (*StructuredQuery_FieldFilter) ProtoMessage Uses

func (*StructuredQuery_FieldFilter) ProtoMessage()

func (*StructuredQuery_FieldFilter) Reset Uses

func (m *StructuredQuery_FieldFilter) Reset()

func (*StructuredQuery_FieldFilter) String Uses

func (m *StructuredQuery_FieldFilter) String() string

func (*StructuredQuery_FieldFilter) XXX_DiscardUnknown Uses

func (m *StructuredQuery_FieldFilter) XXX_DiscardUnknown()

func (*StructuredQuery_FieldFilter) XXX_Marshal Uses

func (m *StructuredQuery_FieldFilter) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*StructuredQuery_FieldFilter) XXX_Merge Uses

func (m *StructuredQuery_FieldFilter) XXX_Merge(src proto.Message)

func (*StructuredQuery_FieldFilter) XXX_Size Uses

func (m *StructuredQuery_FieldFilter) XXX_Size() int

func (*StructuredQuery_FieldFilter) XXX_Unmarshal Uses

func (m *StructuredQuery_FieldFilter) XXX_Unmarshal(b []byte) error

type StructuredQuery_FieldFilter_Operator Uses

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
    // Contains. Requires that the field is an array.
    StructuredQuery_FieldFilter_ARRAY_CONTAINS StructuredQuery_FieldFilter_Operator = 7
    // In. Requires that `value` is a non-empty ArrayValue with at most 10
    // values.
    StructuredQuery_FieldFilter_IN StructuredQuery_FieldFilter_Operator = 8
    // Contains any. Requires that the field is an array and
    // `value` is a non-empty ArrayValue with at most 10 values.
    StructuredQuery_FieldFilter_ARRAY_CONTAINS_ANY StructuredQuery_FieldFilter_Operator = 9
)

func (StructuredQuery_FieldFilter_Operator) EnumDescriptor Uses

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

func (StructuredQuery_FieldFilter_Operator) String Uses

func (x StructuredQuery_FieldFilter_Operator) String() string

type StructuredQuery_FieldReference Uses

type StructuredQuery_FieldReference struct {
    FieldPath            string   `protobuf:"bytes,2,opt,name=field_path,json=fieldPath,proto3" json:"field_path,omitempty"`
    XXX_NoUnkeyedLiteral struct{} `json:"-"`
    XXX_unrecognized     []byte   `json:"-"`
    XXX_sizecache        int32    `json:"-"`
}

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

func (*StructuredQuery_FieldReference) Descriptor Uses

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

func (*StructuredQuery_FieldReference) GetFieldPath Uses

func (m *StructuredQuery_FieldReference) GetFieldPath() string

func (*StructuredQuery_FieldReference) ProtoMessage Uses

func (*StructuredQuery_FieldReference) ProtoMessage()

func (*StructuredQuery_FieldReference) Reset Uses

func (m *StructuredQuery_FieldReference) Reset()

func (*StructuredQuery_FieldReference) String Uses

func (m *StructuredQuery_FieldReference) String() string

func (*StructuredQuery_FieldReference) XXX_DiscardUnknown Uses

func (m *StructuredQuery_FieldReference) XXX_DiscardUnknown()

func (*StructuredQuery_FieldReference) XXX_Marshal Uses

func (m *StructuredQuery_FieldReference) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*StructuredQuery_FieldReference) XXX_Merge Uses

func (m *StructuredQuery_FieldReference) XXX_Merge(src proto.Message)

func (*StructuredQuery_FieldReference) XXX_Size Uses

func (m *StructuredQuery_FieldReference) XXX_Size() int

func (*StructuredQuery_FieldReference) XXX_Unmarshal Uses

func (m *StructuredQuery_FieldReference) XXX_Unmarshal(b []byte) error

type StructuredQuery_Filter Uses

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"`
    XXX_NoUnkeyedLiteral struct{}                            `json:"-"`
    XXX_unrecognized     []byte                              `json:"-"`
    XXX_sizecache        int32                               `json:"-"`
}

A filter.

func (*StructuredQuery_Filter) Descriptor Uses

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

func (*StructuredQuery_Filter) GetCompositeFilter Uses

func (m *StructuredQuery_Filter) GetCompositeFilter() *StructuredQuery_CompositeFilter

func (*StructuredQuery_Filter) GetFieldFilter Uses

func (m *StructuredQuery_Filter) GetFieldFilter() *StructuredQuery_FieldFilter

func (*StructuredQuery_Filter) GetFilterType Uses

func (m *StructuredQuery_Filter) GetFilterType() isStructuredQuery_Filter_FilterType

func (*StructuredQuery_Filter) GetUnaryFilter Uses

func (m *StructuredQuery_Filter) GetUnaryFilter() *StructuredQuery_UnaryFilter

func (*StructuredQuery_Filter) ProtoMessage Uses

func (*StructuredQuery_Filter) ProtoMessage()

func (*StructuredQuery_Filter) Reset Uses

func (m *StructuredQuery_Filter) Reset()

func (*StructuredQuery_Filter) String Uses

func (m *StructuredQuery_Filter) String() string

func (*StructuredQuery_Filter) XXX_DiscardUnknown Uses

func (m *StructuredQuery_Filter) XXX_DiscardUnknown()

func (*StructuredQuery_Filter) XXX_Marshal Uses

func (m *StructuredQuery_Filter) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*StructuredQuery_Filter) XXX_Merge Uses

func (m *StructuredQuery_Filter) XXX_Merge(src proto.Message)

func (*StructuredQuery_Filter) XXX_OneofWrappers Uses

func (*StructuredQuery_Filter) XXX_OneofWrappers() []interface{}

XXX_OneofWrappers is for the internal use of the proto package.

func (*StructuredQuery_Filter) XXX_Size Uses

func (m *StructuredQuery_Filter) XXX_Size() int

func (*StructuredQuery_Filter) XXX_Unmarshal Uses

func (m *StructuredQuery_Filter) XXX_Unmarshal(b []byte) error

type StructuredQuery_Filter_CompositeFilter Uses

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

type StructuredQuery_Filter_FieldFilter Uses

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

type StructuredQuery_Filter_UnaryFilter Uses

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

type StructuredQuery_Order Uses

type StructuredQuery_Order struct {
    // The field to order by.
    Field *StructuredQuery_FieldReference `protobuf:"bytes,1,opt,name=field,proto3" json:"field,omitempty"`
    // The direction to order by. Defaults to `ASCENDING`.
    Direction            StructuredQuery_Direction `protobuf:"varint,2,opt,name=direction,proto3,enum=google.firestore.v1.StructuredQuery_Direction" json:"direction,omitempty"`
    XXX_NoUnkeyedLiteral struct{}                  `json:"-"`
    XXX_unrecognized     []byte                    `json:"-"`
    XXX_sizecache        int32                     `json:"-"`
}

An order on a field.

func (*StructuredQuery_Order) Descriptor Uses

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

func (*StructuredQuery_Order) GetDirection Uses

func (m *StructuredQuery_Order) GetDirection() StructuredQuery_Direction

func (*StructuredQuery_Order) GetField Uses

func (m *StructuredQuery_Order) GetField() *StructuredQuery_FieldReference

func (*StructuredQuery_Order) ProtoMessage Uses

func (*StructuredQuery_Order) ProtoMessage()

func (*StructuredQuery_Order) Reset Uses

func (m *StructuredQuery_Order) Reset()

func (*StructuredQuery_Order) String Uses

func (m *StructuredQuery_Order) String() string

func (*StructuredQuery_Order) XXX_DiscardUnknown Uses

func (m *StructuredQuery_Order) XXX_DiscardUnknown()

func (*StructuredQuery_Order) XXX_Marshal Uses

func (m *StructuredQuery_Order) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*StructuredQuery_Order) XXX_Merge Uses

func (m *StructuredQuery_Order) XXX_Merge(src proto.Message)

func (*StructuredQuery_Order) XXX_Size Uses

func (m *StructuredQuery_Order) XXX_Size() int

func (*StructuredQuery_Order) XXX_Unmarshal Uses

func (m *StructuredQuery_Order) XXX_Unmarshal(b []byte) error

type StructuredQuery_Projection Uses

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

The projection of document's fields to return.

func (*StructuredQuery_Projection) Descriptor Uses

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

func (*StructuredQuery_Projection) GetFields Uses

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

func (*StructuredQuery_Projection) ProtoMessage Uses

func (*StructuredQuery_Projection) ProtoMessage()

func (*StructuredQuery_Projection) Reset Uses

func (m *StructuredQuery_Projection) Reset()

func (*StructuredQuery_Projection) String Uses

func (m *StructuredQuery_Projection) String() string

func (*StructuredQuery_Projection) XXX_DiscardUnknown Uses

func (m *StructuredQuery_Projection) XXX_DiscardUnknown()

func (*StructuredQuery_Projection) XXX_Marshal Uses

func (m *StructuredQuery_Projection) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*StructuredQuery_Projection) XXX_Merge Uses

func (m *StructuredQuery_Projection) XXX_Merge(src proto.Message)

func (*StructuredQuery_Projection) XXX_Size Uses

func (m *StructuredQuery_Projection) XXX_Size() int

func (*StructuredQuery_Projection) XXX_Unmarshal Uses

func (m *StructuredQuery_Projection) XXX_Unmarshal(b []byte) error

type StructuredQuery_UnaryFilter Uses

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

A filter with a single operand.

func (*StructuredQuery_UnaryFilter) Descriptor Uses

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

func (*StructuredQuery_UnaryFilter) GetField Uses

func (m *StructuredQuery_UnaryFilter) GetField() *StructuredQuery_FieldReference

func (*StructuredQuery_UnaryFilter) GetOp Uses

func (m *StructuredQuery_UnaryFilter) GetOp() StructuredQuery_UnaryFilter_Operator

func (*StructuredQuery_UnaryFilter) GetOperandType Uses

func (m *StructuredQuery_UnaryFilter) GetOperandType() isStructuredQuery_UnaryFilter_OperandType

func (*StructuredQuery_UnaryFilter) ProtoMessage Uses

func (*StructuredQuery_UnaryFilter) ProtoMessage()

func (*StructuredQuery_UnaryFilter) Reset Uses

func (m *StructuredQuery_UnaryFilter) Reset()

func (*StructuredQuery_UnaryFilter) String Uses

func (m *StructuredQuery_UnaryFilter) String() string

func (*StructuredQuery_UnaryFilter) XXX_DiscardUnknown Uses

func (m *StructuredQuery_UnaryFilter) XXX_DiscardUnknown()

func (*StructuredQuery_UnaryFilter) XXX_Marshal Uses

func (m *StructuredQuery_UnaryFilter) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*StructuredQuery_UnaryFilter) XXX_Merge Uses

func (m *StructuredQuery_UnaryFilter) XXX_Merge(src proto.Message)

func (*StructuredQuery_UnaryFilter) XXX_OneofWrappers Uses

func (*StructuredQuery_UnaryFilter) XXX_OneofWrappers() []interface{}

XXX_OneofWrappers is for the internal use of the proto package.

func (*StructuredQuery_UnaryFilter) XXX_Size Uses

func (m *StructuredQuery_UnaryFilter) XXX_Size() int

func (*StructuredQuery_UnaryFilter) XXX_Unmarshal Uses

func (m *StructuredQuery_UnaryFilter) XXX_Unmarshal(b []byte) error

type StructuredQuery_UnaryFilter_Field Uses

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

type StructuredQuery_UnaryFilter_Operator Uses

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 expression evaluates to Null.
    StructuredQuery_UnaryFilter_IS_NULL StructuredQuery_UnaryFilter_Operator = 3
)

func (StructuredQuery_UnaryFilter_Operator) EnumDescriptor Uses

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

func (StructuredQuery_UnaryFilter_Operator) String Uses

func (x StructuredQuery_UnaryFilter_Operator) String() string

type Target Uses

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"`
    // The target ID that identifies the target on the stream. Must be a positive
    // number and non-zero.
    TargetId int32 `protobuf:"varint,5,opt,name=target_id,json=targetId,proto3" json:"target_id,omitempty"`
    // If the target should be removed once it is current and consistent.
    Once                 bool     `protobuf:"varint,6,opt,name=once,proto3" json:"once,omitempty"`
    XXX_NoUnkeyedLiteral struct{} `json:"-"`
    XXX_unrecognized     []byte   `json:"-"`
    XXX_sizecache        int32    `json:"-"`
}

A specification of a set of documents to listen to.

func (*Target) Descriptor Uses

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

func (*Target) GetDocuments Uses

func (m *Target) GetDocuments() *Target_DocumentsTarget

func (*Target) GetOnce Uses

func (m *Target) GetOnce() bool

func (*Target) GetQuery Uses

func (m *Target) GetQuery() *Target_QueryTarget

func (*Target) GetReadTime Uses

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

func (*Target) GetResumeToken Uses

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

func (*Target) GetResumeType Uses

func (m *Target) GetResumeType() isTarget_ResumeType

func (*Target) GetTargetId Uses

func (m *Target) GetTargetId() int32

func (*Target) GetTargetType Uses

func (m *Target) GetTargetType() isTarget_TargetType

func (*Target) ProtoMessage Uses

func (*Target) ProtoMessage()

func (*Target) Reset Uses

func (m *Target) Reset()

func (*Target) String Uses

func (m *Target) String() string

func (*Target) XXX_DiscardUnknown Uses

func (m *Target) XXX_DiscardUnknown()

func (*Target) XXX_Marshal Uses

func (m *Target) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Target) XXX_Merge Uses

func (m *Target) XXX_Merge(src proto.Message)

func (*Target) XXX_OneofWrappers Uses

func (*Target) XXX_OneofWrappers() []interface{}

XXX_OneofWrappers is for the internal use of the proto package.

func (*Target) XXX_Size Uses

func (m *Target) XXX_Size() int

func (*Target) XXX_Unmarshal Uses

func (m *Target) XXX_Unmarshal(b []byte) error

type TargetChange Uses

type TargetChange struct {
    // The type of change that occurred.
    TargetChangeType TargetChange_TargetChangeType `protobuf:"varint,1,opt,name=target_change_type,json=targetChangeType,proto3,enum=google.firestore.v1.TargetChange_TargetChangeType" json:"target_change_type,omitempty"`
    // The target IDs of targets that have changed.
    //
    // If empty, the change applies to all targets.
    //
    // The order of the target IDs is not defined.
    TargetIds []int32 `protobuf:"varint,2,rep,packed,name=target_ids,json=targetIds,proto3" json:"target_ids,omitempty"`
    // The error that resulted in this change, if applicable.
    Cause *status.Status `protobuf:"bytes,3,opt,name=cause,proto3" json:"cause,omitempty"`
    // A token that can be used to resume the stream for the given `target_ids`,
    // or all targets if `target_ids` is empty.
    //
    // Not set on every target change.
    ResumeToken []byte `protobuf:"bytes,4,opt,name=resume_token,json=resumeToken,proto3" json:"resume_token,omitempty"`
    // The consistent `read_time` for the given `target_ids` (omitted when the
    // target_ids are not at a consistent snapshot).
    //
    // The stream is guaranteed to send a `read_time` with `target_ids` empty
    // whenever the entire stream reaches a new consistent snapshot. ADD,
    // CURRENT, and RESET messages are guaranteed to (eventually) result in a
    // new consistent snapshot (while NO_CHANGE and REMOVE messages are not).
    //
    // For a given stream, `read_time` is guaranteed to be monotonically
    // increasing.
    ReadTime             *timestamp.Timestamp `protobuf:"bytes,6,opt,name=read_time,json=readTime,proto3" json:"read_time,omitempty"`
    XXX_NoUnkeyedLiteral struct{}             `json:"-"`
    XXX_unrecognized     []byte               `json:"-"`
    XXX_sizecache        int32                `json:"-"`
}

Targets being watched have changed.

func (*TargetChange) Descriptor Uses

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

func (*TargetChange) GetCause Uses

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

func (*TargetChange) GetReadTime Uses

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

func (*TargetChange) GetResumeToken Uses

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

func (*TargetChange) GetTargetChangeType Uses

func (m *TargetChange) GetTargetChangeType() TargetChange_TargetChangeType

func (*TargetChange) GetTargetIds Uses

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

func (*TargetChange) ProtoMessage Uses

func (*TargetChange) ProtoMessage()

func (*TargetChange) Reset Uses

func (m *TargetChange) Reset()

func (*TargetChange) String Uses

func (m *TargetChange) String() string

func (*TargetChange) XXX_DiscardUnknown Uses

func (m *TargetChange) XXX_DiscardUnknown()

func (*TargetChange) XXX_Marshal Uses

func (m *TargetChange) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*TargetChange) XXX_Merge Uses

func (m *TargetChange) XXX_Merge(src proto.Message)

func (*TargetChange) XXX_Size Uses

func (m *TargetChange) XXX_Size() int

func (*TargetChange) XXX_Unmarshal Uses

func (m *TargetChange) XXX_Unmarshal(b []byte) error

type TargetChange_TargetChangeType Uses

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 Uses

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

func (TargetChange_TargetChangeType) String Uses

func (x TargetChange_TargetChangeType) String() string

type Target_Documents Uses

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

type Target_DocumentsTarget Uses

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

A target specified by a set of documents names.

func (*Target_DocumentsTarget) Descriptor Uses

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

func (*Target_DocumentsTarget) GetDocuments Uses

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

func (*Target_DocumentsTarget) ProtoMessage Uses

func (*Target_DocumentsTarget) ProtoMessage()

func (*Target_DocumentsTarget) Reset Uses

func (m *Target_DocumentsTarget) Reset()

func (*Target_DocumentsTarget) String Uses

func (m *Target_DocumentsTarget) String() string

func (*Target_DocumentsTarget) XXX_DiscardUnknown Uses

func (m *Target_DocumentsTarget) XXX_DiscardUnknown()

func (*Target_DocumentsTarget) XXX_Marshal Uses

func (m *Target_DocumentsTarget) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Target_DocumentsTarget) XXX_Merge Uses

func (m *Target_DocumentsTarget) XXX_Merge(src proto.Message)

func (*Target_DocumentsTarget) XXX_Size Uses

func (m *Target_DocumentsTarget) XXX_Size() int

func (*Target_DocumentsTarget) XXX_Unmarshal Uses

func (m *Target_DocumentsTarget) XXX_Unmarshal(b []byte) error

type Target_Query Uses

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

type Target_QueryTarget Uses

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

A target specified by a query.

func (*Target_QueryTarget) Descriptor Uses

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

func (*Target_QueryTarget) GetParent Uses

func (m *Target_QueryTarget) GetParent() string

func (*Target_QueryTarget) GetQueryType Uses

func (m *Target_QueryTarget) GetQueryType() isTarget_QueryTarget_QueryType

func (*Target_QueryTarget) GetStructuredQuery Uses

func (m *Target_QueryTarget) GetStructuredQuery() *StructuredQuery

func (*Target_QueryTarget) ProtoMessage Uses

func (*Target_QueryTarget) ProtoMessage()

func (*Target_QueryTarget) Reset Uses

func (m *Target_QueryTarget) Reset()

func (*Target_QueryTarget) String Uses

func (m *Target_QueryTarget) String() string

func (*Target_QueryTarget) XXX_DiscardUnknown Uses

func (m *Target_QueryTarget) XXX_DiscardUnknown()

func (*Target_QueryTarget) XXX_Marshal Uses

func (m *Target_QueryTarget) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Target_QueryTarget) XXX_Merge Uses

func (m *Target_QueryTarget) XXX_Merge(src proto.Message)

func (*Target_QueryTarget) XXX_OneofWrappers Uses

func (*Target_QueryTarget) XXX_OneofWrappers() []interface{}

XXX_OneofWrappers is for the internal use of the proto package.

func (*Target_QueryTarget) XXX_Size Uses

func (m *Target_QueryTarget) XXX_Size() int

func (*Target_QueryTarget) XXX_Unmarshal Uses

func (m *Target_QueryTarget) XXX_Unmarshal(b []byte) error

type Target_QueryTarget_StructuredQuery Uses

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

type Target_ReadTime Uses

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

type Target_ResumeToken Uses

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

type TransactionOptions Uses

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"`
    XXX_NoUnkeyedLiteral struct{}                  `json:"-"`
    XXX_unrecognized     []byte                    `json:"-"`
    XXX_sizecache        int32                     `json:"-"`
}

Options for creating a new transaction.

func (*TransactionOptions) Descriptor Uses

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

func (*TransactionOptions) GetMode Uses

func (m *TransactionOptions) GetMode() isTransactionOptions_Mode

func (*TransactionOptions) GetReadOnly Uses

func (m *TransactionOptions) GetReadOnly() *TransactionOptions_ReadOnly

func (*TransactionOptions) GetReadWrite Uses

func (m *TransactionOptions) GetReadWrite() *TransactionOptions_ReadWrite

func (*TransactionOptions) ProtoMessage Uses

func (*TransactionOptions) ProtoMessage()

func (*TransactionOptions) Reset Uses

func (m *TransactionOptions) Reset()

func (*TransactionOptions) String Uses

func (m *TransactionOptions) String() string

func (*TransactionOptions) XXX_DiscardUnknown Uses

func (m *TransactionOptions) XXX_DiscardUnknown()

func (*TransactionOptions) XXX_Marshal Uses

func (m *TransactionOptions) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*TransactionOptions) XXX_Merge Uses

func (m *TransactionOptions) XXX_Merge(src proto.Message)

func (*TransactionOptions) XXX_OneofWrappers Uses

func (*TransactionOptions) XXX_OneofWrappers() []interface{}

XXX_OneofWrappers is for the internal use of the proto package.

func (*TransactionOptions) XXX_Size Uses

func (m *TransactionOptions) XXX_Size() int

func (*TransactionOptions) XXX_Unmarshal Uses

func (m *TransactionOptions) XXX_Unmarshal(b []byte) error

type TransactionOptions_ReadOnly Uses

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"`
    XXX_NoUnkeyedLiteral struct{}                                          `json:"-"`
    XXX_unrecognized     []byte                                            `json:"-"`
    XXX_sizecache        int32                                             `json:"-"`
}

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

func (*TransactionOptions_ReadOnly) Descriptor Uses

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

func (*TransactionOptions_ReadOnly) GetConsistencySelector Uses

func (m *TransactionOptions_ReadOnly) GetConsistencySelector() isTransactionOptions_ReadOnly_ConsistencySelector

func (*TransactionOptions_ReadOnly) GetReadTime Uses

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

func (*TransactionOptions_ReadOnly) ProtoMessage Uses

func (*TransactionOptions_ReadOnly) ProtoMessage()

func (*TransactionOptions_ReadOnly) Reset Uses

func (m *TransactionOptions_ReadOnly) Reset()

func (*TransactionOptions_ReadOnly) String Uses

func (m *TransactionOptions_ReadOnly) String() string

func (*TransactionOptions_ReadOnly) XXX_DiscardUnknown Uses

func (m *TransactionOptions_ReadOnly) XXX_DiscardUnknown()

func (*TransactionOptions_ReadOnly) XXX_Marshal Uses

func (m *TransactionOptions_ReadOnly) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*TransactionOptions_ReadOnly) XXX_Merge Uses

func (m *TransactionOptions_ReadOnly) XXX_Merge(src proto.Message)

func (*TransactionOptions_ReadOnly) XXX_OneofWrappers Uses

func (*TransactionOptions_ReadOnly) XXX_OneofWrappers() []interface{}

XXX_OneofWrappers is for the internal use of the proto package.

func (*TransactionOptions_ReadOnly) XXX_Size Uses

func (m *TransactionOptions_ReadOnly) XXX_Size() int

func (*TransactionOptions_ReadOnly) XXX_Unmarshal Uses

func (m *TransactionOptions_ReadOnly) XXX_Unmarshal(b []byte) error

type TransactionOptions_ReadOnly_ Uses

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

type TransactionOptions_ReadOnly_ReadTime Uses

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

type TransactionOptions_ReadWrite Uses

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"`
    XXX_NoUnkeyedLiteral struct{} `json:"-"`
    XXX_unrecognized     []byte   `json:"-"`
    XXX_sizecache        int32    `json:"-"`
}

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

func (*TransactionOptions_ReadWrite) Descriptor Uses

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

func (*TransactionOptions_ReadWrite) GetRetryTransaction Uses

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

func (*TransactionOptions_ReadWrite) ProtoMessage Uses

func (*TransactionOptions_ReadWrite) ProtoMessage()

func (*TransactionOptions_ReadWrite) Reset Uses

func (m *TransactionOptions_ReadWrite) Reset()

func (*TransactionOptions_ReadWrite) String Uses

func (m *TransactionOptions_ReadWrite) String() string

func (*TransactionOptions_ReadWrite) XXX_DiscardUnknown Uses

func (m *TransactionOptions_ReadWrite) XXX_DiscardUnknown()

func (*TransactionOptions_ReadWrite) XXX_Marshal Uses

func (m *TransactionOptions_ReadWrite) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*TransactionOptions_ReadWrite) XXX_Merge Uses

func (m *TransactionOptions_ReadWrite) XXX_Merge(src proto.Message)

func (*TransactionOptions_ReadWrite) XXX_Size Uses

func (m *TransactionOptions_ReadWrite) XXX_Size() int

func (*TransactionOptions_ReadWrite) XXX_Unmarshal Uses

func (m *TransactionOptions_ReadWrite) XXX_Unmarshal(b []byte) error

type TransactionOptions_ReadWrite_ Uses

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

type UnimplementedFirestoreServer Uses

type UnimplementedFirestoreServer struct {
}

UnimplementedFirestoreServer can be embedded to have forward compatible implementations.

func (*UnimplementedFirestoreServer) BatchGetDocuments Uses

func (*UnimplementedFirestoreServer) BatchGetDocuments(req *BatchGetDocumentsRequest, srv Firestore_BatchGetDocumentsServer) error

func (*UnimplementedFirestoreServer) BeginTransaction Uses

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

func (*UnimplementedFirestoreServer) Commit Uses

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

func (*UnimplementedFirestoreServer) CreateDocument Uses

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

func (*UnimplementedFirestoreServer) DeleteDocument Uses

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

func (*UnimplementedFirestoreServer) GetDocument Uses

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

func (*UnimplementedFirestoreServer) ListCollectionIds Uses

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

func (*UnimplementedFirestoreServer) ListDocuments Uses

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

func (*UnimplementedFirestoreServer) Listen Uses

func (*UnimplementedFirestoreServer) Listen(srv Firestore_ListenServer) error

func (*UnimplementedFirestoreServer) Rollback Uses

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

func (*UnimplementedFirestoreServer) RunQuery Uses

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

func (*UnimplementedFirestoreServer) UpdateDocument Uses

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

func (*UnimplementedFirestoreServer) Write Uses

func (*UnimplementedFirestoreServer) Write(srv Firestore_WriteServer) error

type UpdateDocumentRequest Uses

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

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

func (*UpdateDocumentRequest) Descriptor Uses

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

func (*UpdateDocumentRequest) GetCurrentDocument Uses

func (m *UpdateDocumentRequest) GetCurrentDocument() *Precondition

func (*UpdateDocumentRequest) GetDocument Uses

func (m *UpdateDocumentRequest) GetDocument() *Document

func (*UpdateDocumentRequest) GetMask Uses

func (m *UpdateDocumentRequest) GetMask() *DocumentMask

func (*UpdateDocumentRequest) GetUpdateMask Uses

func (m *UpdateDocumentRequest) GetUpdateMask() *DocumentMask

func (*UpdateDocumentRequest) ProtoMessage Uses

func (*UpdateDocumentRequest) ProtoMessage()

func (*UpdateDocumentRequest) Reset Uses

func (m *UpdateDocumentRequest) Reset()

func (*UpdateDocumentRequest) String Uses

func (m *UpdateDocumentRequest) String() string

func (*UpdateDocumentRequest) XXX_DiscardUnknown Uses

func (m *UpdateDocumentRequest) XXX_DiscardUnknown()

func (*UpdateDocumentRequest) XXX_Marshal Uses

func (m *UpdateDocumentRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*UpdateDocumentRequest) XXX_Merge Uses

func (m *UpdateDocumentRequest) XXX_Merge(src proto.Message)

func (*UpdateDocumentRequest) XXX_Size Uses

func (m *UpdateDocumentRequest) XXX_Size() int

func (*UpdateDocumentRequest) XXX_Unmarshal Uses

func (m *UpdateDocumentRequest) XXX_Unmarshal(b []byte) error

type Value Uses

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"`
    XXX_NoUnkeyedLiteral struct{}          `json:"-"`
    XXX_unrecognized     []byte            `json:"-"`
    XXX_sizecache        int32             `json:"-"`
}

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

func (*Value) Descriptor Uses

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

func (*Value) GetArrayValue Uses

func (m *Value) GetArrayValue() *ArrayValue

func (*Value) GetBooleanValue Uses

func (m *Value) GetBooleanValue() bool

func (*Value) GetBytesValue Uses

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

func (*Value) GetDoubleValue Uses

func (m *Value) GetDoubleValue() float64

func (*Value) GetGeoPointValue Uses

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

func (*Value) GetIntegerValue Uses

func (m *Value) GetIntegerValue() int64

func (*Value) GetMapValue Uses

func (m *Value) GetMapValue() *MapValue

func (*Value) GetNullValue Uses

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

func (*Value) GetReferenceValue Uses

func (m *Value) GetReferenceValue() string

func (*Value) GetStringValue Uses

func (m *Value) GetStringValue() string

func (*Value) GetTimestampValue Uses

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

func (*Value) GetValueType Uses

func (m *Value) GetValueType() isValue_ValueType

func (*Value) ProtoMessage Uses

func (*Value) ProtoMessage()

func (*Value) Reset Uses

func (m *Value) Reset()

func (*Value) String Uses

func (m *Value) String() string

func (*Value) XXX_DiscardUnknown Uses

func (m *Value) XXX_DiscardUnknown()

func (*Value) XXX_Marshal Uses

func (m *Value) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Value) XXX_Merge Uses

func (m *Value) XXX_Merge(src proto.Message)

func (*Value) XXX_OneofWrappers Uses

func (*Value) XXX_OneofWrappers() []interface{}

XXX_OneofWrappers is for the internal use of the proto package.

func (*Value) XXX_Size Uses

func (m *Value) XXX_Size() int

func (*Value) XXX_Unmarshal Uses

func (m *Value) XXX_Unmarshal(b []byte) error

type Value_ArrayValue Uses

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

type Value_BooleanValue Uses

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

type Value_BytesValue Uses

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

type Value_DoubleValue Uses

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

type Value_GeoPointValue Uses

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

type Value_IntegerValue Uses

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

type Value_MapValue Uses

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

type Value_NullValue Uses

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

type Value_ReferenceValue Uses

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

type Value_StringValue Uses

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

type Value_TimestampValue Uses

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

type Write Uses

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`.
    // If the mask is not set for an `update` and the document exists, any
    // existing data will be overwritten.
    // If the mask is set and the document on the server has fields not covered by
    // the mask, they are left unchanged.
    // Fields referenced in the mask, but not present in the input document, are
    // deleted from the document on the server.
    // The field paths in this mask must not contain a reserved field name.
    UpdateMask *DocumentMask `protobuf:"bytes,3,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
    // An optional precondition on the document.
    //
    // The write will fail if this is set and not met by the target document.
    CurrentDocument      *Precondition `protobuf:"bytes,4,opt,name=current_document,json=currentDocument,proto3" json:"current_document,omitempty"`
    XXX_NoUnkeyedLiteral struct{}      `json:"-"`
    XXX_unrecognized     []byte        `json:"-"`
    XXX_sizecache        int32         `json:"-"`
}

A write on a document.

func (*Write) Descriptor Uses

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

func (*Write) GetCurrentDocument Uses

func (m *Write) GetCurrentDocument() *Precondition

func (*Write) GetDelete Uses

func (m *Write) GetDelete() string

func (*Write) GetOperation Uses

func (m *Write) GetOperation() isWrite_Operation

func (*Write) GetTransform Uses

func (m *Write) GetTransform() *DocumentTransform

func (*Write) GetUpdate Uses

func (m *Write) GetUpdate() *Document

func (*Write) GetUpdateMask Uses

func (m *Write) GetUpdateMask() *DocumentMask

func (*Write) ProtoMessage Uses

func (*Write) ProtoMessage()

func (*Write) Reset Uses

func (m *Write) Reset()

func (*Write) String Uses

func (m *Write) String() string

func (*Write) XXX_DiscardUnknown Uses

func (m *Write) XXX_DiscardUnknown()

func (*Write) XXX_Marshal Uses

func (m *Write) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Write) XXX_Merge Uses

func (m *Write) XXX_Merge(src proto.Message)

func (*Write) XXX_OneofWrappers Uses

func (*Write) XXX_OneofWrappers() []interface{}

XXX_OneofWrappers is for the internal use of the proto package.

func (*Write) XXX_Size Uses

func (m *Write) XXX_Size() int

func (*Write) XXX_Unmarshal Uses

func (m *Write) XXX_Unmarshal(b []byte) error

type WriteRequest Uses

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

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

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

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

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

func (*WriteRequest) Descriptor Uses

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

func (*WriteRequest) GetDatabase Uses

func (m *WriteRequest) GetDatabase() string

func (*WriteRequest) GetLabels Uses

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

func (*WriteRequest) GetStreamId Uses

func (m *WriteRequest) GetStreamId() string

func (*WriteRequest) GetStreamToken Uses

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

func (*WriteRequest) GetWrites Uses

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

func (*WriteRequest) ProtoMessage Uses

func (*WriteRequest) ProtoMessage()

func (*WriteRequest) Reset Uses

func (m *WriteRequest) Reset()

func (*WriteRequest) String Uses

func (m *WriteRequest) String() string

func (*WriteRequest) XXX_DiscardUnknown Uses

func (m *WriteRequest) XXX_DiscardUnknown()

func (*WriteRequest) XXX_Marshal Uses

func (m *WriteRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*WriteRequest) XXX_Merge Uses

func (m *WriteRequest) XXX_Merge(src proto.Message)

func (*WriteRequest) XXX_Size Uses

func (m *WriteRequest) XXX_Size() int

func (*WriteRequest) XXX_Unmarshal Uses

func (m *WriteRequest) XXX_Unmarshal(b []byte) error

type WriteResponse Uses

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

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

func (*WriteResponse) Descriptor Uses

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

func (*WriteResponse) GetCommitTime Uses

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

func (*WriteResponse) GetStreamId Uses

func (m *WriteResponse) GetStreamId() string

func (*WriteResponse) GetStreamToken Uses

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

func (*WriteResponse) GetWriteResults Uses

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

func (*WriteResponse) ProtoMessage Uses

func (*WriteResponse) ProtoMessage()

func (*WriteResponse) Reset Uses

func (m *WriteResponse) Reset()

func (*WriteResponse) String Uses

func (m *WriteResponse) String() string

func (*WriteResponse) XXX_DiscardUnknown Uses

func (m *WriteResponse) XXX_DiscardUnknown()

func (*WriteResponse) XXX_Marshal Uses

func (m *WriteResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*WriteResponse) XXX_Merge Uses

func (m *WriteResponse) XXX_Merge(src proto.Message)

func (*WriteResponse) XXX_Size Uses

func (m *WriteResponse) XXX_Size() int

func (*WriteResponse) XXX_Unmarshal Uses

func (m *WriteResponse) XXX_Unmarshal(b []byte) error

type WriteResult Uses

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

The result of applying a write.

func (*WriteResult) Descriptor Uses

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

func (*WriteResult) GetTransformResults Uses

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

func (*WriteResult) GetUpdateTime Uses

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

func (*WriteResult) ProtoMessage Uses

func (*WriteResult) ProtoMessage()

func (*WriteResult) Reset Uses

func (m *WriteResult) Reset()

func (*WriteResult) String Uses

func (m *WriteResult) String() string

func (*WriteResult) XXX_DiscardUnknown Uses

func (m *WriteResult) XXX_DiscardUnknown()

func (*WriteResult) XXX_Marshal Uses

func (m *WriteResult) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*WriteResult) XXX_Merge Uses

func (m *WriteResult) XXX_Merge(src proto.Message)

func (*WriteResult) XXX_Size Uses

func (m *WriteResult) XXX_Size() int

func (*WriteResult) XXX_Unmarshal Uses

func (m *WriteResult) XXX_Unmarshal(b []byte) error

type Write_Delete Uses

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

type Write_Transform Uses

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

type Write_Update Uses

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

Package firestore imports 14 packages (graph) and is imported by 9 packages. Updated 2019-12-05. Refresh now. Tools for package owners.