|
790 | 790 | }
|
791 | 791 | },
|
792 | 792 | "availableLocations": {
|
| 793 | + "deprecated": true, |
793 | 794 | "methods": {
|
794 | 795 | "list": {
|
795 |
| - "description": "Lists the valid Google Cloud Platform (GCP) resource locations for the specified Project (including a FirebaseProject). One of these locations can be selected as the Project's [_default_ GCP resource location](https://firebase.google.com/docs/projects/locations), which is the geographical location where the Project's resources, such as Cloud Firestore, will be provisioned by default. However, if the default GCP resource location has already been set for the Project, then this setting cannot be changed. This call checks for any possible [location restrictions](https://cloud.google.com/resource-manager/docs/organization-policy/defining-locations) for the specified Project and, thus, might return a subset of all possible GCP resource locations. To list all GCP resource locations (regardless of any restrictions), call the endpoint without specifying a unique project identifier (that is, `/v1beta1/{parent=projects/-}/listAvailableLocations`). To call `ListAvailableLocations` with a specified project, a member must be at minimum a Viewer of the Project. Calls without a specified project do not require any specific project permissions.", |
| 796 | + "deprecated": true, |
| 797 | + "description": "**DEPRECATED.** _Instead, use the applicable resource-specific REST API (or associated documentation, as needed) to determine valid locations for each resource used in your Project._ Lists the valid Google Cloud Platform (GCP) resource locations for the specified Project (including a FirebaseProject). One of these locations can be selected as the Project's [_default_ GCP resource location](https://firebase.google.com/docs/projects/locations), which is the geographical location where the Project's resources, such as Cloud Firestore, will be provisioned by default. However, if the default GCP resource location has already been set for the Project, then this setting cannot be changed. This call checks for any possible [location restrictions](https://cloud.google.com/resource-manager/docs/organization-policy/defining-locations) for the specified Project and, thus, might return a subset of all possible GCP resource locations. To list all GCP resource locations (regardless of any restrictions), call the endpoint without specifying a unique project identifier (that is, `/v1beta1/{parent=projects/-}/listAvailableLocations`). To call `ListAvailableLocations` with a specified project, a member must be at minimum a Viewer of the Project. Calls without a specified project do not require any specific project permissions.", |
796 | 798 | "flatPath": "v1beta1/projects/{projectsId}/availableLocations",
|
797 | 799 | "httpMethod": "GET",
|
798 | 800 | "id": "firebase.projects.availableLocations.list",
|
|
833 | 835 | }
|
834 | 836 | },
|
835 | 837 | "defaultLocation": {
|
| 838 | + "deprecated": true, |
836 | 839 | "methods": {
|
837 | 840 | "finalize": {
|
838 |
| - "description": "Sets the default Google Cloud Platform (GCP) resource location for the specified FirebaseProject. This method creates an App Engine application with a [default Cloud Storage bucket](https://cloud.google.com/appengine/docs/standard/python/googlecloudstorageclient/setting-up-cloud-storage#activating_a_cloud_storage_bucket), located in the specified [`locationId`](#body.request_body.FIELDS.location_id). This location must be one of the available [GCP resource locations](https://firebase.google.com/docs/projects/locations). After the default GCP resource location is finalized, or if it was already set, it cannot be changed. The default GCP resource location for the specified `FirebaseProject` might already be set because either the underlying GCP `Project` already has an App Engine application or `FinalizeDefaultLocation` was previously called with a specified `locationId`. Any new calls to `FinalizeDefaultLocation` with a *different* specified `locationId` will return a 409 error. The result of this call is an [`Operation`](../../v1beta1/operations), which can be used to track the provisioning process. The [`response`](../../v1beta1/operations#Operation.FIELDS.response) type of the `Operation` is google.protobuf.Empty. The `Operation` can be polled by its `name` using GetOperation until `done` is true. When `done` is true, the `Operation` has either succeeded or failed. If the `Operation` has succeeded, its [`response`](../../v1beta1/operations#Operation.FIELDS.response) will be set to a google.protobuf.Empty; if the `Operation` has failed, its `error` will be set to a google.rpc.Status. The `Operation` is automatically deleted after completion, so there is no need to call DeleteOperation. All fields listed in the [request body](#request-body) are required. To call `FinalizeDefaultLocation`, a member must be an Owner of the Project.", |
| 841 | + "deprecated": true, |
| 842 | + "description": "**DEPRECATED.** _Instead, use the applicable resource-specific REST API to set the location for each resource used in your Project._ Sets the default Google Cloud Platform (GCP) resource location for the specified FirebaseProject. This method creates an App Engine application with a [default Cloud Storage bucket](https://cloud.google.com/appengine/docs/standard/python/googlecloudstorageclient/setting-up-cloud-storage#activating_a_cloud_storage_bucket), located in the specified [`locationId`](#body.request_body.FIELDS.location_id). This location must be one of the available [GCP resource locations](https://firebase.google.com/docs/projects/locations). After the default GCP resource location is finalized, or if it was already set, it cannot be changed. The default GCP resource location for the specified `FirebaseProject` might already be set because either the underlying GCP `Project` already has an App Engine application or `FinalizeDefaultLocation` was previously called with a specified `locationId`. Any new calls to `FinalizeDefaultLocation` with a *different* specified `locationId` will return a 409 error. The result of this call is an [`Operation`](../../v1beta1/operations), which can be used to track the provisioning process. The [`response`](../../v1beta1/operations#Operation.FIELDS.response) type of the `Operation` is google.protobuf.Empty. The `Operation` can be polled by its `name` using GetOperation until `done` is true. When `done` is true, the `Operation` has either succeeded or failed. If the `Operation` has succeeded, its [`response`](../../v1beta1/operations#Operation.FIELDS.response) will be set to a google.protobuf.Empty; if the `Operation` has failed, its `error` will be set to a google.rpc.Status. The `Operation` is automatically deleted after completion, so there is no need to call DeleteOperation. All fields listed in the [request body](#request-body) are required. To call `FinalizeDefaultLocation`, a member must be an Owner of the Project.", |
839 | 843 | "flatPath": "v1beta1/projects/{projectsId}/defaultLocation:finalize",
|
840 | 844 | "httpMethod": "POST",
|
841 | 845 | "id": "firebase.projects.defaultLocation.finalize",
|
|
1320 | 1324 | }
|
1321 | 1325 | }
|
1322 | 1326 | },
|
1323 |
| - "revision": "20230807", |
| 1327 | + "revision": "20230920", |
1324 | 1328 | "rootUrl": "https://firebase.googleapis.com/",
|
1325 | 1329 | "schemas": {
|
1326 | 1330 | "AddFirebaseRequest": {
|
|
1352 | 1356 | "id": "AdminSdkConfig",
|
1353 | 1357 | "properties": {
|
1354 | 1358 | "databaseURL": {
|
1355 |
| - "description": "The default Firebase Realtime Database URL.", |
| 1359 | + "deprecated": true, |
| 1360 | + "description": "**DEPRECATED.** _Instead, find the default Firebase Realtime Database instance name using the [list endpoint](https://firebase.google.com/docs/reference/rest/database/database-management/rest/v1beta/projects.locations.instances/list) within the Firebase Realtime Database REST API. Note that the default instance for the Project might not yet be provisioned, so the return might not contain a default instance._ The default Firebase Realtime Database URL.", |
1356 | 1361 | "type": "string"
|
1357 | 1362 | },
|
1358 | 1363 | "locationId": {
|
1359 |
| - "description": "The ID of the Project's default GCP resource location. The location is one of the available [GCP resource locations](https://firebase.google.com/docs/projects/locations). This field is omitted if the default GCP resource location has not been finalized yet. To set a Project's default GCP resource location, call [`FinalizeDefaultLocation`](../projects.defaultLocation/finalize) after you add Firebase resources to the Project.", |
| 1364 | + "deprecated": true, |
| 1365 | + "description": "**DEPRECATED.** _Instead, use product-specific REST APIs to find the location of resources._ The ID of the Project's default GCP resource location. The location is one of the available [GCP resource locations](https://firebase.google.com/docs/projects/locations). This field is omitted if the default GCP resource location has not been finalized yet. To set a Project's default GCP resource location, call [`FinalizeDefaultLocation`](../projects.defaultLocation/finalize) after you add Firebase resources to the Project.", |
1360 | 1366 | "type": "string"
|
1361 | 1367 | },
|
1362 | 1368 | "projectId": {
|
1363 | 1369 | "description": "Immutable. A user-assigned unique identifier for the `FirebaseProject`. This identifier may appear in URLs or names for some Firebase resources associated with the Project, but it should generally be treated as a convenience alias to reference the Project.",
|
1364 | 1370 | "type": "string"
|
1365 | 1371 | },
|
1366 | 1372 | "storageBucket": {
|
1367 |
| - "description": "The default Cloud Storage for Firebase storage bucket name.", |
| 1373 | + "deprecated": true, |
| 1374 | + "description": "**DEPRECATED.** _Instead, find the default Cloud Storage for Firebase bucket using the [list endpoint](https://firebase.google.com/docs/reference/rest/storage/rest/v1beta/projects.buckets/list) within the Cloud Storage for Firebase REST API. Note that the default bucket for the Project might not yet be provisioned, so the return might not contain a default bucket._ The default Cloud Storage for Firebase storage bucket name.", |
1368 | 1375 | "type": "string"
|
1369 | 1376 | }
|
1370 | 1377 | },
|
|
1496 | 1503 | "type": "object"
|
1497 | 1504 | },
|
1498 | 1505 | "DefaultResources": {
|
1499 |
| - "description": "The default resources associated with the Project.", |
| 1506 | + "deprecated": true, |
| 1507 | + "description": "**DEPRECATED.** _Auto-provisioning of these resources is changing, so this object no longer reliably provides information about the resources within the Project. Instead, retrieve information about each resource directly from its resource-specific API._ The default auto-provisioned resources associated with the Project.", |
1500 | 1508 | "id": "DefaultResources",
|
1501 | 1509 | "properties": {
|
1502 | 1510 | "hostingSite": {
|
1503 |
| - "description": "Output only. The default Firebase Hosting site name, in the format: PROJECT_ID Though rare, your `projectId` might already be used as the name for an existing Hosting site in another project (learn more about creating non-default, [additional sites](https://firebase.google.com/docs/hosting/multisites)). In these cases, your `projectId` is appended with a hyphen then five alphanumeric characters to create your default Hosting site name. For example, if your `projectId` is `myproject123`, your default Hosting site name might be: `myproject123-a5c16`", |
| 1511 | + "deprecated": true, |
| 1512 | + "description": "Output only. **DEPRECATED.** _Instead, find the default Firebase Hosting site name using the [ListSites](https://firebase.google.com/docs/reference/hosting/rest/v1beta1/projects.sites/list) within the Firebase Hosting REST API. Note that the default site for the Project might not yet be provisioned, so the return might not contain a default site._ The default Firebase Hosting site name, in the format: PROJECT_ID Though rare, your `projectId` might already be used as the name for an existing Hosting site in another project (learn more about creating non-default, [additional sites](https://firebase.google.com/docs/hosting/multisites)). In these cases, your `projectId` is appended with a hyphen then five alphanumeric characters to create your default Hosting site name. For example, if your `projectId` is `myproject123`, your default Hosting site name might be: `myproject123-a5c16`", |
1504 | 1513 | "readOnly": true,
|
1505 | 1514 | "type": "string"
|
1506 | 1515 | },
|
1507 | 1516 | "locationId": {
|
1508 |
| - "description": "Output only. The ID of the Project's default GCP resource location. The location is one of the available [GCP resource locations](https://firebase.google.com/docs/projects/locations). This field is omitted if the default GCP resource location has not been finalized yet. To set a Project's default GCP resource location, call [`FinalizeDefaultLocation`](../projects.defaultLocation/finalize) after you add Firebase resources to the Project.", |
| 1517 | + "deprecated": true, |
| 1518 | + "description": "Output only. **DEPRECATED.** _Instead, use product-specific REST APIs to find the location of resources._ The ID of the Project's default GCP resource location. The location is one of the available [GCP resource locations](https://firebase.google.com/docs/projects/locations). This field is omitted if the default GCP resource location has not been finalized yet. To set a Project's default GCP resource location, call [`FinalizeDefaultLocation`](../projects.defaultLocation/finalize) after you add Firebase resources to the Project.", |
1509 | 1519 | "readOnly": true,
|
1510 | 1520 | "type": "string"
|
1511 | 1521 | },
|
1512 | 1522 | "realtimeDatabaseInstance": {
|
1513 |
| - "description": "Output only. The default Firebase Realtime Database instance name, in the format: PROJECT_ID Though rare, your `projectId` might already be used as the name for an existing Realtime Database instance in another project (learn more about [database sharding](https://firebase.google.com/docs/database/usage/sharding)). In these cases, your `projectId` is appended with a hyphen then five alphanumeric characters to create your default Realtime Database instance name. For example, if your `projectId` is `myproject123`, your default database instance name might be: `myproject123-a5c16`", |
| 1523 | + "deprecated": true, |
| 1524 | + "description": "Output only. **DEPRECATED.** _Instead, find the default Firebase Realtime Database instance name using the [list endpoint](https://firebase.google.com/docs/reference/rest/database/database-management/rest/v1beta/projects.locations.instances/list) within the Firebase Realtime Database REST API. Note that the default instance for the Project might not yet be provisioned, so the return might not contain a default instance._ The default Firebase Realtime Database instance name, in the format: PROJECT_ID Though rare, your `projectId` might already be used as the name for an existing Realtime Database instance in another project (learn more about [database sharding](https://firebase.google.com/docs/database/usage/sharding)). In these cases, your `projectId` is appended with a hyphen then five alphanumeric characters to create your default Realtime Database instance name. For example, if your `projectId` is `myproject123`, your default database instance name might be: `myproject123-a5c16`", |
1514 | 1525 | "readOnly": true,
|
1515 | 1526 | "type": "string"
|
1516 | 1527 | },
|
1517 | 1528 | "storageBucket": {
|
1518 |
| - "description": "Output only. The default Cloud Storage for Firebase storage bucket, in the format: PROJECT_ID.appspot.com", |
| 1529 | + "deprecated": true, |
| 1530 | + "description": "Output only. **DEPRECATED.** _Instead, find the default Cloud Storage for Firebase bucket using the [list endpoint](https://firebase.google.com/docs/reference/rest/storage/rest/v1beta/projects.buckets/list) within the Cloud Storage for Firebase REST API. Note that the default bucket for the Project might not yet be provisioned, so the return might not contain a default bucket._ The default Cloud Storage for Firebase storage bucket, in the format: PROJECT_ID.appspot.com", |
1519 | 1531 | "readOnly": true,
|
1520 | 1532 | "type": "string"
|
1521 | 1533 | }
|
|
1529 | 1541 | "type": "object"
|
1530 | 1542 | },
|
1531 | 1543 | "FinalizeDefaultLocationRequest": {
|
| 1544 | + "deprecated": true, |
1532 | 1545 | "id": "FinalizeDefaultLocationRequest",
|
1533 | 1546 | "properties": {
|
1534 | 1547 | "locationId": {
|
|
1640 | 1653 | },
|
1641 | 1654 | "resources": {
|
1642 | 1655 | "$ref": "DefaultResources",
|
1643 |
| - "description": "Output only. The default Firebase resources associated with the Project.", |
| 1656 | + "deprecated": true, |
| 1657 | + "description": "Output only. **DEPRECATED.** _Auto-provisioning of these resources is changing, so this object no longer reliably provides information about the Project. Instead, retrieve information about each resource directly from its resource-specific API._ The default Firebase resources associated with the Project.", |
1644 | 1658 | "readOnly": true
|
1645 | 1659 | },
|
1646 | 1660 | "state": {
|
|
1761 | 1775 | "type": "object"
|
1762 | 1776 | },
|
1763 | 1777 | "ListAvailableLocationsResponse": {
|
| 1778 | + "deprecated": true, |
1764 | 1779 | "id": "ListAvailableLocationsResponse",
|
1765 | 1780 | "properties": {
|
1766 | 1781 | "locations": {
|
|
1859 | 1874 | "type": "object"
|
1860 | 1875 | },
|
1861 | 1876 | "Location": {
|
1862 |
| - "description": "A GCP resource location that can be selected for a FirebaseProject.", |
| 1877 | + "deprecated": true, |
| 1878 | + "description": "**DEPRECATED.** _This Location is no longer used to determine Firebase resource locations. Instead, consult product documentation to determine valid locations for each resource used in your Project._ A GCP resource location that can be selected for a FirebaseProject.", |
1863 | 1879 | "id": "Location",
|
1864 | 1880 | "properties": {
|
1865 | 1881 | "features": {
|
|
2306 | 2322 | "type": "string"
|
2307 | 2323 | },
|
2308 | 2324 | "databaseURL": {
|
2309 |
| - "description": "The default Firebase Realtime Database URL.", |
| 2325 | + "deprecated": true, |
| 2326 | + "description": "**DEPRECATED.** _Instead, find the default Firebase Realtime Database instance name using the [list endpoint](https://firebase.google.com/docs/reference/rest/database/database-management/rest/v1beta/projects.locations.instances/list) within the Firebase Realtime Database REST API. Note that the default instance for the Project might not yet be provisioned, so the return might not contain a default instance._ The default Firebase Realtime Database URL.", |
2310 | 2327 | "type": "string"
|
2311 | 2328 | },
|
2312 | 2329 | "locationId": {
|
2313 |
| - "description": "The ID of the Project's default GCP resource location. The location is one of the available [GCP resource locations](https://firebase.google.com/docs/projects/locations). This field is omitted if the default GCP resource location has not been finalized yet. To set a Project's default GCP resource location, call [`FinalizeDefaultLocation`](../projects.defaultLocation/finalize) after you add Firebase resources to the Project.", |
| 2330 | + "deprecated": true, |
| 2331 | + "description": "**DEPRECATED.** _Instead, use product-specific REST APIs to find the location of resources._ The ID of the Project's default GCP resource location. The location is one of the available [GCP resource locations](https://firebase.google.com/docs/projects/locations). This field is omitted if the default GCP resource location has not been finalized yet. To set a Project's default GCP resource location, call [`FinalizeDefaultLocation`](../projects.defaultLocation/finalize) after you add Firebase resources to the Project.", |
2314 | 2332 | "type": "string"
|
2315 | 2333 | },
|
2316 | 2334 | "measurementId": {
|
|
2326 | 2344 | "type": "string"
|
2327 | 2345 | },
|
2328 | 2346 | "storageBucket": {
|
2329 |
| - "description": "The default Cloud Storage for Firebase storage bucket name.", |
| 2347 | + "deprecated": true, |
| 2348 | + "description": "**DEPRECATED.** _Instead, find the default Cloud Storage for Firebase bucket using the [list endpoint](https://firebase.google.com/docs/reference/rest/storage/rest/v1beta/projects.buckets/list) within the Cloud Storage for Firebase REST API. Note that the default bucket for the Project might not yet be provisioned, so the return might not contain a default bucket._ The default Cloud Storage for Firebase storage bucket name.", |
2330 | 2349 | "type": "string"
|
2331 | 2350 | }
|
2332 | 2351 | },
|
|
0 commit comments