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
18namespace Google\Service\CloudDeploy\Resource;
19
20use Google\Service\CloudDeploy\Config;
21use Google\Service\CloudDeploy\ListLocationsResponse;
22use Google\Service\CloudDeploy\Location;
23
24/**
25 * The "locations" collection of methods.
26 * Typical usage is:
27 *  <code>
28 *   $clouddeployService = new Google\Service\CloudDeploy(...);
29 *   $locations = $clouddeployService->locations;
30 *  </code>
31 */
32class ProjectsLocations extends \Google\Service\Resource
33{
34  /**
35   * Gets information about a location. (locations.get)
36   *
37   * @param string $name Resource name for the location.
38   * @param array $optParams Optional parameters.
39   * @return Location
40   */
41  public function get($name, $optParams = [])
42  {
43    $params = ['name' => $name];
44    $params = array_merge($params, $optParams);
45    return $this->call('get', [$params], Location::class);
46  }
47  /**
48   * Gets the configuration for a location. (locations.getConfig)
49   *
50   * @param string $name Required. Name of requested configuration.
51   * @param array $optParams Optional parameters.
52   * @return Config
53   */
54  public function getConfig($name, $optParams = [])
55  {
56    $params = ['name' => $name];
57    $params = array_merge($params, $optParams);
58    return $this->call('getConfig', [$params], Config::class);
59  }
60  /**
61   * Lists information about the supported locations for this service.
62   * (locations.listProjectsLocations)
63   *
64   * @param string $name The resource that owns the locations collection, if
65   * applicable.
66   * @param array $optParams Optional parameters.
67   *
68   * @opt_param string filter A filter to narrow down results to a preferred
69   * subset. The filtering language accepts strings like `"displayName=tokyo"`,
70   * and is documented in more detail in [AIP-160](https://google.aip.dev/160).
71   * @opt_param int pageSize The maximum number of results to return. If not set,
72   * the service selects a default.
73   * @opt_param string pageToken A page token received from the `next_page_token`
74   * field in the response. Send that page token to receive the subsequent page.
75   * @return ListLocationsResponse
76   */
77  public function listProjectsLocations($name, $optParams = [])
78  {
79    $params = ['name' => $name];
80    $params = array_merge($params, $optParams);
81    return $this->call('list', [$params], ListLocationsResponse::class);
82  }
83}
84
85// Adding a class alias for backwards compatibility with the previous class name.
86class_alias(ProjectsLocations::class, 'Google_Service_CloudDeploy_Resource_ProjectsLocations');
87