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

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