Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / compute_v1.globalAddresses.html
blob: 496b24541784ee6b0f5d3b4d55e8cd4dacd56161 [file] [log] [blame]
Craig Citro065b5302014-08-14 00:47:23 -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_v1.html">Compute Engine API</a> . <a href="compute_v1.globalAddresses.html">globalAddresses</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]78 <code><a href="#delete">delete(project, address, requestId=None)</a></code></p>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]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>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]82<p class="firstline">Returns the specified address resource. Gets a list of available addresses by making a list() request.</p>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]83<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]84 <code><a href="#insert">insert(project, body=None, requestId=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]85<p class="firstline">Creates an address resource in the specified project by using the data included in the request.</p>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]86<p class="toc_element">
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]87 <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]88<p class="firstline">Retrieves a list of global addresses.</p>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]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<h3>Method Details</h3>
93<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]94 <code class="details" id="delete">delete(project, address, requestId=None)</code>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]95 <pre>Deletes the specified address resource.
96
97Args:
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]98 project: string, Project ID for this request. (required)
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]99 address: string, Name of the address resource to delete. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]100 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.
101
102For 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.
103
104The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]105
106Returns:
107 An object of the form:
108
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]109 { # Represents an Operation resource.
110 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]111 # Google Compute Engine has three Operation resources:
112 #
113 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
114 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]115 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
116 #
117 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]118 # - For global operations, use the `globalOperations` resource.
119 # - For regional operations, use the `regionOperations` resource.
120 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]121 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]122 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]123 "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]124 "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]125 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]126 "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]127 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]128 "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^]129 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
130 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]131 "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^]132 "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.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]133 "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^]134 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]135 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]136 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]137 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]138 "message": "A String", # [Output Only] A human-readable description of the warning code.
139 "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.
140 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
141 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]142 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]143 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]144 "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).
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]145 },
146 ],
147 },
148 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]149 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]150 "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^]151 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
152 "name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]153 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]154 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]155 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]156 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]157 "message": "A String", # [Output Only] An optional, human-readable error message.
158 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]159 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]160 },
161 ],
162 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]163 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]164 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]165 "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.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]166 }</pre>
167</div>
168
169<div class="method">
170 <code class="details" id="get">get(project, address)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]171 <pre>Returns the specified address resource. Gets a list of available addresses by making a list() request.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]172
173Args:
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]174 project: string, Project ID for this request. (required)
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]175 address: string, Name of the address resource to return. (required)
176
177Returns:
178 An object of the form:
179
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]180 { # 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]181 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]182 # Use global internal addresses for reserved peering network range.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]183 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]184 # Use regional external addresses for the following resources:
185 #
186 # - 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)
187 #
188 # Use regional internal IP addresses for subnet IP ranges (primary and secondary). This includes:
189 #
190 # - 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
191 #
192 # For more information, read reserved IP address.
193 #
194 # (== resource_for {$api_version}.addresses ==) (== resource_for {$api_version}.globalAddresses ==)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]195 "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.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]196 "users": [ # [Output Only] The URLs of the resources that are using this address.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]197 "A String",
198 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]199 "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses.
200 "addressType": "A String", # The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, defaults to EXTERNAL.
201 "description": "A String", # An optional description of this resource. Provide this field when you create the resource.
202 "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.
203 #
204 # If this field is not specified, it is assumed to be PREMIUM.
205 "prefixLength": 42, # The prefix length if the resource reprensents an IP range.
206 "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.
207 "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.
208 "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.
209 "purpose": "A String", # The purpose of this resource, which can be one of the following values:
210 # - `GCE_ENDPOINT` for addresses that are used by VM instances, alias IP ranges, internal load balancers, and similar resources.
211 # - `DNS_RESOLVER` for a DNS resolver address in a subnetwork
212 # - `VPC_PEERING` for addresses that are reserved for VPC peer networks.
213 # - `NAT_AUTO` for addresses that are external IP addresses automatically reserved for Cloud NAT.
214 "address": "A String", # The static IP address represented by this resource.
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.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]216 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]217 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]218 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]220 }</pre>
221</div>
222
223<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]224 <code class="details" id="insert">insert(project, body=None, requestId=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]225 <pre>Creates an address resource in the specified project by using the data included in the request.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]226
227Args:
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]228 project: string, Project ID for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]229 body: object, The request body.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]230 The object takes the form of:
231
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]232{ # 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]233 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]234 # Use global internal addresses for reserved peering network range.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]235 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]236 # Use regional external addresses for the following resources:
237 #
238 # - 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)
239 #
240 # Use regional internal IP addresses for subnet IP ranges (primary and secondary). This includes:
241 #
242 # - 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
243 #
244 # For more information, read reserved IP address.
245 #
246 # (== resource_for {$api_version}.addresses ==) (== resource_for {$api_version}.globalAddresses ==)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]247 "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.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]248 "users": [ # [Output Only] The URLs of the resources that are using this address.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]249 "A String",
250 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]251 "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses.
252 "addressType": "A String", # The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, defaults to EXTERNAL.
253 "description": "A String", # An optional description of this resource. Provide this field when you create the resource.
254 "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.
255 #
256 # If this field is not specified, it is assumed to be PREMIUM.
257 "prefixLength": 42, # The prefix length if the resource reprensents an IP range.
258 "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.
259 "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.
260 "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.
261 "purpose": "A String", # The purpose of this resource, which can be one of the following values:
262 # - `GCE_ENDPOINT` for addresses that are used by VM instances, alias IP ranges, internal load balancers, and similar resources.
263 # - `DNS_RESOLVER` for a DNS resolver address in a subnetwork
264 # - `VPC_PEERING` for addresses that are reserved for VPC peer networks.
265 # - `NAT_AUTO` for addresses that are external IP addresses automatically reserved for Cloud NAT.
266 "address": "A String", # The static IP address represented by this resource.
267 "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.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]268 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]269 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]270 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]271 "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.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]272 }
273
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]274 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.
275
276For 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.
277
278The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]279
280Returns:
281 An object of the form:
282
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]283 { # Represents an Operation resource.
284 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]285 # Google Compute Engine has three Operation resources:
286 #
287 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
288 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]289 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
290 #
291 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]292 # - For global operations, use the `globalOperations` resource.
293 # - For regional operations, use the `regionOperations` resource.
294 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]295 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]296 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]297 "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]298 "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]299 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]300 "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]301 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]302 "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^]303 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
304 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]305 "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^]306 "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.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]307 "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^]308 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]309 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]310 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]311 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]312 "message": "A String", # [Output Only] A human-readable description of the warning code.
313 "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.
314 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
315 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]316 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]317 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]318 "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).
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]319 },
320 ],
321 },
322 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]323 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]324 "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^]325 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
326 "name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]327 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]328 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]329 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]330 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]331 "message": "A String", # [Output Only] An optional, human-readable error message.
332 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]333 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]334 },
335 ],
336 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]337 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]338 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]339 "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.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]340 }</pre>
341</div>
342
343<div class="method">
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]344 <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]345 <pre>Retrieves a list of global addresses.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]346
347Args:
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]348 project: string, Project ID for this request. (required)
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]349 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
350
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]351You 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 Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]352
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]353Currently, only sorting by `name` or `creationTimestamp desc` is supported.
354 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`)
355 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.
356 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;`.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]357
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]358For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]359
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]360You 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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]361
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]362To 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) ```
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]363
364Returns:
365 An object of the form:
366
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]367 { # Contains a list of addresses.
368 "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]369 "kind": "compute#addressList", # [Output Only] Type of resource. Always compute#addressList for lists of addresses.
370 "items": [ # A list of Address resources.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]371 { # 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]372 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]373 # Use global internal addresses for reserved peering network range.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]374 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]375 # Use regional external addresses for the following resources:
376 #
377 # - 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)
378 #
379 # Use regional internal IP addresses for subnet IP ranges (primary and secondary). This includes:
380 #
381 # - 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
382 #
383 # For more information, read reserved IP address.
384 #
385 # (== resource_for {$api_version}.addresses ==) (== resource_for {$api_version}.globalAddresses ==)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]386 "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.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]387 "users": [ # [Output Only] The URLs of the resources that are using this address.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]388 "A String",
389 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]390 "kind": "compute#address", # [Output Only] Type of the resource. Always compute#address for addresses.
391 "addressType": "A String", # The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, defaults to EXTERNAL.
392 "description": "A String", # An optional description of this resource. Provide this field when you create the resource.
393 "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.
394 #
395 # If this field is not specified, it is assumed to be PREMIUM.
396 "prefixLength": 42, # The prefix length if the resource reprensents an IP range.
397 "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.
398 "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.
399 "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.
400 "purpose": "A String", # The purpose of this resource, which can be one of the following values:
401 # - `GCE_ENDPOINT` for addresses that are used by VM instances, alias IP ranges, internal load balancers, and similar resources.
402 # - `DNS_RESOLVER` for a DNS resolver address in a subnetwork
403 # - `VPC_PEERING` for addresses that are reserved for VPC peer networks.
404 # - `NAT_AUTO` for addresses that are external IP addresses automatically reserved for Cloud NAT.
405 "address": "A String", # The static IP address represented by this resource.
406 "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.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]407 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]408 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]409 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]410 "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.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]411 },
412 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]413 "warning": { # [Output Only] Informational warning message.
414 "message": "A String", # [Output Only] A human-readable description of the warning code.
415 "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.
416 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
417 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
418 {
419 "value": "A String", # [Output Only] A warning data value corresponding to the key.
420 "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).
421 },
422 ],
423 },
424 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
425 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]426 }</pre>
427</div>
428
429<div class="method">
430 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
431 <pre>Retrieves the next page of results.
432
433Args:
434 previous_request: The request for the previous page. (required)
435 previous_response: The response from the request for the previous page. (required)
436
437Returns:
438 A request object that you can call 'execute()' on to request the next
439 page. Returns None if there are no more items in the collection.
440 </pre>
441</div>
442
443</body></html>