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

blob: 789409382b8fb956636d4b915dfd1d3ce7838523 [file] [log] [blame]

Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -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.regionTargetHttpsProxies.html">regionTargetHttpsProxies</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	78	<code><a href="#close">close()</a></code></p>
				79	<p class="firstline">Close httplib2 connections.</p>
				80	<p class="toc_element">
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	81	<code><a href="#delete">delete(project, region, targetHttpsProxy, requestId=None)</a></code></p>
				82	<p class="firstline">Deletes the specified TargetHttpsProxy resource.</p>
				83	<p class="toc_element">
				84	<code><a href="#get">get(project, region, targetHttpsProxy)</a></code></p>
				85	<p class="firstline">Returns the specified TargetHttpsProxy resource in the specified region. Gets a list of available target HTTP proxies by making a list() request.</p>
				86	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	87	<code><a href="#insert">insert(project, region, body=None, requestId=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	88	<p class="firstline">Creates a TargetHttpsProxy resource in the specified project and region using the data included in the request.</p>
				89	<p class="toc_element">
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	90	<code><a href="#list">list(project, region, filter=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]	91	<p class="firstline">Retrieves the list of TargetHttpsProxy resources available to the specified project in the specified region.</p>
				92	<p class="toc_element">
				93	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				94	<p class="firstline">Retrieves the next page of results.</p>
				95	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	96	<code><a href="#setSslCertificates">setSslCertificates(project, region, targetHttpsProxy, body=None, requestId=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	97	<p class="firstline">Replaces SslCertificates for TargetHttpsProxy.</p>
				98	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	99	<code><a href="#setUrlMap">setUrlMap(project, region, targetHttpsProxy, body=None, requestId=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	100	<p class="firstline">Changes the URL map for TargetHttpsProxy.</p>
				101	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	102	<code><a href="#testIamPermissions">testIamPermissions(project, region, resource, body=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	103	<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
				104	<h3>Method Details</h3>
				105	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	106	<code class="details" id="close">close()</code>
				107	<pre>Close httplib2 connections.</pre>
				108	</div>
				109
				110	<div class="method">
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	111	<code class="details" id="delete">delete(project, region, targetHttpsProxy, requestId=None)</code>
				112	<pre>Deletes the specified TargetHttpsProxy resource.
				113
				114	Args:
				115	project: string, Project ID for this request. (required)
				116	region: string, Name of the region scoping this request. (required)
				117	targetHttpsProxy: string, Name of the TargetHttpsProxy resource to delete. (required)
				118	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.
				119
				120	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.
				121
				122	The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
				123
				124	Returns:
				125	An object of the form:
				126
				127	{ # Represents an Operation resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	128	#
				129	# Google Compute Engine has three Operation resources:
				130	#
				131	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				132	#
				133	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				134	#
				135	# Operations can be global, regional or zonal.
				136	# - For global operations, use the `globalOperations` resource.
				137	# - For regional operations, use the `regionOperations` resource.
				138	# - For zonal operations, use the `zonalOperations` resource.
				139	#
				140	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
				141	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				142	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				143	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				144	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				145	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				146	"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]	147	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	148	"code": "A String", # [Output Only] The error type identifier for this error.
				149	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				150	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	151	},
				152	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	153	},
				154	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				155	"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.
				156	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				157	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				158	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				159	"name": "A String", # [Output Only] Name of the operation.
				160	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				161	"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
				162	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				163	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				164	"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
				165	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				166	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				167	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				168	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				169	"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
				170	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				171	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				172	{
				173	"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
				174	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				175	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				176	{
				177	"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
				178	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				179	},
				180	],
				181	"message": "A String", # [Output Only] A human-readable description of the warning code.
				182	},
				183	],
				184	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				185	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	186	</div>
				187
				188	<div class="method">
				189	<code class="details" id="get">get(project, region, targetHttpsProxy)</code>
				190	<pre>Returns the specified TargetHttpsProxy resource in the specified region. Gets a list of available target HTTP proxies by making a list() request.
				191
				192	Args:
				193	project: string, Project ID for this request. (required)
				194	region: string, Name of the region scoping this request. (required)
				195	targetHttpsProxy: string, Name of the TargetHttpsProxy resource to return. (required)
				196
				197	Returns:
				198	An object of the form:
				199
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	200	{ # Represents a Target HTTPS Proxy resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	201	#
				202	# Google Compute Engine has two Target HTTPS Proxy resources:
				203	#
				204	# * [Global](/compute/docs/reference/rest/{$api_version}/targetHttpsProxies) * [Regional](/compute/docs/reference/rest/{$api_version}/regionTargetHttpsProxies)
				205	#
				206	# A target HTTPS proxy is a component of GCP HTTPS load balancers.
				207	#
				208	# * targetHttpsProxies are used by external HTTPS load balancers. * regionTargetHttpsProxies are used by internal HTTPS load balancers.
				209	#
				210	# Forwarding rules reference a target HTTPS 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}.targetHttpsProxies ==) (== resource_for {$api_version}.regionTargetHttpsProxies ==)
				211	"authentication": "A String", # [Deprecated] Use serverTlsPolicy instead.
				212	"authorization": "A String", # [Deprecated] Use authorizationPolicy instead.
				213	"authorizationPolicy": "A String", # Optional. A URL referring to a networksecurity.AuthorizationPolicy resource that describes how the proxy should authorize inbound traffic. If left blank, access will not be restricted by an authorization policy.
				214	# Refer to the AuthorizationPolicy resource for additional details.
				215	# authorizationPolicy only applies to a global TargetHttpsProxy attached to globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED.
				216	# Note: This field currently has no impact.
				217	"certificateMap": "A String", # URL of a certificate map that identifies a certificate map associated with the given target proxy. This field can only be set for global target proxies. If set, sslCertificates will be ignored.
				218	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				219	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				220	"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 TargetHttpsProxy. An up-to-date fingerprint must be provided in order to patch the TargetHttpsProxy; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the TargetHttpsProxy.
				221	"httpFilters": [ # URLs to networkservices.HttpFilter resources enabled for xDS clients using this configuration. For example, https://networkservices.googleapis.com/beta/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.
				222	# httpFilters only applies for loadbalancers with loadBalancingScheme set to INTERNAL_SELF_MANAGED. See ForwardingRule for more details.
				223	"A String",
				224	],
				225	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				226	"kind": "compute#targetHttpsProxy", # [Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies.
				227	"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.
				228	"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]	229	#
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	230	# 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]	231	#
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	232	# The default is false.
				233	"quicOverride": "A String", # Specifies the QUIC override policy for this TargetHttpsProxy resource. This setting determines whether the load balancer attempts to negotiate QUIC with clients. You can specify NONE, ENABLE, or DISABLE.
				234	# - When quic-override is set to NONE, Google manages whether QUIC is used.
				235	# - When quic-override is set to ENABLE, the load balancer uses QUIC when possible.
				236	# - When quic-override is set to DISABLE, the load balancer doesn't use QUIC.
				237	# - If the quic-override flag is not specified, NONE is implied.
				238	# -
				239	"region": "A String", # [Output Only] URL of the region where the regional TargetHttpsProxy resides. This field is not applicable to global TargetHttpsProxies.
				240	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				241	"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
				242	"serverTlsPolicy": "A String", # Optional. A URL referring to a networksecurity.ServerTlsPolicy resource that describes how the proxy should authenticate inbound traffic.
				243	# serverTlsPolicy only applies to a global TargetHttpsProxy attached to globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED.
				244	# If left blank, communications are not encrypted.
				245	# Note: This field currently has no impact.
				246	"sslCertificates": [ # URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates.
				247	"A String",
				248	],
				249	"sslPolicy": "A String", # URL of SslPolicy resource that will be associated with the TargetHttpsProxy resource. If not set, the TargetHttpsProxy resource has no SSL policy configured.
				250	"urlMap": "A String", # A fully-qualified or valid partial URL to the UrlMap resource that defines the mapping from URL to the BackendService. For example, the following are all valid URLs for specifying a URL map:
				251	# - https://www.googleapis.compute/v1/projects/project/global/urlMaps/url-map
				252	# - projects/project/global/urlMaps/url-map
				253	# - global/urlMaps/url-map
				254	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	255	</div>
				256
				257	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	258	<code class="details" id="insert">insert(project, region, body=None, requestId=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	259	<pre>Creates a TargetHttpsProxy resource in the specified project and region using the data included in the request.
				260
				261	Args:
				262	project: string, Project ID for this request. (required)
				263	region: string, Name of the region scoping this request. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	264	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	265	The object takes the form of:
				266
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	267	{ # Represents a Target HTTPS Proxy resource.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	268	#
				269	# Google Compute Engine has two Target HTTPS Proxy resources:
				270	#
				271	# * [Global](/compute/docs/reference/rest/{$api_version}/targetHttpsProxies) * [Regional](/compute/docs/reference/rest/{$api_version}/regionTargetHttpsProxies)
				272	#
				273	# A target HTTPS proxy is a component of GCP HTTPS load balancers.
				274	#
				275	# * targetHttpsProxies are used by external HTTPS load balancers. * regionTargetHttpsProxies are used by internal HTTPS load balancers.
				276	#
				277	# Forwarding rules reference a target HTTPS 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}.targetHttpsProxies ==) (== resource_for {$api_version}.regionTargetHttpsProxies ==)
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	278	"authentication": "A String", # [Deprecated] Use serverTlsPolicy instead.
				279	"authorization": "A String", # [Deprecated] Use authorizationPolicy instead.
				280	"authorizationPolicy": "A String", # Optional. A URL referring to a networksecurity.AuthorizationPolicy resource that describes how the proxy should authorize inbound traffic. If left blank, access will not be restricted by an authorization policy.
				281	# Refer to the AuthorizationPolicy resource for additional details.
				282	# authorizationPolicy only applies to a global TargetHttpsProxy attached to globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	283	# Note: This field currently has no impact.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	284	"certificateMap": "A String", # URL of a certificate map that identifies a certificate map associated with the given target proxy. This field can only be set for global target proxies. If set, sslCertificates will be ignored.
				285	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				286	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	287	"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 TargetHttpsProxy. An up-to-date fingerprint must be provided in order to patch the TargetHttpsProxy; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the TargetHttpsProxy.
				288	"httpFilters": [ # URLs to networkservices.HttpFilter resources enabled for xDS clients using this configuration. For example, https://networkservices.googleapis.com/beta/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.
				289	# httpFilters only applies for loadbalancers with loadBalancingScheme set to INTERNAL_SELF_MANAGED. See ForwardingRule for more details.
				290	"A String",
				291	],
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	292	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				293	"kind": "compute#targetHttpsProxy", # [Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies.
				294	"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]	295	"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.
				296	#
				297	# 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.
				298	#
				299	# The default is false.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	300	"quicOverride": "A String", # Specifies the QUIC override policy for this TargetHttpsProxy resource. This setting determines whether the load balancer attempts to negotiate QUIC with clients. You can specify NONE, ENABLE, or DISABLE.
				301	# - When quic-override is set to NONE, Google manages whether QUIC is used.
				302	# - When quic-override is set to ENABLE, the load balancer uses QUIC when possible.
				303	# - When quic-override is set to DISABLE, the load balancer doesn't use QUIC.
				304	# - If the quic-override flag is not specified, NONE is implied.
				305	# -
				306	"region": "A String", # [Output Only] URL of the region where the regional TargetHttpsProxy resides. This field is not applicable to global TargetHttpsProxies.
				307	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				308	"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	309	"serverTlsPolicy": "A String", # Optional. A URL referring to a networksecurity.ServerTlsPolicy resource that describes how the proxy should authenticate inbound traffic.
				310	# serverTlsPolicy only applies to a global TargetHttpsProxy attached to globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED.
				311	# If left blank, communications are not encrypted.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	312	# Note: This field currently has no impact.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	313	"sslCertificates": [ # URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates.
				314	"A String",
				315	],
				316	"sslPolicy": "A String", # URL of SslPolicy resource that will be associated with the TargetHttpsProxy resource. If not set, the TargetHttpsProxy resource has no SSL policy configured.
				317	"urlMap": "A String", # A fully-qualified or valid partial URL to the UrlMap resource that defines the mapping from URL to the BackendService. For example, the following are all valid URLs for specifying a URL map:
				318	# - https://www.googleapis.compute/v1/projects/project/global/urlMaps/url-map
				319	# - projects/project/global/urlMaps/url-map
				320	# - global/urlMaps/url-map
				321	}
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	322
				323	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.
				324
				325	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.
				326
				327	The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
				328
				329	Returns:
				330	An object of the form:
				331
				332	{ # Represents an Operation resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	333	#
				334	# Google Compute Engine has three Operation resources:
				335	#
				336	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				337	#
				338	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				339	#
				340	# Operations can be global, regional or zonal.
				341	# - For global operations, use the `globalOperations` resource.
				342	# - For regional operations, use the `regionOperations` resource.
				343	# - For zonal operations, use the `zonalOperations` resource.
				344	#
				345	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
				346	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				347	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				348	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				349	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				350	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				351	"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]	352	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	353	"code": "A String", # [Output Only] The error type identifier for this error.
				354	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				355	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	356	},
				357	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	358	},
				359	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				360	"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.
				361	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				362	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				363	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				364	"name": "A String", # [Output Only] Name of the operation.
				365	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				366	"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.
				367	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				368	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				369	"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
				370	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				371	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				372	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				373	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				374	"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.
				375	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				376	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				377	{
				378	"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.
				379	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				380	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				381	{
				382	"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).
				383	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				384	},
				385	],
				386	"message": "A String", # [Output Only] A human-readable description of the warning code.
				387	},
				388	],
				389	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				390	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	391	</div>
				392
				393	<div class="method">
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	394	<code class="details" id="list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	395	<pre>Retrieves the list of TargetHttpsProxy resources available to the specified project in the specified region.
				396
				397	Args:
				398	project: string, Project ID for this request. (required)
				399	region: string, Name of the region scoping this request. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	400	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]	401
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	402	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]	403
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	404	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]	405
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	406	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) ```
				407	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`)
				408	orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
				409
				410	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.
				411
				412	Currently, only sorting by `name` or `creationTimestamp desc` is supported.
				413	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.
				414	returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	415
				416	Returns:
				417	An object of the form:
				418
				419	{ # Contains a list of TargetHttpsProxy resources.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	420	"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
				421	"items": [ # A list of TargetHttpsProxy resources.
				422	{ # Represents a Target HTTPS Proxy resource.
				423	#
				424	# Google Compute Engine has two Target HTTPS Proxy resources:
				425	#
				426	# * [Global](/compute/docs/reference/rest/{$api_version}/targetHttpsProxies) * [Regional](/compute/docs/reference/rest/{$api_version}/regionTargetHttpsProxies)
				427	#
				428	# A target HTTPS proxy is a component of GCP HTTPS load balancers.
				429	#
				430	# * targetHttpsProxies are used by external HTTPS load balancers. * regionTargetHttpsProxies are used by internal HTTPS load balancers.
				431	#
				432	# Forwarding rules reference a target HTTPS 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}.targetHttpsProxies ==) (== resource_for {$api_version}.regionTargetHttpsProxies ==)
				433	"authentication": "A String", # [Deprecated] Use serverTlsPolicy instead.
				434	"authorization": "A String", # [Deprecated] Use authorizationPolicy instead.
				435	"authorizationPolicy": "A String", # Optional. A URL referring to a networksecurity.AuthorizationPolicy resource that describes how the proxy should authorize inbound traffic. If left blank, access will not be restricted by an authorization policy.
				436	# Refer to the AuthorizationPolicy resource for additional details.
				437	# authorizationPolicy only applies to a global TargetHttpsProxy attached to globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED.
				438	# Note: This field currently has no impact.
				439	"certificateMap": "A String", # URL of a certificate map that identifies a certificate map associated with the given target proxy. This field can only be set for global target proxies. If set, sslCertificates will be ignored.
				440	"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
				441	"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
				442	"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 TargetHttpsProxy. An up-to-date fingerprint must be provided in order to patch the TargetHttpsProxy; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the TargetHttpsProxy.
				443	"httpFilters": [ # URLs to networkservices.HttpFilter resources enabled for xDS clients using this configuration. For example, https://networkservices.googleapis.com/beta/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.
				444	# httpFilters only applies for loadbalancers with loadBalancingScheme set to INTERNAL_SELF_MANAGED. See ForwardingRule for more details.
				445	"A String",
				446	],
				447	"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
				448	"kind": "compute#targetHttpsProxy", # [Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies.
				449	"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.
				450	"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]	451	#
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	452	# 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]	453	#
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	454	# The default is false.
				455	"quicOverride": "A String", # Specifies the QUIC override policy for this TargetHttpsProxy resource. This setting determines whether the load balancer attempts to negotiate QUIC with clients. You can specify NONE, ENABLE, or DISABLE.
				456	# - When quic-override is set to NONE, Google manages whether QUIC is used.
				457	# - When quic-override is set to ENABLE, the load balancer uses QUIC when possible.
				458	# - When quic-override is set to DISABLE, the load balancer doesn't use QUIC.
				459	# - If the quic-override flag is not specified, NONE is implied.
				460	# -
				461	"region": "A String", # [Output Only] URL of the region where the regional TargetHttpsProxy resides. This field is not applicable to global TargetHttpsProxies.
				462	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				463	"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
				464	"serverTlsPolicy": "A String", # Optional. A URL referring to a networksecurity.ServerTlsPolicy resource that describes how the proxy should authenticate inbound traffic.
				465	# serverTlsPolicy only applies to a global TargetHttpsProxy attached to globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED.
				466	# If left blank, communications are not encrypted.
				467	# Note: This field currently has no impact.
				468	"sslCertificates": [ # URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates.
				469	"A String",
				470	],
				471	"sslPolicy": "A String", # URL of SslPolicy resource that will be associated with the TargetHttpsProxy resource. If not set, the TargetHttpsProxy resource has no SSL policy configured.
				472	"urlMap": "A String", # A fully-qualified or valid partial URL to the UrlMap resource that defines the mapping from URL to the BackendService. For example, the following are all valid URLs for specifying a URL map:
				473	# - https://www.googleapis.compute/v1/projects/project/global/urlMaps/url-map
				474	# - projects/project/global/urlMaps/url-map
				475	# - global/urlMaps/url-map
				476	},
				477	],
				478	"kind": "compute#targetHttpsProxyList", # Type of resource. Always compute#targetHttpsProxyList for lists of target HTTPS proxies.
				479	"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.
				480	"selfLink": "A String", # [Output Only] Server-defined URL for this resource.
				481	"warning": { # [Output Only] Informational warning message.
				482	"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.
				483	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				484	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				485	{
				486	"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).
				487	"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]	488	},
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	489	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	490	"message": "A String", # [Output Only] A human-readable description of the warning code.
				491	},
				492	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	493	</div>
				494
				495	<div class="method">
				496	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				497	<pre>Retrieves the next page of results.
				498
				499	Args:
				500	previous_request: The request for the previous page. (required)
				501	previous_response: The response from the request for the previous page. (required)
				502
				503	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	504	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]	505	page. Returns None if there are no more items in the collection.
				506	</pre>
				507	</div>
				508
				509	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	510	<code class="details" id="setSslCertificates">setSslCertificates(project, region, targetHttpsProxy, body=None, requestId=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	511	<pre>Replaces SslCertificates for TargetHttpsProxy.
				512
				513	Args:
				514	project: string, Project ID for this request. (required)
				515	region: string, Name of the region scoping this request. (required)
				516	targetHttpsProxy: string, Name of the TargetHttpsProxy resource to set an SslCertificates resource for. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	517	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	518	The object takes the form of:
				519
				520	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	521	"sslCertificates": [ # New set of SslCertificate resources to associate with this TargetHttpsProxy resource. Currently exactly one SslCertificate resource must be specified.
				522	"A String",
				523	],
				524	}
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	525
				526	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.
				527
				528	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.
				529
				530	The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
				531
				532	Returns:
				533	An object of the form:
				534
				535	{ # Represents an Operation resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	536	#
				537	# Google Compute Engine has three Operation resources:
				538	#
				539	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				540	#
				541	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				542	#
				543	# Operations can be global, regional or zonal.
				544	# - For global operations, use the `globalOperations` resource.
				545	# - For regional operations, use the `regionOperations` resource.
				546	# - For zonal operations, use the `zonalOperations` resource.
				547	#
				548	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
				549	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				550	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				551	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				552	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				553	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				554	"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]	555	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	556	"code": "A String", # [Output Only] The error type identifier for this error.
				557	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				558	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	559	},
				560	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	561	},
				562	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				563	"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.
				564	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				565	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				566	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				567	"name": "A String", # [Output Only] Name of the operation.
				568	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				569	"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.
				570	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				571	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				572	"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
				573	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				574	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				575	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				576	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				577	"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.
				578	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				579	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				580	{
				581	"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.
				582	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				583	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				584	{
				585	"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).
				586	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				587	},
				588	],
				589	"message": "A String", # [Output Only] A human-readable description of the warning code.
				590	},
				591	],
				592	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				593	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	594	</div>
				595
				596	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	597	<code class="details" id="setUrlMap">setUrlMap(project, region, targetHttpsProxy, body=None, requestId=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	598	<pre>Changes the URL map for TargetHttpsProxy.
				599
				600	Args:
				601	project: string, Project ID for this request. (required)
				602	region: string, Name of the region scoping this request. (required)
				603	targetHttpsProxy: string, Name of the TargetHttpsProxy to set a URL map for. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	604	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	605	The object takes the form of:
				606
				607	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	608	"urlMap": "A String",
				609	}
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	610
				611	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.
				612
				613	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.
				614
				615	The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
				616
				617	Returns:
				618	An object of the form:
				619
				620	{ # Represents an Operation resource.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	621	#
				622	# Google Compute Engine has three Operation resources:
				623	#
				624	# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
				625	#
				626	# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
				627	#
				628	# Operations can be global, regional or zonal.
				629	# - For global operations, use the `globalOperations` resource.
				630	# - For regional operations, use the `regionOperations` resource.
				631	# - For zonal operations, use the `zonalOperations` resource.
				632	#
				633	# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
				634	"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
				635	"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
				636	"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
				637	"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
				638	"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
				639	"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]	640	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	641	"code": "A String", # [Output Only] The error type identifier for this error.
				642	"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
				643	"message": "A String", # [Output Only] An optional, human-readable error message.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	644	},
				645	],
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	646	},
				647	"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
				648	"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.
				649	"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
				650	"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
				651	"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
				652	"name": "A String", # [Output Only] Name of the operation.
				653	"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
				654	"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.
				655	"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
				656	"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
				657	"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
				658	"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
				659	"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
				660	"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
				661	"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
				662	"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.
				663	"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
				664	"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
				665	{
				666	"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.
				667	"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
				668	# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
				669	{
				670	"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).
				671	"value": "A String", # [Output Only] A warning data value corresponding to the key.
				672	},
				673	],
				674	"message": "A String", # [Output Only] A human-readable description of the warning code.
				675	},
				676	],
				677	"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
				678	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	679	</div>
				680
				681	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	682	<code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	683	<pre>Returns permissions that a caller has on the specified resource.
				684
				685	Args:
				686	project: string, Project ID for this request. (required)
				687	region: string, The name of the region for this request. (required)
				688	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]	689	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	690	The object takes the form of:
				691
				692	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	693	"permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '' or 'storage.') are not allowed.
				694	"A String",
				695	],
				696	}
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	697
				698
				699	Returns:
				700	An object of the form:
				701
				702	{
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame^]	703	"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
				704	"A String",
				705	],
				706	}</pre>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	707	</div>
				708
				709	</body></html>