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

blob: 8c03ef6d8574e56b63dafc14a7134d12dca2c2c8 [file] [log] [blame]

Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	1	<html><body>
				2	<style>
				3
				4	body, h1, h2, h3, div, span, p, pre, a {
				5	margin: 0;
				6	padding: 0;
				7	border: 0;
				8	font-weight: inherit;
				9	font-style: inherit;
				10	font-size: 100%;
				11	font-family: inherit;
				12	vertical-align: baseline;
				13	}
				14
				15	body {
				16	font-size: 13px;
				17	padding: 1em;
				18	}
				19
				20	h1 {
				21	font-size: 26px;
				22	margin-bottom: 1em;
				23	}
				24
				25	h2 {
				26	font-size: 24px;
				27	margin-bottom: 1em;
				28	}
				29
				30	h3 {
				31	font-size: 20px;
				32	margin-bottom: 1em;
				33	margin-top: 1em;
				34	}
				35
				36	pre, code {
				37	line-height: 1.5;
				38	font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
				39	}
				40
				41	pre {
				42	margin-top: 0.5em;
				43	}
				44
				45	h1, h2, h3, p {
				46	font-family: Arial, sans serif;
				47	}
				48
				49	h1, h2, h3 {
				50	border-bottom: solid #CCC 1px;
				51	}
				52
				53	.toc_element {
				54	margin-top: 0.5em;
				55	}
				56
				57	.firstline {
				58	margin-left: 2 em;
				59	}
				60
				61	.method {
				62	margin-top: 1em;
				63	border: solid 1px #CCC;
				64	padding: 1em;
				65	background: #EEE;
				66	}
				67
				68	.details {
				69	font-weight: bold;
				70	font-size: 14px;
				71	}
				72
				73	</style>
				74
				75	<h1><a href="compute_alpha.html">Compute Engine API</a> . <a href="compute_alpha.targetHttpProxies.html">targetHttpProxies</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	78	<code><a href="#aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	79	<p class="firstline">Retrieves the list of all TargetHttpProxy resources, regional and global, available to the specified project.</p>
				80	<p class="toc_element">
				81	<code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p>
				82	<p class="firstline">Retrieves the next page of results.</p>
				83	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	84	<code><a href="#close">close()</a></code></p>
				85	<p class="firstline">Close httplib2 connections.</p>
				86	<p class="toc_element">
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	87	<code><a href="#delete">delete(project, targetHttpProxy, requestId=None)</a></code></p>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	88	<p class="firstline">Deletes the specified TargetHttpProxy resource.</p>
				89	<p class="toc_element">
				90	<code><a href="#get">get(project, targetHttpProxy)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	91	<p class="firstline">Returns the specified TargetHttpProxy resource. Gets a list of available target HTTP proxies by making a list() request.</p>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	92	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	93	<code><a href="#insert">insert(project, 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 TargetHttpProxy resource in the specified project using the data included in the request.</p>
				95	<p class="toc_element">
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	96	<code><a href="#list">list(project, 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 the list of TargetHttpProxy resources available to the specified project.</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">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	102	<code><a href="#patch">patch(project, targetHttpProxy, body=None, requestId=None)</a></code></p>
				103	<p class="firstline">Patches the specified TargetHttpProxy resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==)</p>
				104	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	105	<code><a href="#setUrlMap">setUrlMap(project, targetHttpProxy, body=None, requestId=None)</a></code></p>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	106	<p class="firstline">Changes the URL map for TargetHttpProxy.</p>
				107	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	108	<code><a href="#testIamPermissions">testIamPermissions(project, resource, body=None)</a></code></p>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	109	<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
				110	<h3>Method Details</h3>
				111	<div class="method">
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	112	<code class="details" id="aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	113	<pre>Retrieves the list of all TargetHttpProxy resources, regional and global, available to the specified project.
				114
				115	Args:
				116	project: string, Name of the project scoping this request. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	117	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 `<`.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	118
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	119	For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	120
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	121	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.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	122
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	123	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]	124	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]	125	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`)
				126	orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
				127
				128	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.
				129
				130	Currently, only sorting by `name` or `creationTimestamp desc` is supported.
				131	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^]	132	returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	133
				134	Returns:
				135	An object of the form:
				136
				137	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	138	"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
				139	"items": { # A list of TargetHttpProxiesScopedList resources.
				140	"a_key": { # Name of the scope containing this set of TargetHttpProxies.
				141	"targetHttpProxies": [ # A list of TargetHttpProxies contained in this scope.
				142	{ # Represents a Target HTTP Proxy resource.
				143	#
				144	# Google Compute Engine has two Target HTTP Proxy resources:
				145	#
				146	# * [Global](/compute/docs/reference/rest/{$api_version}/targetHttpProxies) * [Regional](/compute/docs/reference/rest/{$api_version}/regionTargetHttpProxies)
				147	#
				148	# A target HTTP proxy is a component of GCP HTTP load balancers.
				149	#
				150	# * targetHttpProxies are used by external HTTP load balancers and Traffic Director. * regionTargetHttpProxies are used by internal HTTP load balancers.
				151	#
				152	# Forwarding rules reference a target HTTP proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies and Forwarding rule concepts. (== resource_for {$api_version}.targetHttpProxies ==) (== resource_for {$api_version}.regionTargetHttpProxies ==)
				153	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				154	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				155	"fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a TargetHttpProxy. An up-to-date fingerprint must be provided in order to patch/update the TargetHttpProxy; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the TargetHttpProxy.
				156	"httpFilters": [ # URLs to networkservices.HttpFilter resources enabled for xDS clients using this configuration. For example, https://networkservices.googleapis.com/v1alpha1/projects/project/locations/locationhttpFilters/httpFilter Only filters that handle outbound connection and stream events may be specified. These filters work in conjunction with a default set of HTTP filters that may already be configured by Traffic Director. Traffic Director will determine the final location of these filters within xDS configuration based on the name of the HTTP filter. If Traffic Director positions multiple filters at the same location, those filters will be in the same order as specified in this list.
				157	# httpFilters only applies for loadbalancers with loadBalancingScheme set to INTERNAL_SELF_MANAGED. See ForwardingRule for more details.
				158	"A String",
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	159	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	160	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				161	"kind": "compute#targetHttpProxy", # [Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies.
				162	"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.
				163	"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.
				164	#
				165	# 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.
				166	#
				167	# The default is false.
				168	"region": "A String", # [Output Only] URL of the region where the regional Target HTTP Proxy resides. This field is not applicable to global Target HTTP Proxies.
				169	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				170	"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
				171	"urlMap": "A String", # URL to the UrlMap resource that defines the mapping from URL to the BackendService.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	172	},
				173	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	174	"warning": { # Informational warning which replaces the list of backend services when the list is empty.
				175	"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
				176	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				177	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				178	{
				179	"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
				180	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				181	},
				182	],
				183	"message": "A String", # [Output Only] A human-readable description of the warning code.
				184	},
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	185	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	186	},
				187	"kind": "compute#targetHttpProxyAggregatedList", # [Output Only] Type of resource. Always compute#targetHttpProxyAggregatedList for lists of Target HTTP Proxies.
				188	"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.
				189	"selfLink": "A String", # [Output Only] Server-defined URL for this resource.
				190	"unreachables": [ # [Output Only] Unreachable resources.
				191	"A String",
				192	],
				193	"warning": { # [Output Only] Informational warning message.
				194	"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.
				195	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				196	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				197	{
				198	"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).
				199	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				200	},
				201	],
				202	"message": "A String", # [Output Only] A human-readable description of the warning code.
				203	},
				204	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	205	</div>
				206
				207	<div class="method">
				208	<code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code>
				209	<pre>Retrieves the next page of results.
				210
				211	Args:
				212	previous_request: The request for the previous page. (required)
				213	previous_response: The response from the request for the previous page. (required)
				214
				215	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	216	A request object that you can call 'execute()' on to request the next
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	217	page. Returns None if there are no more items in the collection.
				218	</pre>
				219	</div>
				220
				221	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	222	<code class="details" id="close">close()</code>
				223	<pre>Close httplib2 connections.</pre>
				224	</div>
				225
				226	<div class="method">
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	227	<code class="details" id="delete">delete(project, targetHttpProxy, requestId=None)</code>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	228	<pre>Deletes the specified TargetHttpProxy resource.
				229
				230	Args:
				231	project: string, Project ID for this request. (required)
				232	targetHttpProxy: string, Name of the TargetHttpProxy resource to delete. (required)
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	233	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.
				234
				235	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.
				236
				237	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]	238
				239	Returns:
				240	An object of the form:
				241
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	242	{ # Represents an Operation resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	243	#
				244	# Google Compute Engine has three Operation resources:
				245	#
				246	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				247	#
				248	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				249	#
				250	# Operations can be global, regional or zonal.
				251	# - For global operations, use the `globalOperations` resource.
				252	# - For regional operations, use the `regionOperations` resource.
				253	# - For zonal operations, use the `zonalOperations` resource.
				254	#
				255	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
				256	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				257	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				258	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				259	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				260	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				261	"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]	262	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	263	"code": "A String", # [Output Only] The error type identifier for this error.
				264	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				265	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	266	},
				267	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	268	},
				269	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				270	"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.
				271	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				272	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				273	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame^]	274	"metadata": { # `Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. # [Output Only] Service-specific metadata attached to this operation.
				275	#
				276	# Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.
				277	#
				278	# Example 1: Pack and unpack a message in C++.
				279	#
				280	# Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... }
				281	#
				282	# Example 2: Pack and unpack a message in Java.
				283	#
				284	# Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); }
				285	#
				286	# Example 3: Pack and unpack a message in Python.
				287	#
				288	# foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ...
				289	#
				290	# Example 4: Pack and unpack a message in Go
				291	#
				292	# foo := &pb.Foo{...} any, err := anypb.New(foo) if err != nil { ... } ... foo := &pb.Foo{} if err := any.UnmarshalTo(foo); err != nil { ... }
				293	#
				294	# The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".
				295	#
				296	#
				297	#
				298	# JSON ==== The JSON representation of an `Any` value uses the regular representation of the deserialized, embedded message, with an additional field `@type` which contains the type URL. Example:
				299	#
				300	# package google.profile; message Person { string first_name = 1; string last_name = 2; }
				301	#
				302	# { "@type": "type.googleapis.com/google.profile.Person", "firstName": , "lastName": }
				303	#
				304	# If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field `value` which holds the custom JSON in addition to the `@type` field. Example (for message [google.protobuf.Duration][]):
				305	#
				306	# { "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }
				307	"typeUrl": "A String", # A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading "." is not accepted).
				308	#
				309	# In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
				310	#
				311	# * If no scheme is provided, `https` is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
				312	#
				313	# Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
				314	#
				315	# Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics.
				316	"value": "A String", # Must be a valid serialized protocol buffer of the above specified type.
				317	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	318	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame^]	319	"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]	320	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				321	"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.
				322	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				323	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				324	"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
				325	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				326	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				327	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				328	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				329	"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.
				330	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				331	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				332	{
				333	"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.
				334	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				335	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				336	{
				337	"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).
				338	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				339	},
				340	],
				341	"message": "A String", # [Output Only] A human-readable description of the warning code.
				342	},
				343	],
				344	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				345	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	346	</div>
				347
				348	<div class="method">
				349	<code class="details" id="get">get(project, targetHttpProxy)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	350	<pre>Returns the specified TargetHttpProxy resource. Gets a list of available target HTTP proxies by making a list() request.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	351
				352	Args:
				353	project: string, Project ID for this request. (required)
				354	targetHttpProxy: string, Name of the TargetHttpProxy resource to return. (required)
				355
				356	Returns:
				357	An object of the form:
				358
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	359	{ # Represents a Target HTTP Proxy resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	360	#
				361	# Google Compute Engine has two Target HTTP Proxy resources:
				362	#
				363	# * [Global](/compute/docs/reference/rest/{$api_version}/targetHttpProxies) * [Regional](/compute/docs/reference/rest/{$api_version}/regionTargetHttpProxies)
				364	#
				365	# A target HTTP proxy is a component of GCP HTTP load balancers.
				366	#
				367	# * targetHttpProxies are used by external HTTP load balancers and Traffic Director. * regionTargetHttpProxies are used by internal HTTP load balancers.
				368	#
				369	# Forwarding rules reference a target HTTP proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies and Forwarding rule concepts. (== resource_for {$api_version}.targetHttpProxies ==) (== resource_for {$api_version}.regionTargetHttpProxies ==)
				370	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				371	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				372	"fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a TargetHttpProxy. An up-to-date fingerprint must be provided in order to patch/update the TargetHttpProxy; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the TargetHttpProxy.
				373	"httpFilters": [ # URLs to networkservices.HttpFilter resources enabled for xDS clients using this configuration. For example, https://networkservices.googleapis.com/v1alpha1/projects/project/locations/locationhttpFilters/httpFilter Only filters that handle outbound connection and stream events may be specified. These filters work in conjunction with a default set of HTTP filters that may already be configured by Traffic Director. Traffic Director will determine the final location of these filters within xDS configuration based on the name of the HTTP filter. If Traffic Director positions multiple filters at the same location, those filters will be in the same order as specified in this list.
				374	# httpFilters only applies for loadbalancers with loadBalancingScheme set to INTERNAL_SELF_MANAGED. See ForwardingRule for more details.
				375	"A String",
				376	],
				377	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				378	"kind": "compute#targetHttpProxy", # [Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies.
				379	"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.
				380	"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]	381	#
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	382	# 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.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	383	#
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	384	# The default is false.
				385	"region": "A String", # [Output Only] URL of the region where the regional Target HTTP Proxy resides. This field is not applicable to global Target HTTP Proxies.
				386	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				387	"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
				388	"urlMap": "A String", # URL to the UrlMap resource that defines the mapping from URL to the BackendService.
				389	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	390	</div>
				391
				392	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	393	<code class="details" id="insert">insert(project, body=None, requestId=None)</code>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	394	<pre>Creates a TargetHttpProxy resource in the specified project using the data included in the request.
				395
				396	Args:
				397	project: string, Project ID for this request. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	398	body: object, The request body.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	399	The object takes the form of:
				400
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	401	{ # Represents a Target HTTP Proxy resource.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	402	#
				403	# Google Compute Engine has two Target HTTP Proxy resources:
				404	#
				405	# * [Global](/compute/docs/reference/rest/{$api_version}/targetHttpProxies) * [Regional](/compute/docs/reference/rest/{$api_version}/regionTargetHttpProxies)
				406	#
				407	# A target HTTP proxy is a component of GCP HTTP load balancers.
				408	#
				409	# * targetHttpProxies are used by external HTTP load balancers and Traffic Director. * regionTargetHttpProxies are used by internal HTTP load balancers.
				410	#
				411	# Forwarding rules reference a target HTTP proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies and Forwarding rule concepts. (== resource_for {$api_version}.targetHttpProxies ==) (== resource_for {$api_version}.regionTargetHttpProxies ==)
				412	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				413	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	414	"fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a TargetHttpProxy. An up-to-date fingerprint must be provided in order to patch/update the TargetHttpProxy; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the TargetHttpProxy.
				415	"httpFilters": [ # URLs to networkservices.HttpFilter resources enabled for xDS clients using this configuration. For example, https://networkservices.googleapis.com/v1alpha1/projects/project/locations/locationhttpFilters/httpFilter Only filters that handle outbound connection and stream events may be specified. These filters work in conjunction with a default set of HTTP filters that may already be configured by Traffic Director. Traffic Director will determine the final location of these filters within xDS configuration based on the name of the HTTP filter. If Traffic Director positions multiple filters at the same location, those filters will be in the same order as specified in this list.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	416	# httpFilters only applies for loadbalancers with loadBalancingScheme set to INTERNAL_SELF_MANAGED. See ForwardingRule for more details.
				417	"A String",
				418	],
				419	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				420	"kind": "compute#targetHttpProxy", # [Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies.
				421	"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]	422	"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.
				423	#
				424	# 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.
				425	#
				426	# The default is false.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	427	"region": "A String", # [Output Only] URL of the region where the regional Target HTTP Proxy resides. This field is not applicable to global Target HTTP Proxies.
				428	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				429	"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
				430	"urlMap": "A String", # URL to the UrlMap resource that defines the mapping from URL to the BackendService.
				431	}
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	432
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	433	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.
				434
				435	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.
				436
				437	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]	438
				439	Returns:
				440	An object of the form:
				441
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	442	{ # Represents an Operation resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	443	#
				444	# Google Compute Engine has three Operation resources:
				445	#
				446	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				447	#
				448	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				449	#
				450	# Operations can be global, regional or zonal.
				451	# - For global operations, use the `globalOperations` resource.
				452	# - For regional operations, use the `regionOperations` resource.
				453	# - For zonal operations, use the `zonalOperations` resource.
				454	#
				455	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
				456	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				457	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				458	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				459	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				460	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				461	"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]	462	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	463	"code": "A String", # [Output Only] The error type identifier for this error.
				464	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				465	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	466	},
				467	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	468	},
				469	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				470	"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.
				471	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				472	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				473	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame^]	474	"metadata": { # `Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. # [Output Only] Service-specific metadata attached to this operation.
				475	#
				476	# Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.
				477	#
				478	# Example 1: Pack and unpack a message in C++.
				479	#
				480	# Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... }
				481	#
				482	# Example 2: Pack and unpack a message in Java.
				483	#
				484	# Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); }
				485	#
				486	# Example 3: Pack and unpack a message in Python.
				487	#
				488	# foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ...
				489	#
				490	# Example 4: Pack and unpack a message in Go
				491	#
				492	# foo := &pb.Foo{...} any, err := anypb.New(foo) if err != nil { ... } ... foo := &pb.Foo{} if err := any.UnmarshalTo(foo); err != nil { ... }
				493	#
				494	# The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".
				495	#
				496	#
				497	#
				498	# JSON ==== The JSON representation of an `Any` value uses the regular representation of the deserialized, embedded message, with an additional field `@type` which contains the type URL. Example:
				499	#
				500	# package google.profile; message Person { string first_name = 1; string last_name = 2; }
				501	#
				502	# { "@type": "type.googleapis.com/google.profile.Person", "firstName": , "lastName": }
				503	#
				504	# If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field `value` which holds the custom JSON in addition to the `@type` field. Example (for message [google.protobuf.Duration][]):
				505	#
				506	# { "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }
				507	"typeUrl": "A String", # A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading "." is not accepted).
				508	#
				509	# In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
				510	#
				511	# * If no scheme is provided, `https` is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
				512	#
				513	# Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
				514	#
				515	# Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics.
				516	"value": "A String", # Must be a valid serialized protocol buffer of the above specified type.
				517	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	518	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame^]	519	"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]	520	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				521	"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.
				522	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				523	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				524	"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
				525	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				526	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				527	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				528	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				529	"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.
				530	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				531	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				532	{
				533	"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.
				534	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				535	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				536	{
				537	"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).
				538	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				539	},
				540	],
				541	"message": "A String", # [Output Only] A human-readable description of the warning code.
				542	},
				543	],
				544	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				545	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	546	</div>
				547
				548	<div class="method">
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	549	<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]	550	<pre>Retrieves the list of TargetHttpProxy resources available to the specified project.
				551
				552	Args:
				553	project: string, Project ID for this request. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	554	filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	555
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	556	For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	557
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	558	You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	559
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	560	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) ```
				561	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`)
				562	orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
				563
				564	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.
				565
				566	Currently, only sorting by `name` or `creationTimestamp desc` is supported.
				567	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^]	568	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]	569
				570	Returns:
				571	An object of the form:
				572
				573	{ # A list of TargetHttpProxy resources.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	574	"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
				575	"items": [ # A list of TargetHttpProxy resources.
				576	{ # Represents a Target HTTP Proxy resource.
				577	#
				578	# Google Compute Engine has two Target HTTP Proxy resources:
				579	#
				580	# * [Global](/compute/docs/reference/rest/{$api_version}/targetHttpProxies) * [Regional](/compute/docs/reference/rest/{$api_version}/regionTargetHttpProxies)
				581	#
				582	# A target HTTP proxy is a component of GCP HTTP load balancers.
				583	#
				584	# * targetHttpProxies are used by external HTTP load balancers and Traffic Director. * regionTargetHttpProxies are used by internal HTTP load balancers.
				585	#
				586	# Forwarding rules reference a target HTTP proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies and Forwarding rule concepts. (== resource_for {$api_version}.targetHttpProxies ==) (== resource_for {$api_version}.regionTargetHttpProxies ==)
				587	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				588	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				589	"fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a TargetHttpProxy. An up-to-date fingerprint must be provided in order to patch/update the TargetHttpProxy; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the TargetHttpProxy.
				590	"httpFilters": [ # URLs to networkservices.HttpFilter resources enabled for xDS clients using this configuration. For example, https://networkservices.googleapis.com/v1alpha1/projects/project/locations/locationhttpFilters/httpFilter Only filters that handle outbound connection and stream events may be specified. These filters work in conjunction with a default set of HTTP filters that may already be configured by Traffic Director. Traffic Director will determine the final location of these filters within xDS configuration based on the name of the HTTP filter. If Traffic Director positions multiple filters at the same location, those filters will be in the same order as specified in this list.
				591	# httpFilters only applies for loadbalancers with loadBalancingScheme set to INTERNAL_SELF_MANAGED. See ForwardingRule for more details.
				592	"A String",
				593	],
				594	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				595	"kind": "compute#targetHttpProxy", # [Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies.
				596	"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.
				597	"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]	598	#
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	599	# 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.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	600	#
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	601	# The default is false.
				602	"region": "A String", # [Output Only] URL of the region where the regional Target HTTP Proxy resides. This field is not applicable to global Target HTTP Proxies.
				603	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				604	"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
				605	"urlMap": "A String", # URL to the UrlMap resource that defines the mapping from URL to the BackendService.
				606	},
				607	],
				608	"kind": "compute#targetHttpProxyList", # Type of resource. Always compute#targetHttpProxyList for lists of target HTTP proxies.
				609	"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.
				610	"selfLink": "A String", # [Output Only] Server-defined URL for this resource.
				611	"warning": { # [Output Only] Informational warning message.
				612	"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.
				613	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				614	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				615	{
				616	"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).
				617	"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]	618	},
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	619	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	620	"message": "A String", # [Output Only] A human-readable description of the warning code.
				621	},
				622	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	623	</div>
				624
				625	<div class="method">
				626	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				627	<pre>Retrieves the next page of results.
				628
				629	Args:
				630	previous_request: The request for the previous page. (required)
				631	previous_response: The response from the request for the previous page. (required)
				632
				633	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	634	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]	635	page. Returns None if there are no more items in the collection.
				636	</pre>
				637	</div>
				638
				639	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	640	<code class="details" id="patch">patch(project, targetHttpProxy, body=None, requestId=None)</code>
				641	<pre>Patches the specified TargetHttpProxy resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==)
				642
				643	Args:
				644	project: string, Project ID for this request. (required)
				645	targetHttpProxy: string, Name of the TargetHttpProxy resource to patch. (required)
				646	body: object, The request body.
				647	The object takes the form of:
				648
				649	{ # Represents a Target HTTP Proxy resource.
				650	#
				651	# Google Compute Engine has two Target HTTP Proxy resources:
				652	#
				653	# * [Global](/compute/docs/reference/rest/{$api_version}/targetHttpProxies) * [Regional](/compute/docs/reference/rest/{$api_version}/regionTargetHttpProxies)
				654	#
				655	# A target HTTP proxy is a component of GCP HTTP load balancers.
				656	#
				657	# * targetHttpProxies are used by external HTTP load balancers and Traffic Director. * regionTargetHttpProxies are used by internal HTTP load balancers.
				658	#
				659	# Forwarding rules reference a target HTTP proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies and Forwarding rule concepts. (== resource_for {$api_version}.targetHttpProxies ==) (== resource_for {$api_version}.regionTargetHttpProxies ==)
				660	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				661	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				662	"fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a TargetHttpProxy. An up-to-date fingerprint must be provided in order to patch/update the TargetHttpProxy; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the TargetHttpProxy.
				663	"httpFilters": [ # URLs to networkservices.HttpFilter resources enabled for xDS clients using this configuration. For example, https://networkservices.googleapis.com/v1alpha1/projects/project/locations/locationhttpFilters/httpFilter Only filters that handle outbound connection and stream events may be specified. These filters work in conjunction with a default set of HTTP filters that may already be configured by Traffic Director. Traffic Director will determine the final location of these filters within xDS configuration based on the name of the HTTP filter. If Traffic Director positions multiple filters at the same location, those filters will be in the same order as specified in this list.
				664	# httpFilters only applies for loadbalancers with loadBalancingScheme set to INTERNAL_SELF_MANAGED. See ForwardingRule for more details.
				665	"A String",
				666	],
				667	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				668	"kind": "compute#targetHttpProxy", # [Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies.
				669	"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]	670	"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.
				671	#
				672	# 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.
				673	#
				674	# The default is false.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	675	"region": "A String", # [Output Only] URL of the region where the regional Target HTTP Proxy resides. This field is not applicable to global Target HTTP Proxies.
				676	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				677	"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
				678	"urlMap": "A String", # URL to the UrlMap resource that defines the mapping from URL to the BackendService.
				679	}
				680
				681	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.
				682
				683	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.
				684
				685	The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
				686
				687	Returns:
				688	An object of the form:
				689
				690	{ # Represents an Operation resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	691	#
				692	# Google Compute Engine has three Operation resources:
				693	#
				694	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				695	#
				696	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				697	#
				698	# Operations can be global, regional or zonal.
				699	# - For global operations, use the `globalOperations` resource.
				700	# - For regional operations, use the `regionOperations` resource.
				701	# - For zonal operations, use the `zonalOperations` resource.
				702	#
				703	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
				704	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				705	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				706	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				707	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				708	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				709	"errors": [ # [Output Only] The array of errors encountered while processing this operation.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	710	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	711	"code": "A String", # [Output Only] The error type identifier for this error.
				712	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				713	"message": "A String", # [Output Only] An optional, human-readable error message.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	714	},
				715	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	716	},
				717	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				718	"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.
				719	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				720	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				721	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame^]	722	"metadata": { # `Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. # [Output Only] Service-specific metadata attached to this operation.
				723	#
				724	# Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.
				725	#
				726	# Example 1: Pack and unpack a message in C++.
				727	#
				728	# Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... }
				729	#
				730	# Example 2: Pack and unpack a message in Java.
				731	#
				732	# Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); }
				733	#
				734	# Example 3: Pack and unpack a message in Python.
				735	#
				736	# foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ...
				737	#
				738	# Example 4: Pack and unpack a message in Go
				739	#
				740	# foo := &pb.Foo{...} any, err := anypb.New(foo) if err != nil { ... } ... foo := &pb.Foo{} if err := any.UnmarshalTo(foo); err != nil { ... }
				741	#
				742	# The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".
				743	#
				744	#
				745	#
				746	# JSON ==== The JSON representation of an `Any` value uses the regular representation of the deserialized, embedded message, with an additional field `@type` which contains the type URL. Example:
				747	#
				748	# package google.profile; message Person { string first_name = 1; string last_name = 2; }
				749	#
				750	# { "@type": "type.googleapis.com/google.profile.Person", "firstName": , "lastName": }
				751	#
				752	# If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field `value` which holds the custom JSON in addition to the `@type` field. Example (for message [google.protobuf.Duration][]):
				753	#
				754	# { "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }
				755	"typeUrl": "A String", # A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading "." is not accepted).
				756	#
				757	# In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
				758	#
				759	# * If no scheme is provided, `https` is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
				760	#
				761	# Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
				762	#
				763	# Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics.
				764	"value": "A String", # Must be a valid serialized protocol buffer of the above specified type.
				765	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	766	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame^]	767	"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]	768	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				769	"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.
				770	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				771	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				772	"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
				773	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				774	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				775	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				776	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				777	"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.
				778	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				779	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				780	{
				781	"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.
				782	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				783	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				784	{
				785	"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).
				786	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				787	},
				788	],
				789	"message": "A String", # [Output Only] A human-readable description of the warning code.
				790	},
				791	],
				792	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				793	}</pre>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	794	</div>
				795
				796	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	797	<code class="details" id="setUrlMap">setUrlMap(project, targetHttpProxy, body=None, requestId=None)</code>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	798	<pre>Changes the URL map for TargetHttpProxy.
				799
				800	Args:
				801	project: string, Project ID for this request. (required)
				802	targetHttpProxy: string, Name of the TargetHttpProxy to set a URL map for. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	803	body: object, The request body.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	804	The object takes the form of:
				805
				806	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	807	"urlMap": "A String",
				808	}
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	809
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	810	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.
				811
				812	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.
				813
				814	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]	815
				816	Returns:
				817	An object of the form:
				818
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	819	{ # Represents an Operation resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	820	#
				821	# Google Compute Engine has three Operation resources:
				822	#
				823	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				824	#
				825	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				826	#
				827	# Operations can be global, regional or zonal.
				828	# - For global operations, use the `globalOperations` resource.
				829	# - For regional operations, use the `regionOperations` resource.
				830	# - For zonal operations, use the `zonalOperations` resource.
				831	#
				832	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
				833	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				834	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				835	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				836	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				837	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				838	"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]	839	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	840	"code": "A String", # [Output Only] The error type identifier for this error.
				841	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				842	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	843	},
				844	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	845	},
				846	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				847	"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.
				848	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				849	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				850	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame^]	851	"metadata": { # `Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. # [Output Only] Service-specific metadata attached to this operation.
				852	#
				853	# Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.
				854	#
				855	# Example 1: Pack and unpack a message in C++.
				856	#
				857	# Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... }
				858	#
				859	# Example 2: Pack and unpack a message in Java.
				860	#
				861	# Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); }
				862	#
				863	# Example 3: Pack and unpack a message in Python.
				864	#
				865	# foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ...
				866	#
				867	# Example 4: Pack and unpack a message in Go
				868	#
				869	# foo := &pb.Foo{...} any, err := anypb.New(foo) if err != nil { ... } ... foo := &pb.Foo{} if err := any.UnmarshalTo(foo); err != nil { ... }
				870	#
				871	# The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".
				872	#
				873	#
				874	#
				875	# JSON ==== The JSON representation of an `Any` value uses the regular representation of the deserialized, embedded message, with an additional field `@type` which contains the type URL. Example:
				876	#
				877	# package google.profile; message Person { string first_name = 1; string last_name = 2; }
				878	#
				879	# { "@type": "type.googleapis.com/google.profile.Person", "firstName": , "lastName": }
				880	#
				881	# If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field `value` which holds the custom JSON in addition to the `@type` field. Example (for message [google.protobuf.Duration][]):
				882	#
				883	# { "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }
				884	"typeUrl": "A String", # A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading "." is not accepted).
				885	#
				886	# In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
				887	#
				888	# * If no scheme is provided, `https` is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
				889	#
				890	# Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
				891	#
				892	# Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics.
				893	"value": "A String", # Must be a valid serialized protocol buffer of the above specified type.
				894	},
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	895	"name": "A String", # [Output Only] Name of the operation.
yoshi-code-bot	b6dc1b9	2021-03-02 11:49:08 -0800	[diff] [blame^]	896	"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]	897	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				898	"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.
				899	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				900	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				901	"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
				902	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				903	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				904	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				905	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				906	"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.
				907	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				908	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				909	{
				910	"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.
				911	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				912	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				913	{
				914	"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).
				915	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				916	},
				917	],
				918	"message": "A String", # [Output Only] A human-readable description of the warning code.
				919	},
				920	],
				921	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				922	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	923	</div>
				924
				925	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	926	<code class="details" id="testIamPermissions">testIamPermissions(project, resource, body=None)</code>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	927	<pre>Returns permissions that a caller has on the specified resource.
				928
				929	Args:
				930	project: string, Project ID for this request. (required)
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	931	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]	932	body: object, The request body.
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	933	The object takes the form of:
				934
				935	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	936	"permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '' or 'storage.') are not allowed.
				937	"A String",
				938	],
				939	}
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	940
				941
				942	Returns:
				943	An object of the form:
				944
				945	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	946	"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
				947	"A String",
				948	],
				949	}</pre>
Sai Cheemalapati	df61397	2016-10-21 13:59:49 -0700	[diff] [blame]	950	</div>
				951
				952	</body></html>