Blame - docs/dyn/compute_beta.addresses.html - platform/external/python/google-api-python-client

blob: cb2e075fc618862d2feb6e1aaae68641b5c6c2a5 [file] [log] [blame]

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