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

blob: f99d004bc04774d93c20e6f9ca6e8364d0dbd07b [file] [log] [blame]

Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[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
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	75	<h1><a href="compute_alpha.html">Compute Engine API</a> . <a href="compute_alpha.targetTcpProxies.html">targetTcpProxies</a></h1>
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	78	<code><a href="#close">close()</a></code></p>
				79	<p class="firstline">Close httplib2 connections.</p>
				80	<p class="toc_element">
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	81	<code><a href="#delete">delete(project, targetTcpProxy, requestId=None)</a></code></p>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	82	<p class="firstline">Deletes the specified TargetTcpProxy resource.</p>
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	83	<p class="toc_element">
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	84	<code><a href="#get">get(project, targetTcpProxy)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	85	<p class="firstline">Returns the specified TargetTcpProxy resource. Gets a list of available target TCP proxies by making a list() request.</p>
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	86	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	87	<code><a href="#insert">insert(project, body=None, requestId=None)</a></code></p>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	88	<p class="firstline">Creates a TargetTcpProxy resource in the specified project using the data included in the request.</p>
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	89	<p class="toc_element">
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	90	<code><a href="#list">list(project, 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]	91	<p class="firstline">Retrieves the list of TargetTcpProxy resources available to the specified project.</p>
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	92	<p class="toc_element">
				93	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				94	<p class="firstline">Retrieves the next page of results.</p>
				95	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	96	<code><a href="#setBackendService">setBackendService(project, targetTcpProxy, body=None, requestId=None)</a></code></p>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	97	<p class="firstline">Changes the BackendService for TargetTcpProxy.</p>
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	98	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	99	<code><a href="#setProxyHeader">setProxyHeader(project, targetTcpProxy, body=None, requestId=None)</a></code></p>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	100	<p class="firstline">Changes the ProxyHeaderType for TargetTcpProxy.</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, 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>
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	104	<h3>Method Details</h3>
				105	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	106	<code class="details" id="close">close()</code>
				107	<pre>Close httplib2 connections.</pre>
				108	</div>
				109
				110	<div class="method">
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	111	<code class="details" id="delete">delete(project, targetTcpProxy, requestId=None)</code>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	112	<pre>Deletes the specified TargetTcpProxy resource.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	113
				114	Args:
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	115	project: string, Project ID for this request. (required)
				116	targetTcpProxy: string, Name of the TargetTcpProxy resource to delete. (required)
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	117	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.
				118
				119	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.
				120
				121	The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	122
				123	Returns:
				124	An object of the form:
				125
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	126	{ # Represents an Operation resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	127	#
				128	# Google Compute Engine has three Operation resources:
				129	#
				130	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				131	#
				132	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				133	#
				134	# Operations can be global, regional or zonal.
				135	# - For global operations, use the `globalOperations` resource.
				136	# - For regional operations, use the `regionOperations` resource.
				137	# - For zonal operations, use the `zonalOperations` resource.
				138	#
				139	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
				140	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				141	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				142	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				143	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				144	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				145	"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]	146	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	147	"code": "A String", # [Output Only] The error type identifier for this error.
				148	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				149	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	150	},
				151	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	152	},
				153	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				154	"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.
				155	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				156	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				157	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				158	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	159	"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]	160	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				161	"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.
				162	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				163	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				164	"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
				165	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				166	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				167	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				168	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				169	"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.
				170	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				171	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				172	{
				173	"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.
				174	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				175	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				176	{
				177	"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).
				178	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				179	},
				180	],
				181	"message": "A String", # [Output Only] A human-readable description of the warning code.
				182	},
				183	],
				184	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				185	}</pre>
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	186	</div>
				187
				188	<div class="method">
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	189	<code class="details" id="get">get(project, targetTcpProxy)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	190	<pre>Returns the specified TargetTcpProxy resource. Gets a list of available target TCP proxies by making a list() request.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	191
				192	Args:
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	193	project: string, Project ID for this request. (required)
				194	targetTcpProxy: string, Name of the TargetTcpProxy resource to return. (required)
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	195
				196	Returns:
				197	An object of the form:
				198
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	199	{ # Represents a Target TCP Proxy resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	200	#
				201	# A target TCP proxy is a component of a TCP Proxy load balancer. Global forwarding rules reference target TCP proxy, and the target proxy then references an external backend service. For more information, read TCP Proxy Load Balancing overview. (== resource_for {$api_version}.targetTcpProxies ==)
				202	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				203	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				204	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				205	"kind": "compute#targetTcpProxy", # [Output Only] Type of the resource. Always compute#targetTcpProxy for target TCP proxies.
				206	"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.
				207	"proxyBind": True or False, # This field only applies when the forwarding rule that references this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	208	#
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	209	# When this field is set to true, Envoy proxies set up inbound traffic interception and bind to the IP address and port specified in the forwarding rule. This is generally useful when using Traffic Director to configure Envoy as a gateway or middle proxy (in other words, not a sidecar proxy). The Envoy proxy listens for inbound requests and handles requests when it receives them.
				210	#
				211	# The default is false.
				212	"proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
				213	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				214	"service": "A String", # URL to the BackendService resource.
				215	}</pre>
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	216	</div>
				217
				218	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	219	<code class="details" id="insert">insert(project, body=None, requestId=None)</code>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	220	<pre>Creates a TargetTcpProxy resource in the specified project using the data included in the request.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	221
				222	Args:
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	223	project: string, Project ID for this request. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	224	body: object, The request body.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	225	The object takes the form of:
				226
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	227	{ # Represents a Target TCP Proxy resource.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	228	#
				229	# A target TCP proxy is a component of a TCP Proxy load balancer. Global forwarding rules reference target TCP proxy, and the target proxy then references an external backend service. For more information, read TCP Proxy Load Balancing overview. (== resource_for {$api_version}.targetTcpProxies ==)
				230	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				231	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				232	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				233	"kind": "compute#targetTcpProxy", # [Output Only] Type of the resource. Always compute#targetTcpProxy for target TCP proxies.
				234	"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.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	235	"proxyBind": True or False, # This field only applies when the forwarding rule that references this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED.
				236	#
				237	# When this field is set to true, Envoy proxies set up inbound traffic interception and bind to the IP address and port specified in the forwarding rule. This is generally useful when using Traffic Director to configure Envoy as a gateway or middle proxy (in other words, not a sidecar proxy). The Envoy proxy listens for inbound requests and handles requests when it receives them.
				238	#
				239	# The default is false.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	240	"proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
				241	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				242	"service": "A String", # URL to the BackendService resource.
				243	}
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	244
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	245	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.
				246
				247	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.
				248
				249	The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	250
				251	Returns:
				252	An object of the form:
				253
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	254	{ # Represents an Operation resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	255	#
				256	# Google Compute Engine has three Operation resources:
				257	#
				258	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				259	#
				260	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				261	#
				262	# Operations can be global, regional or zonal.
				263	# - For global operations, use the `globalOperations` resource.
				264	# - For regional operations, use the `regionOperations` resource.
				265	# - For zonal operations, use the `zonalOperations` resource.
				266	#
				267	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
				268	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				269	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				270	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				271	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				272	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				273	"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]	274	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	275	"code": "A String", # [Output Only] The error type identifier for this error.
				276	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				277	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	278	},
				279	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	280	},
				281	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				282	"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.
				283	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				284	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				285	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				286	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	287	"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]	288	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				289	"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.
				290	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				291	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				292	"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
				293	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				294	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				295	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				296	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				297	"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.
				298	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				299	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				300	{
				301	"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.
				302	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				303	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				304	{
				305	"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).
				306	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				307	},
				308	],
				309	"message": "A String", # [Output Only] A human-readable description of the warning code.
				310	},
				311	],
				312	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				313	}</pre>
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	314	</div>
				315
				316	<div class="method">
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	317	<code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	318	<pre>Retrieves the list of TargetTcpProxy resources available to the specified project.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	319
				320	Args:
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	321	project: string, Project ID for this request. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	322	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 `<`.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	323
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	324	For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	325
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	326	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.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	327
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	328	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) ```
				329	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`)
				330	orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
				331
				332	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.
				333
				334	Currently, only sorting by `name` or `creationTimestamp desc` is supported.
				335	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]	336	returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	337
				338	Returns:
				339	An object of the form:
				340
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	341	{ # Contains a list of TargetTcpProxy resources.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	342	"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
				343	"items": [ # A list of TargetTcpProxy resources.
				344	{ # Represents a Target TCP Proxy resource.
				345	#
				346	# A target TCP proxy is a component of a TCP Proxy load balancer. Global forwarding rules reference target TCP proxy, and the target proxy then references an external backend service. For more information, read TCP Proxy Load Balancing overview. (== resource_for {$api_version}.targetTcpProxies ==)
				347	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				348	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				349	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				350	"kind": "compute#targetTcpProxy", # [Output Only] Type of the resource. Always compute#targetTcpProxy for target TCP proxies.
				351	"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.
				352	"proxyBind": True or False, # This field only applies when the forwarding rule that references this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	353	#
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	354	# When this field is set to true, Envoy proxies set up inbound traffic interception and bind to the IP address and port specified in the forwarding rule. This is generally useful when using Traffic Director to configure Envoy as a gateway or middle proxy (in other words, not a sidecar proxy). The Envoy proxy listens for inbound requests and handles requests when it receives them.
				355	#
				356	# The default is false.
				357	"proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
				358	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				359	"service": "A String", # URL to the BackendService resource.
				360	},
				361	],
				362	"kind": "compute#targetTcpProxyList", # Type of resource.
				363	"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.
				364	"selfLink": "A String", # [Output Only] Server-defined URL for this resource.
				365	"warning": { # [Output Only] Informational warning message.
				366	"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.
				367	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				368	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				369	{
				370	"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).
				371	"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]	372	},
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	373	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	374	"message": "A String", # [Output Only] A human-readable description of the warning code.
				375	},
				376	}</pre>
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	377	</div>
				378
				379	<div class="method">
				380	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				381	<pre>Retrieves the next page of results.
				382
				383	Args:
				384	previous_request: The request for the previous page. (required)
				385	previous_response: The response from the request for the previous page. (required)
				386
				387	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	388	A request object that you can call 'execute()' on to request the next
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	389	page. Returns None if there are no more items in the collection.
				390	</pre>
				391	</div>
				392
				393	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	394	<code class="details" id="setBackendService">setBackendService(project, targetTcpProxy, body=None, requestId=None)</code>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	395	<pre>Changes the BackendService for TargetTcpProxy.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	396
				397	Args:
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	398	project: string, Project ID for this request. (required)
				399	targetTcpProxy: string, Name of the TargetTcpProxy resource whose BackendService resource is to be set. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	400	body: object, The request body.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	401	The object takes the form of:
				402
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	403	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	404	"service": "A String", # The URL of the new BackendService resource for the targetTcpProxy.
				405	}
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	406
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	407	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.
				408
				409	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.
				410
				411	The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	412
				413	Returns:
				414	An object of the form:
				415
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	416	{ # Represents an Operation resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	417	#
				418	# Google Compute Engine has three Operation resources:
				419	#
				420	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				421	#
				422	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				423	#
				424	# Operations can be global, regional or zonal.
				425	# - For global operations, use the `globalOperations` resource.
				426	# - For regional operations, use the `regionOperations` resource.
				427	# - For zonal operations, use the `zonalOperations` resource.
				428	#
				429	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
				430	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				431	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				432	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				433	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				434	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				435	"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]	436	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	437	"code": "A String", # [Output Only] The error type identifier for this error.
				438	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				439	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	440	},
				441	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	442	},
				443	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				444	"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.
				445	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				446	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				447	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				448	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	449	"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]	450	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				451	"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.
				452	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				453	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				454	"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
				455	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				456	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				457	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				458	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				459	"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.
				460	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				461	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				462	{
				463	"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.
				464	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				465	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				466	{
				467	"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).
				468	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				469	},
				470	],
				471	"message": "A String", # [Output Only] A human-readable description of the warning code.
				472	},
				473	],
				474	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				475	}</pre>
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	476	</div>
				477
				478	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	479	<code class="details" id="setProxyHeader">setProxyHeader(project, targetTcpProxy, body=None, requestId=None)</code>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	480	<pre>Changes the ProxyHeaderType for TargetTcpProxy.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	481
				482	Args:
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	483	project: string, Project ID for this request. (required)
				484	targetTcpProxy: string, Name of the TargetTcpProxy resource whose ProxyHeader is to be set. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	485	body: object, The request body.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	486	The object takes the form of:
				487
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	488	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	489	"proxyHeader": "A String", # The new type of proxy header to append before sending data to the backend. NONE or PROXY_V1 are allowed.
				490	}
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	491
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	492	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.
				493
				494	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.
				495
				496	The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	497
				498	Returns:
				499	An object of the form:
				500
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	501	{ # Represents an Operation resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	502	#
				503	# Google Compute Engine has three Operation resources:
				504	#
				505	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				506	#
				507	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				508	#
				509	# Operations can be global, regional or zonal.
				510	# - For global operations, use the `globalOperations` resource.
				511	# - For regional operations, use the `regionOperations` resource.
				512	# - For zonal operations, use the `zonalOperations` resource.
				513	#
				514	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
				515	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				516	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				517	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				518	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				519	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				520	"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]	521	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	522	"code": "A String", # [Output Only] The error type identifier for this error.
				523	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				524	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	525	},
				526	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	527	},
				528	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				529	"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.
				530	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				531	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				532	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				533	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame]	534	"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]	535	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				536	"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.
				537	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				538	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				539	"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
				540	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				541	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				542	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				543	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				544	"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.
				545	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				546	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				547	{
				548	"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.
				549	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				550	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				551	{
				552	"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).
				553	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				554	},
				555	],
				556	"message": "A String", # [Output Only] A human-readable description of the warning code.
				557	},
				558	],
				559	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				560	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	561	</div>
				562
				563	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	564	<code class="details" id="testIamPermissions">testIamPermissions(project, resource, body=None)</code>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	565	<pre>Returns permissions that a caller has on the specified resource.
				566
				567	Args:
				568	project: string, Project ID for this request. (required)
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	569	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]	570	body: object, The request body.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	571	The object takes the form of:
				572
				573	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	574	"permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '' or 'storage.') are not allowed.
				575	"A String",
				576	],
				577	}
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	578
				579
				580	Returns:
				581	An object of the form:
				582
				583	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	584	"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
				585	"A String",
				586	],
				587	}</pre>
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	588	</div>
				589
				590	</body></html>