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

blob: 07c8dac979bcd83db9535c5eb53d795d56468823 [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.targetVpnGateways.html">targetVpnGateways</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 target VPN gateways.</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, targetVpnGateway, requestId=None)</a></code></p>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	88	<p class="firstline">Deletes the specified target VPN gateway.</p>
				89	<p class="toc_element">
				90	<code><a href="#get">get(project, region, targetVpnGateway)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	91	<p class="firstline">Returns the specified target VPN gateway. Gets a list of available target VPN gateways by making a list() request.</p>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	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>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	94	<p class="firstline">Creates a target VPN gateway in the specified project and region using the data included in the request.</p>
				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 target VPN gateways available to the specified project and 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 a TargetVpnGateway. 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 target VPN gateways.
				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.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	129	returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.
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 TargetVpnGateway resources.
				137	"a_key": { # [Output Only] Name of the scope containing this set of target VPN gateways.
				138	"targetVpnGateways": [ # [Output Only] A list of target VPN gateways contained in this scope.
				139	{ # Represents a Target VPN Gateway resource.
				140	#
				141	# The target VPN gateway resource represents a Classic Cloud VPN gateway. For more information, read the the Cloud VPN Overview. (== resource_for {$api_version}.targetVpnGateways ==)
				142	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				143	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				144	"forwardingRules": [ # [Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated with a VPN gateway.
				145	"A String",
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	146	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	147	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				148	"kind": "compute#targetVpnGateway", # [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.
				149	"labelFingerprint": "A String", # A fingerprint for the labels being applied to this TargetVpnGateway, 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.
				150	#
				151	# To see the latest fingerprint, make a get() request to retrieve a TargetVpnGateway.
				152	"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.
				153	"a_key": "A String",
				154	},
				155	"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])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
				156	"network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.
				157	"region": "A String", # [Output Only] URL of the region where the target VPN gateway resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
				158	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				159	"status": "A String", # [Output Only] The status of the VPN gateway, which can be one of the following: CREATING, READY, FAILED, or DELETING.
				160	"tunnels": [ # [Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using the compute.vpntunnels.insert method and associated with a VPN gateway.
				161	"A String",
				162	],
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	163	},
				164	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	165	"warning": { # [Output Only] Informational warning which replaces the list of addresses when the list is empty.
				166	"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.
				167	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				168	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				169	{
				170	"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).
				171	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				172	},
				173	],
				174	"message": "A String", # [Output Only] A human-readable description of the warning code.
				175	},
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	176	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	177	},
				178	"kind": "compute#targetVpnGatewayAggregatedList", # [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.
				179	"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.
				180	"selfLink": "A String", # [Output Only] Server-defined URL for this resource.
				181	"unreachables": [ # [Output Only] Unreachable resources.
				182	"A String",
				183	],
				184	"warning": { # [Output Only] Informational warning message.
				185	"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.
				186	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				187	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				188	{
				189	"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).
				190	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				191	},
				192	],
				193	"message": "A String", # [Output Only] A human-readable description of the warning code.
				194	},
				195	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	196	</div>
				197
				198	<div class="method">
				199	<code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code>
				200	<pre>Retrieves the next page of results.
				201
				202	Args:
				203	previous_request: The request for the previous page. (required)
				204	previous_response: The response from the request for the previous page. (required)
				205
				206	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	207	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]	208	page. Returns None if there are no more items in the collection.
				209	</pre>
				210	</div>
				211
				212	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	213	<code class="details" id="close">close()</code>
				214	<pre>Close httplib2 connections.</pre>
				215	</div>
				216
				217	<div class="method">
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	218	<code class="details" id="delete">delete(project, region, targetVpnGateway, requestId=None)</code>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	219	<pre>Deletes the specified target VPN gateway.
				220
				221	Args:
				222	project: string, Project ID for this request. (required)
				223	region: string, Name of the region for this request. (required)
				224	targetVpnGateway: string, Name of the target VPN gateway to delete. (required)
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	225	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.
				226
				227	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.
				228
				229	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]	230
				231	Returns:
				232	An object of the form:
				233
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	234	{ # Represents an Operation resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	235	#
				236	# Google Compute Engine has three Operation resources:
				237	#
				238	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				239	#
				240	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				241	#
				242	# Operations can be global, regional or zonal.
				243	# - For global operations, use the `globalOperations` resource.
				244	# - For regional operations, use the `regionOperations` resource.
				245	# - For zonal operations, use the `zonalOperations` resource.
				246	#
				247	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
				248	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				249	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				250	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				251	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				252	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				253	"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]	254	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	255	"code": "A String", # [Output Only] The error type identifier for this error.
				256	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				257	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	258	},
				259	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	260	},
				261	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				262	"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.
				263	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				264	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				265	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				266	"name": "A String", # [Output Only] Name of the operation.
				267	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				268	"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.
				269	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				270	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				271	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				272	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				273	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				274	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				275	"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.
				276	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				277	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				278	{
				279	"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.
				280	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				281	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				282	{
				283	"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).
				284	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				285	},
				286	],
				287	"message": "A String", # [Output Only] A human-readable description of the warning code.
				288	},
				289	],
				290	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				291	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	292	</div>
				293
				294	<div class="method">
				295	<code class="details" id="get">get(project, region, targetVpnGateway)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	296	<pre>Returns the specified target VPN gateway. Gets a list of available target VPN gateways by making a list() request.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	297
				298	Args:
				299	project: string, Project ID for this request. (required)
				300	region: string, Name of the region for this request. (required)
				301	targetVpnGateway: string, Name of the target VPN gateway to return. (required)
				302
				303	Returns:
				304	An object of the form:
				305
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	306	{ # Represents a Target VPN Gateway resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	307	#
				308	# The target VPN gateway resource represents a Classic Cloud VPN gateway. For more information, read the the Cloud VPN Overview. (== resource_for {$api_version}.targetVpnGateways ==)
				309	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				310	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				311	"forwardingRules": [ # [Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated with a VPN gateway.
				312	"A String",
				313	],
				314	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				315	"kind": "compute#targetVpnGateway", # [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.
				316	"labelFingerprint": "A String", # A fingerprint for the labels being applied to this TargetVpnGateway, 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]	317	#
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	318	# To see the latest fingerprint, make a get() request to retrieve a TargetVpnGateway.
				319	"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.
				320	"a_key": "A String",
				321	},
				322	"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])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
				323	"network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.
				324	"region": "A String", # [Output Only] URL of the region where the target VPN gateway resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
				325	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				326	"status": "A String", # [Output Only] The status of the VPN gateway, which can be one of the following: CREATING, READY, FAILED, or DELETING.
				327	"tunnels": [ # [Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using the compute.vpntunnels.insert method and associated with a VPN gateway.
				328	"A String",
				329	],
				330	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	331	</div>
				332
				333	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	334	<code class="details" id="insert">insert(project, region, body=None, requestId=None)</code>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	335	<pre>Creates a target VPN gateway in the specified project and region using the data included in the request.
				336
				337	Args:
				338	project: string, Project ID for this request. (required)
				339	region: string, Name of the region for this request. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	340	body: object, The request body.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	341	The object takes the form of:
				342
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	343	{ # Represents a Target VPN Gateway resource.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	344	#
				345	# The target VPN gateway resource represents a Classic Cloud VPN gateway. For more information, read the the Cloud VPN Overview. (== resource_for {$api_version}.targetVpnGateways ==)
				346	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				347	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				348	"forwardingRules": [ # [Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated with a VPN gateway.
				349	"A String",
				350	],
				351	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				352	"kind": "compute#targetVpnGateway", # [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.
				353	"labelFingerprint": "A String", # A fingerprint for the labels being applied to this TargetVpnGateway, 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]	354	#
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	355	# To see the latest fingerprint, make a get() request to retrieve a TargetVpnGateway.
				356	"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.
				357	"a_key": "A String",
				358	},
				359	"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])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
				360	"network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.
				361	"region": "A String", # [Output Only] URL of the region where the target VPN gateway resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
				362	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				363	"status": "A String", # [Output Only] The status of the VPN gateway, which can be one of the following: CREATING, READY, FAILED, or DELETING.
				364	"tunnels": [ # [Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using the compute.vpntunnels.insert method and associated with a VPN gateway.
				365	"A String",
				366	],
				367	}
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	368
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	369	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.
				370
				371	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.
				372
				373	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]	374
				375	Returns:
				376	An object of the form:
				377
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	378	{ # Represents an Operation resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	379	#
				380	# Google Compute Engine has three Operation resources:
				381	#
				382	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				383	#
				384	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				385	#
				386	# Operations can be global, regional or zonal.
				387	# - For global operations, use the `globalOperations` resource.
				388	# - For regional operations, use the `regionOperations` resource.
				389	# - For zonal operations, use the `zonalOperations` resource.
				390	#
				391	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
				392	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				393	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				394	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				395	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				396	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				397	"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]	398	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	399	"code": "A String", # [Output Only] The error type identifier for this error.
				400	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				401	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	402	},
				403	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	404	},
				405	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				406	"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.
				407	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				408	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				409	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				410	"name": "A String", # [Output Only] Name of the operation.
				411	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				412	"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.
				413	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				414	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				415	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				416	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				417	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				418	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				419	"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.
				420	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				421	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				422	{
				423	"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.
				424	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				425	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				426	{
				427	"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).
				428	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				429	},
				430	],
				431	"message": "A String", # [Output Only] A human-readable description of the warning code.
				432	},
				433	],
				434	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				435	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	436	</div>
				437
				438	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	439	<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]	440	<pre>Retrieves a list of target VPN gateways available to the specified project and region.
				441
				442	Args:
				443	project: string, Project ID for this request. (required)
				444	region: string, Name of the region for this request. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	445	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]	446
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	447	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]	448
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	449	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]	450
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	451	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) ```
				452	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`)
				453	orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
				454
				455	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.
				456
				457	Currently, only sorting by `name` or `creationTimestamp desc` is supported.
				458	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.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	459	returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	460
				461	Returns:
				462	An object of the form:
				463
				464	{ # Contains a list of TargetVpnGateway resources.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	465	"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
				466	"items": [ # A list of TargetVpnGateway resources.
				467	{ # Represents a Target VPN Gateway resource.
				468	#
				469	# The target VPN gateway resource represents a Classic Cloud VPN gateway. For more information, read the the Cloud VPN Overview. (== resource_for {$api_version}.targetVpnGateways ==)
				470	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				471	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				472	"forwardingRules": [ # [Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated with a VPN gateway.
				473	"A String",
				474	],
				475	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				476	"kind": "compute#targetVpnGateway", # [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.
				477	"labelFingerprint": "A String", # A fingerprint for the labels being applied to this TargetVpnGateway, 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]	478	#
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	479	# To see the latest fingerprint, make a get() request to retrieve a TargetVpnGateway.
				480	"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.
				481	"a_key": "A String",
				482	},
				483	"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])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
				484	"network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.
				485	"region": "A String", # [Output Only] URL of the region where the target VPN gateway resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
				486	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				487	"status": "A String", # [Output Only] The status of the VPN gateway, which can be one of the following: CREATING, READY, FAILED, or DELETING.
				488	"tunnels": [ # [Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using the compute.vpntunnels.insert method and associated with a VPN gateway.
				489	"A String",
				490	],
				491	},
				492	],
				493	"kind": "compute#targetVpnGatewayList", # [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.
				494	"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.
				495	"selfLink": "A String", # [Output Only] Server-defined URL for this resource.
				496	"warning": { # [Output Only] Informational warning message.
				497	"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.
				498	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				499	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				500	{
				501	"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).
				502	"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]	503	},
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	504	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	505	"message": "A String", # [Output Only] A human-readable description of the warning code.
				506	},
				507	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	508	</div>
				509
				510	<div class="method">
				511	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				512	<pre>Retrieves the next page of results.
				513
				514	Args:
				515	previous_request: The request for the previous page. (required)
				516	previous_response: The response from the request for the previous page. (required)
				517
				518	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	519	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]	520	page. Returns None if there are no more items in the collection.
				521	</pre>
				522	</div>
				523
				524	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	525	<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]	526	<pre>Sets the labels on a TargetVpnGateway. To learn more about labels, read the Labeling Resources documentation.
				527
				528	Args:
				529	project: string, Project ID for this request. (required)
				530	region: string, The region for this request. (required)
				531	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]	532	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	533	The object takes the form of:
				534
				535	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	536	"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.
				537	"labels": { # The labels to set for this resource.
				538	"a_key": "A String",
				539	},
				540	}
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	541
				542	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.
				543
				544	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.
				545
				546	The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
				547
				548	Returns:
				549	An object of the form:
				550
				551	{ # Represents an Operation resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	552	#
				553	# Google Compute Engine has three Operation resources:
				554	#
				555	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				556	#
				557	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				558	#
				559	# Operations can be global, regional or zonal.
				560	# - For global operations, use the `globalOperations` resource.
				561	# - For regional operations, use the `regionOperations` resource.
				562	# - For zonal operations, use the `zonalOperations` resource.
				563	#
				564	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
				565	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				566	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				567	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				568	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				569	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				570	"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]	571	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	572	"code": "A String", # [Output Only] The error type identifier for this error.
				573	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				574	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	575	},
				576	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	577	},
				578	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				579	"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.
				580	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				581	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				582	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				583	"name": "A String", # [Output Only] Name of the operation.
				584	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				585	"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.
				586	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				587	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				588	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				589	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				590	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				591	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				592	"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.
				593	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				594	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				595	{
				596	"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.
				597	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				598	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				599	{
				600	"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).
				601	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				602	},
				603	],
				604	"message": "A String", # [Output Only] A human-readable description of the warning code.
				605	},
				606	],
				607	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				608	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	609	</div>
				610
				611	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	612	<code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body=None)</code>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	613	<pre>Returns permissions that a caller has on the specified resource.
				614
				615	Args:
				616	project: string, Project ID for this request. (required)
				617	region: string, The name of the region for this request. (required)
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	618	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]	619	body: object, The request body.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	620	The object takes the form of:
				621
				622	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	623	"permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '' or 'storage.') are not allowed.
				624	"A String",
				625	],
				626	}
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	627
				628
				629	Returns:
				630	An object of the form:
				631
				632	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	633	"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
				634	"A String",
				635	],
				636	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	637	</div>
				638
				639	</body></html>