openapi-directory/api/googleapis.com/firestore.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"contact":{"name":"Google","url":"https://google.com"},"description":"Accesses the NoSQL document database built for automatic scaling, high performance, and ease of application development.\n","title":"Cloud Firestore","version":"v1","x-apiClientRegistration":{"url":"https://console.developers.google.com"},"x-apisguru-categories":["backend"],"x-logo":{"url":"https://www.google.com/images/branding/googlelogo/2x/googlelogo_color_272x92dp.png"},"x-origin":[{"converter":{"url":"https://github.com/lucybot/api-spec-converter","version":"2.7.11"},"format":"google","url":"https://firestore.googleapis.com/$discovery/rest?version=v1","version":"v1"}],"x-preferred":true,"x-providerName":"googleapis.com","x-serviceName":"firestore"},"externalDocs":{"url":"https://cloud.google.com/firestore"},"tags":[{"name":"projects"}],"paths":{"/v1/{name}":{"delete":{"description":"Deletes a long-running operation. This method indicates that the client is\nno longer interested in the operation result. It does not cancel the\noperation. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`.","operationId":"firestore.projects.databases.operations.delete","parameters":[{"description":"The name of the operation resource to be deleted.","in":"path","name":"name","required":true,"x-reservedExpansion":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Empty"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]},{"Oauth2":["https://www.googleapis.com/auth/datastore"]}],"tags":["projects"]},"get":{"description":"Gets information about a location.","operationId":"firestore.projects.locations.get","parameters":[{"description":"Resource name for the location.","in":"path","name":"name","required":true,"x-reservedExpansion":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Location"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]},{"Oauth2":["https://www.googleapis.com/auth/datastore"]}],"tags":["projects"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/uploadType"},{"$ref":"#/components/parameters/upload_protocol"}],"patch":{"description":"Updates a field configuration. Currently, field updates apply only to\nsingle field index configuration. However, calls to\nFirestoreAdmin.UpdateField should provide a field mask to avoid\nchanging any configuration that the caller isn't aware of. The field mask\nshould be specified as: `{ paths: \"index_config\" }`.\n\nThis call returns a google.longrunning.Operation which may be used to\ntrack the status of the field update. The metadata for\nthe operation will be the type FieldOperationMetadata.\n\nTo configure the default field settings for the database, use\nthe special `Field` with resource name:\n`projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*`.","operationId":"firestore.projects.databases.collectionGroups.fields.patch","parameters":[{"description":"A field name of the form\n`projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}`\n\nA field path may be a simple field name, e.g. `address` or a path to fields\nwithin map_value , e.g. `address.city`,\nor a special field path. The only valid special field is `*`, which\nrepresents any field.\n\nField paths may be quoted using ` (backtick). The only character that needs\nto be escaped within a quoted field path is the backtick character itself,\nescaped using a backslash. Special characters in field paths that\nmust be quoted include: `*`, `.`,\n``` (backtick), `[`, `]`, as well as any ascii symbolic characters.\n\nExamples:\n(Note: Comments here are written in markdown syntax, so there is an\n additional layer of backticks to represent a code block)\n`\\`address.city\\`` represents a field named `address.city`, not the map key\n`city` in the field `address`.\n`\\`*\\`` represents a field named `*`, not any field.\n\nA special `Field` contains the default indexing settings for all fields.\nThis field's resource name is:\n`projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*`\nIndexes defined on this `Field` will be applied to all fields which do not\nhave their own `Field` index configuration.","in":"path","name":"name","required":true,"x-reservedExpansion":true,"schema":{"type":"string"}},{"description":"A mask, relative to the field. If specified, only configuration specified\nby this field_mask will be updated in the field.","in":"query","name":"updateMask","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleFirestoreAdminV1Field"}}}},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/GoogleLongrunningOperation"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]},{"Oauth2":["https://www.googleapis.com/auth/datastore"]}],"tags":["projects"]}},"/v1/{name}/locations":{"get":{"description":"Lists information about the supported locations for this service.","operationId":"firestore.projects.locations.list","parameters":[{"description":"The standard list filter.","in":"query","name":"filter","schema":{"type":"string"}},{"description":"The resource that owns the locations collection, if applicable.","in":"path","name":"name","required":true,"x-reservedExpansion":true,"schema":{"type":"string"}},{"description":"The standard list page size.","in":"query","name":"pageSize","schema":{"type":"integer"}},{"description":"The standard list page token.","in":"query","name":"pageToken","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ListLocationsResponse"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]},{"Oauth2":["https://www.googleapis.com/auth/datastore"]}],"tags":["projects"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/uploadType"},{"$ref":"#/components/parameters/upload_protocol"}]},"/v1/{name}/operations":{"get":{"description":"Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id.","operationId":"firestore.projects.databases.operations.list","parameters":[{"description":"The standard list filter.","in":"query","name":"filter","schema":{"type":"string"}},{"description":"The name of the operation's parent resource.","in":"path","name":"name","required":true,"x-reservedExpansion":true,"schema":{"type":"string"}},{"description":"The standard list page size.","in":"query","name":"pageSize","schema":{"type":"integer"}},{"description":"The standard list page token.","in":"query","name":"pageToken","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/GoogleLongrunningListOperationsResponse"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]},{"Oauth2":["https://www.googleapis.com/auth/datastore"]}],"tags":["projects"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/uploadType"},{"$ref":"#/components/parameters/upload_protocol"}]},"/v1/{name}:cancel":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/uploadType"},{"$ref":"#/components/parameters/upload_protocol"}],"post":{"description":"Starts asynchronous cancellation on a long-running operation.  The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed.  If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`.  Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.","operationId":"firestore.projects.databases.operations.cancel","parameters":[{"description":"The name of the operation resource to be cancelled.","in":"path","name":"name","required":true,"x-reservedExpansion":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleLongrunningCancelOperationRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Empty"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]},{"Oauth2":["https://www.googleapis.com/auth/datastore"]}],"tags":["projects"]}},"/v1/{name}:exportDocuments":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/uploadType"},{"$ref":"#/components/parameters/upload_protocol"}],"post":{"description":"Exports a copy of all or a subset of documents from Google Cloud Firestore\nto another storage system, such as Google Cloud Storage. Recent updates to\ndocuments may not be reflected in the export. The export occurs in the\nbackground and its progress can be monitored and managed via the\nOperation resource that is created. The output of an export may only be\nused once the associated operation is done. If an export operation is\ncancelled before completion it may leave partial data behind in Google\nCloud Storage.","operationId":"firestore.projects.databases.exportDocuments","parameters":[{"description":"Database to export. Should be of the form:\n`projects/{project_id}/databases/{database_id}`.","in":"path","name":"name","required":true,"x-reservedExpansion":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleFirestoreAdminV1ExportDocumentsRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/GoogleLongrunningOperation"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]},{"Oauth2":["https://www.googleapis.com/auth/datastore"]}],"tags":["projects"]}},"/v1/{name}:importDocuments":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/uploadType"},{"$ref":"#/components/parameters/upload_protocol"}],"post":{"description":"Imports documents into Google Cloud Firestore. Existing documents with the\nsame name are overwritten. The import occurs in the background and its\nprogress can be monitored and managed via the Operation resource that is\ncreated. If an ImportDocuments operation is cancelled, it is possible\nthat a subset of the data has already been imported to Cloud Firestore.","operationId":"firestore.projects.databases.importDocuments","parameters":[{"description":"Database to import into. Should be of the form:\n`projects/{project_id}/databases/{database_id}`.","in":"path","name":"name","required":true,"x-reservedExpansion":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleFirestoreAdminV1ImportDocumentsRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/GoogleLongrunningOperation"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]},{"Oauth2":["https://www.googleapis.com/auth/datastore"]}],"tags":["projects"]}},"/v1/{parent}/fields":{"get":{"description":"Lists the field configuration and metadata for this database.\n\nCurrently, FirestoreAdmin.ListFields only supports listing fields\nthat have been explicitly overridden. To issue this query, call\nFirestoreAdmin.ListFields with the filter set to\n`indexConfig.usesAncestorConfig:false`.","operationId":"firestore.projects.databases.collectionGroups.fields.list","parameters":[{"description":"The filter to apply to list results. Currently,\nFirestoreAdmin.ListFields only supports listing fields\nthat have been explicitly overridden. To issue this query, call\nFirestoreAdmin.ListFields with the filter set to\n`indexConfig.usesAncestorConfig:false`.","in":"query","name":"filter","schema":{"type":"string"}},{"description":"The number of results to return.","in":"query","name":"pageSize","schema":{"type":"integer"}},{"description":"A page token, returned from a previous call to\nFirestoreAdmin.ListFields, that may be used to get the next\npage of results.","in":"query","name":"pageToken","schema":{"type":"string"}},{"description":"A parent name of the form\n`projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}`","in":"path","name":"parent","required":true,"x-reservedExpansion":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/GoogleFirestoreAdminV1ListFieldsResponse"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]},{"Oauth2":["https://www.googleapis.com/auth/datastore"]}],"tags":["projects"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/uploadType"},{"$ref":"#/components/parameters/upload_protocol"}]},"/v1/{parent}/indexes":{"get":{"description":"Lists composite indexes.","operationId":"firestore.projects.databases.collectionGroups.indexes.list","parameters":[{"description":"The filter to apply to list results.","in":"query","name":"filter","schema":{"type":"string"}},{"description":"The number of results to return.","in":"query","name":"pageSize","schema":{"type":"integer"}},{"description":"A page token, returned from a previous call to\nFirestoreAdmin.ListIndexes, that may be used to get the next\npage of results.","in":"query","name":"pageToken","schema":{"type":"string"}},{"description":"A parent name of the form\n`projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}`","in":"path","name":"parent","required":true,"x-reservedExpansion":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/GoogleFirestoreAdminV1ListIndexesResponse"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]},{"Oauth2":["https://www.googleapis.com/auth/datastore"]}],"tags":["projects"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/uploadType"},{"$ref":"#/components/parameters/upload_protocol"}],"post":{"description":"Creates a composite index. This returns a google.longrunning.Operation\nwhich may be used to track the status of the creation. The metadata for\nthe operation will be the type IndexOperationMetadata.","operationId":"firestore.projects.databases.collectionGroups.indexes.create","parameters":[{"description":"A parent name of the form\n`projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}`","in":"path","name":"parent","required":true,"x-reservedExpansion":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoogleFirestoreAdminV1Index"}}}},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/GoogleLongrunningOperation"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]},{"Oauth2":["https://www.googleapis.com/auth/datastore"]}],"tags":["projects"]}}},"servers":[{"url":"https://firestore.googleapis.com/"}],"components":{"parameters":{"access_token":{"description":"OAuth access token.","in":"query","name":"access_token","schema":{"type":"string"}},"alt":{"description":"Data format for response.","in":"query","name":"alt","schema":{"type":"string","enum":["json","media","proto"],"default":"json"}},"callback":{"description":"JSONP","in":"query","name":"callback","schema":{"type":"string"}},"fields":{"description":"Selector specifying which fields to include in a partial response.","in":"query","name":"fields","schema":{"type":"string"}},"key":{"description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","in":"query","name":"key","schema":{"type":"string"}},"oauth_token":{"description":"OAuth 2.0 token for the current user.","in":"query","name":"oauth_token","schema":{"type":"string"}},"prettyPrint":{"description":"Returns response with indentations and line breaks.","in":"query","name":"prettyPrint","schema":{"type":"boolean","default":true}},"quotaUser":{"description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","in":"query","name":"quotaUser","schema":{"type":"string"}},"uploadType":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","in":"query","name":"uploadType","schema":{"type":"string"}},"upload_protocol":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","in":"query","name":"upload_protocol","schema":{"type":"string"}},"_.xgafv":{"description":"V1 error format.","in":"query","name":"$.xgafv","schema":{"type":"string","enum":["1","2"]}}},"securitySchemes":{"Oauth2":{"description":"Oauth 2.0 authentication","type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://accounts.google.com/o/oauth2/auth","scopes":{"https://www.googleapis.com/auth/cloud-platform":"View and manage your data across Google Cloud Platform services","https://www.googleapis.com/auth/datastore":"View and manage your Google Cloud Datastore data"}}}}},"schemas":{"Empty":{"description":"A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n    service Foo {\n      rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n    }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.","properties":{},"type":"object"},"GoogleFirestoreAdminV1ExportDocumentsMetadata":{"description":"Metadata for google.longrunning.Operation results from\nFirestoreAdmin.ExportDocuments.","properties":{"collectionIds":{"description":"Which collection ids are being exported.","items":{"type":"string"},"type":"array"},"endTime":{"description":"The time this operation completed. Will be unset if operation still in\nprogress.","format":"google-datetime","type":"string"},"operationState":{"description":"The state of the export operation.","enum":["OPERATION_STATE_UNSPECIFIED","INITIALIZING","PROCESSING","CANCELLING","FINALIZING","SUCCESSFUL","FAILED","CANCELLED"],"type":"string"},"outputUriPrefix":{"description":"Where the entities are being exported to.","type":"string"},"progressBytes":{"$ref":"#/components/schemas/GoogleFirestoreAdminV1Progress"},"progressDocuments":{"$ref":"#/components/schemas/GoogleFirestoreAdminV1Progress"},"startTime":{"description":"The time this operation started.","format":"google-datetime","type":"string"}},"type":"object"},"GoogleFirestoreAdminV1ExportDocumentsRequest":{"description":"The request for FirestoreAdmin.ExportDocuments.","properties":{"collectionIds":{"description":"Which collection ids to export. Unspecified means all collections.","items":{"type":"string"},"type":"array"},"outputUriPrefix":{"description":"The output URI. Currently only supports Google Cloud Storage URIs of the\nform: `gs://BUCKET_NAME[/NAMESPACE_PATH]`, where `BUCKET_NAME` is the name\nof the Google Cloud Storage bucket and `NAMESPACE_PATH` is an optional\nGoogle Cloud Storage namespace path. When\nchoosing a name, be sure to consider Google Cloud Storage naming\nguidelines: https://cloud.google.com/storage/docs/naming.\nIf the URI is a bucket (without a namespace path), a prefix will be\ngenerated based on the start time.","type":"string"}},"type":"object"},"GoogleFirestoreAdminV1ExportDocumentsResponse":{"description":"Returned in the google.longrunning.Operation response field.","properties":{"outputUriPrefix":{"description":"Location of the output files. This can be used to begin an import\ninto Cloud Firestore (this project or another project) after the operation\ncompletes successfully.","type":"string"}},"type":"object"},"GoogleFirestoreAdminV1Field":{"description":"Represents a single field in the database.\n\nFields are grouped by their \"Collection Group\", which represent all\ncollections in the database with the same id.","properties":{"indexConfig":{"$ref":"#/components/schemas/GoogleFirestoreAdminV1IndexConfig"},"name":{"description":"A field name of the form\n`projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}`\n\nA field path may be a simple field name, e.g. `address` or a path to fields\nwithin map_value , e.g. `address.city`,\nor a special field path. The only valid special field is `*`, which\nrepresents any field.\n\nField paths may be quoted using ` (backtick). The only character that needs\nto be escaped within a quoted field path is the backtick character itself,\nescaped using a backslash. Special characters in field paths that\nmust be quoted include: `*`, `.`,\n``` (backtick), `[`, `]`, as well as any ascii symbolic characters.\n\nExamples:\n(Note: Comments here are written in markdown syntax, so there is an\n additional layer of backticks to represent a code block)\n`\\`address.city\\`` represents a field named `address.city`, not the map key\n`city` in the field `address`.\n`\\`*\\`` represents a field named `*`, not any field.\n\nA special `Field` contains the default indexing settings for all fields.\nThis field's resource name is:\n`projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*`\nIndexes defined on this `Field` will be applied to all fields which do not\nhave their own `Field` index configuration.","type":"string"}},"type":"object"},"GoogleFirestoreAdminV1FieldOperationMetadata":{"description":"Metadata for google.longrunning.Operation results from\nFirestoreAdmin.UpdateField.","properties":{"endTime":{"description":"The time this operation completed. Will be unset if operation still in\nprogress.","format":"google-datetime","type":"string"},"field":{"description":"The field resource that this operation is acting on. For example:\n`projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}`","type":"string"},"indexConfigDeltas":{"description":"A list of IndexConfigDelta, which describe the intent of this\noperation.","items":{"$ref":"#/components/schemas/GoogleFirestoreAdminV1IndexConfigDelta"},"type":"array"},"progressBytes":{"$ref":"#/components/schemas/GoogleFirestoreAdminV1Progress"},"progressDocuments":{"$ref":"#/components/schemas/GoogleFirestoreAdminV1Progress"},"startTime":{"description":"The time this operation started.","format":"google-datetime","type":"string"},"state":{"description":"The state of the operation.","enum":["OPERATION_STATE_UNSPECIFIED","INITIALIZING","PROCESSING","CANCELLING","FINALIZING","SUCCESSFUL","FAILED","CANCELLED"],"type":"string"}},"type":"object"},"GoogleFirestoreAdminV1ImportDocumentsMetadata":{"description":"Metadata for google.longrunning.Operation results from\nFirestoreAdmin.ImportDocuments.","properties":{"collectionIds":{"description":"Which collection ids are being imported.","items":{"type":"string"},"type":"array"},"endTime":{"description":"The time this operation completed. Will be unset if operation still in\nprogress.","format":"google-datetime","type":"string"},"inputUriPrefix":{"description":"The location of the documents being imported.","type":"string"},"operationState":{"description":"The state of the import operation.","enum":["OPERATION_STATE_UNSPECIFIED","INITIALIZING","PROCESSING","CANCELLING","FINALIZING","SUCCESSFUL","FAILED","CANCELLED"],"type":"string"},"progressBytes":{"$ref":"#/components/schemas/GoogleFirestoreAdminV1Progress"},"progressDocuments":{"$ref":"#/components/schemas/GoogleFirestoreAdminV1Progress"},"startTime":{"description":"The time this operation started.","format":"google-datetime","type":"string"}},"type":"object"},"GoogleFirestoreAdminV1ImportDocumentsRequest":{"description":"The request for FirestoreAdmin.ImportDocuments.","properties":{"collectionIds":{"description":"Which collection ids to import. Unspecified means all collections included\nin the import.","items":{"type":"string"},"type":"array"},"inputUriPrefix":{"description":"Location of the exported files.\nThis must match the output_uri_prefix of an ExportDocumentsResponse from\nan export that has completed successfully.\nSee:\ngoogle.firestore.admin.v1.ExportDocumentsResponse.output_uri_prefix.","type":"string"}},"type":"object"},"GoogleFirestoreAdminV1Index":{"description":"Cloud Firestore indexes enable simple and complex queries against\ndocuments in a database.","properties":{"fields":{"description":"The fields supported by this index.\n\nFor composite indexes, this is always 2 or more fields.\nThe last field entry is always for the field path `__name__`. If, on\ncreation, `__name__` was not specified as the last field, it will be added\nautomatically with the same direction as that of the last field defined. If\nthe final field in a composite index is not directional, the `__name__`\nwill be ordered ASCENDING (unless explicitly specified).\n\nFor single field indexes, this will always be exactly one entry with a\nfield path equal to the field path of the associated field.","items":{"$ref":"#/components/schemas/GoogleFirestoreAdminV1IndexField"},"type":"array"},"name":{"description":"Output only.\nA server defined name for this index.\nThe form of this name for composite indexes will be:\n`projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id}`\nFor single field indexes, this field will be empty.","type":"string"},"queryScope":{"description":"Indexes with a collection query scope specified allow queries\nagainst a collection that is the child of a specific document, specified at\nquery time, and that has the same collection id.\n\nIndexes with a collection group query scope specified allow queries against\nall collections descended from a specific document, specified at query\ntime, and that have the same collection id as this index.","enum":["QUERY_SCOPE_UNSPECIFIED","COLLECTION"],"type":"string"},"state":{"description":"Output only.\nThe serving state of the index.","enum":["STATE_UNSPECIFIED","CREATING","READY","NEEDS_REPAIR"],"type":"string"}},"type":"object"},"GoogleFirestoreAdminV1IndexConfig":{"description":"The index configuration for this field.","properties":{"ancestorField":{"description":"Output only.\nSpecifies the resource name of the `Field` from which this field's\nindex configuration is set (when `uses_ancestor_config` is true),\nor from which it *would* be set if this field had no index configuration\n(when `uses_ancestor_config` is false).","type":"string"},"indexes":{"description":"The indexes supported for this field.","items":{"$ref":"#/components/schemas/GoogleFirestoreAdminV1Index"},"type":"array"},"reverting":{"description":"Output only\nWhen true, the `Field`'s index configuration is in the process of being\nreverted. Once complete, the index config will transition to the same\nstate as the field specified by `ancestor_field`, at which point\n`uses_ancestor_config` will be `true` and `reverting` will be `false`.","type":"boolean"},"usesAncestorConfig":{"description":"Output only.\nWhen true, the `Field`'s index configuration is set from the\nconfiguration specified by the `ancestor_field`.\nWhen false, the `Field`'s index configuration is defined explicitly.","type":"boolean"}},"type":"object"},"GoogleFirestoreAdminV1IndexConfigDelta":{"description":"Information about an index configuration change.","properties":{"changeType":{"description":"Specifies how the index is changing.","enum":["CHANGE_TYPE_UNSPECIFIED","ADD","REMOVE"],"type":"string"},"index":{"$ref":"#/components/schemas/GoogleFirestoreAdminV1Index"}},"type":"object"},"GoogleFirestoreAdminV1IndexField":{"description":"A field in an index.\nThe field_path describes which field is indexed, the value_mode describes\nhow the field value is indexed.","properties":{"arrayConfig":{"description":"Indicates that this field supports operations on `array_value`s.","enum":["ARRAY_CONFIG_UNSPECIFIED","CONTAINS"],"type":"string"},"fieldPath":{"description":"Can be __name__.\nFor single field indexes, this must match the name of the field or may\nbe omitted.","type":"string"},"order":{"description":"Indicates that this field supports ordering by the specified order or\ncomparing using =, <, <=, >, >=.","enum":["ORDER_UNSPECIFIED","ASCENDING","DESCENDING"],"type":"string"}},"type":"object"},"GoogleFirestoreAdminV1IndexOperationMetadata":{"description":"Metadata for google.longrunning.Operation results from\nFirestoreAdmin.CreateIndex.","properties":{"endTime":{"description":"The time this operation completed. Will be unset if operation still in\nprogress.","format":"google-datetime","type":"string"},"index":{"description":"The index resource that this operation is acting on. For example:\n`projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}`","type":"string"},"progressBytes":{"$ref":"#/components/schemas/GoogleFirestoreAdminV1Progress"},"progressDocuments":{"$ref":"#/components/schemas/GoogleFirestoreAdminV1Progress"},"startTime":{"description":"The time this operation started.","format":"google-datetime","type":"string"},"state":{"description":"The state of the operation.","enum":["OPERATION_STATE_UNSPECIFIED","INITIALIZING","PROCESSING","CANCELLING","FINALIZING","SUCCESSFUL","FAILED","CANCELLED"],"type":"string"}},"type":"object"},"GoogleFirestoreAdminV1ListFieldsResponse":{"description":"The response for FirestoreAdmin.ListFields.","properties":{"fields":{"description":"The requested fields.","items":{"$ref":"#/components/schemas/GoogleFirestoreAdminV1Field"},"type":"array"},"nextPageToken":{"description":"A page token that may be used to request another page of results. If blank,\nthis is the last page.","type":"string"}},"type":"object"},"GoogleFirestoreAdminV1ListIndexesResponse":{"description":"The response for FirestoreAdmin.ListIndexes.","properties":{"indexes":{"description":"The requested indexes.","items":{"$ref":"#/components/schemas/GoogleFirestoreAdminV1Index"},"type":"array"},"nextPageToken":{"description":"A page token that may be used to request another page of results. If blank,\nthis is the last page.","type":"string"}},"type":"object"},"GoogleFirestoreAdminV1LocationMetadata":{"description":"The metadata message for google.cloud.location.Location.metadata.","properties":{},"type":"object"},"GoogleFirestoreAdminV1Progress":{"description":"Describes the progress of the operation.\nUnit of work is generic and must be interpreted based on where Progress\nis used.","properties":{"completedWork":{"description":"The amount of work completed.","format":"int64","type":"string"},"estimatedWork":{"description":"The amount of work estimated.","format":"int64","type":"string"}},"type":"object"},"GoogleLongrunningCancelOperationRequest":{"description":"The request message for Operations.CancelOperation.","properties":{},"type":"object"},"GoogleLongrunningListOperationsResponse":{"description":"The response message for Operations.ListOperations.","properties":{"nextPageToken":{"description":"The standard List next-page token.","type":"string"},"operations":{"description":"A list of operations that matches the specified filter in the request.","items":{"$ref":"#/components/schemas/GoogleLongrunningOperation"},"type":"array"}},"type":"object"},"GoogleLongrunningOperation":{"description":"This resource represents a long-running operation that is the result of a\nnetwork API call.","properties":{"done":{"description":"If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.","type":"boolean"},"error":{"$ref":"#/components/schemas/Status"},"metadata":{"additionalProperties":{"description":"Properties of the object. Contains field @type with type URL."},"description":"Service-specific metadata associated with the operation.  It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata.  Any method that returns a\nlong-running operation should document the metadata type, if any.","type":"object"},"name":{"description":"The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.","type":"string"},"response":{"additionalProperties":{"description":"Properties of the object. Contains field @type with type URL."},"description":"The normal response of the operation in case of success.  If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`.  If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource.  For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name.  For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.","type":"object"}},"type":"object"},"ListLocationsResponse":{"description":"The response message for Locations.ListLocations.","properties":{"locations":{"description":"A list of locations that matches the specified filter in the request.","items":{"$ref":"#/components/schemas/Location"},"type":"array"},"nextPageToken":{"description":"The standard List next-page token.","type":"string"}},"type":"object"},"Location":{"description":"A resource that represents Google Cloud Platform location.","properties":{"displayName":{"description":"The friendly name for this location, typically a nearby city name.\nFor example, \"Tokyo\".","type":"string"},"labels":{"additionalProperties":{"type":"string"},"description":"Cross-service attributes for the location. For example\n\n    {\"cloud.googleapis.com/region\": \"us-east1\"}","type":"object"},"locationId":{"description":"The canonical id for this location. For example: `\"us-east1\"`.","type":"string"},"metadata":{"additionalProperties":{"description":"Properties of the object. Contains field @type with type URL."},"description":"Service-specific metadata. For example the available capacity at the given\nlocation.","type":"object"},"name":{"description":"Resource name for the location, which may vary between implementations.\nFor example: `\"projects/example-project/locations/us-east1\"`","type":"string"}},"type":"object"},"Status":{"description":"The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed.  The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n    it may embed the `Status` in the normal response to indicate the partial\n    errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n    have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n    `Status` message should be used directly inside batch response, one for\n    each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n    results in its response, the status of those operations should be\n    represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n    be used directly after any stripping needed for security/privacy reasons.","properties":{"code":{"description":"The status code, which should be an enum value of google.rpc.Code.","format":"int32","type":"integer"},"details":{"description":"A list of messages that carry the error details.  There is a common set of\nmessage types for APIs to use.","items":{"additionalProperties":{"description":"Properties of the object. Contains field @type with type URL."},"type":"object"},"type":"array"},"message":{"description":"A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.","type":"string"}},"type":"object"}}}}