Documentation ¶
Overview ¶
Package firestore provides access to the Cloud Firestore API.
This package is DEPRECATED. Use package cloud.google.com/go/firestore instead.
See https://cloud.google.com/firestore
Usage example:
import "google.golang.org/api/firestore/v1" ... firestoreService, err := firestore.New(oauthHttpClient)
Index ¶
- Constants
- type Empty
- type GoogleFirestoreAdminV1ExportDocumentsMetadata
- type GoogleFirestoreAdminV1ExportDocumentsRequest
- type GoogleFirestoreAdminV1ExportDocumentsResponse
- type GoogleFirestoreAdminV1Field
- type GoogleFirestoreAdminV1FieldOperationMetadata
- type GoogleFirestoreAdminV1ImportDocumentsMetadata
- type GoogleFirestoreAdminV1ImportDocumentsRequest
- type GoogleFirestoreAdminV1Index
- type GoogleFirestoreAdminV1IndexConfig
- type GoogleFirestoreAdminV1IndexConfigDelta
- type GoogleFirestoreAdminV1IndexField
- type GoogleFirestoreAdminV1IndexOperationMetadata
- type GoogleFirestoreAdminV1ListFieldsResponse
- type GoogleFirestoreAdminV1ListIndexesResponse
- type GoogleFirestoreAdminV1LocationMetadata
- type GoogleFirestoreAdminV1Progress
- type GoogleLongrunningCancelOperationRequest
- type GoogleLongrunningListOperationsResponse
- type GoogleLongrunningOperation
- type ListLocationsResponse
- type Location
- type ProjectsDatabasesCollectionGroupsFieldsGetCall
- func (c *ProjectsDatabasesCollectionGroupsFieldsGetCall) Context(ctx context.Context) *ProjectsDatabasesCollectionGroupsFieldsGetCall
- func (c *ProjectsDatabasesCollectionGroupsFieldsGetCall) Do(opts ...googleapi.CallOption) (*GoogleFirestoreAdminV1Field, error)
- func (c *ProjectsDatabasesCollectionGroupsFieldsGetCall) Fields(s ...googleapi.Field) *ProjectsDatabasesCollectionGroupsFieldsGetCall
- func (c *ProjectsDatabasesCollectionGroupsFieldsGetCall) Header() http.Header
- func (c *ProjectsDatabasesCollectionGroupsFieldsGetCall) IfNoneMatch(entityTag string) *ProjectsDatabasesCollectionGroupsFieldsGetCall
- type ProjectsDatabasesCollectionGroupsFieldsListCall
- func (c *ProjectsDatabasesCollectionGroupsFieldsListCall) Context(ctx context.Context) *ProjectsDatabasesCollectionGroupsFieldsListCall
- func (c *ProjectsDatabasesCollectionGroupsFieldsListCall) Do(opts ...googleapi.CallOption) (*GoogleFirestoreAdminV1ListFieldsResponse, error)
- func (c *ProjectsDatabasesCollectionGroupsFieldsListCall) Fields(s ...googleapi.Field) *ProjectsDatabasesCollectionGroupsFieldsListCall
- func (c *ProjectsDatabasesCollectionGroupsFieldsListCall) Filter(filter string) *ProjectsDatabasesCollectionGroupsFieldsListCall
- func (c *ProjectsDatabasesCollectionGroupsFieldsListCall) Header() http.Header
- func (c *ProjectsDatabasesCollectionGroupsFieldsListCall) IfNoneMatch(entityTag string) *ProjectsDatabasesCollectionGroupsFieldsListCall
- func (c *ProjectsDatabasesCollectionGroupsFieldsListCall) PageSize(pageSize int64) *ProjectsDatabasesCollectionGroupsFieldsListCall
- func (c *ProjectsDatabasesCollectionGroupsFieldsListCall) PageToken(pageToken string) *ProjectsDatabasesCollectionGroupsFieldsListCall
- func (c *ProjectsDatabasesCollectionGroupsFieldsListCall) Pages(ctx context.Context, f func(*GoogleFirestoreAdminV1ListFieldsResponse) error) error
- type ProjectsDatabasesCollectionGroupsFieldsPatchCall
- func (c *ProjectsDatabasesCollectionGroupsFieldsPatchCall) Context(ctx context.Context) *ProjectsDatabasesCollectionGroupsFieldsPatchCall
- func (c *ProjectsDatabasesCollectionGroupsFieldsPatchCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningOperation, error)
- func (c *ProjectsDatabasesCollectionGroupsFieldsPatchCall) Fields(s ...googleapi.Field) *ProjectsDatabasesCollectionGroupsFieldsPatchCall
- func (c *ProjectsDatabasesCollectionGroupsFieldsPatchCall) Header() http.Header
- func (c *ProjectsDatabasesCollectionGroupsFieldsPatchCall) UpdateMask(updateMask string) *ProjectsDatabasesCollectionGroupsFieldsPatchCall
- type ProjectsDatabasesCollectionGroupsFieldsService
- func (r *ProjectsDatabasesCollectionGroupsFieldsService) Get(name string) *ProjectsDatabasesCollectionGroupsFieldsGetCall
- func (r *ProjectsDatabasesCollectionGroupsFieldsService) List(parent string) *ProjectsDatabasesCollectionGroupsFieldsListCall
- func (r *ProjectsDatabasesCollectionGroupsFieldsService) Patch(name string, googlefirestoreadminv1field *GoogleFirestoreAdminV1Field) *ProjectsDatabasesCollectionGroupsFieldsPatchCall
- type ProjectsDatabasesCollectionGroupsIndexesCreateCall
- func (c *ProjectsDatabasesCollectionGroupsIndexesCreateCall) Context(ctx context.Context) *ProjectsDatabasesCollectionGroupsIndexesCreateCall
- func (c *ProjectsDatabasesCollectionGroupsIndexesCreateCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningOperation, error)
- func (c *ProjectsDatabasesCollectionGroupsIndexesCreateCall) Fields(s ...googleapi.Field) *ProjectsDatabasesCollectionGroupsIndexesCreateCall
- func (c *ProjectsDatabasesCollectionGroupsIndexesCreateCall) Header() http.Header
- type ProjectsDatabasesCollectionGroupsIndexesDeleteCall
- func (c *ProjectsDatabasesCollectionGroupsIndexesDeleteCall) Context(ctx context.Context) *ProjectsDatabasesCollectionGroupsIndexesDeleteCall
- func (c *ProjectsDatabasesCollectionGroupsIndexesDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)
- func (c *ProjectsDatabasesCollectionGroupsIndexesDeleteCall) Fields(s ...googleapi.Field) *ProjectsDatabasesCollectionGroupsIndexesDeleteCall
- func (c *ProjectsDatabasesCollectionGroupsIndexesDeleteCall) Header() http.Header
- type ProjectsDatabasesCollectionGroupsIndexesGetCall
- func (c *ProjectsDatabasesCollectionGroupsIndexesGetCall) Context(ctx context.Context) *ProjectsDatabasesCollectionGroupsIndexesGetCall
- func (c *ProjectsDatabasesCollectionGroupsIndexesGetCall) Do(opts ...googleapi.CallOption) (*GoogleFirestoreAdminV1Index, error)
- func (c *ProjectsDatabasesCollectionGroupsIndexesGetCall) Fields(s ...googleapi.Field) *ProjectsDatabasesCollectionGroupsIndexesGetCall
- func (c *ProjectsDatabasesCollectionGroupsIndexesGetCall) Header() http.Header
- func (c *ProjectsDatabasesCollectionGroupsIndexesGetCall) IfNoneMatch(entityTag string) *ProjectsDatabasesCollectionGroupsIndexesGetCall
- type ProjectsDatabasesCollectionGroupsIndexesListCall
- func (c *ProjectsDatabasesCollectionGroupsIndexesListCall) Context(ctx context.Context) *ProjectsDatabasesCollectionGroupsIndexesListCall
- func (c *ProjectsDatabasesCollectionGroupsIndexesListCall) Do(opts ...googleapi.CallOption) (*GoogleFirestoreAdminV1ListIndexesResponse, error)
- func (c *ProjectsDatabasesCollectionGroupsIndexesListCall) Fields(s ...googleapi.Field) *ProjectsDatabasesCollectionGroupsIndexesListCall
- func (c *ProjectsDatabasesCollectionGroupsIndexesListCall) Filter(filter string) *ProjectsDatabasesCollectionGroupsIndexesListCall
- func (c *ProjectsDatabasesCollectionGroupsIndexesListCall) Header() http.Header
- func (c *ProjectsDatabasesCollectionGroupsIndexesListCall) IfNoneMatch(entityTag string) *ProjectsDatabasesCollectionGroupsIndexesListCall
- func (c *ProjectsDatabasesCollectionGroupsIndexesListCall) PageSize(pageSize int64) *ProjectsDatabasesCollectionGroupsIndexesListCall
- func (c *ProjectsDatabasesCollectionGroupsIndexesListCall) PageToken(pageToken string) *ProjectsDatabasesCollectionGroupsIndexesListCall
- func (c *ProjectsDatabasesCollectionGroupsIndexesListCall) Pages(ctx context.Context, f func(*GoogleFirestoreAdminV1ListIndexesResponse) error) error
- type ProjectsDatabasesCollectionGroupsIndexesService
- func (r *ProjectsDatabasesCollectionGroupsIndexesService) Create(parent string, googlefirestoreadminv1index *GoogleFirestoreAdminV1Index) *ProjectsDatabasesCollectionGroupsIndexesCreateCall
- func (r *ProjectsDatabasesCollectionGroupsIndexesService) Delete(name string) *ProjectsDatabasesCollectionGroupsIndexesDeleteCall
- func (r *ProjectsDatabasesCollectionGroupsIndexesService) Get(name string) *ProjectsDatabasesCollectionGroupsIndexesGetCall
- func (r *ProjectsDatabasesCollectionGroupsIndexesService) List(parent string) *ProjectsDatabasesCollectionGroupsIndexesListCall
- type ProjectsDatabasesCollectionGroupsService
- type ProjectsDatabasesExportDocumentsCall
- func (c *ProjectsDatabasesExportDocumentsCall) Context(ctx context.Context) *ProjectsDatabasesExportDocumentsCall
- func (c *ProjectsDatabasesExportDocumentsCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningOperation, error)
- func (c *ProjectsDatabasesExportDocumentsCall) Fields(s ...googleapi.Field) *ProjectsDatabasesExportDocumentsCall
- func (c *ProjectsDatabasesExportDocumentsCall) Header() http.Header
- type ProjectsDatabasesImportDocumentsCall
- func (c *ProjectsDatabasesImportDocumentsCall) Context(ctx context.Context) *ProjectsDatabasesImportDocumentsCall
- func (c *ProjectsDatabasesImportDocumentsCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningOperation, error)
- func (c *ProjectsDatabasesImportDocumentsCall) Fields(s ...googleapi.Field) *ProjectsDatabasesImportDocumentsCall
- func (c *ProjectsDatabasesImportDocumentsCall) Header() http.Header
- type ProjectsDatabasesOperationsCancelCall
- func (c *ProjectsDatabasesOperationsCancelCall) Context(ctx context.Context) *ProjectsDatabasesOperationsCancelCall
- func (c *ProjectsDatabasesOperationsCancelCall) Do(opts ...googleapi.CallOption) (*Empty, error)
- func (c *ProjectsDatabasesOperationsCancelCall) Fields(s ...googleapi.Field) *ProjectsDatabasesOperationsCancelCall
- func (c *ProjectsDatabasesOperationsCancelCall) Header() http.Header
- type ProjectsDatabasesOperationsDeleteCall
- func (c *ProjectsDatabasesOperationsDeleteCall) Context(ctx context.Context) *ProjectsDatabasesOperationsDeleteCall
- func (c *ProjectsDatabasesOperationsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)
- func (c *ProjectsDatabasesOperationsDeleteCall) Fields(s ...googleapi.Field) *ProjectsDatabasesOperationsDeleteCall
- func (c *ProjectsDatabasesOperationsDeleteCall) Header() http.Header
- type ProjectsDatabasesOperationsGetCall
- func (c *ProjectsDatabasesOperationsGetCall) Context(ctx context.Context) *ProjectsDatabasesOperationsGetCall
- func (c *ProjectsDatabasesOperationsGetCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningOperation, error)
- func (c *ProjectsDatabasesOperationsGetCall) Fields(s ...googleapi.Field) *ProjectsDatabasesOperationsGetCall
- func (c *ProjectsDatabasesOperationsGetCall) Header() http.Header
- func (c *ProjectsDatabasesOperationsGetCall) IfNoneMatch(entityTag string) *ProjectsDatabasesOperationsGetCall
- type ProjectsDatabasesOperationsListCall
- func (c *ProjectsDatabasesOperationsListCall) Context(ctx context.Context) *ProjectsDatabasesOperationsListCall
- func (c *ProjectsDatabasesOperationsListCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningListOperationsResponse, error)
- func (c *ProjectsDatabasesOperationsListCall) Fields(s ...googleapi.Field) *ProjectsDatabasesOperationsListCall
- func (c *ProjectsDatabasesOperationsListCall) Filter(filter string) *ProjectsDatabasesOperationsListCall
- func (c *ProjectsDatabasesOperationsListCall) Header() http.Header
- func (c *ProjectsDatabasesOperationsListCall) IfNoneMatch(entityTag string) *ProjectsDatabasesOperationsListCall
- func (c *ProjectsDatabasesOperationsListCall) PageSize(pageSize int64) *ProjectsDatabasesOperationsListCall
- func (c *ProjectsDatabasesOperationsListCall) PageToken(pageToken string) *ProjectsDatabasesOperationsListCall
- func (c *ProjectsDatabasesOperationsListCall) Pages(ctx context.Context, f func(*GoogleLongrunningListOperationsResponse) error) error
- type ProjectsDatabasesOperationsService
- func (r *ProjectsDatabasesOperationsService) Cancel(name string, ...) *ProjectsDatabasesOperationsCancelCall
- func (r *ProjectsDatabasesOperationsService) Delete(name string) *ProjectsDatabasesOperationsDeleteCall
- func (r *ProjectsDatabasesOperationsService) Get(name string) *ProjectsDatabasesOperationsGetCall
- func (r *ProjectsDatabasesOperationsService) List(name string) *ProjectsDatabasesOperationsListCall
- type ProjectsDatabasesService
- type ProjectsLocationsGetCall
- func (c *ProjectsLocationsGetCall) Context(ctx context.Context) *ProjectsLocationsGetCall
- func (c *ProjectsLocationsGetCall) Do(opts ...googleapi.CallOption) (*Location, error)
- func (c *ProjectsLocationsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsGetCall
- func (c *ProjectsLocationsGetCall) Header() http.Header
- func (c *ProjectsLocationsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsGetCall
- type ProjectsLocationsListCall
- func (c *ProjectsLocationsListCall) Context(ctx context.Context) *ProjectsLocationsListCall
- func (c *ProjectsLocationsListCall) Do(opts ...googleapi.CallOption) (*ListLocationsResponse, error)
- func (c *ProjectsLocationsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsListCall
- func (c *ProjectsLocationsListCall) Filter(filter string) *ProjectsLocationsListCall
- func (c *ProjectsLocationsListCall) Header() http.Header
- func (c *ProjectsLocationsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsListCall
- func (c *ProjectsLocationsListCall) PageSize(pageSize int64) *ProjectsLocationsListCall
- func (c *ProjectsLocationsListCall) PageToken(pageToken string) *ProjectsLocationsListCall
- func (c *ProjectsLocationsListCall) Pages(ctx context.Context, f func(*ListLocationsResponse) error) error
- type ProjectsLocationsService
- type ProjectsService
- type Service
- type Status
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.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Empty ¶
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 GoogleFirestoreAdminV1ExportDocumentsMetadata ¶
type GoogleFirestoreAdminV1ExportDocumentsMetadata 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 *GoogleFirestoreAdminV1Progress `json:"progressBytes,omitempty"` // ProgressDocuments: The progress, in documents, of this operation. ProgressDocuments *GoogleFirestoreAdminV1Progress `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:"-"` }
GoogleFirestoreAdminV1ExportDocumentsMetadata: Metadata for google.longrunning.Operation results from FirestoreAdmin.ExportDocuments.
func (*GoogleFirestoreAdminV1ExportDocumentsMetadata) MarshalJSON ¶
func (s *GoogleFirestoreAdminV1ExportDocumentsMetadata) MarshalJSON() ([]byte, error)
type GoogleFirestoreAdminV1ExportDocumentsRequest ¶
type GoogleFirestoreAdminV1ExportDocumentsRequest 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:"-"` }
GoogleFirestoreAdminV1ExportDocumentsRequest: The request for FirestoreAdmin.ExportDocuments.
func (*GoogleFirestoreAdminV1ExportDocumentsRequest) MarshalJSON ¶
func (s *GoogleFirestoreAdminV1ExportDocumentsRequest) MarshalJSON() ([]byte, error)
type GoogleFirestoreAdminV1ExportDocumentsResponse ¶
type GoogleFirestoreAdminV1ExportDocumentsResponse 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:"-"` }
GoogleFirestoreAdminV1ExportDocumentsResponse: Returned in the google.longrunning.Operation response field.
func (*GoogleFirestoreAdminV1ExportDocumentsResponse) MarshalJSON ¶
func (s *GoogleFirestoreAdminV1ExportDocumentsResponse) MarshalJSON() ([]byte, error)
type GoogleFirestoreAdminV1Field ¶
type GoogleFirestoreAdminV1Field 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 *GoogleFirestoreAdminV1IndexConfig `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:"-"` }
GoogleFirestoreAdminV1Field: 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 (*GoogleFirestoreAdminV1Field) MarshalJSON ¶
func (s *GoogleFirestoreAdminV1Field) MarshalJSON() ([]byte, error)
type GoogleFirestoreAdminV1FieldOperationMetadata ¶
type GoogleFirestoreAdminV1FieldOperationMetadata struct { // 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 []*GoogleFirestoreAdminV1IndexConfigDelta `json:"indexConfigDeltas,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"` // 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:"-"` }
GoogleFirestoreAdminV1FieldOperationMetadata: Metadata for google.longrunning.Operation results from FirestoreAdmin.UpdateField.
func (*GoogleFirestoreAdminV1FieldOperationMetadata) MarshalJSON ¶
func (s *GoogleFirestoreAdminV1FieldOperationMetadata) MarshalJSON() ([]byte, error)
type GoogleFirestoreAdminV1ImportDocumentsMetadata ¶
type GoogleFirestoreAdminV1ImportDocumentsMetadata 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 *GoogleFirestoreAdminV1Progress `json:"progressBytes,omitempty"` // ProgressDocuments: The progress, in documents, of this operation. ProgressDocuments *GoogleFirestoreAdminV1Progress `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:"-"` }
GoogleFirestoreAdminV1ImportDocumentsMetadata: Metadata for google.longrunning.Operation results from FirestoreAdmin.ImportDocuments.
func (*GoogleFirestoreAdminV1ImportDocumentsMetadata) MarshalJSON ¶
func (s *GoogleFirestoreAdminV1ImportDocumentsMetadata) MarshalJSON() ([]byte, error)
type GoogleFirestoreAdminV1ImportDocumentsRequest ¶
type GoogleFirestoreAdminV1ImportDocumentsRequest 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.v1.ExportDocumentsResponse.o // utput_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:"-"` }
GoogleFirestoreAdminV1ImportDocumentsRequest: The request for FirestoreAdmin.ImportDocuments.
func (*GoogleFirestoreAdminV1ImportDocumentsRequest) MarshalJSON ¶
func (s *GoogleFirestoreAdminV1ImportDocumentsRequest) MarshalJSON() ([]byte, error)
type GoogleFirestoreAdminV1Index ¶
type GoogleFirestoreAdminV1Index 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 []*GoogleFirestoreAdminV1IndexField `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:"-"` }
GoogleFirestoreAdminV1Index: Cloud Firestore indexes enable simple and complex queries against documents in a database.
func (*GoogleFirestoreAdminV1Index) MarshalJSON ¶
func (s *GoogleFirestoreAdminV1Index) MarshalJSON() ([]byte, error)
type GoogleFirestoreAdminV1IndexConfig ¶
type GoogleFirestoreAdminV1IndexConfig 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 []*GoogleFirestoreAdminV1Index `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:"-"` }
GoogleFirestoreAdminV1IndexConfig: The index configuration for this field.
func (*GoogleFirestoreAdminV1IndexConfig) MarshalJSON ¶
func (s *GoogleFirestoreAdminV1IndexConfig) MarshalJSON() ([]byte, error)
type GoogleFirestoreAdminV1IndexConfigDelta ¶
type GoogleFirestoreAdminV1IndexConfigDelta 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 *GoogleFirestoreAdminV1Index `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:"-"` }
GoogleFirestoreAdminV1IndexConfigDelta: Information about an index configuration change.
func (*GoogleFirestoreAdminV1IndexConfigDelta) MarshalJSON ¶
func (s *GoogleFirestoreAdminV1IndexConfigDelta) MarshalJSON() ([]byte, error)
type GoogleFirestoreAdminV1IndexField ¶
type GoogleFirestoreAdminV1IndexField 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:"-"` }
GoogleFirestoreAdminV1IndexField: A field in an index. The field_path describes which field is indexed, the value_mode describes how the field value is indexed.
func (*GoogleFirestoreAdminV1IndexField) MarshalJSON ¶
func (s *GoogleFirestoreAdminV1IndexField) MarshalJSON() ([]byte, error)
type GoogleFirestoreAdminV1IndexOperationMetadata ¶
type GoogleFirestoreAdminV1IndexOperationMetadata 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 *GoogleFirestoreAdminV1Progress `json:"progressBytes,omitempty"` // ProgressDocuments: The progress, in documents, of this operation. ProgressDocuments *GoogleFirestoreAdminV1Progress `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:"-"` }
GoogleFirestoreAdminV1IndexOperationMetadata: Metadata for google.longrunning.Operation results from FirestoreAdmin.CreateIndex.
func (*GoogleFirestoreAdminV1IndexOperationMetadata) MarshalJSON ¶
func (s *GoogleFirestoreAdminV1IndexOperationMetadata) MarshalJSON() ([]byte, error)
type GoogleFirestoreAdminV1ListFieldsResponse ¶
type GoogleFirestoreAdminV1ListFieldsResponse struct { // Fields: The requested fields. Fields []*GoogleFirestoreAdminV1Field `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:"-"` }
GoogleFirestoreAdminV1ListFieldsResponse: The response for FirestoreAdmin.ListFields.
func (*GoogleFirestoreAdminV1ListFieldsResponse) MarshalJSON ¶
func (s *GoogleFirestoreAdminV1ListFieldsResponse) MarshalJSON() ([]byte, error)
type GoogleFirestoreAdminV1ListIndexesResponse ¶
type GoogleFirestoreAdminV1ListIndexesResponse struct { // Indexes: The requested indexes. Indexes []*GoogleFirestoreAdminV1Index `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:"-"` }
GoogleFirestoreAdminV1ListIndexesResponse: The response for FirestoreAdmin.ListIndexes.
func (*GoogleFirestoreAdminV1ListIndexesResponse) MarshalJSON ¶
func (s *GoogleFirestoreAdminV1ListIndexesResponse) MarshalJSON() ([]byte, error)
type GoogleFirestoreAdminV1LocationMetadata ¶
type GoogleFirestoreAdminV1LocationMetadata struct { }
GoogleFirestoreAdminV1LocationMetadata: The metadata message for google.cloud.location.Location.metadata.
type GoogleFirestoreAdminV1Progress ¶
type GoogleFirestoreAdminV1Progress 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:"-"` }
GoogleFirestoreAdminV1Progress: Describes the progress of the operation. Unit of work is generic and must be interpreted based on where Progress is used.
func (*GoogleFirestoreAdminV1Progress) MarshalJSON ¶
func (s *GoogleFirestoreAdminV1Progress) MarshalJSON() ([]byte, error)
type GoogleLongrunningCancelOperationRequest ¶
type GoogleLongrunningCancelOperationRequest struct { }
GoogleLongrunningCancelOperationRequest: The request message for Operations.CancelOperation.
type GoogleLongrunningListOperationsResponse ¶
type GoogleLongrunningListOperationsResponse struct { // NextPageToken: The standard List next-page token. NextPageToken string `json:"nextPageToken,omitempty"` // Operations: A list of operations that matches the specified filter in // the request. Operations []*GoogleLongrunningOperation `json:"operations,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "NextPageToken") 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. "NextPageToken") 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:"-"` }
GoogleLongrunningListOperationsResponse: The response message for Operations.ListOperations.
func (*GoogleLongrunningListOperationsResponse) MarshalJSON ¶
func (s *GoogleLongrunningListOperationsResponse) MarshalJSON() ([]byte, error)
type GoogleLongrunningOperation ¶
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 ¶
func (s *GoogleLongrunningOperation) MarshalJSON() ([]byte, error)
type ListLocationsResponse ¶
type ListLocationsResponse struct { // Locations: A list of locations that matches the specified filter in // the request. Locations []*Location `json:"locations,omitempty"` // NextPageToken: The standard List next-page token. NextPageToken string `json:"nextPageToken,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "Locations") 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. "Locations") 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:"-"` }
ListLocationsResponse: The response message for Locations.ListLocations.
func (*ListLocationsResponse) MarshalJSON ¶
func (s *ListLocationsResponse) MarshalJSON() ([]byte, error)
type Location ¶
type Location struct { // DisplayName: The friendly name for this location, typically a nearby // city name. // For example, "Tokyo". DisplayName string `json:"displayName,omitempty"` // Labels: Cross-service attributes for the location. For example // // {"cloud.googleapis.com/region": "us-east1"} Labels map[string]string `json:"labels,omitempty"` // LocationId: The canonical id for this location. For example: // "us-east1". LocationId string `json:"locationId,omitempty"` // Metadata: Service-specific metadata. For example the available // capacity at the given // location. Metadata googleapi.RawMessage `json:"metadata,omitempty"` // Name: Resource name for the location, which may vary between // implementations. // For example: "projects/example-project/locations/us-east1" 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. "DisplayName") 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. "DisplayName") 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:"-"` }
Location: A resource that represents Google Cloud Platform location.
func (*Location) MarshalJSON ¶
type ProjectsDatabasesCollectionGroupsFieldsGetCall ¶
type ProjectsDatabasesCollectionGroupsFieldsGetCall struct {
// contains filtered or unexported fields
}
func (*ProjectsDatabasesCollectionGroupsFieldsGetCall) Context ¶
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 ¶
func (c *ProjectsDatabasesCollectionGroupsFieldsGetCall) Do(opts ...googleapi.CallOption) (*GoogleFirestoreAdminV1Field, error)
Do executes the "firestore.projects.databases.collectionGroups.fields.get" call. Exactly one of *GoogleFirestoreAdminV1Field or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleFirestoreAdminV1Field.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 ¶
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 ¶
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 ¶
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 ¶
type ProjectsDatabasesCollectionGroupsFieldsListCall struct {
// contains filtered or unexported fields
}
func (*ProjectsDatabasesCollectionGroupsFieldsListCall) Context ¶
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 ¶
func (c *ProjectsDatabasesCollectionGroupsFieldsListCall) Do(opts ...googleapi.CallOption) (*GoogleFirestoreAdminV1ListFieldsResponse, error)
Do executes the "firestore.projects.databases.collectionGroups.fields.list" call. Exactly one of *GoogleFirestoreAdminV1ListFieldsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleFirestoreAdminV1ListFieldsResponse.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 ¶
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 ¶
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 ¶
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 ¶
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 ¶
func (c *ProjectsDatabasesCollectionGroupsFieldsListCall) PageSize(pageSize int64) *ProjectsDatabasesCollectionGroupsFieldsListCall
PageSize sets the optional parameter "pageSize": The number of results to return.
func (*ProjectsDatabasesCollectionGroupsFieldsListCall) PageToken ¶
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 ¶
func (c *ProjectsDatabasesCollectionGroupsFieldsListCall) Pages(ctx context.Context, f func(*GoogleFirestoreAdminV1ListFieldsResponse) 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 ¶
type ProjectsDatabasesCollectionGroupsFieldsPatchCall struct {
// contains filtered or unexported fields
}
func (*ProjectsDatabasesCollectionGroupsFieldsPatchCall) Context ¶
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 ¶
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 ¶
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 ¶
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 ¶
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 ¶
type ProjectsDatabasesCollectionGroupsFieldsService struct {
// contains filtered or unexported fields
}
func NewProjectsDatabasesCollectionGroupsFieldsService ¶
func NewProjectsDatabasesCollectionGroupsFieldsService(s *Service) *ProjectsDatabasesCollectionGroupsFieldsService
func (*ProjectsDatabasesCollectionGroupsFieldsService) Get ¶
func (r *ProjectsDatabasesCollectionGroupsFieldsService) Get(name string) *ProjectsDatabasesCollectionGroupsFieldsGetCall
Get: Gets the metadata and configuration for a Field.
func (*ProjectsDatabasesCollectionGroupsFieldsService) List ¶
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 ¶
func (r *ProjectsDatabasesCollectionGroupsFieldsService) Patch(name string, googlefirestoreadminv1field *GoogleFirestoreAdminV1Field) *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 ¶
type ProjectsDatabasesCollectionGroupsIndexesCreateCall struct {
// contains filtered or unexported fields
}
func (*ProjectsDatabasesCollectionGroupsIndexesCreateCall) Context ¶
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 ¶
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 ¶
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 ¶
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 ¶
type ProjectsDatabasesCollectionGroupsIndexesDeleteCall struct {
// contains filtered or unexported fields
}
func (*ProjectsDatabasesCollectionGroupsIndexesDeleteCall) Context ¶
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 ¶
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 ¶
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 ¶
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 ¶
type ProjectsDatabasesCollectionGroupsIndexesGetCall struct {
// contains filtered or unexported fields
}
func (*ProjectsDatabasesCollectionGroupsIndexesGetCall) Context ¶
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 ¶
func (c *ProjectsDatabasesCollectionGroupsIndexesGetCall) Do(opts ...googleapi.CallOption) (*GoogleFirestoreAdminV1Index, error)
Do executes the "firestore.projects.databases.collectionGroups.indexes.get" call. Exactly one of *GoogleFirestoreAdminV1Index or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleFirestoreAdminV1Index.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 ¶
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 ¶
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 ¶
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 ¶
type ProjectsDatabasesCollectionGroupsIndexesListCall struct {
// contains filtered or unexported fields
}
func (*ProjectsDatabasesCollectionGroupsIndexesListCall) Context ¶
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 ¶
func (c *ProjectsDatabasesCollectionGroupsIndexesListCall) Do(opts ...googleapi.CallOption) (*GoogleFirestoreAdminV1ListIndexesResponse, error)
Do executes the "firestore.projects.databases.collectionGroups.indexes.list" call. Exactly one of *GoogleFirestoreAdminV1ListIndexesResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleFirestoreAdminV1ListIndexesResponse.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 ¶
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 ¶
func (c *ProjectsDatabasesCollectionGroupsIndexesListCall) Filter(filter string) *ProjectsDatabasesCollectionGroupsIndexesListCall
Filter sets the optional parameter "filter": The filter to apply to list results.
func (*ProjectsDatabasesCollectionGroupsIndexesListCall) Header ¶
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 ¶
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 ¶
func (c *ProjectsDatabasesCollectionGroupsIndexesListCall) PageSize(pageSize int64) *ProjectsDatabasesCollectionGroupsIndexesListCall
PageSize sets the optional parameter "pageSize": The number of results to return.
func (*ProjectsDatabasesCollectionGroupsIndexesListCall) PageToken ¶
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 ¶
func (c *ProjectsDatabasesCollectionGroupsIndexesListCall) Pages(ctx context.Context, f func(*GoogleFirestoreAdminV1ListIndexesResponse) 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 ¶
type ProjectsDatabasesCollectionGroupsIndexesService struct {
// contains filtered or unexported fields
}
func NewProjectsDatabasesCollectionGroupsIndexesService ¶
func NewProjectsDatabasesCollectionGroupsIndexesService(s *Service) *ProjectsDatabasesCollectionGroupsIndexesService
func (*ProjectsDatabasesCollectionGroupsIndexesService) Create ¶
func (r *ProjectsDatabasesCollectionGroupsIndexesService) Create(parent string, googlefirestoreadminv1index *GoogleFirestoreAdminV1Index) *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 ¶
func (r *ProjectsDatabasesCollectionGroupsIndexesService) Delete(name string) *ProjectsDatabasesCollectionGroupsIndexesDeleteCall
Delete: Deletes a composite index.
func (*ProjectsDatabasesCollectionGroupsIndexesService) Get ¶
func (r *ProjectsDatabasesCollectionGroupsIndexesService) Get(name string) *ProjectsDatabasesCollectionGroupsIndexesGetCall
Get: Gets a composite index.
func (*ProjectsDatabasesCollectionGroupsIndexesService) List ¶
func (r *ProjectsDatabasesCollectionGroupsIndexesService) List(parent string) *ProjectsDatabasesCollectionGroupsIndexesListCall
List: Lists composite indexes.
type ProjectsDatabasesCollectionGroupsService ¶
type ProjectsDatabasesCollectionGroupsService struct { Fields *ProjectsDatabasesCollectionGroupsFieldsService Indexes *ProjectsDatabasesCollectionGroupsIndexesService // contains filtered or unexported fields }
func NewProjectsDatabasesCollectionGroupsService ¶
func NewProjectsDatabasesCollectionGroupsService(s *Service) *ProjectsDatabasesCollectionGroupsService
type ProjectsDatabasesExportDocumentsCall ¶
type ProjectsDatabasesExportDocumentsCall struct {
// contains filtered or unexported fields
}
func (*ProjectsDatabasesExportDocumentsCall) Context ¶
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 ¶
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 ¶
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 ¶
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 ¶
type ProjectsDatabasesImportDocumentsCall struct {
// contains filtered or unexported fields
}
func (*ProjectsDatabasesImportDocumentsCall) Context ¶
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 ¶
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 ¶
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 ¶
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 ProjectsDatabasesOperationsCancelCall ¶
type ProjectsDatabasesOperationsCancelCall struct {
// contains filtered or unexported fields
}
func (*ProjectsDatabasesOperationsCancelCall) Context ¶
func (c *ProjectsDatabasesOperationsCancelCall) Context(ctx context.Context) *ProjectsDatabasesOperationsCancelCall
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 (*ProjectsDatabasesOperationsCancelCall) Do ¶
func (c *ProjectsDatabasesOperationsCancelCall) Do(opts ...googleapi.CallOption) (*Empty, error)
Do executes the "firestore.projects.databases.operations.cancel" 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 (*ProjectsDatabasesOperationsCancelCall) Fields ¶
func (c *ProjectsDatabasesOperationsCancelCall) Fields(s ...googleapi.Field) *ProjectsDatabasesOperationsCancelCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsDatabasesOperationsCancelCall) Header ¶
func (c *ProjectsDatabasesOperationsCancelCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type ProjectsDatabasesOperationsDeleteCall ¶
type ProjectsDatabasesOperationsDeleteCall struct {
// contains filtered or unexported fields
}
func (*ProjectsDatabasesOperationsDeleteCall) Context ¶
func (c *ProjectsDatabasesOperationsDeleteCall) Context(ctx context.Context) *ProjectsDatabasesOperationsDeleteCall
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 (*ProjectsDatabasesOperationsDeleteCall) Do ¶
func (c *ProjectsDatabasesOperationsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)
Do executes the "firestore.projects.databases.operations.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 (*ProjectsDatabasesOperationsDeleteCall) Fields ¶
func (c *ProjectsDatabasesOperationsDeleteCall) Fields(s ...googleapi.Field) *ProjectsDatabasesOperationsDeleteCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsDatabasesOperationsDeleteCall) Header ¶
func (c *ProjectsDatabasesOperationsDeleteCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type ProjectsDatabasesOperationsGetCall ¶
type ProjectsDatabasesOperationsGetCall struct {
// contains filtered or unexported fields
}
func (*ProjectsDatabasesOperationsGetCall) Context ¶
func (c *ProjectsDatabasesOperationsGetCall) Context(ctx context.Context) *ProjectsDatabasesOperationsGetCall
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 (*ProjectsDatabasesOperationsGetCall) Do ¶
func (c *ProjectsDatabasesOperationsGetCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningOperation, error)
Do executes the "firestore.projects.databases.operations.get" 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 (*ProjectsDatabasesOperationsGetCall) Fields ¶
func (c *ProjectsDatabasesOperationsGetCall) Fields(s ...googleapi.Field) *ProjectsDatabasesOperationsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsDatabasesOperationsGetCall) Header ¶
func (c *ProjectsDatabasesOperationsGetCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*ProjectsDatabasesOperationsGetCall) IfNoneMatch ¶
func (c *ProjectsDatabasesOperationsGetCall) IfNoneMatch(entityTag string) *ProjectsDatabasesOperationsGetCall
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 ProjectsDatabasesOperationsListCall ¶
type ProjectsDatabasesOperationsListCall struct {
// contains filtered or unexported fields
}
func (*ProjectsDatabasesOperationsListCall) Context ¶
func (c *ProjectsDatabasesOperationsListCall) Context(ctx context.Context) *ProjectsDatabasesOperationsListCall
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 (*ProjectsDatabasesOperationsListCall) Do ¶
func (c *ProjectsDatabasesOperationsListCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningListOperationsResponse, error)
Do executes the "firestore.projects.databases.operations.list" call. Exactly one of *GoogleLongrunningListOperationsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleLongrunningListOperationsResponse.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 (*ProjectsDatabasesOperationsListCall) Fields ¶
func (c *ProjectsDatabasesOperationsListCall) Fields(s ...googleapi.Field) *ProjectsDatabasesOperationsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsDatabasesOperationsListCall) Filter ¶
func (c *ProjectsDatabasesOperationsListCall) Filter(filter string) *ProjectsDatabasesOperationsListCall
Filter sets the optional parameter "filter": The standard list filter.
func (*ProjectsDatabasesOperationsListCall) Header ¶
func (c *ProjectsDatabasesOperationsListCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*ProjectsDatabasesOperationsListCall) IfNoneMatch ¶
func (c *ProjectsDatabasesOperationsListCall) IfNoneMatch(entityTag string) *ProjectsDatabasesOperationsListCall
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 (*ProjectsDatabasesOperationsListCall) PageSize ¶
func (c *ProjectsDatabasesOperationsListCall) PageSize(pageSize int64) *ProjectsDatabasesOperationsListCall
PageSize sets the optional parameter "pageSize": The standard list page size.
func (*ProjectsDatabasesOperationsListCall) PageToken ¶
func (c *ProjectsDatabasesOperationsListCall) PageToken(pageToken string) *ProjectsDatabasesOperationsListCall
PageToken sets the optional parameter "pageToken": The standard list page token.
func (*ProjectsDatabasesOperationsListCall) Pages ¶
func (c *ProjectsDatabasesOperationsListCall) Pages(ctx context.Context, f func(*GoogleLongrunningListOperationsResponse) 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 ProjectsDatabasesOperationsService ¶
type ProjectsDatabasesOperationsService struct {
// contains filtered or unexported fields
}
func NewProjectsDatabasesOperationsService ¶
func NewProjectsDatabasesOperationsService(s *Service) *ProjectsDatabasesOperationsService
func (*ProjectsDatabasesOperationsService) Cancel ¶
func (r *ProjectsDatabasesOperationsService) Cancel(name string, googlelongrunningcanceloperationrequest *GoogleLongrunningCancelOperationRequest) *ProjectsDatabasesOperationsCancelCall
Cancel: Starts asynchronous cancellation on a long-running operation.
The server
makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
func (*ProjectsDatabasesOperationsService) Delete ¶
func (r *ProjectsDatabasesOperationsService) Delete(name string) *ProjectsDatabasesOperationsDeleteCall
Delete: Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
func (*ProjectsDatabasesOperationsService) Get ¶
func (r *ProjectsDatabasesOperationsService) Get(name string) *ProjectsDatabasesOperationsGetCall
Get: Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
func (*ProjectsDatabasesOperationsService) List ¶
func (r *ProjectsDatabasesOperationsService) List(name string) *ProjectsDatabasesOperationsListCall
List: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
type ProjectsDatabasesService ¶
type ProjectsDatabasesService struct { CollectionGroups *ProjectsDatabasesCollectionGroupsService Operations *ProjectsDatabasesOperationsService // contains filtered or unexported fields }
func NewProjectsDatabasesService ¶
func NewProjectsDatabasesService(s *Service) *ProjectsDatabasesService
func (*ProjectsDatabasesService) ExportDocuments ¶
func (r *ProjectsDatabasesService) ExportDocuments(name string, googlefirestoreadminv1exportdocumentsrequest *GoogleFirestoreAdminV1ExportDocumentsRequest) *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 ¶
func (r *ProjectsDatabasesService) ImportDocuments(name string, googlefirestoreadminv1importdocumentsrequest *GoogleFirestoreAdminV1ImportDocumentsRequest) *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 ProjectsLocationsGetCall ¶
type ProjectsLocationsGetCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsGetCall) Context ¶
func (c *ProjectsLocationsGetCall) Context(ctx context.Context) *ProjectsLocationsGetCall
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 (*ProjectsLocationsGetCall) Do ¶
func (c *ProjectsLocationsGetCall) Do(opts ...googleapi.CallOption) (*Location, error)
Do executes the "firestore.projects.locations.get" call. Exactly one of *Location or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Location.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 (*ProjectsLocationsGetCall) Fields ¶
func (c *ProjectsLocationsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsLocationsGetCall) Header ¶
func (c *ProjectsLocationsGetCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*ProjectsLocationsGetCall) IfNoneMatch ¶
func (c *ProjectsLocationsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsGetCall
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 ProjectsLocationsListCall ¶
type ProjectsLocationsListCall struct {
// contains filtered or unexported fields
}
func (*ProjectsLocationsListCall) Context ¶
func (c *ProjectsLocationsListCall) Context(ctx context.Context) *ProjectsLocationsListCall
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 (*ProjectsLocationsListCall) Do ¶
func (c *ProjectsLocationsListCall) Do(opts ...googleapi.CallOption) (*ListLocationsResponse, error)
Do executes the "firestore.projects.locations.list" call. Exactly one of *ListLocationsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListLocationsResponse.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 (*ProjectsLocationsListCall) Fields ¶
func (c *ProjectsLocationsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsLocationsListCall) Filter ¶
func (c *ProjectsLocationsListCall) Filter(filter string) *ProjectsLocationsListCall
Filter sets the optional parameter "filter": The standard list filter.
func (*ProjectsLocationsListCall) Header ¶
func (c *ProjectsLocationsListCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*ProjectsLocationsListCall) IfNoneMatch ¶
func (c *ProjectsLocationsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsListCall
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 (*ProjectsLocationsListCall) PageSize ¶
func (c *ProjectsLocationsListCall) PageSize(pageSize int64) *ProjectsLocationsListCall
PageSize sets the optional parameter "pageSize": The standard list page size.
func (*ProjectsLocationsListCall) PageToken ¶
func (c *ProjectsLocationsListCall) PageToken(pageToken string) *ProjectsLocationsListCall
PageToken sets the optional parameter "pageToken": The standard list page token.
func (*ProjectsLocationsListCall) Pages ¶
func (c *ProjectsLocationsListCall) Pages(ctx context.Context, f func(*ListLocationsResponse) 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 ProjectsLocationsService ¶
type ProjectsLocationsService struct {
// contains filtered or unexported fields
}
func NewProjectsLocationsService ¶
func NewProjectsLocationsService(s *Service) *ProjectsLocationsService
func (*ProjectsLocationsService) Get ¶
func (r *ProjectsLocationsService) Get(name string) *ProjectsLocationsGetCall
Get: Gets information about a location.
func (*ProjectsLocationsService) List ¶
func (r *ProjectsLocationsService) List(name string) *ProjectsLocationsListCall
List: Lists information about the supported locations for this service.
type ProjectsService ¶
type ProjectsService struct { Databases *ProjectsDatabasesService Locations *ProjectsLocationsService // contains filtered or unexported fields }
func NewProjectsService ¶
func NewProjectsService(s *Service) *ProjectsService
type Service ¶
type Service struct { BasePath string // API endpoint base URL UserAgent string // optional additional User-Agent fragment Projects *ProjectsService // contains filtered or unexported fields }
type Status ¶
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.