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

blob: a3cf80e20144f8f883879a6ee312ba1ddaa8285d [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.targetInstances.html">targetInstances</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
yoshi-code-bot	c3f8675	2021-06-12 00:20:02 -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">
yoshi-code-bot	c3f8675	2021-06-12 00:20:02 -0700	[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">
yoshi-code-bot	c3f8675	2021-06-12 00:20:02 -0700	[diff] [blame]	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">
yoshi-code-bot	c3f8675	2021-06-12 00:20:02 -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">
yoshi-code-bot	c3f8675	2021-06-12 00:20:02 -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">
yoshi-code-bot	c3f8675	2021-06-12 00:20:02 -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">
yoshi-code-bot	c3f8675	2021-06-12 00:20:02 -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)
yoshi-code-bot	c3f8675	2021-06-12 00:20:02 -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 `<`.
				112
				113	For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
				114
				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.
				116
				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`)
yoshi-code-bot	c3f8675	2021-06-12 00:20:02 -0700	[diff] [blame]	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.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	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.
yoshi-code-bot	c3f8675	2021-06-12 00:20:02 -0700	[diff] [blame]	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 ==)
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	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.
yoshi-code-bot	c3f8675	2021-06-12 00:20:02 -0700	[diff] [blame]	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
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	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	"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]	152	},
				153	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	154	"warning": { # Informational warning which replaces the list of addresses when the list is empty.
				155	"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.
yoshi-code-bot	c3f8675	2021-06-12 00:20:02 -0700	[diff] [blame]	156	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				157	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	158	{
				159	"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).
				160	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				161	},
				162	],
				163	"message": "A String", # [Output Only] A human-readable description of the warning code.
				164	},
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	165	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	166	},
				167	"kind": "compute#targetInstanceAggregatedList", # Type of resource.
				168	"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.
				169	"selfLink": "A String", # [Output Only] Server-defined URL for this resource.
				170	"unreachables": [ # [Output Only] Unreachable resources.
				171	"A String",
				172	],
				173	"warning": { # [Output Only] Informational warning message.
				174	"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.
yoshi-code-bot	c3f8675	2021-06-12 00:20:02 -0700	[diff] [blame]	175	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				176	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	177	{
				178	"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).
				179	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				180	},
				181	],
				182	"message": "A String", # [Output Only] A human-readable description of the warning code.
				183	},
				184	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	185	</div>
				186
				187	<div class="method">
				188	<code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code>
				189	<pre>Retrieves the next page of results.
				190
				191	Args:
				192	previous_request: The request for the previous page. (required)
				193	previous_response: The response from the request for the previous page. (required)
				194
				195	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	196	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]	197	page. Returns None if there are no more items in the collection.
				198	</pre>
				199	</div>
				200
				201	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	202	<code class="details" id="close">close()</code>
				203	<pre>Close httplib2 connections.</pre>
				204	</div>
				205
				206	<div class="method">
yoshi-code-bot	c3f8675	2021-06-12 00:20:02 -0700	[diff] [blame]	207	<code class="details" id="delete">delete(project, zone, targetInstance, requestId=None)</code>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	208	<pre>Deletes the specified TargetInstance resource.
				209
				210	Args:
				211	project: string, Project ID for this request. (required)
				212	zone: string, Name of the zone scoping this request. (required)
				213	targetInstance: string, Name of the TargetInstance resource to delete. (required)
yoshi-code-bot	c3f8675	2021-06-12 00:20:02 -0700	[diff] [blame]	214	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.
				215
				216	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.
				217
				218	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]	219
				220	Returns:
				221	An object of the form:
				222
yoshi-code-bot	c3f8675	2021-06-12 00:20:02 -0700	[diff] [blame]	223	{ # Represents an Operation resource.
				224	#
				225	# Google Compute Engine has three Operation resources:
				226	#
				227	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				228	#
				229	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				230	#
				231	# Operations can be global, regional or zonal.
				232	# - For global operations, use the `globalOperations` resource.
				233	# - For regional operations, use the `regionOperations` resource.
				234	# - For zonal operations, use the `zonalOperations` resource.
				235	#
				236	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	237	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				238	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				239	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				240	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				241	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				242	"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]	243	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	244	"code": "A String", # [Output Only] The error type identifier for this error.
				245	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				246	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	247	},
				248	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	249	},
				250	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				251	"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.
				252	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				253	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				254	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				255	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	256	"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]	257	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				258	"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.
				259	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				260	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				261	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				262	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				263	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				264	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				265	"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.
				266	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				267	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				268	{
				269	"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.
yoshi-code-bot	c3f8675	2021-06-12 00:20:02 -0700	[diff] [blame]	270	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				271	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	272	{
				273	"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).
				274	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				275	},
				276	],
				277	"message": "A String", # [Output Only] A human-readable description of the warning code.
				278	},
				279	],
				280	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				281	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	282	</div>
				283
				284	<div class="method">
yoshi-code-bot	c3f8675	2021-06-12 00:20:02 -0700	[diff] [blame]	285	<code class="details" id="get">get(project, zone, targetInstance)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	286	<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]	287
				288	Args:
				289	project: string, Project ID for this request. (required)
				290	zone: string, Name of the zone scoping this request. (required)
				291	targetInstance: string, Name of the TargetInstance resource to return. (required)
				292
				293	Returns:
				294	An object of the form:
				295
yoshi-code-bot	c3f8675	2021-06-12 00:20:02 -0700	[diff] [blame]	296	{ # Represents a Target Instance resource.
				297	#
				298	# 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 ==)
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	299	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				300	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				301	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
yoshi-code-bot	c3f8675	2021-06-12 00:20:02 -0700	[diff] [blame]	302	"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:
				303	# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance
				304	# - projects/project/zones/zone/instances/instance
				305	# - zones/zone/instances/instance
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	306	"kind": "compute#targetInstance", # [Output Only] The type of the resource. Always compute#targetInstance for target instances.
				307	"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.
				308	"natPolicy": "A String", # NAT option controlling how IPs are NAT'ed to the instance. Currently only NO_NAT (default value) is supported.
				309	"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.
				310	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				311	"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.
				312	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	313	</div>
				314
				315	<div class="method">
yoshi-code-bot	c3f8675	2021-06-12 00:20:02 -0700	[diff] [blame]	316	<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]	317	<pre>Creates a TargetInstance resource in the specified project and zone using the data included in the request.
				318
				319	Args:
				320	project: string, Project ID for this request. (required)
				321	zone: string, Name of the zone scoping this request. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	322	body: object, The request body.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	323	The object takes the form of:
				324
yoshi-code-bot	c3f8675	2021-06-12 00:20:02 -0700	[diff] [blame]	325	{ # Represents a Target Instance resource.
				326	#
				327	# 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 ==)
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	328	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				329	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				330	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
yoshi-code-bot	c3f8675	2021-06-12 00:20:02 -0700	[diff] [blame]	331	"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:
				332	# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance
				333	# - projects/project/zones/zone/instances/instance
				334	# - zones/zone/instances/instance
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	335	"kind": "compute#targetInstance", # [Output Only] The type of the resource. Always compute#targetInstance for target instances.
				336	"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.
				337	"natPolicy": "A String", # NAT option controlling how IPs are NAT'ed to the instance. Currently only NO_NAT (default value) is supported.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	338	"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.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	339	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				340	"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.
				341	}
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	342
yoshi-code-bot	c3f8675	2021-06-12 00:20:02 -0700	[diff] [blame]	343	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.
				344
				345	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.
				346
				347	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]	348
				349	Returns:
				350	An object of the form:
				351
yoshi-code-bot	c3f8675	2021-06-12 00:20:02 -0700	[diff] [blame]	352	{ # Represents an Operation resource.
				353	#
				354	# Google Compute Engine has three Operation resources:
				355	#
				356	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				357	#
				358	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				359	#
				360	# Operations can be global, regional or zonal.
				361	# - For global operations, use the `globalOperations` resource.
				362	# - For regional operations, use the `regionOperations` resource.
				363	# - For zonal operations, use the `zonalOperations` resource.
				364	#
				365	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	366	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				367	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				368	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				369	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				370	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				371	"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]	372	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	373	"code": "A String", # [Output Only] The error type identifier for this error.
				374	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				375	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	376	},
				377	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	378	},
				379	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				380	"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.
				381	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				382	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				383	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				384	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	385	"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]	386	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				387	"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.
				388	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				389	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				390	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				391	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				392	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				393	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				394	"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.
				395	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				396	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				397	{
				398	"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.
yoshi-code-bot	c3f8675	2021-06-12 00:20:02 -0700	[diff] [blame]	399	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				400	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	401	{
				402	"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).
				403	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				404	},
				405	],
				406	"message": "A String", # [Output Only] A human-readable description of the warning code.
				407	},
				408	],
				409	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				410	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	411	</div>
				412
				413	<div class="method">
yoshi-code-bot	c3f8675	2021-06-12 00:20:02 -0700	[diff] [blame]	414	<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]	415	<pre>Retrieves a list of TargetInstance resources available to the specified project and zone.
				416
				417	Args:
				418	project: string, Project ID for this request. (required)
				419	zone: string, Name of the zone scoping this request. (required)
yoshi-code-bot	c3f8675	2021-06-12 00:20:02 -0700	[diff] [blame]	420	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 `<`.
				421
				422	For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
				423
				424	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.
				425
				426	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) ```
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	427	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`)
yoshi-code-bot	c3f8675	2021-06-12 00:20:02 -0700	[diff] [blame]	428	orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
				429
				430	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.
				431
				432	Currently, only sorting by `name` or `creationTimestamp desc` is supported.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	433	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]	434	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]	435
				436	Returns:
				437	An object of the form:
				438
				439	{ # Contains a list of TargetInstance resources.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	440	"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
				441	"items": [ # A list of TargetInstance resources.
yoshi-code-bot	c3f8675	2021-06-12 00:20:02 -0700	[diff] [blame]	442	{ # Represents a Target Instance resource.
				443	#
				444	# 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 ==)
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	445	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				446	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				447	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
yoshi-code-bot	c3f8675	2021-06-12 00:20:02 -0700	[diff] [blame]	448	"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:
				449	# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance
				450	# - projects/project/zones/zone/instances/instance
				451	# - zones/zone/instances/instance
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	452	"kind": "compute#targetInstance", # [Output Only] The type of the resource. Always compute#targetInstance for target instances.
				453	"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.
				454	"natPolicy": "A String", # NAT option controlling how IPs are NAT'ed to the instance. Currently only NO_NAT (default value) is supported.
				455	"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.
				456	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				457	"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.
				458	},
				459	],
				460	"kind": "compute#targetInstanceList", # Type of resource.
				461	"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.
				462	"selfLink": "A String", # [Output Only] Server-defined URL for this resource.
				463	"warning": { # [Output Only] Informational warning message.
				464	"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.
yoshi-code-bot	c3f8675	2021-06-12 00:20:02 -0700	[diff] [blame]	465	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				466	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	467	{
				468	"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).
				469	"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]	470	},
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	471	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	472	"message": "A String", # [Output Only] A human-readable description of the warning code.
				473	},
				474	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	475	</div>
				476
				477	<div class="method">
				478	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				479	<pre>Retrieves the next page of results.
				480
				481	Args:
				482	previous_request: The request for the previous page. (required)
				483	previous_response: The response from the request for the previous page. (required)
				484
				485	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	486	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]	487	page. Returns None if there are no more items in the collection.
				488	</pre>
				489	</div>
				490
				491	<div class="method">
yoshi-code-bot	c3f8675	2021-06-12 00:20:02 -0700	[diff] [blame]	492	<code class="details" id="testIamPermissions">testIamPermissions(project, zone, resource, body=None)</code>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	493	<pre>Returns permissions that a caller has on the specified resource.
				494
				495	Args:
				496	project: string, Project ID for this request. (required)
				497	zone: string, The name of the zone for this request. (required)
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	498	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]	499	body: object, The request body.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	500	The object takes the form of:
				501
				502	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	503	"permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '' or 'storage.') are not allowed.
				504	"A String",
				505	],
				506	}
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	507
				508
				509	Returns:
				510	An object of the form:
				511
				512	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	513	"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
				514	"A String",
				515	],
				516	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	517	</div>
				518
				519	</body></html>