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

type GoogleFirestoreAdminV1BulkDeleteDocumentsMetadata struct {// CollectionIds: The IDs of the collection groups that are being deleted.CollectionIds []string `json:"collectionIds,omitempty"`// EndTime: The time this operation completed. Will be unset if operation still// in progress.EndTimestring `json:"endTime,omitempty"`// NamespaceIds: Which namespace IDs are being deleted.NamespaceIds []string `json:"namespaceIds,omitempty"`// OperationState: 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.OperationStatestring `json:"operationState,omitempty"`// ProgressBytes: The progress, in bytes, of this operation.ProgressBytes *GoogleFirestoreAdminV1Progress `json:"progressBytes,omitempty"`// ProgressDocuments: The progress, in documents, of this operation.ProgressDocuments *GoogleFirestoreAdminV1Progress `json:"progressDocuments,omitempty"`// SnapshotTime: The timestamp that corresponds to the version of the database// that is being read to get the list of documents to delete. This time can// also be used as the timestamp of PITR in case of disaster recovery (subject// to PITR window limit).SnapshotTimestring `json:"snapshotTime,omitempty"`// StartTime: The time this operation started.StartTimestring `json:"startTime,omitempty"`// ForceSendFields is a list of field names (e.g. "CollectionIds") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (GoogleFirestoreAdminV1BulkDeleteDocumentsMetadata)MarshalJSON¶added inv0.186.0

func (sGoogleFirestoreAdminV1BulkDeleteDocumentsMetadata) MarshalJSON() ([]byte,error)

type GoogleFirestoreAdminV1CloneDatabaseMetadata struct {// Database: The name of the database being cloned to.Databasestring `json:"database,omitempty"`// EndTime: The time the clone finished, unset for ongoing clones.EndTimestring `json:"endTime,omitempty"`// OperationState: The operation state of the clone.//// 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.OperationStatestring `json:"operationState,omitempty"`// PitrSnapshot: The snapshot from which this database was cloned.PitrSnapshot *GoogleFirestoreAdminV1PitrSnapshot `json:"pitrSnapshot,omitempty"`// ProgressPercentage: How far along the clone is as an estimated percentage of// remaining time.ProgressPercentage *GoogleFirestoreAdminV1Progress `json:"progressPercentage,omitempty"`// StartTime: The time the clone was started.StartTimestring `json:"startTime,omitempty"`// ForceSendFields is a list of field names (e.g. "Database") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Database") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (GoogleFirestoreAdminV1CloneDatabaseMetadata)MarshalJSON¶added inv0.240.0

func (sGoogleFirestoreAdminV1CloneDatabaseMetadata) MarshalJSON() ([]byte,error)

type GoogleFirestoreAdminV1CreateDatabaseMetadata struct {}

type GoogleFirestoreAdminV1DeleteDatabaseMetadata struct {}

type GoogleFirestoreAdminV1PitrSnapshot struct {// Database: Required. The name of the database that this was a snapshot of.// Format: `projects/{project}/databases/{database}`.Databasestring `json:"database,omitempty"`// DatabaseUid: Output only. Public UUID of the database the snapshot was// associated with.DatabaseUidstring `json:"databaseUid,omitempty"`// SnapshotTime: Required. Snapshot time of the database.SnapshotTimestring `json:"snapshotTime,omitempty"`// ForceSendFields is a list of field names (e.g. "Database") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Database") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (GoogleFirestoreAdminV1PitrSnapshot)MarshalJSON¶added inv0.240.0

func (sGoogleFirestoreAdminV1PitrSnapshot) MarshalJSON() ([]byte,error)

type GoogleFirestoreAdminV1Progress struct {// CompletedWork: The amount of work completed.CompletedWorkint64 `json:"completedWork,omitempty,string"`// EstimatedWork: The amount of work estimated.EstimatedWorkint64 `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 or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (GoogleFirestoreAdminV1Progress)MarshalJSON¶added inv0.135.0

func (sGoogleFirestoreAdminV1Progress) MarshalJSON() ([]byte,error)

type GoogleFirestoreAdminV1RestoreDatabaseMetadata struct {// Backup: The name of the backup restoring from.Backupstring `json:"backup,omitempty"`// Database: The name of the database being restored to.Databasestring `json:"database,omitempty"`// EndTime: The time the restore finished, unset for ongoing restores.EndTimestring `json:"endTime,omitempty"`// OperationState: The operation state of the restore.//// 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.OperationStatestring `json:"operationState,omitempty"`// ProgressPercentage: How far along the restore is as an estimated percentage// of remaining time.ProgressPercentage *GoogleFirestoreAdminV1Progress `json:"progressPercentage,omitempty"`// StartTime: The time the restore was started.StartTimestring `json:"startTime,omitempty"`// ForceSendFields is a list of field names (e.g. "Backup") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Backup") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (GoogleFirestoreAdminV1RestoreDatabaseMetadata)MarshalJSON¶added inv0.130.0

func (sGoogleFirestoreAdminV1RestoreDatabaseMetadata) MarshalJSON() ([]byte,error)

type GoogleFirestoreAdminV1UpdateDatabaseMetadata struct {}

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.EndTimestring `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.OperationStatestring `json:"operationState,omitempty"`// OutputUriPrefix: Where the entities are being exported to.OutputUriPrefixstring `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.StartTimestring `json:"startTime,omitempty"`// ForceSendFields is a list of field names (e.g. "CollectionIds") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (GoogleFirestoreAdminV1beta2ExportDocumentsMetadata)MarshalJSON¶

func (sGoogleFirestoreAdminV1beta2ExportDocumentsMetadata) MarshalJSON() ([]byte,error)

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.OutputUriPrefixstring `json:"outputUriPrefix,omitempty"`// ForceSendFields is a list of field names (e.g. "CollectionIds") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (GoogleFirestoreAdminV1beta2ExportDocumentsRequest)MarshalJSON¶

func (sGoogleFirestoreAdminV1beta2ExportDocumentsRequest) MarshalJSON() ([]byte,error)

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.OutputUriPrefixstring `json:"outputUriPrefix,omitempty"`// ForceSendFields is a list of field names (e.g. "OutputUriPrefix") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (GoogleFirestoreAdminV1beta2ExportDocumentsResponse)MarshalJSON¶

func (sGoogleFirestoreAdminV1beta2ExportDocumentsResponse) MarshalJSON() ([]byte,error)

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_i// d}/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__/f// ields/*` Indexes defined on this `Field` will be applied to all fields which// do not have their own `Field` index configuration.Namestring `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 or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (GoogleFirestoreAdminV1beta2Field)MarshalJSON¶

func (sGoogleFirestoreAdminV1beta2Field) MarshalJSON() ([]byte,error)

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.EndTimestring `json:"endTime,omitempty"`// Field: The field resource that this operation is acting on. For example:// `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_i// d}/fields/{field_path}`Fieldstring `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.StartTimestring `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.Statestring `json:"state,omitempty"`// ForceSendFields is a list of field names (e.g. "BytesProgress") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (GoogleFirestoreAdminV1beta2FieldOperationMetadata)MarshalJSON¶

func (sGoogleFirestoreAdminV1beta2FieldOperationMetadata) MarshalJSON() ([]byte,error)

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.EndTimestring `json:"endTime,omitempty"`// InputUriPrefix: The location of the documents being imported.InputUriPrefixstring `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.OperationStatestring `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.StartTimestring `json:"startTime,omitempty"`// ForceSendFields is a list of field names (e.g. "CollectionIds") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (GoogleFirestoreAdminV1beta2ImportDocumentsMetadata)MarshalJSON¶

func (sGoogleFirestoreAdminV1beta2ImportDocumentsMetadata) MarshalJSON() ([]byte,error)

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.ExportDocumentsResponse.output_uri_prefix.InputUriPrefixstring `json:"inputUriPrefix,omitempty"`// ForceSendFields is a list of field names (e.g. "CollectionIds") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (GoogleFirestoreAdminV1beta2ImportDocumentsRequest)MarshalJSON¶

func (sGoogleFirestoreAdminV1beta2ImportDocumentsRequest) MarshalJSON() ([]byte,error)

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/{collection_i// d}/indexes/{composite_index_id}` For single field indexes, this field will// be empty.Namestring `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.//   "COLLECTION_GROUP" - Indexes with a collection group query scope specified// allow queries against all collections that has the collection id specified// by the index.QueryScopestring `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.Statestring `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 or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (GoogleFirestoreAdminV1beta2Index)MarshalJSON¶

func (sGoogleFirestoreAdminV1beta2Index) MarshalJSON() ([]byte,error)

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).AncestorFieldstring `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`.Revertingbool `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.UsesAncestorConfigbool `json:"usesAncestorConfig,omitempty"`// ForceSendFields is a list of field names (e.g. "AncestorField") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (GoogleFirestoreAdminV1beta2IndexConfig)MarshalJSON¶

func (sGoogleFirestoreAdminV1beta2IndexConfig) MarshalJSON() ([]byte,error)

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.ChangeTypestring `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 or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (GoogleFirestoreAdminV1beta2IndexConfigDelta)MarshalJSON¶

func (sGoogleFirestoreAdminV1beta2IndexConfigDelta) MarshalJSON() ([]byte,error)

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.ArrayConfigstring `json:"arrayConfig,omitempty"`// FieldPath: Can be __name__. For single field indexes, this must match the// name of the field or may be omitted.FieldPathstring `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.Orderstring `json:"order,omitempty"`// ForceSendFields is a list of field names (e.g. "ArrayConfig") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (GoogleFirestoreAdminV1beta2IndexField)MarshalJSON¶

func (sGoogleFirestoreAdminV1beta2IndexField) MarshalJSON() ([]byte,error)

type GoogleFirestoreAdminV1beta2IndexOperationMetadata struct {// EndTime: The time this operation completed. Will be unset if operation still// in progress.EndTimestring `json:"endTime,omitempty"`// Index: The index resource that this operation is acting on. For example:// `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_i// d}/indexes/{index_id}`Indexstring `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.StartTimestring `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.Statestring `json:"state,omitempty"`// ForceSendFields is a list of field names (e.g. "EndTime") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (GoogleFirestoreAdminV1beta2IndexOperationMetadata)MarshalJSON¶

func (sGoogleFirestoreAdminV1beta2IndexOperationMetadata) MarshalJSON() ([]byte,error)

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.NextPageTokenstring `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 or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (GoogleFirestoreAdminV1beta2ListFieldsResponse)MarshalJSON¶

func (sGoogleFirestoreAdminV1beta2ListFieldsResponse) MarshalJSON() ([]byte,error)

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.NextPageTokenstring `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 or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (GoogleFirestoreAdminV1beta2ListIndexesResponse)MarshalJSON¶

func (sGoogleFirestoreAdminV1beta2ListIndexesResponse) MarshalJSON() ([]byte,error)

type GoogleFirestoreAdminV1beta2Progress struct {// CompletedWork: The amount of work completed.CompletedWorkint64 `json:"completedWork,omitempty,string"`// EstimatedWork: The amount of work estimated.EstimatedWorkint64 `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 or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (GoogleFirestoreAdminV1beta2Progress)MarshalJSON¶

func (sGoogleFirestoreAdminV1beta2Progress) MarshalJSON() ([]byte,error)

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.Donebool `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.Metadatagoogleapi.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 be a resource name ending with `operations/{unique_id}`.Namestring `json:"name,omitempty"`// Response: The normal, successful response of the operation. 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`.Responsegoogleapi.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 or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (GoogleLongrunningOperation)MarshalJSON¶

func (sGoogleLongrunningOperation) MarshalJSON() ([]byte,error)

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

func (*ProjectsDatabasesCollectionGroupsFieldsGetCall)Context¶

func (c *ProjectsDatabasesCollectionGroupsFieldsGetCall) Context(ctxcontext.Context) *ProjectsDatabasesCollectionGroupsFieldsGetCall

Context sets the context to be used in this call's Do method.

func (*ProjectsDatabasesCollectionGroupsFieldsGetCall)Do¶

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

Do executes the "firestore.projects.databases.collectionGroups.fields.get" call.Any non-2xx status code is an error. Response headers are in either*GoogleFirestoreAdminV1beta2Field.ServerResponse.Header or (if a responsewas returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsDatabasesCollectionGroupsFieldsGetCall)Fields¶

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsDatabasesCollectionGroupsFieldsGetCall)Header¶

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

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsDatabasesCollectionGroupsFieldsGetCall)IfNoneMatch¶

func (c *ProjectsDatabasesCollectionGroupsFieldsGetCall) IfNoneMatch(entityTagstring) *ProjectsDatabasesCollectionGroupsFieldsGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

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

func (*ProjectsDatabasesCollectionGroupsFieldsListCall)Context¶

func (c *ProjectsDatabasesCollectionGroupsFieldsListCall) Context(ctxcontext.Context) *ProjectsDatabasesCollectionGroupsFieldsListCall

Context sets the context to be used in this call's Do method.

func (*ProjectsDatabasesCollectionGroupsFieldsListCall)Do¶

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

Do executes the "firestore.projects.databases.collectionGroups.fields.list" call.Any non-2xx status code is an error. Response headers are in either*GoogleFirestoreAdminV1beta2ListFieldsResponse.ServerResponse.Header or (ifa response was returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsDatabasesCollectionGroupsFieldsListCall)Fields¶

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsDatabasesCollectionGroupsFieldsListCall)Filter¶

func (c *ProjectsDatabasesCollectionGroupsFieldsListCall) Filter(filterstring) *ProjectsDatabasesCollectionGroupsFieldsListCall

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

func (*ProjectsDatabasesCollectionGroupsFieldsListCall)Header¶

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

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsDatabasesCollectionGroupsFieldsListCall)IfNoneMatch¶

func (c *ProjectsDatabasesCollectionGroupsFieldsListCall) IfNoneMatch(entityTagstring) *ProjectsDatabasesCollectionGroupsFieldsListCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ProjectsDatabasesCollectionGroupsFieldsListCall)PageSize¶

func (c *ProjectsDatabasesCollectionGroupsFieldsListCall) PageSize(pageSizeint64) *ProjectsDatabasesCollectionGroupsFieldsListCall

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

func (*ProjectsDatabasesCollectionGroupsFieldsListCall)PageToken¶

func (c *ProjectsDatabasesCollectionGroupsFieldsListCall) PageToken(pageTokenstring) *ProjectsDatabasesCollectionGroupsFieldsListCall

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

func (*ProjectsDatabasesCollectionGroupsFieldsListCall)Pages¶

func (c *ProjectsDatabasesCollectionGroupsFieldsListCall) Pages(ctxcontext.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 struct {// contains filtered or unexported fields}

func (*ProjectsDatabasesCollectionGroupsFieldsPatchCall)Context¶

func (c *ProjectsDatabasesCollectionGroupsFieldsPatchCall) Context(ctxcontext.Context) *ProjectsDatabasesCollectionGroupsFieldsPatchCall

Context sets the context to be used in this call's Do method.

func (*ProjectsDatabasesCollectionGroupsFieldsPatchCall)Do¶

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

Do executes the "firestore.projects.databases.collectionGroups.fields.patch" call.Any non-2xx status code is an error. Response headers are in either*GoogleLongrunningOperation.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsDatabasesCollectionGroupsFieldsPatchCall)Fields¶

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsDatabasesCollectionGroupsFieldsPatchCall)Header¶

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

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsDatabasesCollectionGroupsFieldsPatchCall)UpdateMask¶

func (c *ProjectsDatabasesCollectionGroupsFieldsPatchCall) UpdateMask(updateMaskstring) *ProjectsDatabasesCollectionGroupsFieldsPatchCall

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

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

funcNewProjectsDatabasesCollectionGroupsFieldsService¶

func NewProjectsDatabasesCollectionGroupsFieldsService(s *Service) *ProjectsDatabasesCollectionGroupsFieldsService

func (*ProjectsDatabasesCollectionGroupsFieldsService)Get¶

func (r *ProjectsDatabasesCollectionGroupsFieldsService) Get(namestring) *ProjectsDatabasesCollectionGroupsFieldsGetCall

Get: Gets the metadata and configuration for a Field.

• name: A name of the form`projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_id}`.

func (*ProjectsDatabasesCollectionGroupsFieldsService)List¶

func (r *ProjectsDatabasesCollectionGroupsFieldsService) List(parentstring) *ProjectsDatabasesCollectionGroupsFieldsListCall

List: Lists the field configuration and metadata for this database.Currently, FirestoreAdmin.ListFields only supports listing fields that havebeen explicitly overridden. To issue this query, callFirestoreAdmin.ListFields with the filter set to`indexConfig.usesAncestorConfig:false`.

• parent: A parent name of the form`projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}`.

func (*ProjectsDatabasesCollectionGroupsFieldsService)Patch¶

func (r *ProjectsDatabasesCollectionGroupsFieldsService) Patch(namestring, googlefirestoreadminv1beta2field *GoogleFirestoreAdminV1beta2Field) *ProjectsDatabasesCollectionGroupsFieldsPatchCall

Patch: Updates a field configuration. Currently, field updates apply only tosingle field index configuration. However, calls toFirestoreAdmin.UpdateField should provide a field mask to avoid changing anyconfiguration that the caller isn't aware of. The field mask should bespecified as: `{ paths: "index_config" }`. This call returns agoogle.longrunning.Operation which may be used to track the status of thefield update. The metadata for the operation will be the typeFieldOperationMetadata. To configure the default field settings for thedatabase, use the special `Field` with resource name:`projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*`.

• 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 aspecial field path. The only valid special field is `*`, which representsany field. Field paths may be quoted using ` (backtick). The onlycharacter that needs to be escaped within a quoted field path is thebacktick character itself, escaped using a backslash. Special charactersin field paths that must be quoted include: `*`, `.`, ``` (backtick), `[`,`]`, as well as any ascii symbolic characters. Examples: (Note: Commentshere are written in markdown syntax, so there is an additional layer ofbackticks to represent a code block) `\`address.city\“ represents a fieldnamed `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'sresource name is:`projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*` Indexes defined on this `Field` will be applied to all fieldswhich do not have their own `Field` index configuration.

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

func (*ProjectsDatabasesCollectionGroupsIndexesCreateCall)Context¶

func (c *ProjectsDatabasesCollectionGroupsIndexesCreateCall) Context(ctxcontext.Context) *ProjectsDatabasesCollectionGroupsIndexesCreateCall

Context sets the context to be used in this call's Do method.

func (*ProjectsDatabasesCollectionGroupsIndexesCreateCall)Do¶

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

Do executes the "firestore.projects.databases.collectionGroups.indexes.create" call.Any non-2xx status code is an error. Response headers are in either*GoogleLongrunningOperation.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsDatabasesCollectionGroupsIndexesCreateCall)Fields¶

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsDatabasesCollectionGroupsIndexesCreateCall)Header¶

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

Header returns a http.Header that can be modified by the caller to addheaders to the request.

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

func (*ProjectsDatabasesCollectionGroupsIndexesDeleteCall)Context¶

func (c *ProjectsDatabasesCollectionGroupsIndexesDeleteCall) Context(ctxcontext.Context) *ProjectsDatabasesCollectionGroupsIndexesDeleteCall

Context sets the context to be used in this call's Do method.

func (*ProjectsDatabasesCollectionGroupsIndexesDeleteCall)Do¶

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

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

func (*ProjectsDatabasesCollectionGroupsIndexesDeleteCall)Fields¶

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsDatabasesCollectionGroupsIndexesDeleteCall)Header¶

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

Header returns a http.Header that can be modified by the caller to addheaders to the request.

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

func (*ProjectsDatabasesCollectionGroupsIndexesGetCall)Context¶

func (c *ProjectsDatabasesCollectionGroupsIndexesGetCall) Context(ctxcontext.Context) *ProjectsDatabasesCollectionGroupsIndexesGetCall

Context sets the context to be used in this call's Do method.

func (*ProjectsDatabasesCollectionGroupsIndexesGetCall)Do¶

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

Do executes the "firestore.projects.databases.collectionGroups.indexes.get" call.Any non-2xx status code is an error. Response headers are in either*GoogleFirestoreAdminV1beta2Index.ServerResponse.Header or (if a responsewas returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsDatabasesCollectionGroupsIndexesGetCall)Fields¶

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsDatabasesCollectionGroupsIndexesGetCall)Header¶

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

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsDatabasesCollectionGroupsIndexesGetCall)IfNoneMatch¶

func (c *ProjectsDatabasesCollectionGroupsIndexesGetCall) IfNoneMatch(entityTagstring) *ProjectsDatabasesCollectionGroupsIndexesGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

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

func (*ProjectsDatabasesCollectionGroupsIndexesListCall)Context¶

func (c *ProjectsDatabasesCollectionGroupsIndexesListCall) Context(ctxcontext.Context) *ProjectsDatabasesCollectionGroupsIndexesListCall

Context sets the context to be used in this call's Do method.

func (*ProjectsDatabasesCollectionGroupsIndexesListCall)Do¶

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

Do executes the "firestore.projects.databases.collectionGroups.indexes.list" call.Any non-2xx status code is an error. Response headers are in either*GoogleFirestoreAdminV1beta2ListIndexesResponse.ServerResponse.Header or (ifa response was returned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsDatabasesCollectionGroupsIndexesListCall)Fields¶

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsDatabasesCollectionGroupsIndexesListCall)Filter¶

func (c *ProjectsDatabasesCollectionGroupsIndexesListCall) Filter(filterstring) *ProjectsDatabasesCollectionGroupsIndexesListCall

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

func (*ProjectsDatabasesCollectionGroupsIndexesListCall)Header¶

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

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*ProjectsDatabasesCollectionGroupsIndexesListCall)IfNoneMatch¶

func (c *ProjectsDatabasesCollectionGroupsIndexesListCall) IfNoneMatch(entityTagstring) *ProjectsDatabasesCollectionGroupsIndexesListCall

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*ProjectsDatabasesCollectionGroupsIndexesListCall)PageSize¶

func (c *ProjectsDatabasesCollectionGroupsIndexesListCall) PageSize(pageSizeint64) *ProjectsDatabasesCollectionGroupsIndexesListCall

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

func (*ProjectsDatabasesCollectionGroupsIndexesListCall)PageToken¶

func (c *ProjectsDatabasesCollectionGroupsIndexesListCall) PageToken(pageTokenstring) *ProjectsDatabasesCollectionGroupsIndexesListCall

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

func (*ProjectsDatabasesCollectionGroupsIndexesListCall)Pages¶

func (c *ProjectsDatabasesCollectionGroupsIndexesListCall) Pages(ctxcontext.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 struct {// contains filtered or unexported fields}

funcNewProjectsDatabasesCollectionGroupsIndexesService¶

func NewProjectsDatabasesCollectionGroupsIndexesService(s *Service) *ProjectsDatabasesCollectionGroupsIndexesService

func (*ProjectsDatabasesCollectionGroupsIndexesService)Create¶

func (r *ProjectsDatabasesCollectionGroupsIndexesService) Create(parentstring, googlefirestoreadminv1beta2index *GoogleFirestoreAdminV1beta2Index) *ProjectsDatabasesCollectionGroupsIndexesCreateCall

Create: Creates a composite index. This returns agoogle.longrunning.Operation which may be used to track the status of thecreation. The metadata for the operation will be the typeIndexOperationMetadata.

• parent: A parent name of the form`projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}`.

func (*ProjectsDatabasesCollectionGroupsIndexesService)Delete¶

func (r *ProjectsDatabasesCollectionGroupsIndexesService) Delete(namestring) *ProjectsDatabasesCollectionGroupsIndexesDeleteCall

Delete: Deletes a composite index.

• name: A name of the form`projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}`.

func (*ProjectsDatabasesCollectionGroupsIndexesService)Get¶

func (r *ProjectsDatabasesCollectionGroupsIndexesService) Get(namestring) *ProjectsDatabasesCollectionGroupsIndexesGetCall

Get: Gets a composite index.

• name: A name of the form`projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}`.

func (*ProjectsDatabasesCollectionGroupsIndexesService)List¶

func (r *ProjectsDatabasesCollectionGroupsIndexesService) List(parentstring) *ProjectsDatabasesCollectionGroupsIndexesListCall

List: Lists composite indexes.

• parent: A parent name of the form`projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}`.

type ProjectsDatabasesCollectionGroupsService struct {Fields *ProjectsDatabasesCollectionGroupsFieldsServiceIndexes *ProjectsDatabasesCollectionGroupsIndexesService// contains filtered or unexported fields}

funcNewProjectsDatabasesCollectionGroupsService¶

func NewProjectsDatabasesCollectionGroupsService(s *Service) *ProjectsDatabasesCollectionGroupsService

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

func (*ProjectsDatabasesExportDocumentsCall)Context¶

func (c *ProjectsDatabasesExportDocumentsCall) Context(ctxcontext.Context) *ProjectsDatabasesExportDocumentsCall

Context sets the context to be used in this call's Do method.

func (*ProjectsDatabasesExportDocumentsCall)Do¶

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

Do executes the "firestore.projects.databases.exportDocuments" call.Any non-2xx status code is an error. Response headers are in either*GoogleLongrunningOperation.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsDatabasesExportDocumentsCall)Fields¶

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsDatabasesExportDocumentsCall)Header¶

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

Header returns a http.Header that can be modified by the caller to addheaders to the request.

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

func (*ProjectsDatabasesImportDocumentsCall)Context¶

func (c *ProjectsDatabasesImportDocumentsCall) Context(ctxcontext.Context) *ProjectsDatabasesImportDocumentsCall

Context sets the context to be used in this call's Do method.

func (*ProjectsDatabasesImportDocumentsCall)Do¶

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

Do executes the "firestore.projects.databases.importDocuments" call.Any non-2xx status code is an error. Response headers are in either*GoogleLongrunningOperation.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsDatabasesImportDocumentsCall)Fields¶

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

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsDatabasesImportDocumentsCall)Header¶

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

Header returns a http.Header that can be modified by the caller to addheaders to the request.

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

funcNewProjectsDatabasesService¶

func NewProjectsDatabasesService(s *Service) *ProjectsDatabasesService

func (*ProjectsDatabasesService)ExportDocuments¶

func (r *ProjectsDatabasesService) ExportDocuments(namestring, googlefirestoreadminv1beta2exportdocumentsrequest *GoogleFirestoreAdminV1beta2ExportDocumentsRequest) *ProjectsDatabasesExportDocumentsCall

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

• name: Database to export. Should be of the form:`projects/{project_id}/databases/{database_id}`.

func (*ProjectsDatabasesService)ImportDocuments¶

func (r *ProjectsDatabasesService) ImportDocuments(namestring, googlefirestoreadminv1beta2importdocumentsrequest *GoogleFirestoreAdminV1beta2ImportDocumentsRequest) *ProjectsDatabasesImportDocumentsCall

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

• name: Database to import into. Should be of the form:`projects/{project_id}/databases/{database_id}`.

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

funcNewProjectsService¶

func NewProjectsService(s *Service) *ProjectsService

type Service struct {BasePathstring// API endpoint base URLUserAgentstring// optional additional User-Agent fragmentProjects *ProjectsService// contains filtered or unexported fields}

funcNewService¶added inv0.3.0

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

NewService creates a new Service.

type Status struct {// Code: The status code, which should be an enum value of google.rpc.Code.Codeint64 `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.Messagestring `json:"message,omitempty"`// ForceSendFields is a list of field names (e.g. "Code") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (Status)MarshalJSON¶

func (sStatus) MarshalJSON() ([]byte,error)