api: google.golang.org/api/firestore/v1beta1 Index | Files

package firestore

import "google.golang.org/api/firestore/v1beta1"

Package firestore provides access to the Cloud Firestore API.

This package is DEPRECATED. Use package cloud.google.com/go/firestore instead.

For product documentation, see: https://cloud.google.com/firestore

Creating a client

Usage example:

import "google.golang.org/api/firestore/v1beta1"
...
ctx := context.Background()
firestoreService, err := firestore.NewService(ctx)

In this example, Google Application Default Credentials are used for authentication.

For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options

By default, all available scopes (see "Constants") are used to authenticate. To restrict scopes, use option.WithScopes:

firestoreService, err := firestore.NewService(ctx, option.WithScopes(firestore.DatastoreScope))

To use an API key for authentication (note: some APIs do not support API keys), use option.WithAPIKey:

firestoreService, err := firestore.NewService(ctx, option.WithAPIKey("AIza..."))

To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow), use option.WithTokenSource:

config := &oauth2.Config{...}
// ...
token, err := config.Exchange(ctx, ...)
firestoreService, err := firestore.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

See https://godoc.org/google.golang.org/api/option/ for details on options.

Index

Package Files

firestore-gen.go

Constants

const (
    // View and manage your data across Google Cloud Platform services
    CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"

    // View and manage your Google Cloud Datastore data
    DatastoreScope = "https://www.googleapis.com/auth/datastore"
)

OAuth2 scopes used by this API.

type ArrayValue Uses

type ArrayValue struct {
    // Values: Values in the array.
    Values []*Value `json:"values,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Values") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Values") to include in API
    // requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

ArrayValue: An array value.

func (*ArrayValue) MarshalJSON Uses

func (s *ArrayValue) MarshalJSON() ([]byte, error)

type BatchGetDocumentsRequest Uses

type BatchGetDocumentsRequest struct {
    // Documents: The names of the documents to retrieve. In the
    // format:
    // `projects/{project_id}/databases/{database_id}/documents/{docu
    // ment_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 `json:"documents,omitempty"`

    // Mask: 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 `json:"mask,omitempty"`

    // NewTransaction: Starts a new transaction and reads the
    // documents.
    // Defaults to a read-only transaction.
    // The new transaction ID will be returned as the first response in
    // the
    // stream.
    NewTransaction *TransactionOptions `json:"newTransaction,omitempty"`

    // ReadTime: Reads documents as they were at the given time.
    // This may not be older than 60 seconds.
    ReadTime string `json:"readTime,omitempty"`

    // Transaction: Reads documents in a transaction.
    Transaction string `json:"transaction,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Documents") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Documents") to include in
    // API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

BatchGetDocumentsRequest: The request for Firestore.BatchGetDocuments.

func (*BatchGetDocumentsRequest) MarshalJSON Uses

func (s *BatchGetDocumentsRequest) MarshalJSON() ([]byte, error)

type BatchGetDocumentsResponse Uses

type BatchGetDocumentsResponse struct {
    // Found: A document that was requested.
    Found *Document `json:"found,omitempty"`

    // Missing: A document name that was requested but does not exist. In
    // the
    // format:
    // `projects/{project_id}/databases/{database_id}/documents/{docu
    // ment_path}`.
    Missing string `json:"missing,omitempty"`

    // ReadTime: 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 string `json:"readTime,omitempty"`

    // Transaction: The transaction that was started as part of this
    // request.
    // Will only be set in the first response, and only
    // if
    // BatchGetDocumentsRequest.new_transaction was set in the request.
    Transaction string `json:"transaction,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "Found") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Found") to include in API
    // requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

BatchGetDocumentsResponse: The streamed response for Firestore.BatchGetDocuments.

func (*BatchGetDocumentsResponse) MarshalJSON Uses

func (s *BatchGetDocumentsResponse) MarshalJSON() ([]byte, error)

type BeginTransactionRequest Uses

type BeginTransactionRequest struct {
    // Options: The options for the transaction.
    // Defaults to a read-write transaction.
    Options *TransactionOptions `json:"options,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Options") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Options") to include in
    // API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

BeginTransactionRequest: The request for Firestore.BeginTransaction.

func (*BeginTransactionRequest) MarshalJSON Uses

func (s *BeginTransactionRequest) MarshalJSON() ([]byte, error)

type BeginTransactionResponse Uses

type BeginTransactionResponse struct {
    // Transaction: The transaction that was started.
    Transaction string `json:"transaction,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "Transaction") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Transaction") to include
    // in API requests with the JSON null value. By default, fields with
    // empty values are omitted from API requests. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

BeginTransactionResponse: The response for Firestore.BeginTransaction.

func (*BeginTransactionResponse) MarshalJSON Uses

func (s *BeginTransactionResponse) MarshalJSON() ([]byte, error)

type CollectionSelector Uses

type CollectionSelector struct {
    // AllDescendants: 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 `json:"allDescendants,omitempty"`

    // CollectionId: The collection ID.
    // When set, selects only collections with this ID.
    CollectionId string `json:"collectionId,omitempty"`

    // ForceSendFields is a list of field names (e.g. "AllDescendants") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "AllDescendants") to
    // include in API requests with the JSON null value. By default, fields
    // with empty values are omitted from API requests. However, any field
    // with an empty value appearing in NullFields will be sent to the
    // server as null. It is an error if a field in this list has a
    // non-empty value. This may be used to include null fields in Patch
    // requests.
    NullFields []string `json:"-"`
}

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

func (*CollectionSelector) MarshalJSON Uses

func (s *CollectionSelector) MarshalJSON() ([]byte, error)

type CommitRequest Uses

type CommitRequest struct {
    // Transaction: If set, applies all writes in this transaction, and
    // commits it.
    Transaction string `json:"transaction,omitempty"`

    // Writes: The writes to apply.
    //
    // Always executed atomically and in order.
    Writes []*Write `json:"writes,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Transaction") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Transaction") to include
    // in API requests with the JSON null value. By default, fields with
    // empty values are omitted from API requests. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

CommitRequest: The request for Firestore.Commit.

func (*CommitRequest) MarshalJSON Uses

func (s *CommitRequest) MarshalJSON() ([]byte, error)

type CommitResponse Uses

type CommitResponse struct {
    // CommitTime: The time at which the commit occurred.
    CommitTime string `json:"commitTime,omitempty"`

    // WriteResults: The result of applying the writes.
    //
    // This i-th write result corresponds to the i-th write in the
    // request.
    WriteResults []*WriteResult `json:"writeResults,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "CommitTime") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "CommitTime") to include in
    // API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

CommitResponse: The response for Firestore.Commit.

func (*CommitResponse) MarshalJSON Uses

func (s *CommitResponse) MarshalJSON() ([]byte, error)

type CompositeFilter Uses

type CompositeFilter struct {
    // Filters: The list of filters to combine.
    // Must contain at least one filter.
    Filters []*Filter `json:"filters,omitempty"`

    // Op: The operator for combining multiple filters.
    //
    // Possible values:
    //   "OPERATOR_UNSPECIFIED" - Unspecified. This value must not be used.
    //   "AND" - The results are required to satisfy each of the combined
    // filters.
    Op  string `json:"op,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Filters") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Filters") to include in
    // API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

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

func (*CompositeFilter) MarshalJSON Uses

func (s *CompositeFilter) MarshalJSON() ([]byte, error)

type Cursor Uses

type Cursor struct {
    // Before: If the position is just before or just after the given
    // values, relative
    // to the sort order defined by the query.
    Before bool `json:"before,omitempty"`

    // Values: 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 `json:"values,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Before") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Before") to include in API
    // requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

Cursor: A position in a query result set.

func (*Cursor) MarshalJSON Uses

func (s *Cursor) MarshalJSON() ([]byte, error)

type Document Uses

type Document struct {
    // CreateTime: 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 string `json:"createTime,omitempty"`

    // Fields: 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 `json:"fields,omitempty"`

    // Name: The resource name of the document, for
    // example
    // `projects/{project_id}/databases/{database_id}/documents/{docu
    // ment_path}`.
    Name string `json:"name,omitempty"`

    // UpdateTime: 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 string `json:"updateTime,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "CreateTime") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "CreateTime") to include in
    // API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

Document: A Firestore document.

Must not exceed 1 MiB - 4 bytes.

func (*Document) MarshalJSON Uses

func (s *Document) MarshalJSON() ([]byte, error)

type DocumentChange Uses

type DocumentChange struct {
    // Document: The new state of the Document.
    //
    // If `mask` is set, contains only fields that were updated or added.
    Document *Document `json:"document,omitempty"`

    // RemovedTargetIds: A set of target IDs for targets that no longer
    // match this document.
    RemovedTargetIds []int64 `json:"removedTargetIds,omitempty"`

    // TargetIds: A set of target IDs of targets that match this document.
    TargetIds []int64 `json:"targetIds,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Document") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Document") to include in
    // API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

DocumentChange: A Document has changed.

May be the result of multiple writes, including deletes, that ultimately resulted in a new value for the Document.

Multiple DocumentChange messages may be returned for the same logical change, if multiple targets are affected.

func (*DocumentChange) MarshalJSON Uses

func (s *DocumentChange) MarshalJSON() ([]byte, error)

type DocumentDelete Uses

type DocumentDelete struct {
    // Document: The resource name of the Document that was deleted.
    Document string `json:"document,omitempty"`

    // ReadTime: The read timestamp at which the delete was
    // observed.
    //
    // Greater or equal to the `commit_time` of the delete.
    ReadTime string `json:"readTime,omitempty"`

    // RemovedTargetIds: A set of target IDs for targets that previously
    // matched this entity.
    RemovedTargetIds []int64 `json:"removedTargetIds,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Document") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Document") to include in
    // API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

DocumentDelete: A Document has been deleted.

May be the result of multiple writes, including updates, the last of which deleted the Document.

Multiple DocumentDelete messages may be returned for the same logical delete, if multiple targets are affected.

func (*DocumentDelete) MarshalJSON Uses

func (s *DocumentDelete) MarshalJSON() ([]byte, error)

type DocumentMask Uses

type DocumentMask struct {
    // FieldPaths: The list of field paths in the mask. See Document.fields
    // for a field
    // path syntax reference.
    FieldPaths []string `json:"fieldPaths,omitempty"`

    // ForceSendFields is a list of field names (e.g. "FieldPaths") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "FieldPaths") to include in
    // API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

DocumentMask: 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, and takes in account the dynamic nature of Value.

func (*DocumentMask) MarshalJSON Uses

func (s *DocumentMask) MarshalJSON() ([]byte, error)

type DocumentRemove Uses

type DocumentRemove struct {
    // Document: The resource name of the Document that has gone out of
    // view.
    Document string `json:"document,omitempty"`

    // ReadTime: The read timestamp at which the remove was
    // observed.
    //
    // Greater or equal to the `commit_time` of the change/delete/remove.
    ReadTime string `json:"readTime,omitempty"`

    // RemovedTargetIds: A set of target IDs for targets that previously
    // matched this document.
    RemovedTargetIds []int64 `json:"removedTargetIds,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Document") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Document") to include in
    // API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

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

func (*DocumentRemove) MarshalJSON Uses

func (s *DocumentRemove) MarshalJSON() ([]byte, error)

type DocumentTransform Uses

type DocumentTransform struct {
    // Document: The name of the document to transform.
    Document string `json:"document,omitempty"`

    // FieldTransforms: The list of transformations to apply to the fields
    // of the document, in
    // order.
    // This must not be empty.
    FieldTransforms []*FieldTransform `json:"fieldTransforms,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Document") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Document") to include in
    // API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

DocumentTransform: A transformation of a document.

func (*DocumentTransform) MarshalJSON Uses

func (s *DocumentTransform) MarshalJSON() ([]byte, error)

type DocumentsTarget Uses

type DocumentsTarget struct {
    // Documents: The names of the documents to retrieve. In the
    // format:
    // `projects/{project_id}/databases/{database_id}/documents/{docu
    // ment_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 `json:"documents,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Documents") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Documents") to include in
    // API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

DocumentsTarget: A target specified by a set of documents names.

func (*DocumentsTarget) MarshalJSON Uses

func (s *DocumentsTarget) MarshalJSON() ([]byte, error)

type Empty Uses

type Empty struct {
    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`
}

Empty: A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:

service Foo {
  rpc Bar(google.protobuf.Empty) returns

(google.protobuf.Empty);

}

The JSON representation for `Empty` is empty JSON object `{}`.

type ExistenceFilter Uses

type ExistenceFilter struct {
    // Count: The total count of documents that match 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 int64 `json:"count,omitempty"`

    // TargetId: The target ID to which this filter applies.
    TargetId int64 `json:"targetId,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Count") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Count") to include in API
    // requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

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

func (*ExistenceFilter) MarshalJSON Uses

func (s *ExistenceFilter) MarshalJSON() ([]byte, error)

type FieldFilter Uses

type FieldFilter struct {
    // Field: The field to filter by.
    Field *FieldReference `json:"field,omitempty"`

    // Op: The operator to filter by.
    //
    // Possible values:
    //   "OPERATOR_UNSPECIFIED" - Unspecified. This value must not be used.
    //   "LESS_THAN" - Less than. Requires that the field come first in
    // `order_by`.
    //   "LESS_THAN_OR_EQUAL" - Less than or equal. Requires that the field
    // come first in `order_by`.
    //   "GREATER_THAN" - Greater than. Requires that the field come first
    // in `order_by`.
    //   "GREATER_THAN_OR_EQUAL" - Greater than or equal. Requires that the
    // field come first in
    // `order_by`.
    //   "EQUAL" - Equal.
    //   "ARRAY_CONTAINS" - Contains. Requires that the field is an array.
    Op  string `json:"op,omitempty"`

    // Value: The value to compare to.
    Value *Value `json:"value,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Field") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Field") to include in API
    // requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

FieldFilter: A filter on a specific field.

func (*FieldFilter) MarshalJSON Uses

func (s *FieldFilter) MarshalJSON() ([]byte, error)

type FieldReference Uses

type FieldReference struct {
    FieldPath string `json:"fieldPath,omitempty"`

    // ForceSendFields is a list of field names (e.g. "FieldPath") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "FieldPath") to include in
    // API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

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

func (*FieldReference) MarshalJSON Uses

func (s *FieldReference) MarshalJSON() ([]byte, error)

type FieldTransform Uses

type FieldTransform struct {
    // AppendMissingElements: Append the given elements in order if they are
    // not already present in
    // the current field value.
    // If the field is not an array, or if the field does not yet exist, it
    // is
    // first set to the empty array.
    //
    // Equivalent numbers of different types (e.g. 3L and 3.0)
    // are
    // considered equal when checking if a value is missing.
    // NaN is equal to NaN, and Null is equal to Null.
    // If the input contains multiple equivalent values, only the first
    // will
    // be considered.
    //
    // The corresponding transform_result will be the null value.
    AppendMissingElements *ArrayValue `json:"appendMissingElements,omitempty"`

    // FieldPath: The path of the field. See Document.fields for the field
    // path syntax
    // reference.
    FieldPath string `json:"fieldPath,omitempty"`

    // Increment: Adds the given value to the field's current value.
    //
    // This must be an integer or a double value.
    // If the field is not an integer or double, or if the field does not
    // yet
    // exist, the transformation will set the field to the given value.
    // If either of the given value or the current field value are
    // doubles,
    // both values will be interpreted as doubles. Double arithmetic
    // and
    // representation of double values follow IEEE 754 semantics.
    // If there is positive/negative integer overflow, the field is
    // resolved
    // to the largest magnitude positive/negative integer.
    Increment *Value `json:"increment,omitempty"`

    // Maximum: Sets the field to the maximum of its current value and the
    // given value.
    //
    // This must be an integer or a double value.
    // If the field is not an integer or double, or if the field does not
    // yet
    // exist, the transformation will set the field to the given value.
    // If a maximum operation is applied where the field and the input
    // value
    // are of mixed types (that is - one is an integer and one is a
    // double)
    // the field takes on the type of the larger operand. If the operands
    // are
    // equivalent (e.g. 3 and 3.0), the field does not change.
    // 0, 0.0, and -0.0 are all zero. The maximum of a zero stored value
    // and
    // zero input value is always the stored value.
    // The maximum of any numeric value x and NaN is NaN.
    Maximum *Value `json:"maximum,omitempty"`

    // Minimum: Sets the field to the minimum of its current value and the
    // given value.
    //
    // This must be an integer or a double value.
    // If the field is not an integer or double, or if the field does not
    // yet
    // exist, the transformation will set the field to the input value.
    // If a minimum operation is applied where the field and the input
    // value
    // are of mixed types (that is - one is an integer and one is a
    // double)
    // the field takes on the type of the smaller operand. If the operands
    // are
    // equivalent (e.g. 3 and 3.0), the field does not change.
    // 0, 0.0, and -0.0 are all zero. The minimum of a zero stored value
    // and
    // zero input value is always the stored value.
    // The minimum of any numeric value x and NaN is NaN.
    Minimum *Value `json:"minimum,omitempty"`

    // RemoveAllFromArray: Remove all of the given elements from the array
    // in the field.
    // If the field is not an array, or if the field does not yet exist, it
    // is
    // set to the empty array.
    //
    // Equivalent numbers of the different types (e.g. 3L and 3.0)
    // are
    // considered equal when deciding whether an element should be
    // removed.
    // NaN is equal to NaN, and Null is equal to Null.
    // This will remove all equivalent values if there are duplicates.
    //
    // The corresponding transform_result will be the null value.
    RemoveAllFromArray *ArrayValue `json:"removeAllFromArray,omitempty"`

    // SetToServerValue: Sets the field to the given server value.
    //
    // Possible values:
    //   "SERVER_VALUE_UNSPECIFIED" - Unspecified. This value must not be
    // used.
    //   "REQUEST_TIME" - The time at which the server processed the
    // request, with millisecond
    // precision.
    SetToServerValue string `json:"setToServerValue,omitempty"`

    // ForceSendFields is a list of field names (e.g.
    // "AppendMissingElements") to unconditionally include in API requests.
    // By default, fields with empty values are omitted from API requests.
    // However, any non-pointer, non-interface field appearing in
    // ForceSendFields will be sent to the server regardless of whether the
    // field is empty or not. This may be used to include empty fields in
    // Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "AppendMissingElements") to
    // include in API requests with the JSON null value. By default, fields
    // with empty values are omitted from API requests. However, any field
    // with an empty value appearing in NullFields will be sent to the
    // server as null. It is an error if a field in this list has a
    // non-empty value. This may be used to include null fields in Patch
    // requests.
    NullFields []string `json:"-"`
}

FieldTransform: A transformation of a field of the document.

func (*FieldTransform) MarshalJSON Uses

func (s *FieldTransform) MarshalJSON() ([]byte, error)

type Filter Uses

type Filter struct {
    // CompositeFilter: A composite filter.
    CompositeFilter *CompositeFilter `json:"compositeFilter,omitempty"`

    // FieldFilter: A filter on a document field.
    FieldFilter *FieldFilter `json:"fieldFilter,omitempty"`

    // UnaryFilter: A filter that takes exactly one argument.
    UnaryFilter *UnaryFilter `json:"unaryFilter,omitempty"`

    // ForceSendFields is a list of field names (e.g. "CompositeFilter") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "CompositeFilter") to
    // include in API requests with the JSON null value. By default, fields
    // with empty values are omitted from API requests. However, any field
    // with an empty value appearing in NullFields will be sent to the
    // server as null. It is an error if a field in this list has a
    // non-empty value. This may be used to include null fields in Patch
    // requests.
    NullFields []string `json:"-"`
}

Filter: A filter.

func (*Filter) MarshalJSON Uses

func (s *Filter) MarshalJSON() ([]byte, error)

type GoogleFirestoreAdminV1beta1ExportDocumentsMetadata Uses

type GoogleFirestoreAdminV1beta1ExportDocumentsMetadata struct {
    // CollectionIds: Which collection ids are being exported.
    CollectionIds []string `json:"collectionIds,omitempty"`

    // EndTime: The time the operation ended, either successfully or
    // otherwise. Unset if
    // the operation is still active.
    EndTime string `json:"endTime,omitempty"`

    // OperationState: The state of the export operation.
    //
    // Possible values:
    //   "STATE_UNSPECIFIED" - Unspecified.
    //   "INITIALIZING" - Request is being prepared for processing.
    //   "PROCESSING" - Request is actively being processed.
    //   "CANCELLING" - Request is in the process of being cancelled after
    // user called
    // google.longrunning.Operations.CancelOperation on the operation.
    //   "FINALIZING" - Request has been processed and is in its
    // finalization stage.
    //   "SUCCESSFUL" - Request has completed successfully.
    //   "FAILED" - Request has finished being processed, but encountered an
    // error.
    //   "CANCELLED" - Request has finished being cancelled after user
    // called
    // google.longrunning.Operations.CancelOperation.
    OperationState string `json:"operationState,omitempty"`

    // OutputUriPrefix: Where the entities are being exported to.
    OutputUriPrefix string `json:"outputUriPrefix,omitempty"`

    // ProgressBytes: An estimate of the number of bytes processed.
    ProgressBytes *GoogleFirestoreAdminV1beta1Progress `json:"progressBytes,omitempty"`

    // ProgressDocuments: An estimate of the number of documents processed.
    ProgressDocuments *GoogleFirestoreAdminV1beta1Progress `json:"progressDocuments,omitempty"`

    // StartTime: The time that work began on the operation.
    StartTime string `json:"startTime,omitempty"`

    // ForceSendFields is a list of field names (e.g. "CollectionIds") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "CollectionIds") to include
    // in API requests with the JSON null value. By default, fields with
    // empty values are omitted from API requests. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

GoogleFirestoreAdminV1beta1ExportDocumentsMetadata: Metadata for ExportDocuments operations.

func (*GoogleFirestoreAdminV1beta1ExportDocumentsMetadata) MarshalJSON Uses

func (s *GoogleFirestoreAdminV1beta1ExportDocumentsMetadata) MarshalJSON() ([]byte, error)

type GoogleFirestoreAdminV1beta1ExportDocumentsRequest Uses

type GoogleFirestoreAdminV1beta1ExportDocumentsRequest struct {
    // CollectionIds: Which collection ids to export. Unspecified means all
    // collections.
    CollectionIds []string `json:"collectionIds,omitempty"`

    // OutputUriPrefix: The output URI. Currently only supports Google Cloud
    // Storage URIs of the
    // form: `gs://BUCKET_NAME[/NAMESPACE_PATH]`, where `BUCKET_NAME` is the
    // name
    // of the Google Cloud Storage bucket and `NAMESPACE_PATH` is an
    // optional
    // Google Cloud Storage namespace path. When
    // choosing a name, be sure to consider Google Cloud Storage
    // naming
    // guidelines: https://cloud.google.com/storage/docs/naming.
    // If the URI is a bucket (without a namespace path), a prefix will
    // be
    // generated based on the start time.
    OutputUriPrefix string `json:"outputUriPrefix,omitempty"`

    // ForceSendFields is a list of field names (e.g. "CollectionIds") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "CollectionIds") to include
    // in API requests with the JSON null value. By default, fields with
    // empty values are omitted from API requests. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

GoogleFirestoreAdminV1beta1ExportDocumentsRequest: The request for FirestoreAdmin.ExportDocuments.

func (*GoogleFirestoreAdminV1beta1ExportDocumentsRequest) MarshalJSON Uses

func (s *GoogleFirestoreAdminV1beta1ExportDocumentsRequest) MarshalJSON() ([]byte, error)

type GoogleFirestoreAdminV1beta1ExportDocumentsResponse Uses

type GoogleFirestoreAdminV1beta1ExportDocumentsResponse struct {
    // OutputUriPrefix: Location of the output files. This can be used to
    // begin an import
    // into Cloud Firestore (this project or another project) after the
    // operation
    // completes successfully.
    OutputUriPrefix string `json:"outputUriPrefix,omitempty"`

    // ForceSendFields is a list of field names (e.g. "OutputUriPrefix") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "OutputUriPrefix") to
    // include in API requests with the JSON null value. By default, fields
    // with empty values are omitted from API requests. However, any field
    // with an empty value appearing in NullFields will be sent to the
    // server as null. It is an error if a field in this list has a
    // non-empty value. This may be used to include null fields in Patch
    // requests.
    NullFields []string `json:"-"`
}

GoogleFirestoreAdminV1beta1ExportDocumentsResponse: Returned in the google.longrunning.Operation response field.

func (*GoogleFirestoreAdminV1beta1ExportDocumentsResponse) MarshalJSON Uses

func (s *GoogleFirestoreAdminV1beta1ExportDocumentsResponse) MarshalJSON() ([]byte, error)

type GoogleFirestoreAdminV1beta1ImportDocumentsMetadata Uses

type GoogleFirestoreAdminV1beta1ImportDocumentsMetadata struct {
    // CollectionIds: Which collection ids are being imported.
    CollectionIds []string `json:"collectionIds,omitempty"`

    // EndTime: The time the operation ended, either successfully or
    // otherwise. Unset if
    // the operation is still active.
    EndTime string `json:"endTime,omitempty"`

    // InputUriPrefix: The location of the documents being imported.
    InputUriPrefix string `json:"inputUriPrefix,omitempty"`

    // OperationState: The state of the import operation.
    //
    // Possible values:
    //   "STATE_UNSPECIFIED" - Unspecified.
    //   "INITIALIZING" - Request is being prepared for processing.
    //   "PROCESSING" - Request is actively being processed.
    //   "CANCELLING" - Request is in the process of being cancelled after
    // user called
    // google.longrunning.Operations.CancelOperation on the operation.
    //   "FINALIZING" - Request has been processed and is in its
    // finalization stage.
    //   "SUCCESSFUL" - Request has completed successfully.
    //   "FAILED" - Request has finished being processed, but encountered an
    // error.
    //   "CANCELLED" - Request has finished being cancelled after user
    // called
    // google.longrunning.Operations.CancelOperation.
    OperationState string `json:"operationState,omitempty"`

    // ProgressBytes: An estimate of the number of bytes processed.
    ProgressBytes *GoogleFirestoreAdminV1beta1Progress `json:"progressBytes,omitempty"`

    // ProgressDocuments: An estimate of the number of documents processed.
    ProgressDocuments *GoogleFirestoreAdminV1beta1Progress `json:"progressDocuments,omitempty"`

    // StartTime: The time that work began on the operation.
    StartTime string `json:"startTime,omitempty"`

    // ForceSendFields is a list of field names (e.g. "CollectionIds") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "CollectionIds") to include
    // in API requests with the JSON null value. By default, fields with
    // empty values are omitted from API requests. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

GoogleFirestoreAdminV1beta1ImportDocumentsMetadata: Metadata for ImportDocuments operations.

func (*GoogleFirestoreAdminV1beta1ImportDocumentsMetadata) MarshalJSON Uses

func (s *GoogleFirestoreAdminV1beta1ImportDocumentsMetadata) MarshalJSON() ([]byte, error)

type GoogleFirestoreAdminV1beta1ImportDocumentsRequest Uses

type GoogleFirestoreAdminV1beta1ImportDocumentsRequest struct {
    // CollectionIds: Which collection ids to import. Unspecified means all
    // collections included
    // in the import.
    CollectionIds []string `json:"collectionIds,omitempty"`

    // InputUriPrefix: Location of the exported files.
    // This must match the output_uri_prefix of an ExportDocumentsResponse
    // from
    // an export that has completed
    // successfully.
    // See:
    // google.firestore.admin.v1beta1.ExportDocumentsRespo
    // nse.output_uri_prefix.
    InputUriPrefix string `json:"inputUriPrefix,omitempty"`

    // ForceSendFields is a list of field names (e.g. "CollectionIds") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "CollectionIds") to include
    // in API requests with the JSON null value. By default, fields with
    // empty values are omitted from API requests. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

GoogleFirestoreAdminV1beta1ImportDocumentsRequest: The request for FirestoreAdmin.ImportDocuments.

func (*GoogleFirestoreAdminV1beta1ImportDocumentsRequest) MarshalJSON Uses

func (s *GoogleFirestoreAdminV1beta1ImportDocumentsRequest) MarshalJSON() ([]byte, error)

type GoogleFirestoreAdminV1beta1Index Uses

type GoogleFirestoreAdminV1beta1Index struct {
    // CollectionId: The collection ID to which this index applies.
    // Required.
    CollectionId string `json:"collectionId,omitempty"`

    // Fields: The fields to index.
    Fields []*GoogleFirestoreAdminV1beta1IndexField `json:"fields,omitempty"`

    // Name: The resource name of the index.
    // Output only.
    Name string `json:"name,omitempty"`

    // State: The state of the index.
    // Output only.
    //
    // Possible values:
    //   "STATE_UNSPECIFIED" - The state is unspecified.
    //   "CREATING" - The index is being created.
    // There is an active long-running operation for the index.
    // The index is updated when writing a document.
    // Some index data may exist.
    //   "READY" - The index is ready to be used.
    // The index is updated when writing a document.
    // The index is fully populated from all stored documents it applies to.
    //   "ERROR" - The index was being created, but something went
    // wrong.
    // There is no active long-running operation for the index,
    // and the most recently finished long-running operation failed.
    // The index is not updated when writing a document.
    // Some index data may exist.
    State string `json:"state,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "CollectionId") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "CollectionId") to include
    // in API requests with the JSON null value. By default, fields with
    // empty values are omitted from API requests. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

GoogleFirestoreAdminV1beta1Index: An index definition.

func (*GoogleFirestoreAdminV1beta1Index) MarshalJSON Uses

func (s *GoogleFirestoreAdminV1beta1Index) MarshalJSON() ([]byte, error)

type GoogleFirestoreAdminV1beta1IndexField Uses

type GoogleFirestoreAdminV1beta1IndexField struct {
    // FieldPath: The path of the field. Must match the field path
    // specification described
    // by google.firestore.v1beta1.Document.fields.
    // Special field path `__name__` may be used by itself or at the end of
    // a
    // path. `__type__` may be used only at the end of path.
    FieldPath string `json:"fieldPath,omitempty"`

    // Mode: The field's mode.
    //
    // Possible values:
    //   "MODE_UNSPECIFIED" - The mode is unspecified.
    //   "ASCENDING" - The field's values are indexed so as to support
    // sequencing in
    // ascending order and also query by <, >, <=, >=, and =.
    //   "DESCENDING" - The field's values are indexed so as to support
    // sequencing in
    // descending order and also query by <, >, <=, >=, and =.
    //   "ARRAY_CONTAINS" - The field's array values are indexed so as to
    // support membership using
    // ARRAY_CONTAINS queries.
    Mode string `json:"mode,omitempty"`

    // ForceSendFields is a list of field names (e.g. "FieldPath") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "FieldPath") to include in
    // API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

GoogleFirestoreAdminV1beta1IndexField: A field of an index.

func (*GoogleFirestoreAdminV1beta1IndexField) MarshalJSON Uses

func (s *GoogleFirestoreAdminV1beta1IndexField) MarshalJSON() ([]byte, error)

type GoogleFirestoreAdminV1beta1IndexOperationMetadata Uses

type GoogleFirestoreAdminV1beta1IndexOperationMetadata struct {
    // Cancelled: True if the [google.longrunning.Operation] was cancelled.
    // If the
    // cancellation is in progress, cancelled will be true
    // but
    // google.longrunning.Operation.done will be false.
    Cancelled bool `json:"cancelled,omitempty"`

    // DocumentProgress: Progress of the existing operation, measured in
    // number of documents.
    DocumentProgress *GoogleFirestoreAdminV1beta1Progress `json:"documentProgress,omitempty"`

    // EndTime: The time the operation ended, either successfully or
    // otherwise. Unset if
    // the operation is still active.
    EndTime string `json:"endTime,omitempty"`

    // Index: The index resource that this operation is acting on. For
    // example:
    // `projects/{project_id}/databases/{database_id}/indexes/{index
    // _id}`
    Index string `json:"index,omitempty"`

    // OperationType: The type of index operation.
    //
    // Possible values:
    //   "OPERATION_TYPE_UNSPECIFIED" - Unspecified. Never set by server.
    //   "CREATING_INDEX" - The operation is creating the index. Initiated
    // by a `CreateIndex` call.
    OperationType string `json:"operationType,omitempty"`

    // StartTime: The time that work began on the operation.
    StartTime string `json:"startTime,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Cancelled") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Cancelled") to include in
    // API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

GoogleFirestoreAdminV1beta1IndexOperationMetadata: Metadata for index operations. This metadata populates the metadata field of google.longrunning.Operation.

func (*GoogleFirestoreAdminV1beta1IndexOperationMetadata) MarshalJSON Uses

func (s *GoogleFirestoreAdminV1beta1IndexOperationMetadata) MarshalJSON() ([]byte, error)

type GoogleFirestoreAdminV1beta1ListIndexesResponse Uses

type GoogleFirestoreAdminV1beta1ListIndexesResponse struct {
    // Indexes: The indexes.
    Indexes []*GoogleFirestoreAdminV1beta1Index `json:"indexes,omitempty"`

    // NextPageToken: The standard List next-page token.
    NextPageToken string `json:"nextPageToken,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "Indexes") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Indexes") to include in
    // API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

GoogleFirestoreAdminV1beta1ListIndexesResponse: The response for FirestoreAdmin.ListIndexes.

func (*GoogleFirestoreAdminV1beta1ListIndexesResponse) MarshalJSON Uses

func (s *GoogleFirestoreAdminV1beta1ListIndexesResponse) MarshalJSON() ([]byte, error)

type GoogleFirestoreAdminV1beta1LocationMetadata Uses

type GoogleFirestoreAdminV1beta1LocationMetadata struct {
}

GoogleFirestoreAdminV1beta1LocationMetadata: The metadata message for google.cloud.location.Location.metadata.

type GoogleFirestoreAdminV1beta1Progress Uses

type GoogleFirestoreAdminV1beta1Progress struct {
    // WorkCompleted: An estimate of how much work has been completed. Note
    // that this may be
    // greater than `work_estimated`.
    WorkCompleted int64 `json:"workCompleted,omitempty,string"`

    // WorkEstimated: An estimate of how much work needs to be performed.
    // Zero if the
    // work estimate is unavailable. May change as work progresses.
    WorkEstimated int64 `json:"workEstimated,omitempty,string"`

    // ForceSendFields is a list of field names (e.g. "WorkCompleted") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "WorkCompleted") to include
    // in API requests with the JSON null value. By default, fields with
    // empty values are omitted from API requests. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

GoogleFirestoreAdminV1beta1Progress: Measures the progress of a particular metric.

func (*GoogleFirestoreAdminV1beta1Progress) MarshalJSON Uses

func (s *GoogleFirestoreAdminV1beta1Progress) MarshalJSON() ([]byte, error)

type GoogleLongrunningOperation Uses

type GoogleLongrunningOperation struct {
    // Done: If the value is `false`, it means the operation is still in
    // progress.
    // If `true`, the operation is completed, and either `error` or
    // `response` is
    // available.
    Done bool `json:"done,omitempty"`

    // Error: The error result of the operation in case of failure or
    // cancellation.
    Error *Status `json:"error,omitempty"`

    // Metadata: Service-specific metadata associated with the operation.
    // It typically
    // contains progress information and common metadata such as create
    // time.
    // Some services might not provide such metadata.  Any method that
    // returns a
    // long-running operation should document the metadata type, if any.
    Metadata googleapi.RawMessage `json:"metadata,omitempty"`

    // Name: The server-assigned name, which is only unique within the same
    // service that
    // originally returns it. If you use the default HTTP mapping,
    // the
    // `name` should have the format of `operations/some/unique/name`.
    Name string `json:"name,omitempty"`

    // Response: The normal response of the operation in case of success.
    // If the original
    // method returns no data on success, such as `Delete`, the response
    // is
    // `google.protobuf.Empty`.  If the original method is
    // standard
    // `Get`/`Create`/`Update`, the response should be the resource.  For
    // other
    // methods, the response should have the type `XxxResponse`, where
    // `Xxx`
    // is the original method name.  For example, if the original method
    // name
    // is `TakeSnapshot()`, the inferred response type
    // is
    // `TakeSnapshotResponse`.
    Response googleapi.RawMessage `json:"response,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "Done") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Done") to include in API
    // requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

GoogleLongrunningOperation: This resource represents a long-running operation that is the result of a network API call.

func (*GoogleLongrunningOperation) MarshalJSON Uses

func (s *GoogleLongrunningOperation) MarshalJSON() ([]byte, error)

type LatLng Uses

type LatLng struct {
    // Latitude: The latitude in degrees. It must be in the range [-90.0,
    // +90.0].
    Latitude float64 `json:"latitude,omitempty"`

    // Longitude: The longitude in degrees. It must be in the range [-180.0,
    // +180.0].
    Longitude float64 `json:"longitude,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Latitude") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Latitude") to include in
    // API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

LatLng: An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 st andard</a>. Values must be within normalized ranges.

func (*LatLng) MarshalJSON Uses

func (s *LatLng) MarshalJSON() ([]byte, error)

func (*LatLng) UnmarshalJSON Uses

func (s *LatLng) UnmarshalJSON(data []byte) error

type ListCollectionIdsRequest Uses

type ListCollectionIdsRequest struct {
    // PageSize: The maximum number of results to return.
    PageSize int64 `json:"pageSize,omitempty"`

    // PageToken: A page token. Must be a value
    // from
    // ListCollectionIdsResponse.
    PageToken string `json:"pageToken,omitempty"`

    // ForceSendFields is a list of field names (e.g. "PageSize") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "PageSize") to include in
    // API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

ListCollectionIdsRequest: The request for Firestore.ListCollectionIds.

func (*ListCollectionIdsRequest) MarshalJSON Uses

func (s *ListCollectionIdsRequest) MarshalJSON() ([]byte, error)

type ListCollectionIdsResponse Uses

type ListCollectionIdsResponse struct {
    // CollectionIds: The collection ids.
    CollectionIds []string `json:"collectionIds,omitempty"`

    // NextPageToken: A page token that may be used to continue the list.
    NextPageToken string `json:"nextPageToken,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "CollectionIds") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "CollectionIds") to include
    // in API requests with the JSON null value. By default, fields with
    // empty values are omitted from API requests. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

ListCollectionIdsResponse: The response from Firestore.ListCollectionIds.

func (*ListCollectionIdsResponse) MarshalJSON Uses

func (s *ListCollectionIdsResponse) MarshalJSON() ([]byte, error)

type ListDocumentsResponse Uses

type ListDocumentsResponse struct {
    // Documents: The Documents found.
    Documents []*Document `json:"documents,omitempty"`

    // NextPageToken: The next page token.
    NextPageToken string `json:"nextPageToken,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "Documents") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Documents") to include in
    // API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

ListDocumentsResponse: The response for Firestore.ListDocuments.

func (*ListDocumentsResponse) MarshalJSON Uses

func (s *ListDocumentsResponse) MarshalJSON() ([]byte, error)

type ListenRequest Uses

type ListenRequest struct {
    // AddTarget: A target to add to this stream.
    AddTarget *Target `json:"addTarget,omitempty"`

    // Labels: Labels associated with this target change.
    Labels map[string]string `json:"labels,omitempty"`

    // RemoveTarget: The ID of a target to remove from this stream.
    RemoveTarget int64 `json:"removeTarget,omitempty"`

    // ForceSendFields is a list of field names (e.g. "AddTarget") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "AddTarget") to include in
    // API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

ListenRequest: A request for Firestore.Listen

func (*ListenRequest) MarshalJSON Uses

func (s *ListenRequest) MarshalJSON() ([]byte, error)

type ListenResponse Uses

type ListenResponse struct {
    // DocumentChange: A Document has changed.
    DocumentChange *DocumentChange `json:"documentChange,omitempty"`

    // DocumentDelete: A Document has been deleted.
    DocumentDelete *DocumentDelete `json:"documentDelete,omitempty"`

    // DocumentRemove: A Document has been removed from a target (because it
    // is no longer
    // relevant to that target).
    DocumentRemove *DocumentRemove `json:"documentRemove,omitempty"`

    // Filter: A filter to apply to the set of documents previously returned
    // for the
    // given target.
    //
    // Returned when documents may have been removed from the given target,
    // but
    // the exact documents are unknown.
    Filter *ExistenceFilter `json:"filter,omitempty"`

    // TargetChange: Targets have changed.
    TargetChange *TargetChange `json:"targetChange,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "DocumentChange") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "DocumentChange") to
    // include in API requests with the JSON null value. By default, fields
    // with empty values are omitted from API requests. However, any field
    // with an empty value appearing in NullFields will be sent to the
    // server as null. It is an error if a field in this list has a
    // non-empty value. This may be used to include null fields in Patch
    // requests.
    NullFields []string `json:"-"`
}

ListenResponse: The response for Firestore.Listen.

func (*ListenResponse) MarshalJSON Uses

func (s *ListenResponse) MarshalJSON() ([]byte, error)

type MapValue Uses

type MapValue struct {
    // Fields: 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 `json:"fields,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Fields") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Fields") to include in API
    // requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

MapValue: A map value.

func (*MapValue) MarshalJSON Uses

func (s *MapValue) MarshalJSON() ([]byte, error)

type Order Uses

type Order struct {
    // Direction: The direction to order by. Defaults to `ASCENDING`.
    //
    // Possible values:
    //   "DIRECTION_UNSPECIFIED" - Unspecified.
    //   "ASCENDING" - Ascending.
    //   "DESCENDING" - Descending.
    Direction string `json:"direction,omitempty"`

    // Field: The field to order by.
    Field *FieldReference `json:"field,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Direction") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Direction") to include in
    // API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

Order: An order on a field.

func (*Order) MarshalJSON Uses

func (s *Order) MarshalJSON() ([]byte, error)

type Precondition Uses

type Precondition struct {
    // Exists: When set to `true`, the target document must exist.
    // When set to `false`, the target document must not exist.
    Exists bool `json:"exists,omitempty"`

    // UpdateTime: When set, the target document must exist and have been
    // last updated at
    // that time.
    UpdateTime string `json:"updateTime,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Exists") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Exists") to include in API
    // requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

Precondition: A precondition on a document, used for conditional operations.

func (*Precondition) MarshalJSON Uses

func (s *Precondition) MarshalJSON() ([]byte, error)

type Projection Uses

type Projection struct {
    // Fields: The fields to return.
    //
    // If empty, all fields are returned. To only return the name
    // of the document, use `['__name__']`.
    Fields []*FieldReference `json:"fields,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Fields") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Fields") to include in API
    // requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

Projection: The projection of document's fields to return.

func (*Projection) MarshalJSON Uses

func (s *Projection) MarshalJSON() ([]byte, error)

type ProjectsDatabasesDocumentsBatchGetCall Uses

type ProjectsDatabasesDocumentsBatchGetCall struct {
    // contains filtered or unexported fields
}

func (*ProjectsDatabasesDocumentsBatchGetCall) Context Uses

func (c *ProjectsDatabasesDocumentsBatchGetCall) Context(ctx context.Context) *ProjectsDatabasesDocumentsBatchGetCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsDatabasesDocumentsBatchGetCall) Do Uses

func (c *ProjectsDatabasesDocumentsBatchGetCall) Do(opts ...googleapi.CallOption) (*BatchGetDocumentsResponse, error)

Do executes the "firestore.projects.databases.documents.batchGet" call. Exactly one of *BatchGetDocumentsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *BatchGetDocumentsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsDatabasesDocumentsBatchGetCall) Fields Uses

func (c *ProjectsDatabasesDocumentsBatchGetCall) Fields(s ...googleapi.Field) *ProjectsDatabasesDocumentsBatchGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsDatabasesDocumentsBatchGetCall) Header Uses

func (c *ProjectsDatabasesDocumentsBatchGetCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsDatabasesDocumentsBeginTransactionCall Uses

type ProjectsDatabasesDocumentsBeginTransactionCall struct {
    // contains filtered or unexported fields
}

func (*ProjectsDatabasesDocumentsBeginTransactionCall) Context Uses

func (c *ProjectsDatabasesDocumentsBeginTransactionCall) Context(ctx context.Context) *ProjectsDatabasesDocumentsBeginTransactionCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsDatabasesDocumentsBeginTransactionCall) Do Uses

func (c *ProjectsDatabasesDocumentsBeginTransactionCall) Do(opts ...googleapi.CallOption) (*BeginTransactionResponse, error)

Do executes the "firestore.projects.databases.documents.beginTransaction" call. Exactly one of *BeginTransactionResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *BeginTransactionResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsDatabasesDocumentsBeginTransactionCall) Fields Uses

func (c *ProjectsDatabasesDocumentsBeginTransactionCall) Fields(s ...googleapi.Field) *ProjectsDatabasesDocumentsBeginTransactionCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsDatabasesDocumentsBeginTransactionCall) Header Uses

func (c *ProjectsDatabasesDocumentsBeginTransactionCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsDatabasesDocumentsCommitCall Uses

type ProjectsDatabasesDocumentsCommitCall struct {
    // contains filtered or unexported fields
}

func (*ProjectsDatabasesDocumentsCommitCall) Context Uses

func (c *ProjectsDatabasesDocumentsCommitCall) Context(ctx context.Context) *ProjectsDatabasesDocumentsCommitCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsDatabasesDocumentsCommitCall) Do Uses

func (c *ProjectsDatabasesDocumentsCommitCall) Do(opts ...googleapi.CallOption) (*CommitResponse, error)

Do executes the "firestore.projects.databases.documents.commit" call. Exactly one of *CommitResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *CommitResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsDatabasesDocumentsCommitCall) Fields Uses

func (c *ProjectsDatabasesDocumentsCommitCall) Fields(s ...googleapi.Field) *ProjectsDatabasesDocumentsCommitCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsDatabasesDocumentsCommitCall) Header Uses

func (c *ProjectsDatabasesDocumentsCommitCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsDatabasesDocumentsCreateDocumentCall Uses

type ProjectsDatabasesDocumentsCreateDocumentCall struct {
    // contains filtered or unexported fields
}

func (*ProjectsDatabasesDocumentsCreateDocumentCall) Context Uses

func (c *ProjectsDatabasesDocumentsCreateDocumentCall) Context(ctx context.Context) *ProjectsDatabasesDocumentsCreateDocumentCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsDatabasesDocumentsCreateDocumentCall) Do Uses

func (c *ProjectsDatabasesDocumentsCreateDocumentCall) Do(opts ...googleapi.CallOption) (*Document, error)

Do executes the "firestore.projects.databases.documents.createDocument" call. Exactly one of *Document or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Document.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsDatabasesDocumentsCreateDocumentCall) DocumentId Uses

func (c *ProjectsDatabasesDocumentsCreateDocumentCall) DocumentId(documentId string) *ProjectsDatabasesDocumentsCreateDocumentCall

DocumentId sets the optional parameter "documentId": The client-assigned document ID to use for this document.

If not specified, an ID will be assigned by the service.

func (*ProjectsDatabasesDocumentsCreateDocumentCall) Fields Uses

func (c *ProjectsDatabasesDocumentsCreateDocumentCall) Fields(s ...googleapi.Field) *ProjectsDatabasesDocumentsCreateDocumentCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsDatabasesDocumentsCreateDocumentCall) Header Uses

func (c *ProjectsDatabasesDocumentsCreateDocumentCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsDatabasesDocumentsCreateDocumentCall) MaskFieldPaths Uses

func (c *ProjectsDatabasesDocumentsCreateDocumentCall) MaskFieldPaths(maskFieldPaths ...string) *ProjectsDatabasesDocumentsCreateDocumentCall

MaskFieldPaths sets the optional parameter "mask.fieldPaths": The list of field paths in the mask. See Document.fields for a field path syntax reference.

type ProjectsDatabasesDocumentsDeleteCall Uses

type ProjectsDatabasesDocumentsDeleteCall struct {
    // contains filtered or unexported fields
}

func (*ProjectsDatabasesDocumentsDeleteCall) Context Uses

func (c *ProjectsDatabasesDocumentsDeleteCall) Context(ctx context.Context) *ProjectsDatabasesDocumentsDeleteCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsDatabasesDocumentsDeleteCall) CurrentDocumentExists Uses

func (c *ProjectsDatabasesDocumentsDeleteCall) CurrentDocumentExists(currentDocumentExists bool) *ProjectsDatabasesDocumentsDeleteCall

CurrentDocumentExists sets the optional parameter "currentDocument.exists": When set to `true`, the target document must exist. When set to `false`, the target document must not exist.

func (*ProjectsDatabasesDocumentsDeleteCall) CurrentDocumentUpdateTime Uses

func (c *ProjectsDatabasesDocumentsDeleteCall) CurrentDocumentUpdateTime(currentDocumentUpdateTime string) *ProjectsDatabasesDocumentsDeleteCall

CurrentDocumentUpdateTime sets the optional parameter "currentDocument.updateTime": When set, the target document must exist and have been last updated at that time.

func (*ProjectsDatabasesDocumentsDeleteCall) Do Uses

func (c *ProjectsDatabasesDocumentsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "firestore.projects.databases.documents.delete" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsDatabasesDocumentsDeleteCall) Fields Uses

func (c *ProjectsDatabasesDocumentsDeleteCall) Fields(s ...googleapi.Field) *ProjectsDatabasesDocumentsDeleteCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsDatabasesDocumentsDeleteCall) Header Uses

func (c *ProjectsDatabasesDocumentsDeleteCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsDatabasesDocumentsGetCall Uses

type ProjectsDatabasesDocumentsGetCall struct {
    // contains filtered or unexported fields
}

func (*ProjectsDatabasesDocumentsGetCall) Context Uses

func (c *ProjectsDatabasesDocumentsGetCall) Context(ctx context.Context) *ProjectsDatabasesDocumentsGetCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsDatabasesDocumentsGetCall) Do Uses

func (c *ProjectsDatabasesDocumentsGetCall) Do(opts ...googleapi.CallOption) (*Document, error)

Do executes the "firestore.projects.databases.documents.get" call. Exactly one of *Document or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Document.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsDatabasesDocumentsGetCall) Fields Uses

func (c *ProjectsDatabasesDocumentsGetCall) Fields(s ...googleapi.Field) *ProjectsDatabasesDocumentsGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsDatabasesDocumentsGetCall) Header Uses

func (c *ProjectsDatabasesDocumentsGetCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsDatabasesDocumentsGetCall) IfNoneMatch Uses

func (c *ProjectsDatabasesDocumentsGetCall) IfNoneMatch(entityTag string) *ProjectsDatabasesDocumentsGetCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsDatabasesDocumentsGetCall) MaskFieldPaths Uses

func (c *ProjectsDatabasesDocumentsGetCall) MaskFieldPaths(maskFieldPaths ...string) *ProjectsDatabasesDocumentsGetCall

MaskFieldPaths sets the optional parameter "mask.fieldPaths": The list of field paths in the mask. See Document.fields for a field path syntax reference.

func (*ProjectsDatabasesDocumentsGetCall) ReadTime Uses

func (c *ProjectsDatabasesDocumentsGetCall) ReadTime(readTime string) *ProjectsDatabasesDocumentsGetCall

ReadTime sets the optional parameter "readTime": Reads the version of the document at the given time. This may not be older than 60 seconds.

func (*ProjectsDatabasesDocumentsGetCall) Transaction Uses

func (c *ProjectsDatabasesDocumentsGetCall) Transaction(transaction string) *ProjectsDatabasesDocumentsGetCall

Transaction sets the optional parameter "transaction": Reads the document in a transaction.

type ProjectsDatabasesDocumentsListCall Uses

type ProjectsDatabasesDocumentsListCall struct {
    // contains filtered or unexported fields
}

func (*ProjectsDatabasesDocumentsListCall) Context Uses

func (c *ProjectsDatabasesDocumentsListCall) Context(ctx context.Context) *ProjectsDatabasesDocumentsListCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsDatabasesDocumentsListCall) Do Uses

func (c *ProjectsDatabasesDocumentsListCall) Do(opts ...googleapi.CallOption) (*ListDocumentsResponse, error)

Do executes the "firestore.projects.databases.documents.list" call. Exactly one of *ListDocumentsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListDocumentsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsDatabasesDocumentsListCall) Fields Uses

func (c *ProjectsDatabasesDocumentsListCall) Fields(s ...googleapi.Field) *ProjectsDatabasesDocumentsListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsDatabasesDocumentsListCall) Header Uses

func (c *ProjectsDatabasesDocumentsListCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsDatabasesDocumentsListCall) IfNoneMatch Uses

func (c *ProjectsDatabasesDocumentsListCall) IfNoneMatch(entityTag string) *ProjectsDatabasesDocumentsListCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsDatabasesDocumentsListCall) MaskFieldPaths Uses

func (c *ProjectsDatabasesDocumentsListCall) MaskFieldPaths(maskFieldPaths ...string) *ProjectsDatabasesDocumentsListCall

MaskFieldPaths sets the optional parameter "mask.fieldPaths": The list of field paths in the mask. See Document.fields for a field path syntax reference.

func (*ProjectsDatabasesDocumentsListCall) OrderBy Uses

func (c *ProjectsDatabasesDocumentsListCall) OrderBy(orderBy string) *ProjectsDatabasesDocumentsListCall

OrderBy sets the optional parameter "orderBy": The order to sort results by. For example: `priority desc, name`.

func (*ProjectsDatabasesDocumentsListCall) PageSize Uses

func (c *ProjectsDatabasesDocumentsListCall) PageSize(pageSize int64) *ProjectsDatabasesDocumentsListCall

PageSize sets the optional parameter "pageSize": The maximum number of documents to return.

func (*ProjectsDatabasesDocumentsListCall) PageToken Uses

func (c *ProjectsDatabasesDocumentsListCall) PageToken(pageToken string) *ProjectsDatabasesDocumentsListCall

PageToken sets the optional parameter "pageToken": The `next_page_token` value returned from a previous List request, if any.

func (*ProjectsDatabasesDocumentsListCall) Pages Uses

func (c *ProjectsDatabasesDocumentsListCall) Pages(ctx context.Context, f func(*ListDocumentsResponse) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

func (*ProjectsDatabasesDocumentsListCall) ReadTime Uses

func (c *ProjectsDatabasesDocumentsListCall) ReadTime(readTime string) *ProjectsDatabasesDocumentsListCall

ReadTime sets the optional parameter "readTime": Reads documents as they were at the given time. This may not be older than 60 seconds.

func (*ProjectsDatabasesDocumentsListCall) ShowMissing Uses

func (c *ProjectsDatabasesDocumentsListCall) ShowMissing(showMissing bool) *ProjectsDatabasesDocumentsListCall

ShowMissing sets the optional parameter "showMissing": 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, or Document.update_time set.

Requests with `show_missing` may not specify `where` or `order_by`.

func (*ProjectsDatabasesDocumentsListCall) Transaction Uses

func (c *ProjectsDatabasesDocumentsListCall) Transaction(transaction string) *ProjectsDatabasesDocumentsListCall

Transaction sets the optional parameter "transaction": Reads documents in a transaction.

type ProjectsDatabasesDocumentsListCollectionIdsCall Uses

type ProjectsDatabasesDocumentsListCollectionIdsCall struct {
    // contains filtered or unexported fields
}

func (*ProjectsDatabasesDocumentsListCollectionIdsCall) Context Uses

func (c *ProjectsDatabasesDocumentsListCollectionIdsCall) Context(ctx context.Context) *ProjectsDatabasesDocumentsListCollectionIdsCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsDatabasesDocumentsListCollectionIdsCall) Do Uses

func (c *ProjectsDatabasesDocumentsListCollectionIdsCall) Do(opts ...googleapi.CallOption) (*ListCollectionIdsResponse, error)

Do executes the "firestore.projects.databases.documents.listCollectionIds" call. Exactly one of *ListCollectionIdsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListCollectionIdsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsDatabasesDocumentsListCollectionIdsCall) Fields Uses

func (c *ProjectsDatabasesDocumentsListCollectionIdsCall) Fields(s ...googleapi.Field) *ProjectsDatabasesDocumentsListCollectionIdsCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsDatabasesDocumentsListCollectionIdsCall) Header Uses

func (c *ProjectsDatabasesDocumentsListCollectionIdsCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsDatabasesDocumentsListCollectionIdsCall) Pages Uses

func (c *ProjectsDatabasesDocumentsListCollectionIdsCall) Pages(ctx context.Context, f func(*ListCollectionIdsResponse) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsDatabasesDocumentsListenCall Uses

type ProjectsDatabasesDocumentsListenCall struct {
    // contains filtered or unexported fields
}

func (*ProjectsDatabasesDocumentsListenCall) Context Uses

func (c *ProjectsDatabasesDocumentsListenCall) Context(ctx context.Context) *ProjectsDatabasesDocumentsListenCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsDatabasesDocumentsListenCall) Do Uses

func (c *ProjectsDatabasesDocumentsListenCall) Do(opts ...googleapi.CallOption) (*ListenResponse, error)

Do executes the "firestore.projects.databases.documents.listen" call. Exactly one of *ListenResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListenResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsDatabasesDocumentsListenCall) Fields Uses

func (c *ProjectsDatabasesDocumentsListenCall) Fields(s ...googleapi.Field) *ProjectsDatabasesDocumentsListenCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsDatabasesDocumentsListenCall) Header Uses

func (c *ProjectsDatabasesDocumentsListenCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsDatabasesDocumentsPatchCall Uses

type ProjectsDatabasesDocumentsPatchCall struct {
    // contains filtered or unexported fields
}

func (*ProjectsDatabasesDocumentsPatchCall) Context Uses

func (c *ProjectsDatabasesDocumentsPatchCall) Context(ctx context.Context) *ProjectsDatabasesDocumentsPatchCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsDatabasesDocumentsPatchCall) CurrentDocumentExists Uses

func (c *ProjectsDatabasesDocumentsPatchCall) CurrentDocumentExists(currentDocumentExists bool) *ProjectsDatabasesDocumentsPatchCall

CurrentDocumentExists sets the optional parameter "currentDocument.exists": When set to `true`, the target document must exist. When set to `false`, the target document must not exist.

func (*ProjectsDatabasesDocumentsPatchCall) CurrentDocumentUpdateTime Uses

func (c *ProjectsDatabasesDocumentsPatchCall) CurrentDocumentUpdateTime(currentDocumentUpdateTime string) *ProjectsDatabasesDocumentsPatchCall

CurrentDocumentUpdateTime sets the optional parameter "currentDocument.updateTime": When set, the target document must exist and have been last updated at that time.

func (*ProjectsDatabasesDocumentsPatchCall) Do Uses

func (c *ProjectsDatabasesDocumentsPatchCall) Do(opts ...googleapi.CallOption) (*Document, error)

Do executes the "firestore.projects.databases.documents.patch" call. Exactly one of *Document or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Document.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsDatabasesDocumentsPatchCall) Fields Uses

func (c *ProjectsDatabasesDocumentsPatchCall) Fields(s ...googleapi.Field) *ProjectsDatabasesDocumentsPatchCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsDatabasesDocumentsPatchCall) Header Uses

func (c *ProjectsDatabasesDocumentsPatchCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsDatabasesDocumentsPatchCall) MaskFieldPaths Uses

func (c *ProjectsDatabasesDocumentsPatchCall) MaskFieldPaths(maskFieldPaths ...string) *ProjectsDatabasesDocumentsPatchCall

MaskFieldPaths sets the optional parameter "mask.fieldPaths": The list of field paths in the mask. See Document.fields for a field path syntax reference.

func (*ProjectsDatabasesDocumentsPatchCall) UpdateMaskFieldPaths Uses

func (c *ProjectsDatabasesDocumentsPatchCall) UpdateMaskFieldPaths(updateMaskFieldPaths ...string) *ProjectsDatabasesDocumentsPatchCall

UpdateMaskFieldPaths sets the optional parameter "updateMask.fieldPaths": The list of field paths in the mask. See Document.fields for a field path syntax reference.

type ProjectsDatabasesDocumentsRollbackCall Uses

type ProjectsDatabasesDocumentsRollbackCall struct {
    // contains filtered or unexported fields
}

func (*ProjectsDatabasesDocumentsRollbackCall) Context Uses

func (c *ProjectsDatabasesDocumentsRollbackCall) Context(ctx context.Context) *ProjectsDatabasesDocumentsRollbackCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsDatabasesDocumentsRollbackCall) Do Uses

func (c *ProjectsDatabasesDocumentsRollbackCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "firestore.projects.databases.documents.rollback" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsDatabasesDocumentsRollbackCall) Fields Uses

func (c *ProjectsDatabasesDocumentsRollbackCall) Fields(s ...googleapi.Field) *ProjectsDatabasesDocumentsRollbackCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsDatabasesDocumentsRollbackCall) Header Uses

func (c *ProjectsDatabasesDocumentsRollbackCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsDatabasesDocumentsRunQueryCall Uses

type ProjectsDatabasesDocumentsRunQueryCall struct {
    // contains filtered or unexported fields
}

func (*ProjectsDatabasesDocumentsRunQueryCall) Context Uses

func (c *ProjectsDatabasesDocumentsRunQueryCall) Context(ctx context.Context) *ProjectsDatabasesDocumentsRunQueryCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsDatabasesDocumentsRunQueryCall) Do Uses

func (c *ProjectsDatabasesDocumentsRunQueryCall) Do(opts ...googleapi.CallOption) (*RunQueryResponse, error)

Do executes the "firestore.projects.databases.documents.runQuery" call. Exactly one of *RunQueryResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *RunQueryResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsDatabasesDocumentsRunQueryCall) Fields Uses

func (c *ProjectsDatabasesDocumentsRunQueryCall) Fields(s ...googleapi.Field) *ProjectsDatabasesDocumentsRunQueryCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsDatabasesDocumentsRunQueryCall) Header Uses

func (c *ProjectsDatabasesDocumentsRunQueryCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsDatabasesDocumentsService Uses

type ProjectsDatabasesDocumentsService struct {
    // contains filtered or unexported fields
}

func NewProjectsDatabasesDocumentsService Uses

func NewProjectsDatabasesDocumentsService(s *Service) *ProjectsDatabasesDocumentsService

func (*ProjectsDatabasesDocumentsService) BatchGet Uses

func (r *ProjectsDatabasesDocumentsService) BatchGet(database string, batchgetdocumentsrequest *BatchGetDocumentsRequest) *ProjectsDatabasesDocumentsBatchGetCall

BatchGet: Gets multiple documents.

Documents returned by this method are not guaranteed to be returned in the same order that they were requested.

func (*ProjectsDatabasesDocumentsService) BeginTransaction Uses

func (r *ProjectsDatabasesDocumentsService) BeginTransaction(database string, begintransactionrequest *BeginTransactionRequest) *ProjectsDatabasesDocumentsBeginTransactionCall

BeginTransaction: Starts a new transaction.

func (*ProjectsDatabasesDocumentsService) Commit Uses

func (r *ProjectsDatabasesDocumentsService) Commit(database string, commitrequest *CommitRequest) *ProjectsDatabasesDocumentsCommitCall

Commit: Commits a transaction, while optionally updating documents.

func (*ProjectsDatabasesDocumentsService) CreateDocument Uses

func (r *ProjectsDatabasesDocumentsService) CreateDocument(parent string, collectionId string, document *Document) *ProjectsDatabasesDocumentsCreateDocumentCall

CreateDocument: Creates a new document.

func (*ProjectsDatabasesDocumentsService) Delete Uses

func (r *ProjectsDatabasesDocumentsService) Delete(name string) *ProjectsDatabasesDocumentsDeleteCall

Delete: Deletes a document.

func (*ProjectsDatabasesDocumentsService) Get Uses

func (r *ProjectsDatabasesDocumentsService) Get(name string) *ProjectsDatabasesDocumentsGetCall

Get: Gets a single document.

func (*ProjectsDatabasesDocumentsService) List Uses

func (r *ProjectsDatabasesDocumentsService) List(parent string, collectionId string) *ProjectsDatabasesDocumentsListCall

List: Lists documents.

func (*ProjectsDatabasesDocumentsService) ListCollectionIds Uses

func (r *ProjectsDatabasesDocumentsService) ListCollectionIds(parent string, listcollectionidsrequest *ListCollectionIdsRequest) *ProjectsDatabasesDocumentsListCollectionIdsCall

ListCollectionIds: Lists all the collection IDs underneath a document.

func (*ProjectsDatabasesDocumentsService) Listen Uses

func (r *ProjectsDatabasesDocumentsService) Listen(database string, listenrequest *ListenRequest) *ProjectsDatabasesDocumentsListenCall

Listen: Listens to changes.

func (*ProjectsDatabasesDocumentsService) Patch Uses

func (r *ProjectsDatabasesDocumentsService) Patch(name string, document *Document) *ProjectsDatabasesDocumentsPatchCall

Patch: Updates or inserts a document.

func (*ProjectsDatabasesDocumentsService) Rollback Uses

func (r *ProjectsDatabasesDocumentsService) Rollback(database string, rollbackrequest *RollbackRequest) *ProjectsDatabasesDocumentsRollbackCall

Rollback: Rolls back a transaction.

func (*ProjectsDatabasesDocumentsService) RunQuery Uses

func (r *ProjectsDatabasesDocumentsService) RunQuery(parent string, runqueryrequest *RunQueryRequest) *ProjectsDatabasesDocumentsRunQueryCall

RunQuery: Runs a query.

func (*ProjectsDatabasesDocumentsService) Write Uses

func (r *ProjectsDatabasesDocumentsService) Write(database string, writerequest *WriteRequest) *ProjectsDatabasesDocumentsWriteCall

Write: Streams batches of document updates and deletes, in order.

type ProjectsDatabasesDocumentsWriteCall Uses

type ProjectsDatabasesDocumentsWriteCall struct {
    // contains filtered or unexported fields
}

func (*ProjectsDatabasesDocumentsWriteCall) Context Uses

func (c *ProjectsDatabasesDocumentsWriteCall) Context(ctx context.Context) *ProjectsDatabasesDocumentsWriteCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsDatabasesDocumentsWriteCall) Do Uses

func (c *ProjectsDatabasesDocumentsWriteCall) Do(opts ...googleapi.CallOption) (*WriteResponse, error)

Do executes the "firestore.projects.databases.documents.write" call. Exactly one of *WriteResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *WriteResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsDatabasesDocumentsWriteCall) Fields Uses

func (c *ProjectsDatabasesDocumentsWriteCall) Fields(s ...googleapi.Field) *ProjectsDatabasesDocumentsWriteCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsDatabasesDocumentsWriteCall) Header Uses

func (c *ProjectsDatabasesDocumentsWriteCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsDatabasesExportDocumentsCall Uses

type ProjectsDatabasesExportDocumentsCall struct {
    // contains filtered or unexported fields
}

func (*ProjectsDatabasesExportDocumentsCall) Context Uses

func (c *ProjectsDatabasesExportDocumentsCall) Context(ctx context.Context) *ProjectsDatabasesExportDocumentsCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsDatabasesExportDocumentsCall) Do Uses

func (c *ProjectsDatabasesExportDocumentsCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningOperation, error)

Do executes the "firestore.projects.databases.exportDocuments" call. Exactly one of *GoogleLongrunningOperation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleLongrunningOperation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsDatabasesExportDocumentsCall) Fields Uses

func (c *ProjectsDatabasesExportDocumentsCall) Fields(s ...googleapi.Field) *ProjectsDatabasesExportDocumentsCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsDatabasesExportDocumentsCall) Header Uses

func (c *ProjectsDatabasesExportDocumentsCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsDatabasesImportDocumentsCall Uses

type ProjectsDatabasesImportDocumentsCall struct {
    // contains filtered or unexported fields
}

func (*ProjectsDatabasesImportDocumentsCall) Context Uses

func (c *ProjectsDatabasesImportDocumentsCall) Context(ctx context.Context) *ProjectsDatabasesImportDocumentsCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsDatabasesImportDocumentsCall) Do Uses

func (c *ProjectsDatabasesImportDocumentsCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningOperation, error)

Do executes the "firestore.projects.databases.importDocuments" call. Exactly one of *GoogleLongrunningOperation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleLongrunningOperation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsDatabasesImportDocumentsCall) Fields Uses

func (c *ProjectsDatabasesImportDocumentsCall) Fields(s ...googleapi.Field) *ProjectsDatabasesImportDocumentsCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsDatabasesImportDocumentsCall) Header Uses

func (c *ProjectsDatabasesImportDocumentsCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsDatabasesIndexesCreateCall Uses

type ProjectsDatabasesIndexesCreateCall struct {
    // contains filtered or unexported fields
}

func (*ProjectsDatabasesIndexesCreateCall) Context Uses

func (c *ProjectsDatabasesIndexesCreateCall) Context(ctx context.Context) *ProjectsDatabasesIndexesCreateCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsDatabasesIndexesCreateCall) Do Uses

func (c *ProjectsDatabasesIndexesCreateCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningOperation, error)

Do executes the "firestore.projects.databases.indexes.create" call. Exactly one of *GoogleLongrunningOperation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleLongrunningOperation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsDatabasesIndexesCreateCall) Fields Uses

func (c *ProjectsDatabasesIndexesCreateCall) Fields(s ...googleapi.Field) *ProjectsDatabasesIndexesCreateCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsDatabasesIndexesCreateCall) Header Uses

func (c *ProjectsDatabasesIndexesCreateCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsDatabasesIndexesDeleteCall Uses

type ProjectsDatabasesIndexesDeleteCall struct {
    // contains filtered or unexported fields
}

func (*ProjectsDatabasesIndexesDeleteCall) Context Uses

func (c *ProjectsDatabasesIndexesDeleteCall) Context(ctx context.Context) *ProjectsDatabasesIndexesDeleteCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsDatabasesIndexesDeleteCall) Do Uses

func (c *ProjectsDatabasesIndexesDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "firestore.projects.databases.indexes.delete" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsDatabasesIndexesDeleteCall) Fields Uses

func (c *ProjectsDatabasesIndexesDeleteCall) Fields(s ...googleapi.Field) *ProjectsDatabasesIndexesDeleteCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsDatabasesIndexesDeleteCall) Header Uses

func (c *ProjectsDatabasesIndexesDeleteCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsDatabasesIndexesGetCall Uses

type ProjectsDatabasesIndexesGetCall struct {
    // contains filtered or unexported fields
}

func (*ProjectsDatabasesIndexesGetCall) Context Uses

func (c *ProjectsDatabasesIndexesGetCall) Context(ctx context.Context) *ProjectsDatabasesIndexesGetCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsDatabasesIndexesGetCall) Do Uses

func (c *ProjectsDatabasesIndexesGetCall) Do(opts ...googleapi.CallOption) (*GoogleFirestoreAdminV1beta1Index, error)

Do executes the "firestore.projects.databases.indexes.get" call. Exactly one of *GoogleFirestoreAdminV1beta1Index or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleFirestoreAdminV1beta1Index.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsDatabasesIndexesGetCall) Fields Uses

func (c *ProjectsDatabasesIndexesGetCall) Fields(s ...googleapi.Field) *ProjectsDatabasesIndexesGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsDatabasesIndexesGetCall) Header Uses

func (c *ProjectsDatabasesIndexesGetCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsDatabasesIndexesGetCall) IfNoneMatch Uses

func (c *ProjectsDatabasesIndexesGetCall) IfNoneMatch(entityTag string) *ProjectsDatabasesIndexesGetCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsDatabasesIndexesListCall Uses

type ProjectsDatabasesIndexesListCall struct {
    // contains filtered or unexported fields
}

func (*ProjectsDatabasesIndexesListCall) Context Uses

func (c *ProjectsDatabasesIndexesListCall) Context(ctx context.Context) *ProjectsDatabasesIndexesListCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsDatabasesIndexesListCall) Do Uses

func (c *ProjectsDatabasesIndexesListCall) Do(opts ...googleapi.CallOption) (*GoogleFirestoreAdminV1beta1ListIndexesResponse, error)

Do executes the "firestore.projects.databases.indexes.list" call. Exactly one of *GoogleFirestoreAdminV1beta1ListIndexesResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleFirestoreAdminV1beta1ListIndexesResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsDatabasesIndexesListCall) Fields Uses

func (c *ProjectsDatabasesIndexesListCall) Fields(s ...googleapi.Field) *ProjectsDatabasesIndexesListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsDatabasesIndexesListCall) Filter Uses

func (c *ProjectsDatabasesIndexesListCall) Filter(filter string) *ProjectsDatabasesIndexesListCall

Filter sets the optional parameter "filter":

func (*ProjectsDatabasesIndexesListCall) Header Uses

func (c *ProjectsDatabasesIndexesListCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsDatabasesIndexesListCall) IfNoneMatch Uses

func (c *ProjectsDatabasesIndexesListCall) IfNoneMatch(entityTag string) *ProjectsDatabasesIndexesListCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsDatabasesIndexesListCall) PageSize Uses

func (c *ProjectsDatabasesIndexesListCall) PageSize(pageSize int64) *ProjectsDatabasesIndexesListCall

PageSize sets the optional parameter "pageSize": The standard List page size.

func (*ProjectsDatabasesIndexesListCall) PageToken Uses

func (c *ProjectsDatabasesIndexesListCall) PageToken(pageToken string) *ProjectsDatabasesIndexesListCall

PageToken sets the optional parameter "pageToken": The standard List page token.

func (*ProjectsDatabasesIndexesListCall) Pages Uses

func (c *ProjectsDatabasesIndexesListCall) Pages(ctx context.Context, f func(*GoogleFirestoreAdminV1beta1ListIndexesResponse) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsDatabasesIndexesService Uses

type ProjectsDatabasesIndexesService struct {
    // contains filtered or unexported fields
}

func NewProjectsDatabasesIndexesService Uses

func NewProjectsDatabasesIndexesService(s *Service) *ProjectsDatabasesIndexesService

func (*ProjectsDatabasesIndexesService) Create Uses

func (r *ProjectsDatabasesIndexesService) Create(parent string, googlefirestoreadminv1beta1index *GoogleFirestoreAdminV1beta1Index) *ProjectsDatabasesIndexesCreateCall

Create: Creates the specified index. A newly created index's initial state is `CREATING`. On completion of the returned google.longrunning.Operation, the state will be `READY`. If the index already exists, the call will return an `ALREADY_EXISTS` status.

During creation, the process could result in an error, in which case the index will move to the `ERROR` state. The process can be recovered by fixing the data that caused the error, removing the index with delete, then re-creating the index with create.

Indexes with a single field cannot be created.

func (*ProjectsDatabasesIndexesService) Delete Uses

func (r *ProjectsDatabasesIndexesService) Delete(name string) *ProjectsDatabasesIndexesDeleteCall

Delete: Deletes an index.

func (*ProjectsDatabasesIndexesService) Get Uses

func (r *ProjectsDatabasesIndexesService) Get(name string) *ProjectsDatabasesIndexesGetCall

Get: Gets an index.

func (*ProjectsDatabasesIndexesService) List Uses

func (r *ProjectsDatabasesIndexesService) List(parent string) *ProjectsDatabasesIndexesListCall

List: Lists the indexes that match the specified filters.

type ProjectsDatabasesService Uses

type ProjectsDatabasesService struct {
    Documents *ProjectsDatabasesDocumentsService

    Indexes *ProjectsDatabasesIndexesService
    // contains filtered or unexported fields
}

func NewProjectsDatabasesService Uses

func NewProjectsDatabasesService(s *Service) *ProjectsDatabasesService

func (*ProjectsDatabasesService) ExportDocuments Uses

func (r *ProjectsDatabasesService) ExportDocuments(name string, googlefirestoreadminv1beta1exportdocumentsrequest *GoogleFirestoreAdminV1beta1ExportDocumentsRequest) *ProjectsDatabasesExportDocumentsCall

ExportDocuments: Exports a copy of all or a subset of documents from Google Cloud Firestore to another storage system, such as Google Cloud Storage. Recent updates to documents may not be reflected in the export. The export occurs in the background and its progress can be monitored and managed via the Operation resource that is created. The output of an export may only be used once the associated operation is done. If an export operation is cancelled before completion it may leave partial data behind in Google Cloud Storage.

func (*ProjectsDatabasesService) ImportDocuments Uses

func (r *ProjectsDatabasesService) ImportDocuments(name string, googlefirestoreadminv1beta1importdocumentsrequest *GoogleFirestoreAdminV1beta1ImportDocumentsRequest) *ProjectsDatabasesImportDocumentsCall

ImportDocuments: Imports documents into Google Cloud Firestore. Existing documents with the same name are overwritten. The import occurs in the background and its progress can be monitored and managed via the Operation resource that is created. If an ImportDocuments operation is cancelled, it is possible that a subset of the data has already been imported to Cloud Firestore.

type ProjectsService Uses

type ProjectsService struct {
    Databases *ProjectsDatabasesService
    // contains filtered or unexported fields
}

func NewProjectsService Uses

func NewProjectsService(s *Service) *ProjectsService

type QueryTarget Uses

type QueryTarget struct {
    // Parent: 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-c
    // hatroom`
    Parent string `json:"parent,omitempty"`

    // StructuredQuery: A structured query.
    StructuredQuery *StructuredQuery `json:"structuredQuery,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Parent") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Parent") to include in API
    // requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

QueryTarget: A target specified by a query.

func (*QueryTarget) MarshalJSON Uses

func (s *QueryTarget) MarshalJSON() ([]byte, error)

type ReadOnly Uses

type ReadOnly struct {
    // ReadTime: Reads documents at the given time.
    // This may not be older than 60 seconds.
    ReadTime string `json:"readTime,omitempty"`

    // ForceSendFields is a list of field names (e.g. "ReadTime") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "ReadTime") to include in
    // API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

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

func (*ReadOnly) MarshalJSON Uses

func (s *ReadOnly) MarshalJSON() ([]byte, error)

type ReadWrite Uses

type ReadWrite struct {
    // RetryTransaction: An optional transaction to retry.
    RetryTransaction string `json:"retryTransaction,omitempty"`

    // ForceSendFields is a list of field names (e.g. "RetryTransaction") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "RetryTransaction") to
    // include in API requests with the JSON null value. By default, fields
    // with empty values are omitted from API requests. However, any field
    // with an empty value appearing in NullFields will be sent to the
    // server as null. It is an error if a field in this list has a
    // non-empty value. This may be used to include null fields in Patch
    // requests.
    NullFields []string `json:"-"`
}

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

func (*ReadWrite) MarshalJSON Uses

func (s *ReadWrite) MarshalJSON() ([]byte, error)

type RollbackRequest Uses

type RollbackRequest struct {
    // Transaction: The transaction to roll back.
    Transaction string `json:"transaction,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Transaction") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Transaction") to include
    // in API requests with the JSON null value. By default, fields with
    // empty values are omitted from API requests. However, any field with
    // an empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

RollbackRequest: The request for Firestore.Rollback.

func (*RollbackRequest) MarshalJSON Uses

func (s *RollbackRequest) MarshalJSON() ([]byte, error)

type RunQueryRequest Uses

type RunQueryRequest struct {
    // NewTransaction: Starts a new transaction and reads the
    // documents.
    // Defaults to a read-only transaction.
    // The new transaction ID will be returned as the first response in
    // the
    // stream.
    NewTransaction *TransactionOptions `json:"newTransaction,omitempty"`

    // ReadTime: Reads documents as they were at the given time.
    // This may not be older than 60 seconds.
    ReadTime string `json:"readTime,omitempty"`

    // StructuredQuery: A structured query.
    StructuredQuery *StructuredQuery `json:"structuredQuery,omitempty"`

    // Transaction: Reads documents in a transaction.
    Transaction string `json:"transaction,omitempty"`

    // ForceSendFields is a list of field names (e.g. "NewTransaction") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "NewTransaction") to
    // include in API requests with the JSON null value. By default, fields
    // with empty values are omitted from API requests. However, any field
    // with an empty value appearing in NullFields will be sent to the
    // server as null. It is an error if a field in this list has a
    // non-empty value. This may be used to include null fields in Patch
    // requests.
    NullFields []string `json:"-"`
}

RunQueryRequest: The request for Firestore.RunQuery.

func (*RunQueryRequest) MarshalJSON Uses

func (s *RunQueryRequest) MarshalJSON() ([]byte, error)

type RunQueryResponse Uses

type RunQueryResponse struct {
    // Document: A query result.
    // Not set when reporting partial progress.
    Document *Document `json:"document,omitempty"`

    // ReadTime: 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 string `json:"readTime,omitempty"`

    // SkippedResults: The number of results that have been skipped due to
    // an offset between
    // the last response and the current response.
    SkippedResults int64 `json:"skippedResults,omitempty"`

    // Transaction: The transaction that was started as part of this
    // request.
    // Can only be set in the first response, and only
    // if
    // RunQueryRequest.new_transaction was set in the request.
    // If set, no other fields will be set in this response.
    Transaction string `json:"transaction,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "Document") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Document") to include in
    // API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

RunQueryResponse: The response for Firestore.RunQuery.

func (*RunQueryResponse) MarshalJSON Uses

func (s *RunQueryResponse) MarshalJSON() ([]byte, error)

type Service Uses

type Service struct {
    BasePath  string // API endpoint base URL
    UserAgent string // optional additional User-Agent fragment

    Projects *ProjectsService
    // contains filtered or unexported fields
}

func New Uses

func New(client *http.Client) (*Service, error)

New creates a new Service. It uses the provided http.Client for requests.

Deprecated: please use NewService instead. To provide a custom HTTP client, use option.WithHTTPClient. If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.

func NewService Uses

func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error)

NewService creates a new Service.

type Status Uses

type Status struct {
    // Code: The status code, which should be an enum value of
    // google.rpc.Code.
    Code int64 `json:"code,omitempty"`

    // Details: A list of messages that carry the error details.  There is a
    // common set of
    // message types for APIs to use.
    Details []googleapi.RawMessage `json:"details,omitempty"`

    // Message: A developer-facing error message, which should be in
    // English. Any
    // user-facing error message should be localized and sent in
    // the
    // google.rpc.Status.details field, or localized by the client.
    Message string `json:"message,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Code") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Code") to include in API
    // requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

Status: The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be:

- Simple to use and understand for most users - Flexible enough to meet unexpected needs

# Overview

The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions.

# Language mapping

The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.

# Other uses

The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.

Example uses of this error model include:

- Partial errors. If a service needs to return partial errors to the client,

it may embed the `Status` in the normal response to indicate the

partial

errors.

- Workflow errors. A typical workflow has multiple steps. Each step may

have a `Status` message for error reporting.

- Batch operations. If a client uses batch request and batch response, the

`Status` message should be used directly inside batch response,

one for

each error sub-response.

- Asynchronous operations. If an API call embeds asynchronous operation

results in its response, the status of those operations should

be

represented directly using the `Status` message.

- Logging. If some API errors are stored in logs, the message `Status` could

be used directly after any stripping needed for security/privacy

reasons.

func (*Status) MarshalJSON Uses

func (s *Status) MarshalJSON() ([]byte, error)

type StructuredQuery Uses

type StructuredQuery struct {
    // EndAt: A end point for the query results.
    EndAt *Cursor `json:"endAt,omitempty"`

    // From: The collections to query.
    From []*CollectionSelector `json:"from,omitempty"`

    // Limit: The maximum number of results to return.
    //
    // Applies after all other constraints.
    // Must be >= 0 if specified.
    Limit int64 `json:"limit,omitempty"`

    // Offset: The number of results to skip.
    //
    // Applies before limit, but after all other constraints. Must be >= 0
    // if
    // specified.
    Offset int64 `json:"offset,omitempty"`

    // OrderBy: 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 []*Order `json:"orderBy,omitempty"`

    // Select: The projection to return.
    Select *Projection `json:"select,omitempty"`

    // StartAt: A starting point for the query results.
    StartAt *Cursor `json:"startAt,omitempty"`

    // Where: The filter to apply.
    Where *Filter `json:"where,omitempty"`

    // ForceSendFields is a list of field names (e.g. "EndAt") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "EndAt") to include in API
    // requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

StructuredQuery: A Firestore query.

func (*StructuredQuery) MarshalJSON Uses

func (s *StructuredQuery) MarshalJSON() ([]byte, error)

type Target Uses

type Target struct {
    // Documents: A target specified by a set of document names.
    Documents *DocumentsTarget `json:"documents,omitempty"`

    // Once: If the target should be removed once it is current and
    // consistent.
    Once bool `json:"once,omitempty"`

    // Query: A target specified by a query.
    Query *QueryTarget `json:"query,omitempty"`

    // ReadTime: Start listening after a specific `read_time`.
    //
    // The client must know the state of matching documents at this time.
    ReadTime string `json:"readTime,omitempty"`

    // ResumeToken: A resume token from a prior TargetChange for an
    // identical target.
    //
    // Using a resume token with a different target is unsupported and may
    // fail.
    ResumeToken string `json:"resumeToken,omitempty"`

    // TargetId: A client provided target ID.
    //
    // If not set, the server will assign an ID for the target.
    //
    // Used for resuming a target without changing IDs. The IDs can either
    // be
    // client-assigned or be server-assigned in a previous stream. All
    // targets
    // with client provided IDs must be added before adding a target that
    // needs
    // a server-assigned id.
    TargetId int64 `json:"targetId,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Documents") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Documents") to include in
    // API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

Target: A specification of a set of documents to listen to.

func (*Target) MarshalJSON Uses

func (s *Target) MarshalJSON() ([]byte, error)

type TargetChange Uses

type TargetChange struct {
    // Cause: The error that resulted in this change, if applicable.
    Cause *Status `json:"cause,omitempty"`

    // ReadTime: 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 string `json:"readTime,omitempty"`

    // ResumeToken: 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 string `json:"resumeToken,omitempty"`

    // TargetChangeType: The type of change that occurred.
    //
    // Possible values:
    //   "NO_CHANGE" - No change has occurred. Used only to send an updated
    // `resume_token`.
    //   "ADD" - The targets have been added.
    //   "REMOVE" - The targets have been removed.
    //   "CURRENT" - 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.
    //   "RESET" - 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`.
    TargetChangeType string `json:"targetChangeType,omitempty"`

    // TargetIds: The target IDs of targets that have changed.
    //
    // If empty, the change applies to all targets.
    //
    // For `target_change_type=ADD`, the order of the target IDs matches the
    // order
    // of the requests to add the targets. This allows clients to
    // unambiguously
    // associate server-assigned target IDs with added targets.
    //
    // For other states, the order of the target IDs is not defined.
    TargetIds []int64 `json:"targetIds,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Cause") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Cause") to include in API
    // requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

TargetChange: Targets being watched have changed.

func (*TargetChange) MarshalJSON Uses

func (s *TargetChange) MarshalJSON() ([]byte, error)

type TransactionOptions Uses

type TransactionOptions struct {
    // ReadOnly: The transaction can only be used for read operations.
    ReadOnly *ReadOnly `json:"readOnly,omitempty"`

    // ReadWrite: The transaction can be used for both read and write
    // operations.
    ReadWrite *ReadWrite `json:"readWrite,omitempty"`

    // ForceSendFields is a list of field names (e.g. "ReadOnly") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "ReadOnly") to include in
    // API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

TransactionOptions: Options for creating a new transaction.

func (*TransactionOptions) MarshalJSON Uses

func (s *TransactionOptions) MarshalJSON() ([]byte, error)

type UnaryFilter Uses

type UnaryFilter struct {
    // Field: The field to which to apply the operator.
    Field *FieldReference `json:"field,omitempty"`

    // Op: The unary operator to apply.
    //
    // Possible values:
    //   "OPERATOR_UNSPECIFIED" - Unspecified. This value must not be used.
    //   "IS_NAN" - Test if a field is equal to NaN.
    //   "IS_NULL" - Test if an exprestion evaluates to Null.
    Op  string `json:"op,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Field") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Field") to include in API
    // requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

UnaryFilter: A filter with a single operand.

func (*UnaryFilter) MarshalJSON Uses

func (s *UnaryFilter) MarshalJSON() ([]byte, error)

type Value Uses

type Value struct {
    // ArrayValue: An array value.
    //
    // Cannot directly contain another array value, though can contain
    // an
    // map which contains another array.
    ArrayValue *ArrayValue `json:"arrayValue,omitempty"`

    // BooleanValue: A boolean value.
    BooleanValue bool `json:"booleanValue,omitempty"`

    // BytesValue: A bytes value.
    //
    // Must not exceed 1 MiB - 89 bytes.
    // Only the first 1,500 bytes are considered by queries.
    BytesValue string `json:"bytesValue,omitempty"`

    // DoubleValue: A double value.
    DoubleValue float64 `json:"doubleValue,omitempty"`

    // GeoPointValue: A geo point value representing a point on the surface
    // of Earth.
    GeoPointValue *LatLng `json:"geoPointValue,omitempty"`

    // IntegerValue: An integer value.
    IntegerValue int64 `json:"integerValue,omitempty,string"`

    // MapValue: A map value.
    MapValue *MapValue `json:"mapValue,omitempty"`

    // NullValue: A null value.
    //
    // Possible values:
    //   "NULL_VALUE" - Null value.
    NullValue string `json:"nullValue,omitempty"`

    // ReferenceValue: A reference to a document. For
    // example:
    // `projects/{project_id}/databases/{database_id}/documents/{doc
    // ument_path}`.
    ReferenceValue string `json:"referenceValue,omitempty"`

    // StringValue: A string value.
    //
    // The string, represented as UTF-8, must not exceed 1 MiB - 89
    // bytes.
    // Only the first 1,500 bytes of the UTF-8 representation are considered
    // by
    // queries.
    StringValue string `json:"stringValue,omitempty"`

    // TimestampValue: A timestamp value.
    //
    // Precise only to microseconds. When stored, any additional precision
    // is
    // rounded down.
    TimestampValue string `json:"timestampValue,omitempty"`

    // ForceSendFields is a list of field names (e.g. "ArrayValue") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "ArrayValue") to include in
    // API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

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

func (*Value) MarshalJSON Uses

func (s *Value) MarshalJSON() ([]byte, error)

func (*Value) UnmarshalJSON Uses

func (s *Value) UnmarshalJSON(data []byte) error

type Write Uses

type Write struct {
    // CurrentDocument: An optional precondition on the document.
    //
    // The write will fail if this is set and not met by the target
    // document.
    CurrentDocument *Precondition `json:"currentDocument,omitempty"`

    // Delete: A document name to delete. In the
    // format:
    // `projects/{project_id}/databases/{database_id}/documents/{docu
    // ment_path}`.
    Delete string `json:"delete,omitempty"`

    // Transform: Applies a transformation to a document.
    // At most one `transform` per document is allowed in a given
    // request.
    // An `update` cannot follow a `transform` on the same document in a
    // given
    // request.
    Transform *DocumentTransform `json:"transform,omitempty"`

    // Update: A document to write.
    Update *Document `json:"update,omitempty"`

    // UpdateMask: 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 `json:"updateMask,omitempty"`

    // ForceSendFields is a list of field names (e.g. "CurrentDocument") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "CurrentDocument") to
    // include in API requests with the JSON null value. By default, fields
    // with empty values are omitted from API requests. However, any field
    // with an empty value appearing in NullFields will be sent to the
    // server as null. It is an error if a field in this list has a
    // non-empty value. This may be used to include null fields in Patch
    // requests.
    NullFields []string `json:"-"`
}

Write: A write on a document.

func (*Write) MarshalJSON Uses

func (s *Write) MarshalJSON() ([]byte, error)

type WriteRequest Uses

type WriteRequest struct {
    // Labels: Labels associated with this write request.
    Labels map[string]string `json:"labels,omitempty"`

    // StreamId: 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 `json:"streamId,omitempty"`

    // StreamToken: A stream token that was previously sent by the
    // server.
    //
    // The client should set this field to the token from the most
    // recent
    // 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 string `json:"streamToken,omitempty"`

    // Writes: 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 `json:"writes,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Labels") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "Labels") to include in API
    // requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

WriteRequest: The request for 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) MarshalJSON Uses

func (s *WriteRequest) MarshalJSON() ([]byte, error)

type WriteResponse Uses

type WriteResponse struct {
    // CommitTime: The time at which the commit occurred.
    CommitTime string `json:"commitTime,omitempty"`

    // StreamId: The ID of the stream.
    // Only set on the first message, when a new stream was created.
    StreamId string `json:"streamId,omitempty"`

    // StreamToken: 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 string `json:"streamToken,omitempty"`

    // WriteResults: The result of applying the writes.
    //
    // This i-th write result corresponds to the i-th write in the
    // request.
    WriteResults []*WriteResult `json:"writeResults,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "CommitTime") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "CommitTime") to include in
    // API requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

WriteResponse: The response for Firestore.Write.

func (*WriteResponse) MarshalJSON Uses

func (s *WriteResponse) MarshalJSON() ([]byte, error)

type WriteResult Uses

type WriteResult struct {
    // TransformResults: The results of applying each
    // DocumentTransform.FieldTransform, in the
    // same order.
    TransformResults []*Value `json:"transformResults,omitempty"`

    // UpdateTime: 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 string `json:"updateTime,omitempty"`

    // ForceSendFields is a list of field names (e.g. "TransformResults") to
    // unconditionally include in API requests. By default, fields with
    // empty values are omitted from API requests. However, any non-pointer,
    // non-interface field appearing in ForceSendFields will be sent to the
    // server regardless of whether the field is empty or not. This may be
    // used to include empty fields in Patch requests.
    ForceSendFields []string `json:"-"`

    // NullFields is a list of field names (e.g. "TransformResults") to
    // include in API requests with the JSON null value. By default, fields
    // with empty values are omitted from API requests. However, any field
    // with an empty value appearing in NullFields will be sent to the
    // server as null. It is an error if a field in this list has a
    // non-empty value. This may be used to include null fields in Patch
    // requests.
    NullFields []string `json:"-"`
}

WriteResult: The result of applying a write.

func (*WriteResult) MarshalJSON Uses

func (s *WriteResult) MarshalJSON() ([]byte, error)

Package firestore imports 14 packages (graph). Updated 2019-07-21. Refresh now. Tools for package owners.