Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / f80be181200f4aae910badec3f4bddea08ae5044 / . / docs / dyn / compute_beta.addresses.html
blob: 292a1c342aa19fa4f0ee9ee6db90115616d94150 [file] [log] [blame]
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]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_beta.html">Compute Engine API</a> . <a href="compute_beta.addresses.html">addresses</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]78 <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None, includeAllScopes=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]79<p class="firstline">Retrieves an aggregated list of addresses.</p>
80<p class="toc_element">
81 <code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p>
82<p class="firstline">Retrieves the next page of results.</p>
83<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]84 <code><a href="#delete">delete(project, region, address, requestId=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]85<p class="firstline">Deletes the specified address resource.</p>
86<p class="toc_element">
87 <code><a href="#get">get(project, region, address)</a></code></p>
88<p class="firstline">Returns the specified address resource.</p>
89<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]90 <code><a href="#insert">insert(project, region, body=None, requestId=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]91<p class="firstline">Creates an address resource in the specified project by using the data included in the request.</p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]92<p class="toc_element">
93 <code><a href="#list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
94<p class="firstline">Retrieves a list of addresses contained within the specified region.</p>
95<p class="toc_element">
96 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
97<p class="firstline">Retrieves the next page of results.</p>
98<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]99 <code><a href="#setLabels">setLabels(project, region, resource, body=None, requestId=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]100<p class="firstline">Sets the labels on an Address. To learn more about labels, read the Labeling Resources documentation.</p>
101<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]102 <code><a href="#testIamPermissions">testIamPermissions(project, region, resource, body=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]103<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
104<h3>Method Details</h3>
105<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]106 <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None, includeAllScopes=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]107 <pre>Retrieves an aggregated list of addresses.
108
109Args:
110 project: string, Project ID for this request. (required)
111 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
112
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]113You 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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]114
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]115Currently, only sorting by `name` or `creationTimestamp desc` is supported.
116 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`)
117 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.
118 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 `=`, `!=`, `&gt;`, or `&lt;`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]119
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]120For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]121
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]122You 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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]123
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]124To 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) ```
125 includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]126
127Returns:
128 An object of the form:
129
130 {
131 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]132 "kind": "compute#addressAggregatedList", # [Output Only] Type of resource. Always compute#addressAggregatedList for aggregated lists of addresses.
133 "items": { # A list of AddressesScopedList resources.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]134 "a_key": { # [Output Only] Name of the scope containing this set of addresses.
135 "warning": { # [Output Only] Informational warning which replaces the list of addresses when the list is empty.
136 "message": "A String", # [Output Only] A human-readable description of the warning code.
137 "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.
138 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
139 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
140 {
141 "value": "A String", # [Output Only] A warning data value corresponding to the key.
142 "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).
143 },
144 ],
145 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]146 "addresses": [ # [Output Only] A list of addresses contained in this scope.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]147 { # Use global external addresses for GFE-based external HTTP(S) load balancers in Premium Tier.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]148 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]149 # Use global internal addresses for reserved peering network range.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]150 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]151 # Use regional external addresses for the following resources:
152 #
153 # - External IP addresses for VM instances - Regional external forwarding rules - Cloud NAT external IP addresses - GFE based LBs in Standard Tier - Network LBs in Premium or Standard Tier - Cloud VPN gateways (both Classic and HA)
154 #
155 # Use regional internal IP addresses for subnet IP ranges (primary and secondary). This includes:
156 #
157 # - Internal IP addresses for VM instances - Alias IP ranges of VM instances (/32 only) - Regional internal forwarding rules - Internal TCP/UDP load balancer addresses - Internal HTTP(S) load balancer addresses - Cloud DNS inbound forwarding IP addresses
158 #
159 # For more information, read reserved IP address.
160 #
161 # (== resource_for {$api_version}.addresses ==) (== resource_for {$api_version}.globalAddresses ==)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]162 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]163 "users": [ # [Output Only] The URLs of the resources that are using this address.
164 "A String",
165 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]166 "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses.
167 "addressType": "A String", # The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, defaults to EXTERNAL.
168 "description": "A String", # An optional description of this resource. Provide this field when you create the resource.
169 "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.
170 #
171 # If this field is not specified, it is assumed to be PREMIUM.
172 "prefixLength": 42, # The prefix length if the resource reprensents an IP range.
173 "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.
174 #
175 # To see the latest fingerprint, make a get() request to retrieve an Address.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]176 "labels": { # Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]177 "a_key": "A String",
178 },
179 "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.
180 "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.
181 "purpose": "A String", # The purpose of this resource, which can be one of the following values:
182 # - `GCE_ENDPOINT` for addresses that are used by VM instances, alias IP ranges, internal load balancers, and similar resources.
183 # - `DNS_RESOLVER` for a DNS resolver address in a subnetwork
184 # - `VPC_PEERING` for addresses that are reserved for VPC peer networks.
185 # - `NAT_AUTO` for addresses that are external IP addresses automatically reserved for Cloud NAT.
186 "address": "A String", # The static IP address represented by this resource.
187 "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.
188 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]189 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
190 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
191 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]192 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]193 },
194 ],
195 },
196 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]197 "warning": { # [Output Only] Informational warning message.
198 "message": "A String", # [Output Only] A human-readable description of the warning code.
199 "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.
200 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
201 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
202 {
203 "value": "A String", # [Output Only] A warning data value corresponding to the key.
204 "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).
205 },
206 ],
207 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]208 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
209 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
210 }</pre>
211</div>
212
213<div class="method">
214 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code>
215 <pre>Retrieves the next page of results.
216
217Args:
218 previous_request: The request for the previous page. (required)
219 previous_response: The response from the request for the previous page. (required)
220
221Returns:
222 A request object that you can call 'execute()' on to request the next
223 page. Returns None if there are no more items in the collection.
224 </pre>
225</div>
226
227<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]228 <code class="details" id="delete">delete(project, region, address, requestId=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]229 <pre>Deletes the specified address resource.
230
231Args:
232 project: string, Project ID for this request. (required)
233 region: string, Name of the region for this request. (required)
234 address: string, Name of the address resource to delete. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]235 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.
236
237For 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.
238
239The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]240
241Returns:
242 An object of the form:
243
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]244 { # Represents an Operation resource.
245 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]246 # Google Compute Engine has three Operation resources:
247 #
248 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
249 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]250 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
251 #
252 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]253 # - For global operations, use the `globalOperations` resource.
254 # - For regional operations, use the `regionOperations` resource.
255 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]256 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]257 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]258 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]259 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]260 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]261 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]262 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]263 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]264 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
265 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]266 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]267 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]268 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]269 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]270 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
271 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
272 {
273 "message": "A String", # [Output Only] A human-readable description of the warning code.
274 "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.
275 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
276 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
277 {
278 "value": "A String", # [Output Only] A warning data value corresponding to the key.
279 "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).
280 },
281 ],
282 },
283 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]284 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]285 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]286 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
287 "name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]288 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]289 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
290 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
291 {
292 "message": "A String", # [Output Only] An optional, human-readable error message.
293 "code": "A String", # [Output Only] The error type identifier for this error.
294 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
295 },
296 ],
297 },
298 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
299 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]300 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]301 }</pre>
302</div>
303
304<div class="method">
305 <code class="details" id="get">get(project, region, address)</code>
306 <pre>Returns the specified address resource.
307
308Args:
309 project: string, Project ID for this request. (required)
310 region: string, Name of the region for this request. (required)
311 address: string, Name of the address resource to return. (required)
312
313Returns:
314 An object of the form:
315
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]316 { # Use global external addresses for GFE-based external HTTP(S) load balancers in Premium Tier.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]317 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]318 # Use global internal addresses for reserved peering network range.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]319 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]320 # Use regional external addresses for the following resources:
321 #
322 # - External IP addresses for VM instances - Regional external forwarding rules - Cloud NAT external IP addresses - GFE based LBs in Standard Tier - Network LBs in Premium or Standard Tier - Cloud VPN gateways (both Classic and HA)
323 #
324 # Use regional internal IP addresses for subnet IP ranges (primary and secondary). This includes:
325 #
326 # - Internal IP addresses for VM instances - Alias IP ranges of VM instances (/32 only) - Regional internal forwarding rules - Internal TCP/UDP load balancer addresses - Internal HTTP(S) load balancer addresses - Cloud DNS inbound forwarding IP addresses
327 #
328 # For more information, read reserved IP address.
329 #
330 # (== resource_for {$api_version}.addresses ==) (== resource_for {$api_version}.globalAddresses ==)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]331 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]332 "users": [ # [Output Only] The URLs of the resources that are using this address.
333 "A String",
334 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]335 "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses.
336 "addressType": "A String", # The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, defaults to EXTERNAL.
337 "description": "A String", # An optional description of this resource. Provide this field when you create the resource.
338 "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.
339 #
340 # If this field is not specified, it is assumed to be PREMIUM.
341 "prefixLength": 42, # The prefix length if the resource reprensents an IP range.
342 "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.
343 #
344 # To see the latest fingerprint, make a get() request to retrieve an Address.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]345 "labels": { # Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]346 "a_key": "A String",
347 },
348 "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.
349 "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.
350 "purpose": "A String", # The purpose of this resource, which can be one of the following values:
351 # - `GCE_ENDPOINT` for addresses that are used by VM instances, alias IP ranges, internal load balancers, and similar resources.
352 # - `DNS_RESOLVER` for a DNS resolver address in a subnetwork
353 # - `VPC_PEERING` for addresses that are reserved for VPC peer networks.
354 # - `NAT_AUTO` for addresses that are external IP addresses automatically reserved for Cloud NAT.
355 "address": "A String", # The static IP address represented by this resource.
356 "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.
357 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]358 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
359 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
360 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]361 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]362 }</pre>
363</div>
364
365<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]366 <code class="details" id="insert">insert(project, region, body=None, requestId=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]367 <pre>Creates an address resource in the specified project by using the data included in the request.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]368
369Args:
370 project: string, Project ID for this request. (required)
371 region: string, Name of the region for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]372 body: object, The request body.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]373 The object takes the form of:
374
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]375{ # Use global external addresses for GFE-based external HTTP(S) load balancers in Premium Tier.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]376 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]377 # Use global internal addresses for reserved peering network range.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]378 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]379 # Use regional external addresses for the following resources:
380 #
381 # - External IP addresses for VM instances - Regional external forwarding rules - Cloud NAT external IP addresses - GFE based LBs in Standard Tier - Network LBs in Premium or Standard Tier - Cloud VPN gateways (both Classic and HA)
382 #
383 # Use regional internal IP addresses for subnet IP ranges (primary and secondary). This includes:
384 #
385 # - Internal IP addresses for VM instances - Alias IP ranges of VM instances (/32 only) - Regional internal forwarding rules - Internal TCP/UDP load balancer addresses - Internal HTTP(S) load balancer addresses - Cloud DNS inbound forwarding IP addresses
386 #
387 # For more information, read reserved IP address.
388 #
389 # (== resource_for {$api_version}.addresses ==) (== resource_for {$api_version}.globalAddresses ==)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]390 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]391 "users": [ # [Output Only] The URLs of the resources that are using this address.
392 "A String",
393 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]394 "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses.
395 "addressType": "A String", # The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, defaults to EXTERNAL.
396 "description": "A String", # An optional description of this resource. Provide this field when you create the resource.
397 "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.
398 #
399 # If this field is not specified, it is assumed to be PREMIUM.
400 "prefixLength": 42, # The prefix length if the resource reprensents an IP range.
401 "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.
402 #
403 # To see the latest fingerprint, make a get() request to retrieve an Address.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]404 "labels": { # Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]405 "a_key": "A String",
406 },
407 "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.
408 "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.
409 "purpose": "A String", # The purpose of this resource, which can be one of the following values:
410 # - `GCE_ENDPOINT` for addresses that are used by VM instances, alias IP ranges, internal load balancers, and similar resources.
411 # - `DNS_RESOLVER` for a DNS resolver address in a subnetwork
412 # - `VPC_PEERING` for addresses that are reserved for VPC peer networks.
413 # - `NAT_AUTO` for addresses that are external IP addresses automatically reserved for Cloud NAT.
414 "address": "A String", # The static IP address represented by this resource.
415 "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.
416 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]417 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
418 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
419 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]420 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]421 }
422
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]423 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.
424
425For 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.
426
427The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]428
429Returns:
430 An object of the form:
431
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]432 { # Represents an Operation resource.
433 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]434 # Google Compute Engine has three Operation resources:
435 #
436 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
437 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]438 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
439 #
440 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]441 # - For global operations, use the `globalOperations` resource.
442 # - For regional operations, use the `regionOperations` resource.
443 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]444 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]445 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]446 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]447 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]448 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]449 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]450 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]451 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]452 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
453 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]454 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]455 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]456 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]457 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]458 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
459 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
460 {
461 "message": "A String", # [Output Only] A human-readable description of the warning code.
462 "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.
463 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
464 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
465 {
466 "value": "A String", # [Output Only] A warning data value corresponding to the key.
467 "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).
468 },
469 ],
470 },
471 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]472 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]473 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]474 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
475 "name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]476 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]477 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
478 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
479 {
480 "message": "A String", # [Output Only] An optional, human-readable error message.
481 "code": "A String", # [Output Only] The error type identifier for this error.
482 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
483 },
484 ],
485 },
486 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
487 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]488 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]489 }</pre>
490</div>
491
492<div class="method">
493 <code class="details" id="list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
494 <pre>Retrieves a list of addresses contained within the specified region.
495
496Args:
497 project: string, Project ID for this request. (required)
498 region: string, Name of the region for this request. (required)
499 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
500
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]501You 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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]502
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]503Currently, only sorting by `name` or `creationTimestamp desc` is supported.
504 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`)
505 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.
506 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 `=`, `!=`, `&gt;`, or `&lt;`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]507
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]508For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]509
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]510You 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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]511
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]512To 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) ```
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]513
514Returns:
515 An object of the form:
516
517 { # Contains a list of addresses.
518 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]519 "kind": "compute#addressList", # [Output Only] Type of resource. Always compute#addressList for lists of addresses.
520 "items": [ # A list of Address resources.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]521 { # Use global external addresses for GFE-based external HTTP(S) load balancers in Premium Tier.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]522 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]523 # Use global internal addresses for reserved peering network range.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]524 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]525 # Use regional external addresses for the following resources:
526 #
527 # - External IP addresses for VM instances - Regional external forwarding rules - Cloud NAT external IP addresses - GFE based LBs in Standard Tier - Network LBs in Premium or Standard Tier - Cloud VPN gateways (both Classic and HA)
528 #
529 # Use regional internal IP addresses for subnet IP ranges (primary and secondary). This includes:
530 #
531 # - Internal IP addresses for VM instances - Alias IP ranges of VM instances (/32 only) - Regional internal forwarding rules - Internal TCP/UDP load balancer addresses - Internal HTTP(S) load balancer addresses - Cloud DNS inbound forwarding IP addresses
532 #
533 # For more information, read reserved IP address.
534 #
535 # (== resource_for {$api_version}.addresses ==) (== resource_for {$api_version}.globalAddresses ==)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]536 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]537 "users": [ # [Output Only] The URLs of the resources that are using this address.
538 "A String",
539 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]540 "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses.
541 "addressType": "A String", # The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, defaults to EXTERNAL.
542 "description": "A String", # An optional description of this resource. Provide this field when you create the resource.
543 "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.
544 #
545 # If this field is not specified, it is assumed to be PREMIUM.
546 "prefixLength": 42, # The prefix length if the resource reprensents an IP range.
547 "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.
548 #
549 # To see the latest fingerprint, make a get() request to retrieve an Address.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]550 "labels": { # Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]551 "a_key": "A String",
552 },
553 "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.
554 "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.
555 "purpose": "A String", # The purpose of this resource, which can be one of the following values:
556 # - `GCE_ENDPOINT` for addresses that are used by VM instances, alias IP ranges, internal load balancers, and similar resources.
557 # - `DNS_RESOLVER` for a DNS resolver address in a subnetwork
558 # - `VPC_PEERING` for addresses that are reserved for VPC peer networks.
559 # - `NAT_AUTO` for addresses that are external IP addresses automatically reserved for Cloud NAT.
560 "address": "A String", # The static IP address represented by this resource.
561 "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.
562 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]563 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
564 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
565 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]566 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]567 },
568 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]569 "warning": { # [Output Only] Informational warning message.
570 "message": "A String", # [Output Only] A human-readable description of the warning code.
571 "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.
572 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
573 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
574 {
575 "value": "A String", # [Output Only] A warning data value corresponding to the key.
576 "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).
577 },
578 ],
579 },
580 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
581 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]582 }</pre>
583</div>
584
585<div class="method">
586 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
587 <pre>Retrieves the next page of results.
588
589Args:
590 previous_request: The request for the previous page. (required)
591 previous_response: The response from the request for the previous page. (required)
592
593Returns:
594 A request object that you can call 'execute()' on to request the next
595 page. Returns None if there are no more items in the collection.
596 </pre>
597</div>
598
599<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]600 <code class="details" id="setLabels">setLabels(project, region, resource, body=None, requestId=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]601 <pre>Sets the labels on an Address. To learn more about labels, read the Labeling Resources documentation.
602
603Args:
604 project: string, Project ID for this request. (required)
605 region: string, The region for this request. (required)
606 resource: string, Name or id of the resource for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]607 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]608 The object takes the form of:
609
610{
611 "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 in order to update or change labels. Make a get() request to the resource to get the latest fingerprint.
612 "labels": { # The labels to set for this resource.
613 "a_key": "A String",
614 },
615 }
616
617 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.
618
619For 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.
620
621The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
622
623Returns:
624 An object of the form:
625
626 { # Represents an Operation resource.
627 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]628 # Google Compute Engine has three Operation resources:
629 #
630 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
631 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]632 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
633 #
634 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]635 # - For global operations, use the `globalOperations` resource.
636 # - For regional operations, use the `regionOperations` resource.
637 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]638 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]639 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]640 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
641 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
642 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]643 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]644 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
645 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]646 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
647 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]648 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]649 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]650 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]651 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]652 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
653 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
654 {
655 "message": "A String", # [Output Only] A human-readable description of the warning code.
656 "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.
657 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
658 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
659 {
660 "value": "A String", # [Output Only] A warning data value corresponding to the key.
661 "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).
662 },
663 ],
664 },
665 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]666 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]667 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]668 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
669 "name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]670 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
671 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
672 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
673 {
674 "message": "A String", # [Output Only] An optional, human-readable error message.
675 "code": "A String", # [Output Only] The error type identifier for this error.
676 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
677 },
678 ],
679 },
680 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
681 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
682 "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.
683 }</pre>
684</div>
685
686<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]687 <code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]688 <pre>Returns permissions that a caller has on the specified resource.
689
690Args:
691 project: string, Project ID for this request. (required)
692 region: string, The name of the region for this request. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]693 resource: string, Name or id of the resource for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]694 body: object, The request body.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]695 The object takes the form of:
696
697{
698 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
699 "A String",
700 ],
701 }
702
703
704Returns:
705 An object of the form:
706
707 {
708 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
709 "A String",
710 ],
711 }</pre>
712</div>
713
714</body></html>