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

package firestore

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

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/v1beta2"
...
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 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 GoogleFirestoreAdminV1beta2ExportDocumentsMetadata Uses

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

    // EndTime: The time this operation completed. Will be unset if
    // operation still in
    // progress.
    EndTime string `json:"endTime,omitempty"`

    // OperationState: The state of the export operation.
    //
    // Possible values:
    //   "OPERATION_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: The progress, in bytes, of this operation.
    ProgressBytes *GoogleFirestoreAdminV1beta2Progress `json:"progressBytes,omitempty"`

    // ProgressDocuments: The progress, in documents, of this operation.
    ProgressDocuments *GoogleFirestoreAdminV1beta2Progress `json:"progressDocuments,omitempty"`

    // StartTime: The time this operation started.
    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:"-"`
}

GoogleFirestoreAdminV1beta2ExportDocumentsMetadata: Metadata for google.longrunning.Operation results from FirestoreAdmin.ExportDocuments.

func (*GoogleFirestoreAdminV1beta2ExportDocumentsMetadata) MarshalJSON Uses

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

type GoogleFirestoreAdminV1beta2ExportDocumentsRequest Uses

type GoogleFirestoreAdminV1beta2ExportDocumentsRequest 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:"-"`
}

GoogleFirestoreAdminV1beta2ExportDocumentsRequest: The request for FirestoreAdmin.ExportDocuments.

func (*GoogleFirestoreAdminV1beta2ExportDocumentsRequest) MarshalJSON Uses

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

type GoogleFirestoreAdminV1beta2ExportDocumentsResponse Uses

type GoogleFirestoreAdminV1beta2ExportDocumentsResponse 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:"-"`
}

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

func (*GoogleFirestoreAdminV1beta2ExportDocumentsResponse) MarshalJSON Uses

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

type GoogleFirestoreAdminV1beta2Field Uses

type GoogleFirestoreAdminV1beta2Field struct {
    // IndexConfig: The index configuration for this field. If unset, field
    // indexing will
    // revert to the configuration defined by the `ancestor_field`.
    // To
    // explicitly remove all indexes for this field, specify an index
    // config
    // with an empty list of indexes.
    IndexConfig *GoogleFirestoreAdminV1beta2IndexConfig `json:"indexConfig,omitempty"`

    // Name: A field name of the
    // form
    // `projects/{project_id}/databases/{database_id}/collectionGroups/{
    // collection_id}/fields/{field_path}`
    //
    // A field path may be a simple field name, e.g. `address` or a path to
    // fields
    // within map_value , e.g. `address.city`,
    // or a special field path. The only valid special field is `*`,
    // which
    // represents any field.
    //
    // Field paths may be quoted using ` (backtick). The only character that
    // needs
    // to be escaped within a quoted field path is the backtick character
    // itself,
    // escaped using a backslash. Special characters in field paths
    // that
    // must be quoted include: `*`, `.`,
    // ``` (backtick), `[`, `]`, as well as any ascii symbolic
    // characters.
    //
    // Examples:
    // (Note: Comments here are written in markdown syntax, so there is an
    //  additional layer of backticks to represent a code
    // block)
    // `\`address.city\`` represents a field named `address.city`, not the
    // map key
    // `city` in the field `address`.
    // `\`*\`` represents a field named `*`, not any field.
    //
    // A special `Field` contains the default indexing settings for all
    // fields.
    // This field's resource name
    // is:
    // `projects/{project_id}/databases/{database_id}/collectionGroups/__
    // default__/fields/*`
    // Indexes defined on this `Field` will be applied to all fields which
    // do not
    // have their own `Field` index configuration.
    Name string `json:"name,omitempty"`

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

    // ForceSendFields is a list of field names (e.g. "IndexConfig") 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. "IndexConfig") 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:"-"`
}

GoogleFirestoreAdminV1beta2Field: Represents a single field in the database.

Fields are grouped by their "Collection Group", which represent all collections in the database with the same id.

func (*GoogleFirestoreAdminV1beta2Field) MarshalJSON Uses

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

type GoogleFirestoreAdminV1beta2FieldOperationMetadata Uses

type GoogleFirestoreAdminV1beta2FieldOperationMetadata struct {
    // BytesProgress: The progress, in bytes, of this operation.
    BytesProgress *GoogleFirestoreAdminV1beta2Progress `json:"bytesProgress,omitempty"`

    // DocumentProgress: The progress, in documents, of this operation.
    DocumentProgress *GoogleFirestoreAdminV1beta2Progress `json:"documentProgress,omitempty"`

    // EndTime: The time this operation completed. Will be unset if
    // operation still in
    // progress.
    EndTime string `json:"endTime,omitempty"`

    // Field: The field resource that this operation is acting on. For
    // example:
    // `projects/{project_id}/databases/{database_id}/collectionGrou
    // ps/{collection_id}/fields/{field_path}`
    Field string `json:"field,omitempty"`

    // IndexConfigDeltas: A list of IndexConfigDelta, which describe the
    // intent of this
    // operation.
    IndexConfigDeltas []*GoogleFirestoreAdminV1beta2IndexConfigDelta `json:"indexConfigDeltas,omitempty"`

    // StartTime: The time this operation started.
    StartTime string `json:"startTime,omitempty"`

    // State: The state of the operation.
    //
    // Possible values:
    //   "OPERATION_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.
    State string `json:"state,omitempty"`

    // ForceSendFields is a list of field names (e.g. "BytesProgress") 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. "BytesProgress") 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:"-"`
}

GoogleFirestoreAdminV1beta2FieldOperationMetadata: Metadata for google.longrunning.Operation results from FirestoreAdmin.UpdateField.

func (*GoogleFirestoreAdminV1beta2FieldOperationMetadata) MarshalJSON Uses

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

type GoogleFirestoreAdminV1beta2ImportDocumentsMetadata Uses

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

    // EndTime: The time this operation completed. Will be unset if
    // operation still in
    // progress.
    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:
    //   "OPERATION_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: The progress, in bytes, of this operation.
    ProgressBytes *GoogleFirestoreAdminV1beta2Progress `json:"progressBytes,omitempty"`

    // ProgressDocuments: The progress, in documents, of this operation.
    ProgressDocuments *GoogleFirestoreAdminV1beta2Progress `json:"progressDocuments,omitempty"`

    // StartTime: The time this operation started.
    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:"-"`
}

GoogleFirestoreAdminV1beta2ImportDocumentsMetadata: Metadata for google.longrunning.Operation results from FirestoreAdmin.ImportDocuments.

func (*GoogleFirestoreAdminV1beta2ImportDocumentsMetadata) MarshalJSON Uses

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

type GoogleFirestoreAdminV1beta2ImportDocumentsRequest Uses

type GoogleFirestoreAdminV1beta2ImportDocumentsRequest 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.v1beta2.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:"-"`
}

GoogleFirestoreAdminV1beta2ImportDocumentsRequest: The request for FirestoreAdmin.ImportDocuments.

func (*GoogleFirestoreAdminV1beta2ImportDocumentsRequest) MarshalJSON Uses

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

type GoogleFirestoreAdminV1beta2Index Uses

type GoogleFirestoreAdminV1beta2Index struct {
    // Fields: The fields supported by this index.
    //
    // For composite indexes, this is always 2 or more fields.
    // The last field entry is always for the field path `__name__`. If,
    // on
    // creation, `__name__` was not specified as the last field, it will be
    // added
    // automatically with the same direction as that of the last field
    // defined. If
    // the final field in a composite index is not directional, the
    // `__name__`
    // will be ordered ASCENDING (unless explicitly specified).
    //
    // For single field indexes, this will always be exactly one entry with
    // a
    // field path equal to the field path of the associated field.
    Fields []*GoogleFirestoreAdminV1beta2IndexField `json:"fields,omitempty"`

    // Name: Output only.
    // A server defined name for this index.
    // The form of this name for composite indexes will
    // be:
    // `projects/{project_id}/databases/{database_id}/collectionGroups/{c
    // ollection_id}/indexes/{composite_index_id}`
    // For single field indexes, this field will be empty.
    Name string `json:"name,omitempty"`

    // QueryScope: Indexes with a collection query scope specified allow
    // queries
    // against a collection that is the child of a specific document,
    // specified at
    // query time, and that has the same collection id.
    //
    // Indexes with a collection group query scope specified allow queries
    // against
    // all collections descended from a specific document, specified at
    // query
    // time, and that have the same collection id as this index.
    //
    // Possible values:
    //   "QUERY_SCOPE_UNSPECIFIED" - The query scope is unspecified. Not a
    // valid option.
    //   "COLLECTION" - Indexes with a collection query scope specified
    // allow queries
    // against a collection that is the child of a specific document,
    // specified
    // at query time, and that has the collection id specified by the index.
    QueryScope string `json:"queryScope,omitempty"`

    // State: Output only.
    // The serving state of the index.
    //
    // 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.
    //   "NEEDS_REPAIR" - 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.
    // Use the google.longrunning.Operations API to determine why the
    // operation
    // that last attempted to create this index failed, then re-create
    // the
    // index.
    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. "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:"-"`
}

GoogleFirestoreAdminV1beta2Index: Cloud Firestore indexes enable simple and complex queries against documents in a database.

func (*GoogleFirestoreAdminV1beta2Index) MarshalJSON Uses

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

type GoogleFirestoreAdminV1beta2IndexConfig Uses

type GoogleFirestoreAdminV1beta2IndexConfig struct {
    // AncestorField: Output only.
    // Specifies the resource name of the `Field` from which this
    // field's
    // index configuration is set (when `uses_ancestor_config` is true),
    // or from which it *would* be set if this field had no index
    // configuration
    // (when `uses_ancestor_config` is false).
    AncestorField string `json:"ancestorField,omitempty"`

    // Indexes: The indexes supported for this field.
    Indexes []*GoogleFirestoreAdminV1beta2Index `json:"indexes,omitempty"`

    // Reverting: Output only
    // When true, the `Field`'s index configuration is in the process of
    // being
    // reverted. Once complete, the index config will transition to the
    // same
    // state as the field specified by `ancestor_field`, at which
    // point
    // `uses_ancestor_config` will be `true` and `reverting` will be
    // `false`.
    Reverting bool `json:"reverting,omitempty"`

    // UsesAncestorConfig: Output only.
    // When true, the `Field`'s index configuration is set from
    // the
    // configuration specified by the `ancestor_field`.
    // When false, the `Field`'s index configuration is defined explicitly.
    UsesAncestorConfig bool `json:"usesAncestorConfig,omitempty"`

    // ForceSendFields is a list of field names (e.g. "AncestorField") 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. "AncestorField") 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:"-"`
}

GoogleFirestoreAdminV1beta2IndexConfig: The index configuration for this field.

func (*GoogleFirestoreAdminV1beta2IndexConfig) MarshalJSON Uses

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

type GoogleFirestoreAdminV1beta2IndexConfigDelta Uses

type GoogleFirestoreAdminV1beta2IndexConfigDelta struct {
    // ChangeType: Specifies how the index is changing.
    //
    // Possible values:
    //   "CHANGE_TYPE_UNSPECIFIED" - The type of change is not specified or
    // known.
    //   "ADD" - The single field index is being added.
    //   "REMOVE" - The single field index is being removed.
    ChangeType string `json:"changeType,omitempty"`

    // Index: The index being changed.
    Index *GoogleFirestoreAdminV1beta2Index `json:"index,omitempty"`

    // ForceSendFields is a list of field names (e.g. "ChangeType") 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. "ChangeType") 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:"-"`
}

GoogleFirestoreAdminV1beta2IndexConfigDelta: Information about an index configuration change.

func (*GoogleFirestoreAdminV1beta2IndexConfigDelta) MarshalJSON Uses

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

type GoogleFirestoreAdminV1beta2IndexField Uses

type GoogleFirestoreAdminV1beta2IndexField struct {
    // ArrayConfig: Indicates that this field supports operations on
    // `array_value`s.
    //
    // Possible values:
    //   "ARRAY_CONFIG_UNSPECIFIED" - The index does not support additional
    // array queries.
    //   "CONTAINS" - The index supports array containment queries.
    ArrayConfig string `json:"arrayConfig,omitempty"`

    // FieldPath: Can be __name__.
    // For single field indexes, this must match the name of the field or
    // may
    // be omitted.
    FieldPath string `json:"fieldPath,omitempty"`

    // Order: Indicates that this field supports ordering by the specified
    // order or
    // comparing using =, <, <=, >, >=.
    //
    // Possible values:
    //   "ORDER_UNSPECIFIED" - The ordering is unspecified. Not a valid
    // option.
    //   "ASCENDING" - The field is ordered by ascending field value.
    //   "DESCENDING" - The field is ordered by descending field value.
    Order string `json:"order,omitempty"`

    // ForceSendFields is a list of field names (e.g. "ArrayConfig") 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. "ArrayConfig") 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:"-"`
}

GoogleFirestoreAdminV1beta2IndexField: A field in an index. The field_path describes which field is indexed, the value_mode describes how the field value is indexed.

func (*GoogleFirestoreAdminV1beta2IndexField) MarshalJSON Uses

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

type GoogleFirestoreAdminV1beta2IndexOperationMetadata Uses

type GoogleFirestoreAdminV1beta2IndexOperationMetadata struct {
    // EndTime: The time this operation completed. Will be unset if
    // operation still in
    // progress.
    EndTime string `json:"endTime,omitempty"`

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

    // ProgressBytes: The progress, in bytes, of this operation.
    ProgressBytes *GoogleFirestoreAdminV1beta2Progress `json:"progressBytes,omitempty"`

    // ProgressDocuments: The progress, in documents, of this operation.
    ProgressDocuments *GoogleFirestoreAdminV1beta2Progress `json:"progressDocuments,omitempty"`

    // StartTime: The time this operation started.
    StartTime string `json:"startTime,omitempty"`

    // State: The state of the operation.
    //
    // Possible values:
    //   "OPERATION_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.
    State string `json:"state,omitempty"`

    // ForceSendFields is a list of field names (e.g. "EndTime") 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. "EndTime") 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:"-"`
}

GoogleFirestoreAdminV1beta2IndexOperationMetadata: Metadata for google.longrunning.Operation results from FirestoreAdmin.CreateIndex.

func (*GoogleFirestoreAdminV1beta2IndexOperationMetadata) MarshalJSON Uses

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

type GoogleFirestoreAdminV1beta2ListFieldsResponse Uses

type GoogleFirestoreAdminV1beta2ListFieldsResponse struct {
    // Fields: The requested fields.
    Fields []*GoogleFirestoreAdminV1beta2Field `json:"fields,omitempty"`

    // NextPageToken: A page token that may be used to request another page
    // of results. If blank,
    // this is the last page.
    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. "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:"-"`
}

GoogleFirestoreAdminV1beta2ListFieldsResponse: The response for FirestoreAdmin.ListFields.

func (*GoogleFirestoreAdminV1beta2ListFieldsResponse) MarshalJSON Uses

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

type GoogleFirestoreAdminV1beta2ListIndexesResponse Uses

type GoogleFirestoreAdminV1beta2ListIndexesResponse struct {
    // Indexes: The requested indexes.
    Indexes []*GoogleFirestoreAdminV1beta2Index `json:"indexes,omitempty"`

    // NextPageToken: A page token that may be used to request another page
    // of results. If blank,
    // this is the last page.
    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:"-"`
}

GoogleFirestoreAdminV1beta2ListIndexesResponse: The response for FirestoreAdmin.ListIndexes.

func (*GoogleFirestoreAdminV1beta2ListIndexesResponse) MarshalJSON Uses

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

type GoogleFirestoreAdminV1beta2Progress Uses

type GoogleFirestoreAdminV1beta2Progress struct {
    // CompletedWork: The amount of work completed.
    CompletedWork int64 `json:"completedWork,omitempty,string"`

    // EstimatedWork: The amount of work estimated.
    EstimatedWork int64 `json:"estimatedWork,omitempty,string"`

    // ForceSendFields is a list of field names (e.g. "CompletedWork") 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. "CompletedWork") 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:"-"`
}

GoogleFirestoreAdminV1beta2Progress: Describes the progress of the operation. Unit of work is generic and must be interpreted based on where Progress is used.

func (*GoogleFirestoreAdminV1beta2Progress) MarshalJSON Uses

func (s *GoogleFirestoreAdminV1beta2Progress) 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 ProjectsDatabasesCollectionGroupsFieldsGetCall Uses

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

func (*ProjectsDatabasesCollectionGroupsFieldsGetCall) Context Uses

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

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 (*ProjectsDatabasesCollectionGroupsFieldsGetCall) Do Uses

func (c *ProjectsDatabasesCollectionGroupsFieldsGetCall) Do(opts ...googleapi.CallOption) (*GoogleFirestoreAdminV1beta2Field, error)

Do executes the "firestore.projects.databases.collectionGroups.fields.get" call. Exactly one of *GoogleFirestoreAdminV1beta2Field or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleFirestoreAdminV1beta2Field.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 (*ProjectsDatabasesCollectionGroupsFieldsGetCall) Fields Uses

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

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

func (*ProjectsDatabasesCollectionGroupsFieldsGetCall) Header Uses

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

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

func (*ProjectsDatabasesCollectionGroupsFieldsGetCall) IfNoneMatch Uses

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

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 ProjectsDatabasesCollectionGroupsFieldsListCall Uses

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

func (*ProjectsDatabasesCollectionGroupsFieldsListCall) Context Uses

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

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 (*ProjectsDatabasesCollectionGroupsFieldsListCall) Do Uses

func (c *ProjectsDatabasesCollectionGroupsFieldsListCall) Do(opts ...googleapi.CallOption) (*GoogleFirestoreAdminV1beta2ListFieldsResponse, error)

Do executes the "firestore.projects.databases.collectionGroups.fields.list" call. Exactly one of *GoogleFirestoreAdminV1beta2ListFieldsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleFirestoreAdminV1beta2ListFieldsResponse.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 (*ProjectsDatabasesCollectionGroupsFieldsListCall) Fields Uses

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

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

func (*ProjectsDatabasesCollectionGroupsFieldsListCall) Filter Uses

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

Filter sets the optional parameter "filter": The filter to apply to list results. Currently, FirestoreAdmin.ListFields only supports listing fields that have been explicitly overridden. To issue this query, call FirestoreAdmin.ListFields with the filter set to `indexConfig.usesAncestorConfig:false`.

func (*ProjectsDatabasesCollectionGroupsFieldsListCall) Header Uses

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

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

func (*ProjectsDatabasesCollectionGroupsFieldsListCall) IfNoneMatch Uses

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

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 (*ProjectsDatabasesCollectionGroupsFieldsListCall) PageSize Uses

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

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

func (*ProjectsDatabasesCollectionGroupsFieldsListCall) PageToken Uses

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

PageToken sets the optional parameter "pageToken": A page token, returned from a previous call to FirestoreAdmin.ListFields, that may be used to get the next page of results.

func (*ProjectsDatabasesCollectionGroupsFieldsListCall) Pages Uses

func (c *ProjectsDatabasesCollectionGroupsFieldsListCall) Pages(ctx context.Context, f func(*GoogleFirestoreAdminV1beta2ListFieldsResponse) 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 ProjectsDatabasesCollectionGroupsFieldsPatchCall Uses

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

func (*ProjectsDatabasesCollectionGroupsFieldsPatchCall) Context Uses

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

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 (*ProjectsDatabasesCollectionGroupsFieldsPatchCall) Do Uses

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

Do executes the "firestore.projects.databases.collectionGroups.fields.patch" 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 (*ProjectsDatabasesCollectionGroupsFieldsPatchCall) Fields Uses

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

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

func (*ProjectsDatabasesCollectionGroupsFieldsPatchCall) Header Uses

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

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

func (*ProjectsDatabasesCollectionGroupsFieldsPatchCall) UpdateMask Uses

func (c *ProjectsDatabasesCollectionGroupsFieldsPatchCall) UpdateMask(updateMask string) *ProjectsDatabasesCollectionGroupsFieldsPatchCall

UpdateMask sets the optional parameter "updateMask": A mask, relative to the field. If specified, only configuration specified by this field_mask will be updated in the field.

type ProjectsDatabasesCollectionGroupsFieldsService Uses

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

func NewProjectsDatabasesCollectionGroupsFieldsService Uses

func NewProjectsDatabasesCollectionGroupsFieldsService(s *Service) *ProjectsDatabasesCollectionGroupsFieldsService

func (*ProjectsDatabasesCollectionGroupsFieldsService) Get Uses

func (r *ProjectsDatabasesCollectionGroupsFieldsService) Get(name string) *ProjectsDatabasesCollectionGroupsFieldsGetCall

Get: Gets the metadata and configuration for a Field.

func (*ProjectsDatabasesCollectionGroupsFieldsService) List Uses

func (r *ProjectsDatabasesCollectionGroupsFieldsService) List(parent string) *ProjectsDatabasesCollectionGroupsFieldsListCall

List: Lists the field configuration and metadata for this database.

Currently, FirestoreAdmin.ListFields only supports listing fields that have been explicitly overridden. To issue this query, call FirestoreAdmin.ListFields with the filter set to `indexConfig.usesAncestorConfig:false`.

func (*ProjectsDatabasesCollectionGroupsFieldsService) Patch Uses

func (r *ProjectsDatabasesCollectionGroupsFieldsService) Patch(name string, googlefirestoreadminv1beta2field *GoogleFirestoreAdminV1beta2Field) *ProjectsDatabasesCollectionGroupsFieldsPatchCall

Patch: Updates a field configuration. Currently, field updates apply only to single field index configuration. However, calls to FirestoreAdmin.UpdateField should provide a field mask to avoid changing any configuration that the caller isn't aware of. The field mask should be specified as: `{ paths: "index_config" }`.

This call returns a google.longrunning.Operation which may be used to track the status of the field update. The metadata for the operation will be the type FieldOperationMetadata.

To configure the default field settings for the database, use the special `Field` with resource name: `projects/{project_id}/databases/{database_id}/collectionGroups/ __default__/fields/*`.

type ProjectsDatabasesCollectionGroupsIndexesCreateCall Uses

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

func (*ProjectsDatabasesCollectionGroupsIndexesCreateCall) Context Uses

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

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 (*ProjectsDatabasesCollectionGroupsIndexesCreateCall) Do Uses

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

Do executes the "firestore.projects.databases.collectionGroups.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 (*ProjectsDatabasesCollectionGroupsIndexesCreateCall) Fields Uses

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

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

func (*ProjectsDatabasesCollectionGroupsIndexesCreateCall) Header Uses

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

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

type ProjectsDatabasesCollectionGroupsIndexesDeleteCall Uses

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

func (*ProjectsDatabasesCollectionGroupsIndexesDeleteCall) Context Uses

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

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 (*ProjectsDatabasesCollectionGroupsIndexesDeleteCall) Do Uses

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

Do executes the "firestore.projects.databases.collectionGroups.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 (*ProjectsDatabasesCollectionGroupsIndexesDeleteCall) Fields Uses

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

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

func (*ProjectsDatabasesCollectionGroupsIndexesDeleteCall) Header Uses

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

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

type ProjectsDatabasesCollectionGroupsIndexesGetCall Uses

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

func (*ProjectsDatabasesCollectionGroupsIndexesGetCall) Context Uses

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

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 (*ProjectsDatabasesCollectionGroupsIndexesGetCall) Do Uses

func (c *ProjectsDatabasesCollectionGroupsIndexesGetCall) Do(opts ...googleapi.CallOption) (*GoogleFirestoreAdminV1beta2Index, error)

Do executes the "firestore.projects.databases.collectionGroups.indexes.get" call. Exactly one of *GoogleFirestoreAdminV1beta2Index or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleFirestoreAdminV1beta2Index.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 (*ProjectsDatabasesCollectionGroupsIndexesGetCall) Fields Uses

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

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

func (*ProjectsDatabasesCollectionGroupsIndexesGetCall) Header Uses

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

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

func (*ProjectsDatabasesCollectionGroupsIndexesGetCall) IfNoneMatch Uses

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

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 ProjectsDatabasesCollectionGroupsIndexesListCall Uses

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

func (*ProjectsDatabasesCollectionGroupsIndexesListCall) Context Uses

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

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 (*ProjectsDatabasesCollectionGroupsIndexesListCall) Do Uses

func (c *ProjectsDatabasesCollectionGroupsIndexesListCall) Do(opts ...googleapi.CallOption) (*GoogleFirestoreAdminV1beta2ListIndexesResponse, error)

Do executes the "firestore.projects.databases.collectionGroups.indexes.list" call. Exactly one of *GoogleFirestoreAdminV1beta2ListIndexesResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleFirestoreAdminV1beta2ListIndexesResponse.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 (*ProjectsDatabasesCollectionGroupsIndexesListCall) Fields Uses

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

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

func (*ProjectsDatabasesCollectionGroupsIndexesListCall) Filter Uses

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

Filter sets the optional parameter "filter": The filter to apply to list results.

func (*ProjectsDatabasesCollectionGroupsIndexesListCall) Header Uses

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

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

func (*ProjectsDatabasesCollectionGroupsIndexesListCall) IfNoneMatch Uses

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

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 (*ProjectsDatabasesCollectionGroupsIndexesListCall) PageSize Uses

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

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

func (*ProjectsDatabasesCollectionGroupsIndexesListCall) PageToken Uses

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

PageToken sets the optional parameter "pageToken": A page token, returned from a previous call to FirestoreAdmin.ListIndexes, that may be used to get the next page of results.

func (*ProjectsDatabasesCollectionGroupsIndexesListCall) Pages Uses

func (c *ProjectsDatabasesCollectionGroupsIndexesListCall) Pages(ctx context.Context, f func(*GoogleFirestoreAdminV1beta2ListIndexesResponse) 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 ProjectsDatabasesCollectionGroupsIndexesService Uses

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

func NewProjectsDatabasesCollectionGroupsIndexesService Uses

func NewProjectsDatabasesCollectionGroupsIndexesService(s *Service) *ProjectsDatabasesCollectionGroupsIndexesService

func (*ProjectsDatabasesCollectionGroupsIndexesService) Create Uses

func (r *ProjectsDatabasesCollectionGroupsIndexesService) Create(parent string, googlefirestoreadminv1beta2index *GoogleFirestoreAdminV1beta2Index) *ProjectsDatabasesCollectionGroupsIndexesCreateCall

Create: Creates a composite index. This returns a google.longrunning.Operation which may be used to track the status of the creation. The metadata for the operation will be the type IndexOperationMetadata.

func (*ProjectsDatabasesCollectionGroupsIndexesService) Delete Uses

func (r *ProjectsDatabasesCollectionGroupsIndexesService) Delete(name string) *ProjectsDatabasesCollectionGroupsIndexesDeleteCall

Delete: Deletes a composite index.

func (*ProjectsDatabasesCollectionGroupsIndexesService) Get Uses

func (r *ProjectsDatabasesCollectionGroupsIndexesService) Get(name string) *ProjectsDatabasesCollectionGroupsIndexesGetCall

Get: Gets a composite index.

func (*ProjectsDatabasesCollectionGroupsIndexesService) List Uses

func (r *ProjectsDatabasesCollectionGroupsIndexesService) List(parent string) *ProjectsDatabasesCollectionGroupsIndexesListCall

List: Lists composite indexes.

type ProjectsDatabasesCollectionGroupsService Uses

type ProjectsDatabasesCollectionGroupsService struct {
    Fields *ProjectsDatabasesCollectionGroupsFieldsService

    Indexes *ProjectsDatabasesCollectionGroupsIndexesService
    // contains filtered or unexported fields
}

func NewProjectsDatabasesCollectionGroupsService Uses

func NewProjectsDatabasesCollectionGroupsService(s *Service) *ProjectsDatabasesCollectionGroupsService

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 ProjectsDatabasesService Uses

type ProjectsDatabasesService struct {
    CollectionGroups *ProjectsDatabasesCollectionGroupsService
    // contains filtered or unexported fields
}

func NewProjectsDatabasesService Uses

func NewProjectsDatabasesService(s *Service) *ProjectsDatabasesService

func (*ProjectsDatabasesService) ExportDocuments Uses

func (r *ProjectsDatabasesService) ExportDocuments(name string, googlefirestoreadminv1beta2exportdocumentsrequest *GoogleFirestoreAdminV1beta2ExportDocumentsRequest) *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, googlefirestoreadminv1beta2importdocumentsrequest *GoogleFirestoreAdminV1beta2ImportDocumentsRequest) *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 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)

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