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