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\Compute\Resource;
19
20use Google\Service\Compute\Address;
21use Google\Service\Compute\AddressAggregatedList;
22use Google\Service\Compute\AddressList;
23use Google\Service\Compute\Operation;
24
25/**
26 * The "addresses" collection of methods.
27 * Typical usage is:
28 *  <code>
29 *   $computeService = new Google\Service\Compute(...);
30 *   $addresses = $computeService->addresses;
31 *  </code>
32 */
33class Addresses extends \Google\Service\Resource
34{
35  /**
36   * Retrieves an aggregated list of addresses. (addresses.aggregatedList)
37   *
38   * @param string $project Project ID for this request.
39   * @param array $optParams Optional parameters.
40   *
41   * @opt_param string filter A filter expression that filters resources listed in
42   * the response. The expression must specify the field name, an operator, and
43   * the value that you want to use for filtering. The value must be a string, a
44   * number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`,
45   * `>=` or `:`. For example, if you are filtering Compute Engine instances, you
46   * can exclude instances named `example-instance` by specifying `name !=
47   * example-instance`. The `:` operator can be used with string fields to match
48   * substrings. For non-string fields it is equivalent to the `=` operator. The
49   * `:*` comparison can be used to test whether a key has been defined. For
50   * example, to find all objects with `owner` label use: ``` labels.owner:* ```
51   * You can also filter nested fields. For example, you could specify
52   * `scheduling.automaticRestart = false` to include instances only if they are
53   * not scheduled for automatic restarts. You can use filtering on nested fields
54   * to filter based on resource labels. To filter on multiple expressions,
55   * provide each separate expression within parentheses. For example: ```
56   * (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By
57   * default, each expression is an `AND` expression. However, you can include
58   * `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel
59   * Skylake") OR (cpuPlatform = "Intel Broadwell") AND
60   * (scheduling.automaticRestart = true) ```
61   * @opt_param bool includeAllScopes Indicates whether every visible scope for
62   * each scope type (zone, region, global) should be included in the response.
63   * For new resource types added after this field, the flag has no effect as new
64   * resource types will always include every visible scope for each scope type in
65   * response. For resource types which predate this field, if this flag is
66   * omitted or false, only scopes of the scope types where the resource type is
67   * expected to be found will be included.
68   * @opt_param string maxResults The maximum number of results per page that
69   * should be returned. If the number of available results is larger than
70   * `maxResults`, Compute Engine returns a `nextPageToken` that can be used to
71   * get the next page of results in subsequent list requests. Acceptable values
72   * are `0` to `500`, inclusive. (Default: `500`)
73   * @opt_param string orderBy Sorts list results by a certain order. By default,
74   * results are returned in alphanumerical order based on the resource name. You
75   * can also sort results in descending order based on the creation timestamp
76   * using `orderBy="creationTimestamp desc"`. This sorts results based on the
77   * `creationTimestamp` field in reverse chronological order (newest result
78   * first). Use this to sort resources like operations so that the newest
79   * operation is returned first. Currently, only sorting by `name` or
80   * `creationTimestamp desc` is supported.
81   * @opt_param string pageToken Specifies a page token to use. Set `pageToken` to
82   * the `nextPageToken` returned by a previous list request to get the next page
83   * of results.
84   * @opt_param bool returnPartialSuccess Opt-in for partial success behavior
85   * which provides partial results in case of failure. The default value is
86   * false.
87   * @return AddressAggregatedList
88   */
89  public function aggregatedList($project, $optParams = [])
90  {
91    $params = ['project' => $project];
92    $params = array_merge($params, $optParams);
93    return $this->call('aggregatedList', [$params], AddressAggregatedList::class);
94  }
95  /**
96   * Deletes the specified address resource. (addresses.delete)
97   *
98   * @param string $project Project ID for this request.
99   * @param string $region Name of the region for this request.
100   * @param string $address Name of the address resource to delete.
101   * @param array $optParams Optional parameters.
102   *
103   * @opt_param string requestId An optional request ID to identify requests.
104   * Specify a unique request ID so that if you must retry your request, the
105   * server will know to ignore the request if it has already been completed. For
106   * example, consider a situation where you make an initial request and the
107   * request times out. If you make the request again with the same request ID,
108   * the server can check if original operation with the same request ID was
109   * received, and if so, will ignore the second request. This prevents clients
110   * from accidentally creating duplicate commitments. The request ID must be a
111   * valid UUID with the exception that zero UUID is not supported (
112   * 00000000-0000-0000-0000-000000000000).
113   * @return Operation
114   */
115  public function delete($project, $region, $address, $optParams = [])
116  {
117    $params = ['project' => $project, 'region' => $region, 'address' => $address];
118    $params = array_merge($params, $optParams);
119    return $this->call('delete', [$params], Operation::class);
120  }
121  /**
122   * Returns the specified address resource. (addresses.get)
123   *
124   * @param string $project Project ID for this request.
125   * @param string $region Name of the region for this request.
126   * @param string $address Name of the address resource to return.
127   * @param array $optParams Optional parameters.
128   * @return Address
129   */
130  public function get($project, $region, $address, $optParams = [])
131  {
132    $params = ['project' => $project, 'region' => $region, 'address' => $address];
133    $params = array_merge($params, $optParams);
134    return $this->call('get', [$params], Address::class);
135  }
136  /**
137   * Creates an address resource in the specified project by using the data
138   * included in the request. (addresses.insert)
139   *
140   * @param string $project Project ID for this request.
141   * @param string $region Name of the region for this request.
142   * @param Address $postBody
143   * @param array $optParams Optional parameters.
144   *
145   * @opt_param string requestId An optional request ID to identify requests.
146   * Specify a unique request ID so that if you must retry your request, the
147   * server will know to ignore the request if it has already been completed. For
148   * example, consider a situation where you make an initial request and the
149   * request times out. If you make the request again with the same request ID,
150   * the server can check if original operation with the same request ID was
151   * received, and if so, will ignore the second request. This prevents clients
152   * from accidentally creating duplicate commitments. The request ID must be a
153   * valid UUID with the exception that zero UUID is not supported (
154   * 00000000-0000-0000-0000-000000000000).
155   * @return Operation
156   */
157  public function insert($project, $region, Address $postBody, $optParams = [])
158  {
159    $params = ['project' => $project, 'region' => $region, 'postBody' => $postBody];
160    $params = array_merge($params, $optParams);
161    return $this->call('insert', [$params], Operation::class);
162  }
163  /**
164   * Retrieves a list of addresses contained within the specified region.
165   * (addresses.listAddresses)
166   *
167   * @param string $project Project ID for this request.
168   * @param string $region Name of the region for this request.
169   * @param array $optParams Optional parameters.
170   *
171   * @opt_param string filter A filter expression that filters resources listed in
172   * the response. The expression must specify the field name, an operator, and
173   * the value that you want to use for filtering. The value must be a string, a
174   * number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`,
175   * `>=` or `:`. For example, if you are filtering Compute Engine instances, you
176   * can exclude instances named `example-instance` by specifying `name !=
177   * example-instance`. The `:` operator can be used with string fields to match
178   * substrings. For non-string fields it is equivalent to the `=` operator. The
179   * `:*` comparison can be used to test whether a key has been defined. For
180   * example, to find all objects with `owner` label use: ``` labels.owner:* ```
181   * You can also filter nested fields. For example, you could specify
182   * `scheduling.automaticRestart = false` to include instances only if they are
183   * not scheduled for automatic restarts. You can use filtering on nested fields
184   * to filter based on resource labels. To filter on multiple expressions,
185   * provide each separate expression within parentheses. For example: ```
186   * (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By
187   * default, each expression is an `AND` expression. However, you can include
188   * `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel
189   * Skylake") OR (cpuPlatform = "Intel Broadwell") AND
190   * (scheduling.automaticRestart = true) ```
191   * @opt_param string maxResults The maximum number of results per page that
192   * should be returned. If the number of available results is larger than
193   * `maxResults`, Compute Engine returns a `nextPageToken` that can be used to
194   * get the next page of results in subsequent list requests. Acceptable values
195   * are `0` to `500`, inclusive. (Default: `500`)
196   * @opt_param string orderBy Sorts list results by a certain order. By default,
197   * results are returned in alphanumerical order based on the resource name. You
198   * can also sort results in descending order based on the creation timestamp
199   * using `orderBy="creationTimestamp desc"`. This sorts results based on the
200   * `creationTimestamp` field in reverse chronological order (newest result
201   * first). Use this to sort resources like operations so that the newest
202   * operation is returned first. Currently, only sorting by `name` or
203   * `creationTimestamp desc` is supported.
204   * @opt_param string pageToken Specifies a page token to use. Set `pageToken` to
205   * the `nextPageToken` returned by a previous list request to get the next page
206   * of results.
207   * @opt_param bool returnPartialSuccess Opt-in for partial success behavior
208   * which provides partial results in case of failure. The default value is
209   * false.
210   * @return AddressList
211   */
212  public function listAddresses($project, $region, $optParams = [])
213  {
214    $params = ['project' => $project, 'region' => $region];
215    $params = array_merge($params, $optParams);
216    return $this->call('list', [$params], AddressList::class);
217  }
218}
219
220// Adding a class alias for backwards compatibility with the previous class name.
221class_alias(Addresses::class, 'Google_Service_Compute_Resource_Addresses');
222