[e3d4e0a] | 1 | <?php
|
---|
| 2 | /*
|
---|
| 3 | * Copyright 2014 Google Inc.
|
---|
| 4 | *
|
---|
| 5 | * Licensed under the Apache License, Version 2.0 (the "License"); you may not
|
---|
| 6 | * use this file except in compliance with the License. You may obtain a copy of
|
---|
| 7 | * the License at
|
---|
| 8 | *
|
---|
| 9 | * http://www.apache.org/licenses/LICENSE-2.0
|
---|
| 10 | *
|
---|
| 11 | * Unless required by applicable law or agreed to in writing, software
|
---|
| 12 | * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
---|
| 13 | * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
---|
| 14 | * License for the specific language governing permissions and limitations under
|
---|
| 15 | * the License.
|
---|
| 16 | */
|
---|
| 17 |
|
---|
| 18 | namespace Google\Service\FirebaseManagement\Resource;
|
---|
| 19 |
|
---|
| 20 | use Google\Service\FirebaseManagement\ListAvailableLocationsResponse;
|
---|
| 21 |
|
---|
| 22 | /**
|
---|
| 23 | * The "availableLocations" collection of methods.
|
---|
| 24 | * Typical usage is:
|
---|
| 25 | * <code>
|
---|
| 26 | * $firebaseService = new Google\Service\FirebaseManagement(...);
|
---|
| 27 | * $availableLocations = $firebaseService->projects_availableLocations;
|
---|
| 28 | * </code>
|
---|
| 29 | */
|
---|
| 30 | class ProjectsAvailableLocations extends \Google\Service\Resource
|
---|
| 31 | {
|
---|
| 32 | /**
|
---|
| 33 | * **DECOMMISSIONED.** **If called, this endpoint will return a 404 error.**
|
---|
| 34 | * _Instead, use the applicable resource-specific REST API (or associated
|
---|
| 35 | * documentation, as needed) to determine valid locations for each resource used
|
---|
| 36 | * in your Project._ Lists the valid ["locations for default Google Cloud
|
---|
| 37 | * resources"](https://firebase.google.com/docs/projects/locations#default-
|
---|
| 38 | * cloud-location) for the specified Project (including a FirebaseProject). One
|
---|
| 39 | * of these locations can be selected as the Project's location for default
|
---|
| 40 | * Google Cloud resources, which is the geographical location where the
|
---|
| 41 | * Project's resources associated with Google App Engine (such as the default
|
---|
| 42 | * Cloud Firestore instance) will be provisioned by default. However, if the
|
---|
| 43 | * location for default Google Cloud resources has already been set for the
|
---|
| 44 | * Project, then this setting cannot be changed. This call checks for any
|
---|
| 45 | * possible [location restrictions](https://cloud.google.com/resource-
|
---|
| 46 | * manager/docs/organization-policy/defining-locations) for the specified
|
---|
| 47 | * Project and, thus, might return a subset of all possible locations. To list
|
---|
| 48 | * all locations (regardless of any restrictions), call the endpoint without
|
---|
| 49 | * specifying a unique project identifier (that is,
|
---|
| 50 | * `/v1beta1/{parent=projects/-}/listAvailableLocations`). To call
|
---|
| 51 | * `ListAvailableLocations` with a specified project, a member must be at
|
---|
| 52 | * minimum a Viewer of the Project. Calls without a specified project do not
|
---|
| 53 | * require any specific project permissions.
|
---|
| 54 | * (availableLocations.listProjectsAvailableLocations)
|
---|
| 55 | *
|
---|
| 56 | * @param string $parent The FirebaseProject for which to list [locations for
|
---|
| 57 | * default Google Cloud
|
---|
| 58 | * resources](https://firebase.google.com/docs/projects/locations#default-cloud-
|
---|
| 59 | * location), in the format: projects/PROJECT_IDENTIFIER Refer to the
|
---|
| 60 | * `FirebaseProject` [`name`](../projects#FirebaseProject.FIELDS.name) field for
|
---|
| 61 | * details about PROJECT_IDENTIFIER values. If no unique project identifier is
|
---|
| 62 | * specified (that is, `projects/-`), the returned list does not take into
|
---|
| 63 | * account org-specific or project-specific location restrictions.
|
---|
| 64 | * @param array $optParams Optional parameters.
|
---|
| 65 | *
|
---|
| 66 | * @opt_param int pageSize The maximum number of locations to return in the
|
---|
| 67 | * response. The server may return fewer than this value at its discretion. If
|
---|
| 68 | * no value is specified (or too large a value is specified), then the server
|
---|
| 69 | * will impose its own limit. This value cannot be negative.
|
---|
| 70 | * @opt_param string pageToken Token returned from a previous call to
|
---|
| 71 | * `ListAvailableLocations` indicating where in the list of locations to resume
|
---|
| 72 | * listing.
|
---|
| 73 | * @return ListAvailableLocationsResponse
|
---|
| 74 | * @throws \Google\Service\Exception
|
---|
| 75 | */
|
---|
| 76 | public function listProjectsAvailableLocations($parent, $optParams = [])
|
---|
| 77 | {
|
---|
| 78 | $params = ['parent' => $parent];
|
---|
| 79 | $params = array_merge($params, $optParams);
|
---|
| 80 | return $this->call('list', [$params], ListAvailableLocationsResponse::class);
|
---|
| 81 | }
|
---|
| 82 | }
|
---|
| 83 |
|
---|
| 84 | // Adding a class alias for backwards compatibility with the previous class name.
|
---|
| 85 | class_alias(ProjectsAvailableLocations::class, 'Google_Service_FirebaseManagement_Resource_ProjectsAvailableLocations');
|
---|