Blame - docs/dyn/compute_alpha.targetInstances.html - platform/external/python/google-api-python-client

blob: 19c2f79d21981c66fb9ea5dfb6223f7afdb2fb0f [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_alpha.html">Compute Engine API</a> . <a href="compute_alpha.targetInstances.html">targetInstances</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
Bu Sun Kim	6502091	2020-05-20 12:08:20 -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 instances.</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">
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	87	<code><a href="#delete">delete(project, zone, targetInstance, requestId=None)</a></code></p>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	88	<p class="firstline">Deletes the specified TargetInstance resource.</p>
				89	<p class="toc_element">
				90	<code><a href="#get">get(project, zone, targetInstance)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	91	<p class="firstline">Returns the specified TargetInstance resource. Gets a list of available target instances 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, zone, 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 TargetInstance resource in the specified project and zone using the data included in the request.</p>
				95	<p class="toc_element">
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	96	<code><a href="#list">list(project, zone, 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 TargetInstance resources available to the specified project and zone.</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="#testIamPermissions">testIamPermissions(project, zone, resource, body=None)</a></code></p>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	103	<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
				104	<h3>Method Details</h3>
				105	<div class="method">
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	106	<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]	107	<pre>Retrieves an aggregated list of target instances.
				108
				109	Args:
				110	project: string, Project ID for this request. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	111	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]	112
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	113	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]	114
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	115	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]	116
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	117	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]	118	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]	119	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`)
				120	orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
				121
				122	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.
				123
				124	Currently, only sorting by `name` or `creationTimestamp desc` is supported.
				125	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^]	126	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]	127
				128	Returns:
				129	An object of the form:
				130
				131	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	132	"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
				133	"items": { # A list of TargetInstance resources.
				134	"a_key": { # Name of the scope containing this set of target instances.
				135	"targetInstances": [ # A list of target instances contained in this scope.
				136	{ # Represents a Target Instance resource.
				137	#
				138	# You can use a target instance to handle traffic for one or more forwarding rules, which is ideal for forwarding protocol traffic that is managed by a single source. For example, ESP, AH, TCP, or UDP. For more information, read Target instances. (== resource_for {$api_version}.targetInstances ==)
				139	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				140	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				141	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				142	"instance": "A String", # A URL to the virtual machine instance that handles traffic for this target instance. When creating a target instance, you can provide the fully-qualified URL or a valid partial URL to the desired virtual machine. For example, the following are all valid URLs:
				143	# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance
				144	# - projects/project/zones/zone/instances/instance
				145	# - zones/zone/instances/instance
				146	"kind": "compute#targetInstance", # [Output Only] The type of the resource. Always compute#targetInstance for target instances.
				147	"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.
				148	"natPolicy": "A String", # NAT option controlling how IPs are NAT'ed to the instance. Currently only NO_NAT (default value) is supported.
				149	"network": "A String", # The URL of the network this target instance uses to forward traffic. If not specified, the traffic will be forwarded to the network that the default network interface belongs to.
				150	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				151	"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
				152	"zone": "A String", # [Output Only] URL of the zone where the target instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	153	},
				154	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	155	"warning": { # Informational warning which replaces the list of addresses when the list is empty.
				156	"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.
				157	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				158	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				159	{
				160	"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).
				161	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				162	},
				163	],
				164	"message": "A String", # [Output Only] A human-readable description of the warning code.
				165	},
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	166	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	167	},
				168	"kind": "compute#targetInstanceAggregatedList", # Type of resource.
				169	"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.
				170	"selfLink": "A String", # [Output Only] Server-defined URL for this resource.
				171	"unreachables": [ # [Output Only] Unreachable resources.
				172	"A String",
				173	],
				174	"warning": { # [Output Only] Informational warning message.
				175	"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.
				176	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				177	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				178	{
				179	"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).
				180	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				181	},
				182	],
				183	"message": "A String", # [Output Only] A human-readable description of the warning code.
				184	},
				185	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	186	</div>
				187
				188	<div class="method">
				189	<code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code>
				190	<pre>Retrieves the next page of results.
				191
				192	Args:
				193	previous_request: The request for the previous page. (required)
				194	previous_response: The response from the request for the previous page. (required)
				195
				196	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	197	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]	198	page. Returns None if there are no more items in the collection.
				199	</pre>
				200	</div>
				201
				202	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	203	<code class="details" id="close">close()</code>
				204	<pre>Close httplib2 connections.</pre>
				205	</div>
				206
				207	<div class="method">
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	208	<code class="details" id="delete">delete(project, zone, targetInstance, requestId=None)</code>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	209	<pre>Deletes the specified TargetInstance resource.
				210
				211	Args:
				212	project: string, Project ID for this request. (required)
				213	zone: string, Name of the zone scoping this request. (required)
				214	targetInstance: string, Name of the TargetInstance resource to delete. (required)
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	215	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.
				216
				217	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.
				218
				219	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]	220
				221	Returns:
				222	An object of the form:
				223
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	224	{ # Represents an Operation resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	225	#
				226	# Google Compute Engine has three Operation resources:
				227	#
				228	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				229	#
				230	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				231	#
				232	# Operations can be global, regional or zonal.
				233	# - For global operations, use the `globalOperations` resource.
				234	# - For regional operations, use the `regionOperations` resource.
				235	# - For zonal operations, use the `zonalOperations` resource.
				236	#
				237	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
				238	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				239	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				240	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				241	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				242	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				243	"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]	244	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	245	"code": "A String", # [Output Only] The error type identifier for this error.
				246	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				247	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	248	},
				249	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	250	},
				251	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				252	"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.
				253	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				254	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				255	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame^]	256	"metadata": { # `Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. # [Output Only] Service-specific metadata attached to this operation.
				257	#
				258	# Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.
				259	#
				260	# Example 1: Pack and unpack a message in C++.
				261	#
				262	# Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... }
				263	#
				264	# Example 2: Pack and unpack a message in Java.
				265	#
				266	# Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); }
				267	#
				268	# Example 3: Pack and unpack a message in Python.
				269	#
				270	# foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ...
				271	#
				272	# Example 4: Pack and unpack a message in Go
				273	#
				274	# foo := &pb.Foo{...} any, err := anypb.New(foo) if err != nil { ... } ... foo := &pb.Foo{} if err := any.UnmarshalTo(foo); err != nil { ... }
				275	#
				276	# The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".
				277	#
				278	#
				279	#
				280	# JSON ==== The JSON representation of an `Any` value uses the regular representation of the deserialized, embedded message, with an additional field `@type` which contains the type URL. Example:
				281	#
				282	# package google.profile; message Person { string first_name = 1; string last_name = 2; }
				283	#
				284	# { "@type": "type.googleapis.com/google.profile.Person", "firstName": , "lastName": }
				285	#
				286	# If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field `value` which holds the custom JSON in addition to the `@type` field. Example (for message [google.protobuf.Duration][]):
				287	#
				288	# { "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }
				289	"typeUrl": "A String", # A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading "." is not accepted).
				290	#
				291	# In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
				292	#
				293	# * If no scheme is provided, `https` is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
				294	#
				295	# Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
				296	#
				297	# Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics.
				298	"value": "A String", # Must be a valid serialized protocol buffer of the above specified type.
				299	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	300	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame^]	301	"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]	302	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				303	"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.
				304	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				305	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				306	"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
				307	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				308	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				309	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				310	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				311	"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.
				312	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				313	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				314	{
				315	"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.
				316	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				317	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				318	{
				319	"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).
				320	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				321	},
				322	],
				323	"message": "A String", # [Output Only] A human-readable description of the warning code.
				324	},
				325	],
				326	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				327	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	328	</div>
				329
				330	<div class="method">
				331	<code class="details" id="get">get(project, zone, targetInstance)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	332	<pre>Returns the specified TargetInstance resource. Gets a list of available target instances by making a list() request.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	333
				334	Args:
				335	project: string, Project ID for this request. (required)
				336	zone: string, Name of the zone scoping this request. (required)
				337	targetInstance: string, Name of the TargetInstance resource to return. (required)
				338
				339	Returns:
				340	An object of the form:
				341
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	342	{ # Represents a Target Instance resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	343	#
				344	# You can use a target instance to handle traffic for one or more forwarding rules, which is ideal for forwarding protocol traffic that is managed by a single source. For example, ESP, AH, TCP, or UDP. For more information, read Target instances. (== resource_for {$api_version}.targetInstances ==)
				345	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				346	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				347	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				348	"instance": "A String", # A URL to the virtual machine instance that handles traffic for this target instance. When creating a target instance, you can provide the fully-qualified URL or a valid partial URL to the desired virtual machine. For example, the following are all valid URLs:
				349	# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance
				350	# - projects/project/zones/zone/instances/instance
				351	# - zones/zone/instances/instance
				352	"kind": "compute#targetInstance", # [Output Only] The type of the resource. Always compute#targetInstance for target instances.
				353	"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.
				354	"natPolicy": "A String", # NAT option controlling how IPs are NAT'ed to the instance. Currently only NO_NAT (default value) is supported.
				355	"network": "A String", # The URL of the network this target instance uses to forward traffic. If not specified, the traffic will be forwarded to the network that the default network interface belongs to.
				356	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				357	"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
				358	"zone": "A String", # [Output Only] URL of the zone where the target instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
				359	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	360	</div>
				361
				362	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	363	<code class="details" id="insert">insert(project, zone, body=None, requestId=None)</code>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	364	<pre>Creates a TargetInstance resource in the specified project and zone using the data included in the request.
				365
				366	Args:
				367	project: string, Project ID for this request. (required)
				368	zone: string, Name of the zone scoping this request. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	369	body: object, The request body.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	370	The object takes the form of:
				371
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	372	{ # Represents a Target Instance resource.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	373	#
				374	# You can use a target instance to handle traffic for one or more forwarding rules, which is ideal for forwarding protocol traffic that is managed by a single source. For example, ESP, AH, TCP, or UDP. For more information, read Target instances. (== resource_for {$api_version}.targetInstances ==)
				375	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				376	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				377	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				378	"instance": "A String", # A URL to the virtual machine instance that handles traffic for this target instance. When creating a target instance, you can provide the fully-qualified URL or a valid partial URL to the desired virtual machine. For example, the following are all valid URLs:
				379	# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance
				380	# - projects/project/zones/zone/instances/instance
				381	# - zones/zone/instances/instance
				382	"kind": "compute#targetInstance", # [Output Only] The type of the resource. Always compute#targetInstance for target instances.
				383	"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.
				384	"natPolicy": "A String", # NAT option controlling how IPs are NAT'ed to the instance. Currently only NO_NAT (default value) is supported.
				385	"network": "A String", # The URL of the network this target instance uses to forward traffic. If not specified, the traffic will be forwarded to the network that the default network interface belongs to.
				386	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				387	"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
				388	"zone": "A String", # [Output Only] URL of the zone where the target instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
				389	}
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	390
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	391	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.
				392
				393	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.
				394
				395	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]	396
				397	Returns:
				398	An object of the form:
				399
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	400	{ # Represents an Operation resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	401	#
				402	# Google Compute Engine has three Operation resources:
				403	#
				404	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				405	#
				406	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				407	#
				408	# Operations can be global, regional or zonal.
				409	# - For global operations, use the `globalOperations` resource.
				410	# - For regional operations, use the `regionOperations` resource.
				411	# - For zonal operations, use the `zonalOperations` resource.
				412	#
				413	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
				414	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				415	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				416	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				417	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				418	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				419	"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]	420	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	421	"code": "A String", # [Output Only] The error type identifier for this error.
				422	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				423	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	424	},
				425	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	426	},
				427	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				428	"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.
				429	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				430	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				431	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame^]	432	"metadata": { # `Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. # [Output Only] Service-specific metadata attached to this operation.
				433	#
				434	# Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.
				435	#
				436	# Example 1: Pack and unpack a message in C++.
				437	#
				438	# Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... }
				439	#
				440	# Example 2: Pack and unpack a message in Java.
				441	#
				442	# Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); }
				443	#
				444	# Example 3: Pack and unpack a message in Python.
				445	#
				446	# foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ...
				447	#
				448	# Example 4: Pack and unpack a message in Go
				449	#
				450	# foo := &pb.Foo{...} any, err := anypb.New(foo) if err != nil { ... } ... foo := &pb.Foo{} if err := any.UnmarshalTo(foo); err != nil { ... }
				451	#
				452	# The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".
				453	#
				454	#
				455	#
				456	# JSON ==== The JSON representation of an `Any` value uses the regular representation of the deserialized, embedded message, with an additional field `@type` which contains the type URL. Example:
				457	#
				458	# package google.profile; message Person { string first_name = 1; string last_name = 2; }
				459	#
				460	# { "@type": "type.googleapis.com/google.profile.Person", "firstName": , "lastName": }
				461	#
				462	# If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field `value` which holds the custom JSON in addition to the `@type` field. Example (for message [google.protobuf.Duration][]):
				463	#
				464	# { "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }
				465	"typeUrl": "A String", # A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading "." is not accepted).
				466	#
				467	# In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
				468	#
				469	# * If no scheme is provided, `https` is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
				470	#
				471	# Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
				472	#
				473	# Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics.
				474	"value": "A String", # Must be a valid serialized protocol buffer of the above specified type.
				475	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	476	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame^]	477	"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]	478	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				479	"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.
				480	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				481	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				482	"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
				483	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				484	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				485	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				486	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				487	"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.
				488	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				489	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				490	{
				491	"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.
				492	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				493	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				494	{
				495	"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).
				496	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				497	},
				498	],
				499	"message": "A String", # [Output Only] A human-readable description of the warning code.
				500	},
				501	],
				502	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				503	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	504	</div>
				505
				506	<div class="method">
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	507	<code class="details" id="list">list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	508	<pre>Retrieves a list of TargetInstance resources available to the specified project and zone.
				509
				510	Args:
				511	project: string, Project ID for this request. (required)
				512	zone: string, Name of the zone scoping this request. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	513	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]	514
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	515	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]	516
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	517	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]	518
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	519	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) ```
				520	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`)
				521	orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
				522
				523	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.
				524
				525	Currently, only sorting by `name` or `creationTimestamp desc` is supported.
				526	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^]	527	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]	528
				529	Returns:
				530	An object of the form:
				531
				532	{ # Contains a list of TargetInstance resources.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	533	"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
				534	"items": [ # A list of TargetInstance resources.
				535	{ # Represents a Target Instance resource.
				536	#
				537	# You can use a target instance to handle traffic for one or more forwarding rules, which is ideal for forwarding protocol traffic that is managed by a single source. For example, ESP, AH, TCP, or UDP. For more information, read Target instances. (== resource_for {$api_version}.targetInstances ==)
				538	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				539	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				540	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				541	"instance": "A String", # A URL to the virtual machine instance that handles traffic for this target instance. When creating a target instance, you can provide the fully-qualified URL or a valid partial URL to the desired virtual machine. For example, the following are all valid URLs:
				542	# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance
				543	# - projects/project/zones/zone/instances/instance
				544	# - zones/zone/instances/instance
				545	"kind": "compute#targetInstance", # [Output Only] The type of the resource. Always compute#targetInstance for target instances.
				546	"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.
				547	"natPolicy": "A String", # NAT option controlling how IPs are NAT'ed to the instance. Currently only NO_NAT (default value) is supported.
				548	"network": "A String", # The URL of the network this target instance uses to forward traffic. If not specified, the traffic will be forwarded to the network that the default network interface belongs to.
				549	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				550	"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
				551	"zone": "A String", # [Output Only] URL of the zone where the target instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
				552	},
				553	],
				554	"kind": "compute#targetInstanceList", # Type of resource.
				555	"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.
				556	"selfLink": "A String", # [Output Only] Server-defined URL for this resource.
				557	"warning": { # [Output Only] Informational warning message.
				558	"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.
				559	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				560	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				561	{
				562	"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).
				563	"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]	564	},
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	565	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	566	"message": "A String", # [Output Only] A human-readable description of the warning code.
				567	},
				568	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	569	</div>
				570
				571	<div class="method">
				572	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				573	<pre>Retrieves the next page of results.
				574
				575	Args:
				576	previous_request: The request for the previous page. (required)
				577	previous_response: The response from the request for the previous page. (required)
				578
				579	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	580	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]	581	page. Returns None if there are no more items in the collection.
				582	</pre>
				583	</div>
				584
				585	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	586	<code class="details" id="testIamPermissions">testIamPermissions(project, zone, resource, body=None)</code>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	587	<pre>Returns permissions that a caller has on the specified resource.
				588
				589	Args:
				590	project: string, Project ID for this request. (required)
				591	zone: string, The name of the zone for this request. (required)
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	592	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]	593	body: object, The request body.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	594	The object takes the form of:
				595
				596	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	597	"permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '' or 'storage.') are not allowed.
				598	"A String",
				599	],
				600	}
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	601
				602
				603	Returns:
				604	An object of the form:
				605
				606	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	607	"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
				608	"A String",
				609	],
				610	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	611	</div>
				612
				613	</body></html>