• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5  margin: 0;
6  padding: 0;
7  border: 0;
8  font-weight: inherit;
9  font-style: inherit;
10  font-size: 100%;
11  font-family: inherit;
12  vertical-align: baseline;
13}
14
15body {
16  font-size: 13px;
17  padding: 1em;
18}
19
20h1 {
21  font-size: 26px;
22  margin-bottom: 1em;
23}
24
25h2 {
26  font-size: 24px;
27  margin-bottom: 1em;
28}
29
30h3 {
31  font-size: 20px;
32  margin-bottom: 1em;
33  margin-top: 1em;
34}
35
36pre, code {
37  line-height: 1.5;
38  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42  margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46  font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50  border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54  margin-top: 0.5em;
55}
56
57.firstline {
58  margin-left: 2 em;
59}
60
61.method  {
62  margin-top: 1em;
63  border: solid 1px #CCC;
64  padding: 1em;
65  background: #EEE;
66}
67
68.details {
69  font-weight: bold;
70  font-size: 14px;
71}
72
73</style>
74
75<h1><a href="compute_alpha.html">Compute Engine API</a> . <a href="compute_alpha.globalAddresses.html">globalAddresses</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="#delete">delete(project, address, requestId=None)</a></code></p>
79<p class="firstline">Deletes the specified address resource.</p>
80<p class="toc_element">
81  <code><a href="#get">get(project, address)</a></code></p>
82<p class="firstline">Returns the specified address resource. Gets a list of available addresses by making a list() request.</p>
83<p class="toc_element">
84  <code><a href="#insert">insert(project, body, requestId=None)</a></code></p>
85<p class="firstline">Creates an address resource in the specified project by using the data included in the request.</p>
86<p class="toc_element">
87  <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
88<p class="firstline">Retrieves a list of global addresses.</p>
89<p class="toc_element">
90  <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<p class="toc_element">
93  <code><a href="#setLabels">setLabels(project, resource, body)</a></code></p>
94<p class="firstline">Sets the labels on a GlobalAddress. To learn more about labels, read the Labeling Resources documentation.</p>
95<p class="toc_element">
96  <code><a href="#testIamPermissions">testIamPermissions(project, resource, body)</a></code></p>
97<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
98<h3>Method Details</h3>
99<div class="method">
100    <code class="details" id="delete">delete(project, address, requestId=None)</code>
101  <pre>Deletes the specified address resource.
102
103Args:
104  project: string, Project ID for this request. (required)
105  address: string, Name of the address resource to delete. (required)
106  requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
107
108For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
109
110The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
111
112Returns:
113  An object of the form:
114
115    { # Represents an Operation resource.
116      #
117      # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
118      #
119      # Operations can be global, regional or zonal.
120      # - For global operations, use the globalOperations resource.
121      # - For regional operations, use the regionOperations resource.
122      # - For zonal operations, use the zonalOperations resource.
123      #
124      # For more information, read  Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)
125    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
126    "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
127    "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
128    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
129    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
130    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
131    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
132    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
133    "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
134    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
135    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
136    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
137    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
138    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
139      {
140        "message": "A String", # [Output Only] A human-readable description of the warning code.
141        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
142        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
143            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
144          {
145            "value": "A String", # [Output Only] A warning data value corresponding to the key.
146            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
147          },
148        ],
149      },
150    ],
151    "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
152    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
153    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
154    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
155    "name": "A String", # [Output Only] Name of the resource.
156    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
157    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
158      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
159        {
160          "message": "A String", # [Output Only] An optional, human-readable error message.
161          "code": "A String", # [Output Only] The error type identifier for this error.
162          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
163        },
164      ],
165    },
166    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
167    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
168    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
169  }</pre>
170</div>
171
172<div class="method">
173    <code class="details" id="get">get(project, address)</code>
174  <pre>Returns the specified address resource. Gets a list of available addresses by making a list() request.
175
176Args:
177  project: string, Project ID for this request. (required)
178  address: string, Name of the address resource to return. (required)
179
180Returns:
181  An object of the form:
182
183    { # Represents an IP Address resource.
184        #
185        # An address resource represents a regional internal IP address. Regional internal IP addresses are RFC 1918 addresses that come from either a primary or secondary IP range of a subnet in a VPC network. Regional external IP addresses can be assigned to GCP VM instances, Cloud VPN gateways, regional external forwarding rules for network load balancers (in either Standard or Premium Tier), and regional external forwarding rules for HTTP(S), SSL Proxy, and TCP Proxy load balancers in Standard Tier. For more information, read IP addresses.
186        #
187        # A globalAddresses resource represent a global external IP address. Global external IP addresses are IPv4 or IPv6 addresses. They can only be assigned to global forwarding rules for HTTP(S), SSL Proxy, or TCP Proxy load balancers in Premium Tier. For more information, read Global resources. (== resource_for beta.addresses ==) (== resource_for v1.addresses ==) (== resource_for beta.globalAddresses ==) (== resource_for v1.globalAddresses ==)
188      "status": "A String", # [Output Only] The status of the address, which can be one of RESERVING, RESERVED, or IN_USE. An address that is RESERVING is currently in the process of being reserved. A RESERVED address is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.
189      "users": [ # [Output Only] The URLs of the resources that are using this address.
190        "A String",
191      ],
192      "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses.
193      "addressType": "A String", # The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, defaults to EXTERNAL.
194      "description": "A String", # An optional description of this resource. Provide this field when you create the resource.
195      "networkTier": "A String", # This signifies the networking tier used for configuring this address and can only take the following values: PREMIUM or STANDARD. Global forwarding rules can only be Premium Tier. Regional forwarding rules can be either Premium or Standard Tier. Standard Tier addresses applied to regional forwarding rules can be used with any external load balancer. Regional forwarding rules in Premium Tier can only be used with a network load balancer.
196          #
197          # If this field is not specified, it is assumed to be PREMIUM.
198      "prefixLength": 42, # The prefix length if the resource reprensents an IP range.
199      "labelFingerprint": "A String", # A fingerprint for the labels being applied to this Address, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet.
200          #
201          # To see the latest fingerprint, make a get() request to retrieve an Address.
202      "labels": { # Labels to apply to this Address resource. These can be later modified by the setLabels method. Each label key/value must comply with RFC1035. Label values may be empty.
203        "a_key": "A String",
204      },
205      "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
206      "ipVersion": "A String", # The IP version that will be used by this address. Valid options are IPV4 or IPV6. This can only be specified for a global address.
207      "network": "A String", # The URL of the network in which to reserve the address. This field can only be used with INTERNAL type with the VPC_PEERING purpose.
208      "purpose": "A String", # The purpose of this resource, which can be one of the following values:
209          # - `GCE_ENDPOINT` for addresses that are used by VM instances, alias IP ranges, internal load balancers, and similar resources.
210          # - `DNS_RESOLVER` for a DNS resolver address in a subnetwork
211          # - `VPC_PEERING` for addresses that are reserved for VPC peer networks.
212          # - `NAT_AUTO` for addresses that are external IP addresses automatically reserved for Cloud NAT.
213      "address": "A String", # The static IP address represented by this resource.
214      "region": "A String", # [Output Only] The URL of the region where the regional address resides. This field is not applicable to global addresses. You must specify this field as part of the HTTP request URL.
215      "subnetwork": "A String", # The URL of the subnetwork in which to reserve the address. If an IP address is specified, it must be within the subnetwork's IP range. This field can only be used with INTERNAL type with a GCE_ENDPOINT or DNS_RESOLVER purpose.
216      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
217      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
218      "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
219      "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.
220    }</pre>
221</div>
222
223<div class="method">
224    <code class="details" id="insert">insert(project, body, requestId=None)</code>
225  <pre>Creates an address resource in the specified project by using the data included in the request.
226
227Args:
228  project: string, Project ID for this request. (required)
229  body: object, The request body. (required)
230    The object takes the form of:
231
232{ # Represents an IP Address resource.
233      #
234      # An address resource represents a regional internal IP address. Regional internal IP addresses are RFC 1918 addresses that come from either a primary or secondary IP range of a subnet in a VPC network. Regional external IP addresses can be assigned to GCP VM instances, Cloud VPN gateways, regional external forwarding rules for network load balancers (in either Standard or Premium Tier), and regional external forwarding rules for HTTP(S), SSL Proxy, and TCP Proxy load balancers in Standard Tier. For more information, read IP addresses.
235      #
236      # A globalAddresses resource represent a global external IP address. Global external IP addresses are IPv4 or IPv6 addresses. They can only be assigned to global forwarding rules for HTTP(S), SSL Proxy, or TCP Proxy load balancers in Premium Tier. For more information, read Global resources. (== resource_for beta.addresses ==) (== resource_for v1.addresses ==) (== resource_for beta.globalAddresses ==) (== resource_for v1.globalAddresses ==)
237    "status": "A String", # [Output Only] The status of the address, which can be one of RESERVING, RESERVED, or IN_USE. An address that is RESERVING is currently in the process of being reserved. A RESERVED address is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.
238    "users": [ # [Output Only] The URLs of the resources that are using this address.
239      "A String",
240    ],
241    "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses.
242    "addressType": "A String", # The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, defaults to EXTERNAL.
243    "description": "A String", # An optional description of this resource. Provide this field when you create the resource.
244    "networkTier": "A String", # This signifies the networking tier used for configuring this address and can only take the following values: PREMIUM or STANDARD. Global forwarding rules can only be Premium Tier. Regional forwarding rules can be either Premium or Standard Tier. Standard Tier addresses applied to regional forwarding rules can be used with any external load balancer. Regional forwarding rules in Premium Tier can only be used with a network load balancer.
245        #
246        # If this field is not specified, it is assumed to be PREMIUM.
247    "prefixLength": 42, # The prefix length if the resource reprensents an IP range.
248    "labelFingerprint": "A String", # A fingerprint for the labels being applied to this Address, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet.
249        #
250        # To see the latest fingerprint, make a get() request to retrieve an Address.
251    "labels": { # Labels to apply to this Address resource. These can be later modified by the setLabels method. Each label key/value must comply with RFC1035. Label values may be empty.
252      "a_key": "A String",
253    },
254    "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
255    "ipVersion": "A String", # The IP version that will be used by this address. Valid options are IPV4 or IPV6. This can only be specified for a global address.
256    "network": "A String", # The URL of the network in which to reserve the address. This field can only be used with INTERNAL type with the VPC_PEERING purpose.
257    "purpose": "A String", # The purpose of this resource, which can be one of the following values:
258        # - `GCE_ENDPOINT` for addresses that are used by VM instances, alias IP ranges, internal load balancers, and similar resources.
259        # - `DNS_RESOLVER` for a DNS resolver address in a subnetwork
260        # - `VPC_PEERING` for addresses that are reserved for VPC peer networks.
261        # - `NAT_AUTO` for addresses that are external IP addresses automatically reserved for Cloud NAT.
262    "address": "A String", # The static IP address represented by this resource.
263    "region": "A String", # [Output Only] The URL of the region where the regional address resides. This field is not applicable to global addresses. You must specify this field as part of the HTTP request URL.
264    "subnetwork": "A String", # The URL of the subnetwork in which to reserve the address. If an IP address is specified, it must be within the subnetwork's IP range. This field can only be used with INTERNAL type with a GCE_ENDPOINT or DNS_RESOLVER purpose.
265    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
266    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
267    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
268    "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.
269  }
270
271  requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
272
273For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
274
275The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
276
277Returns:
278  An object of the form:
279
280    { # Represents an Operation resource.
281      #
282      # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
283      #
284      # Operations can be global, regional or zonal.
285      # - For global operations, use the globalOperations resource.
286      # - For regional operations, use the regionOperations resource.
287      # - For zonal operations, use the zonalOperations resource.
288      #
289      # For more information, read  Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)
290    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
291    "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
292    "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
293    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
294    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
295    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
296    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
297    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
298    "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
299    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
300    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
301    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
302    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
303    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
304      {
305        "message": "A String", # [Output Only] A human-readable description of the warning code.
306        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
307        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
308            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
309          {
310            "value": "A String", # [Output Only] A warning data value corresponding to the key.
311            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
312          },
313        ],
314      },
315    ],
316    "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
317    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
318    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
319    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
320    "name": "A String", # [Output Only] Name of the resource.
321    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
322    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
323      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
324        {
325          "message": "A String", # [Output Only] An optional, human-readable error message.
326          "code": "A String", # [Output Only] The error type identifier for this error.
327          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
328        },
329      ],
330    },
331    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
332    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
333    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
334  }</pre>
335</div>
336
337<div class="method">
338    <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
339  <pre>Retrieves a list of global addresses.
340
341Args:
342  project: string, Project ID for this request. (required)
343  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
344
345You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
346
347Currently, only sorting by name or creationTimestamp desc is supported.
348  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)
349  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
350  filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.
351
352For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.
353
354You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.
355
356To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).
357
358Returns:
359  An object of the form:
360
361    { # Contains a list of addresses.
362    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
363    "kind": "compute#addressList", # [Output Only] Type of resource. Always compute#addressList for lists of addresses.
364    "items": [ # A list of Address resources.
365      { # Represents an IP Address resource.
366            #
367            # An address resource represents a regional internal IP address. Regional internal IP addresses are RFC 1918 addresses that come from either a primary or secondary IP range of a subnet in a VPC network. Regional external IP addresses can be assigned to GCP VM instances, Cloud VPN gateways, regional external forwarding rules for network load balancers (in either Standard or Premium Tier), and regional external forwarding rules for HTTP(S), SSL Proxy, and TCP Proxy load balancers in Standard Tier. For more information, read IP addresses.
368            #
369            # A globalAddresses resource represent a global external IP address. Global external IP addresses are IPv4 or IPv6 addresses. They can only be assigned to global forwarding rules for HTTP(S), SSL Proxy, or TCP Proxy load balancers in Premium Tier. For more information, read Global resources. (== resource_for beta.addresses ==) (== resource_for v1.addresses ==) (== resource_for beta.globalAddresses ==) (== resource_for v1.globalAddresses ==)
370          "status": "A String", # [Output Only] The status of the address, which can be one of RESERVING, RESERVED, or IN_USE. An address that is RESERVING is currently in the process of being reserved. A RESERVED address is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.
371          "users": [ # [Output Only] The URLs of the resources that are using this address.
372            "A String",
373          ],
374          "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses.
375          "addressType": "A String", # The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, defaults to EXTERNAL.
376          "description": "A String", # An optional description of this resource. Provide this field when you create the resource.
377          "networkTier": "A String", # This signifies the networking tier used for configuring this address and can only take the following values: PREMIUM or STANDARD. Global forwarding rules can only be Premium Tier. Regional forwarding rules can be either Premium or Standard Tier. Standard Tier addresses applied to regional forwarding rules can be used with any external load balancer. Regional forwarding rules in Premium Tier can only be used with a network load balancer.
378              #
379              # If this field is not specified, it is assumed to be PREMIUM.
380          "prefixLength": 42, # The prefix length if the resource reprensents an IP range.
381          "labelFingerprint": "A String", # A fingerprint for the labels being applied to this Address, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet.
382              #
383              # To see the latest fingerprint, make a get() request to retrieve an Address.
384          "labels": { # Labels to apply to this Address resource. These can be later modified by the setLabels method. Each label key/value must comply with RFC1035. Label values may be empty.
385            "a_key": "A String",
386          },
387          "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
388          "ipVersion": "A String", # The IP version that will be used by this address. Valid options are IPV4 or IPV6. This can only be specified for a global address.
389          "network": "A String", # The URL of the network in which to reserve the address. This field can only be used with INTERNAL type with the VPC_PEERING purpose.
390          "purpose": "A String", # The purpose of this resource, which can be one of the following values:
391              # - `GCE_ENDPOINT` for addresses that are used by VM instances, alias IP ranges, internal load balancers, and similar resources.
392              # - `DNS_RESOLVER` for a DNS resolver address in a subnetwork
393              # - `VPC_PEERING` for addresses that are reserved for VPC peer networks.
394              # - `NAT_AUTO` for addresses that are external IP addresses automatically reserved for Cloud NAT.
395          "address": "A String", # The static IP address represented by this resource.
396          "region": "A String", # [Output Only] The URL of the region where the regional address resides. This field is not applicable to global addresses. You must specify this field as part of the HTTP request URL.
397          "subnetwork": "A String", # The URL of the subnetwork in which to reserve the address. If an IP address is specified, it must be within the subnetwork's IP range. This field can only be used with INTERNAL type with a GCE_ENDPOINT or DNS_RESOLVER purpose.
398          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
399          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
400          "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
401          "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.
402        },
403    ],
404    "warning": { # [Output Only] Informational warning message.
405      "message": "A String", # [Output Only] A human-readable description of the warning code.
406      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
407      "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
408          # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
409        {
410          "value": "A String", # [Output Only] A warning data value corresponding to the key.
411          "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
412        },
413      ],
414    },
415    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
416    "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
417  }</pre>
418</div>
419
420<div class="method">
421    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
422  <pre>Retrieves the next page of results.
423
424Args:
425  previous_request: The request for the previous page. (required)
426  previous_response: The response from the request for the previous page. (required)
427
428Returns:
429  A request object that you can call 'execute()' on to request the next
430  page. Returns None if there are no more items in the collection.
431    </pre>
432</div>
433
434<div class="method">
435    <code class="details" id="setLabels">setLabels(project, resource, body)</code>
436  <pre>Sets the labels on a GlobalAddress. To learn more about labels, read the Labeling Resources documentation.
437
438Args:
439  project: string, Project ID for this request. (required)
440  resource: string, Name or id of the resource for this request. (required)
441  body: object, The request body. (required)
442    The object takes the form of:
443
444{
445    "labelFingerprint": "A String", # The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash when updating or changing labels, otherwise the request will fail with error 412 conditionNotMet. Make a get() request to the resource to get the latest fingerprint.
446    "labels": { # A list of labels to apply for this resource. Each label key & value must comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. For example, "webserver-frontend": "images". A label value can also be empty (e.g. "my-label": "").
447      "a_key": "A String",
448    },
449  }
450
451
452Returns:
453  An object of the form:
454
455    { # Represents an Operation resource.
456      #
457      # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
458      #
459      # Operations can be global, regional or zonal.
460      # - For global operations, use the globalOperations resource.
461      # - For regional operations, use the regionOperations resource.
462      # - For zonal operations, use the zonalOperations resource.
463      #
464      # For more information, read  Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)
465    "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
466    "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
467    "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
468    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
469    "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
470    "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
471    "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
472    "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
473    "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
474    "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.
475    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
476    "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
477    "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
478    "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
479      {
480        "message": "A String", # [Output Only] A human-readable description of the warning code.
481        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
482        "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
483            # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
484          {
485            "value": "A String", # [Output Only] A warning data value corresponding to the key.
486            "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
487          },
488        ],
489      },
490    ],
491    "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
492    "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
493    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
494    "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
495    "name": "A String", # [Output Only] Name of the resource.
496    "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
497    "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
498      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
499        {
500          "message": "A String", # [Output Only] An optional, human-readable error message.
501          "code": "A String", # [Output Only] The error type identifier for this error.
502          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
503        },
504      ],
505    },
506    "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
507    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
508    "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
509  }</pre>
510</div>
511
512<div class="method">
513    <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body)</code>
514  <pre>Returns permissions that a caller has on the specified resource.
515
516Args:
517  project: string, Project ID for this request. (required)
518  resource: string, Name or id of the resource for this request. (required)
519  body: object, The request body. (required)
520    The object takes the form of:
521
522{
523    "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
524      "A String",
525    ],
526  }
527
528
529Returns:
530  An object of the form:
531
532    {
533    "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
534      "A String",
535    ],
536  }</pre>
537</div>
538
539</body></html>