blob: c993724735d7542ce3b9f3cc2ac420c5f103b3a2 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001<html><body>
2<style>
3
4body, 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
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, 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 Frenkel3e17f892020-10-06 16:46:05 -070078 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070081 <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'Mearadd494642020-05-01 07:42:23 -070087 <code><a href="#insert">insert(project, region, body=None, requestId=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070088<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 Kim65020912020-05-20 12:08:20 -070090 <code><a href="#list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070091<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'Mearadd494642020-05-01 07:42:23 -070096 <code><a href="#setSslCertificates">setSslCertificates(project, region, targetHttpsProxy, body=None, requestId=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070097<p class="firstline">Replaces SslCertificates for TargetHttpsProxy.</p>
98<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070099 <code><a href="#setUrlMap">setUrlMap(project, region, targetHttpsProxy, body=None, requestId=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700100<p class="firstline">Changes the URL map for TargetHttpsProxy.</p>
101<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700102 <code><a href="#testIamPermissions">testIamPermissions(project, region, resource, body=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700103<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
104<h3>Method Details</h3>
105<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700106 <code class="details" id="close">close()</code>
107 <pre>Close httplib2 connections.</pre>
108</div>
109
110<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700111 <code class="details" id="delete">delete(project, region, targetHttpsProxy, requestId=None)</code>
112 <pre>Deletes the specified TargetHttpsProxy resource.
113
114Args:
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
120For 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
122The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
123
124Returns:
125 An object of the form:
126
127 { # Represents an Operation resource.
128 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700129 # 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 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700133 # 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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700136 # - For global operations, use the `globalOperations` resource.
137 # - For regional operations, use the `regionOperations` resource.
138 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700139 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700140 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Bu Sun Kim65020912020-05-20 12:08:20 -0700141 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
142 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
143 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
144 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
145 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
146 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700147 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700148 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
149 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
150 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700151 },
152 ],
153 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700154 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
155 &quot;httpErrorStatusCode&quot;: 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 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
157 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
158 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
159 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
160 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
161 &quot;progress&quot;: 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 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
163 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
164 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource with the resource id.
165 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
166 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
167 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
168 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
169 &quot;targetLink&quot;: &quot;A String&quot;, # [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 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
171 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
172 {
173 &quot;code&quot;: &quot;A String&quot;, # [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 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
175 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
176 {
177 &quot;key&quot;: &quot;A String&quot;, # [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 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
179 },
180 ],
181 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
182 },
183 ],
184 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700185 }</pre>
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
192Args:
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
197Returns:
198 An object of the form:
199
Dan O'Mearadd494642020-05-01 07:42:23 -0700200 { # Represents a Target HTTPS Proxy resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700201 #
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 ==)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700211 &quot;authentication&quot;: &quot;A String&quot;, # [Deprecated] Use serverTlsPolicy instead.
212 &quot;authorization&quot;: &quot;A String&quot;, # [Deprecated] Use authorizationPolicy instead.
213 &quot;authorizationPolicy&quot;: &quot;A String&quot;, # 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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700216 # Note: This field currently has no impact.
Bu Sun Kim65020912020-05-20 12:08:20 -0700217 &quot;certificateMap&quot;: &quot;A String&quot;, # 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 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp in RFC3339 text format.
219 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you create the resource.
220 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
221 &quot;kind&quot;: &quot;compute#targetHttpsProxy&quot;, # [Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies.
222 &quot;name&quot;: &quot;A String&quot;, # 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.
223 &quot;proxyBind&quot;: True or False, # This field only applies when the loadBalancingScheme is INTERNAL_SELF_MANAGED. When set to true the Envoy binds on the IP address specified by the forwarding rule. Default is false.
224 &quot;quicOverride&quot;: &quot;A String&quot;, # 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.
225 # - When quic-override is set to NONE, Google manages whether QUIC is used.
226 # - When quic-override is set to ENABLE, the load balancer uses QUIC when possible.
227 # - When quic-override is set to DISABLE, the load balancer doesn&#x27;t use QUIC.
228 # - If the quic-override flag is not specified, NONE is implied.
229 # -
230 &quot;region&quot;: &quot;A String&quot;, # [Output Only] URL of the region where the regional TargetHttpsProxy resides. This field is not applicable to global TargetHttpsProxies.
231 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
232 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource with the resource id.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700233 &quot;serverTlsPolicy&quot;: &quot;A String&quot;, # Optional. A URL referring to a networksecurity.ServerTlsPolicy resource that describes how the proxy should authenticate inbound traffic.
234 # serverTlsPolicy only applies to a global TargetHttpsProxy attached to globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED.
235 # If left blank, communications are not encrypted.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700236 # Note: This field currently has no impact.
Bu Sun Kim65020912020-05-20 12:08:20 -0700237 &quot;sslCertificates&quot;: [ # 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.
238 &quot;A String&quot;,
239 ],
240 &quot;sslPolicy&quot;: &quot;A String&quot;, # URL of SslPolicy resource that will be associated with the TargetHttpsProxy resource. If not set, the TargetHttpsProxy resource has no SSL policy configured.
241 &quot;urlMap&quot;: &quot;A String&quot;, # 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:
242 # - https://www.googleapis.compute/v1/projects/project/global/urlMaps/url-map
243 # - projects/project/global/urlMaps/url-map
244 # - global/urlMaps/url-map
245 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700246</div>
247
248<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700249 <code class="details" id="insert">insert(project, region, body=None, requestId=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700250 <pre>Creates a TargetHttpsProxy resource in the specified project and region using the data included in the request.
251
252Args:
253 project: string, Project ID for this request. (required)
254 region: string, Name of the region scoping this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700255 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700256 The object takes the form of:
257
Dan O'Mearadd494642020-05-01 07:42:23 -0700258{ # Represents a Target HTTPS Proxy resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700259 #
260 # Google Compute Engine has two Target HTTPS Proxy resources:
261 #
262 # * [Global](/compute/docs/reference/rest/{$api_version}/targetHttpsProxies) * [Regional](/compute/docs/reference/rest/{$api_version}/regionTargetHttpsProxies)
263 #
264 # A target HTTPS proxy is a component of GCP HTTPS load balancers.
265 #
266 # * targetHttpsProxies are used by external HTTPS load balancers. * regionTargetHttpsProxies are used by internal HTTPS load balancers.
267 #
268 # 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 Kimd059ad82020-07-22 17:02:09 -0700269 &quot;authentication&quot;: &quot;A String&quot;, # [Deprecated] Use serverTlsPolicy instead.
270 &quot;authorization&quot;: &quot;A String&quot;, # [Deprecated] Use authorizationPolicy instead.
271 &quot;authorizationPolicy&quot;: &quot;A String&quot;, # 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.
272 # Refer to the AuthorizationPolicy resource for additional details.
273 # authorizationPolicy only applies to a global TargetHttpsProxy attached to globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700274 # Note: This field currently has no impact.
Bu Sun Kim65020912020-05-20 12:08:20 -0700275 &quot;certificateMap&quot;: &quot;A String&quot;, # 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.
276 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp in RFC3339 text format.
277 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you create the resource.
278 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
279 &quot;kind&quot;: &quot;compute#targetHttpsProxy&quot;, # [Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies.
280 &quot;name&quot;: &quot;A String&quot;, # 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.
281 &quot;proxyBind&quot;: True or False, # This field only applies when the loadBalancingScheme is INTERNAL_SELF_MANAGED. When set to true the Envoy binds on the IP address specified by the forwarding rule. Default is false.
282 &quot;quicOverride&quot;: &quot;A String&quot;, # 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.
283 # - When quic-override is set to NONE, Google manages whether QUIC is used.
284 # - When quic-override is set to ENABLE, the load balancer uses QUIC when possible.
285 # - When quic-override is set to DISABLE, the load balancer doesn&#x27;t use QUIC.
286 # - If the quic-override flag is not specified, NONE is implied.
287 # -
288 &quot;region&quot;: &quot;A String&quot;, # [Output Only] URL of the region where the regional TargetHttpsProxy resides. This field is not applicable to global TargetHttpsProxies.
289 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
290 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource with the resource id.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700291 &quot;serverTlsPolicy&quot;: &quot;A String&quot;, # Optional. A URL referring to a networksecurity.ServerTlsPolicy resource that describes how the proxy should authenticate inbound traffic.
292 # serverTlsPolicy only applies to a global TargetHttpsProxy attached to globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED.
293 # If left blank, communications are not encrypted.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700294 # Note: This field currently has no impact.
Bu Sun Kim65020912020-05-20 12:08:20 -0700295 &quot;sslCertificates&quot;: [ # 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.
296 &quot;A String&quot;,
297 ],
298 &quot;sslPolicy&quot;: &quot;A String&quot;, # URL of SslPolicy resource that will be associated with the TargetHttpsProxy resource. If not set, the TargetHttpsProxy resource has no SSL policy configured.
299 &quot;urlMap&quot;: &quot;A String&quot;, # 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:
300 # - https://www.googleapis.compute/v1/projects/project/global/urlMaps/url-map
301 # - projects/project/global/urlMaps/url-map
302 # - global/urlMaps/url-map
303}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700304
305 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.
306
307For 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.
308
309The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
310
311Returns:
312 An object of the form:
313
314 { # Represents an Operation resource.
315 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700316 # Google Compute Engine has three Operation resources:
317 #
318 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
319 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700320 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
321 #
322 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700323 # - For global operations, use the `globalOperations` resource.
324 # - For regional operations, use the `regionOperations` resource.
325 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700326 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700327 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Bu Sun Kim65020912020-05-20 12:08:20 -0700328 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
329 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
330 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
331 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
332 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
333 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700334 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700335 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
336 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
337 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700338 },
339 ],
340 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700341 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
342 &quot;httpErrorStatusCode&quot;: 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.
343 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
344 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
345 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
346 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
347 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
348 &quot;progress&quot;: 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.
349 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
350 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
351 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource with the resource id.
352 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
353 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
354 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
355 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
356 &quot;targetLink&quot;: &quot;A String&quot;, # [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.
357 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
358 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
359 {
360 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
361 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
362 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
363 {
364 &quot;key&quot;: &quot;A String&quot;, # [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).
365 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
366 },
367 ],
368 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
369 },
370 ],
371 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700372 }</pre>
373</div>
374
375<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700376 <code class="details" id="list">list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700377 <pre>Retrieves the list of TargetHttpsProxy resources available to the specified project in the specified region.
378
379Args:
380 project: string, Project ID for this request. (required)
381 region: string, Name of the region scoping this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700382 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 `=`, `!=`, `&gt;`, or `&lt;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700383
Dan O'Mearadd494642020-05-01 07:42:23 -0700384For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700385
Dan O'Mearadd494642020-05-01 07:42:23 -0700386You 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 Kim715bd7f2019-06-14 16:50:42 -0700387
Bu Sun Kim65020912020-05-20 12:08:20 -0700388To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = &quot;Intel Skylake&quot;) ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = &quot;Intel Skylake&quot;) OR (cpuPlatform = &quot;Intel Broadwell&quot;) AND (scheduling.automaticRestart = true) ```
389 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`)
390 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
391
392You can also sort results in descending order based on the creation timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. 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.
393
394Currently, only sorting by `name` or `creationTimestamp desc` is supported.
395 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.
396 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 Kim715bd7f2019-06-14 16:50:42 -0700397
398Returns:
399 An object of the form:
400
401 { # Contains a list of TargetHttpsProxy resources.
Bu Sun Kim65020912020-05-20 12:08:20 -0700402 &quot;id&quot;: &quot;A String&quot;, # [Output Only] Unique identifier for the resource; defined by the server.
403 &quot;items&quot;: [ # A list of TargetHttpsProxy resources.
Dan O'Mearadd494642020-05-01 07:42:23 -0700404 { # Represents a Target HTTPS Proxy resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700405 #
406 # Google Compute Engine has two Target HTTPS Proxy resources:
407 #
408 # * [Global](/compute/docs/reference/rest/{$api_version}/targetHttpsProxies) * [Regional](/compute/docs/reference/rest/{$api_version}/regionTargetHttpsProxies)
409 #
410 # A target HTTPS proxy is a component of GCP HTTPS load balancers.
411 #
412 # * targetHttpsProxies are used by external HTTPS load balancers. * regionTargetHttpsProxies are used by internal HTTPS load balancers.
413 #
414 # 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 Kimd059ad82020-07-22 17:02:09 -0700415 &quot;authentication&quot;: &quot;A String&quot;, # [Deprecated] Use serverTlsPolicy instead.
416 &quot;authorization&quot;: &quot;A String&quot;, # [Deprecated] Use authorizationPolicy instead.
417 &quot;authorizationPolicy&quot;: &quot;A String&quot;, # 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.
418 # Refer to the AuthorizationPolicy resource for additional details.
419 # authorizationPolicy only applies to a global TargetHttpsProxy attached to globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700420 # Note: This field currently has no impact.
Bu Sun Kim65020912020-05-20 12:08:20 -0700421 &quot;certificateMap&quot;: &quot;A String&quot;, # 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.
422 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Output Only] Creation timestamp in RFC3339 text format.
423 &quot;description&quot;: &quot;A String&quot;, # An optional description of this resource. Provide this property when you create the resource.
424 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
425 &quot;kind&quot;: &quot;compute#targetHttpsProxy&quot;, # [Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies.
426 &quot;name&quot;: &quot;A String&quot;, # 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.
427 &quot;proxyBind&quot;: True or False, # This field only applies when the loadBalancingScheme is INTERNAL_SELF_MANAGED. When set to true the Envoy binds on the IP address specified by the forwarding rule. Default is false.
428 &quot;quicOverride&quot;: &quot;A String&quot;, # 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.
429 # - When quic-override is set to NONE, Google manages whether QUIC is used.
430 # - When quic-override is set to ENABLE, the load balancer uses QUIC when possible.
431 # - When quic-override is set to DISABLE, the load balancer doesn&#x27;t use QUIC.
432 # - If the quic-override flag is not specified, NONE is implied.
433 # -
434 &quot;region&quot;: &quot;A String&quot;, # [Output Only] URL of the region where the regional TargetHttpsProxy resides. This field is not applicable to global TargetHttpsProxies.
435 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
436 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource with the resource id.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700437 &quot;serverTlsPolicy&quot;: &quot;A String&quot;, # Optional. A URL referring to a networksecurity.ServerTlsPolicy resource that describes how the proxy should authenticate inbound traffic.
438 # serverTlsPolicy only applies to a global TargetHttpsProxy attached to globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED.
439 # If left blank, communications are not encrypted.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700440 # Note: This field currently has no impact.
Bu Sun Kim65020912020-05-20 12:08:20 -0700441 &quot;sslCertificates&quot;: [ # 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.
442 &quot;A String&quot;,
443 ],
444 &quot;sslPolicy&quot;: &quot;A String&quot;, # URL of SslPolicy resource that will be associated with the TargetHttpsProxy resource. If not set, the TargetHttpsProxy resource has no SSL policy configured.
445 &quot;urlMap&quot;: &quot;A String&quot;, # 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:
446 # - https://www.googleapis.compute/v1/projects/project/global/urlMaps/url-map
447 # - projects/project/global/urlMaps/url-map
448 # - global/urlMaps/url-map
449 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700450 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700451 &quot;kind&quot;: &quot;compute#targetHttpsProxyList&quot;, # Type of resource. Always compute#targetHttpsProxyList for lists of target HTTPS proxies.
452 &quot;nextPageToken&quot;: &quot;A String&quot;, # [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.
453 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource.
454 &quot;warning&quot;: { # [Output Only] Informational warning message.
455 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
456 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
457 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700458 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700459 &quot;key&quot;: &quot;A String&quot;, # [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).
460 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700461 },
462 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700463 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700464 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700465 }</pre>
466</div>
467
468<div class="method">
469 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
470 <pre>Retrieves the next page of results.
471
472Args:
473 previous_request: The request for the previous page. (required)
474 previous_response: The response from the request for the previous page. (required)
475
476Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700477 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700478 page. Returns None if there are no more items in the collection.
479 </pre>
480</div>
481
482<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700483 <code class="details" id="setSslCertificates">setSslCertificates(project, region, targetHttpsProxy, body=None, requestId=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700484 <pre>Replaces SslCertificates for TargetHttpsProxy.
485
486Args:
487 project: string, Project ID for this request. (required)
488 region: string, Name of the region scoping this request. (required)
489 targetHttpsProxy: string, Name of the TargetHttpsProxy resource to set an SslCertificates resource for. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700490 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700491 The object takes the form of:
492
493{
Bu Sun Kim65020912020-05-20 12:08:20 -0700494 &quot;sslCertificates&quot;: [ # New set of SslCertificate resources to associate with this TargetHttpsProxy resource. Currently exactly one SslCertificate resource must be specified.
495 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700496 ],
497 }
498
499 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.
500
501For 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.
502
503The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
504
505Returns:
506 An object of the form:
507
508 { # Represents an Operation resource.
509 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700510 # Google Compute Engine has three Operation resources:
511 #
512 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
513 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700514 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
515 #
516 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700517 # - For global operations, use the `globalOperations` resource.
518 # - For regional operations, use the `regionOperations` resource.
519 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700520 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700521 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Bu Sun Kim65020912020-05-20 12:08:20 -0700522 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
523 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
524 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
525 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
526 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
527 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700528 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700529 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
530 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
531 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700532 },
533 ],
534 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700535 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
536 &quot;httpErrorStatusCode&quot;: 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.
537 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
538 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
539 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
540 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
541 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
542 &quot;progress&quot;: 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.
543 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
544 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
545 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource with the resource id.
546 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
547 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
548 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
549 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
550 &quot;targetLink&quot;: &quot;A String&quot;, # [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.
551 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
552 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
553 {
554 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
555 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
556 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
557 {
558 &quot;key&quot;: &quot;A String&quot;, # [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).
559 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
560 },
561 ],
562 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
563 },
564 ],
565 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700566 }</pre>
567</div>
568
569<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700570 <code class="details" id="setUrlMap">setUrlMap(project, region, targetHttpsProxy, body=None, requestId=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700571 <pre>Changes the URL map for TargetHttpsProxy.
572
573Args:
574 project: string, Project ID for this request. (required)
575 region: string, Name of the region scoping this request. (required)
576 targetHttpsProxy: string, Name of the TargetHttpsProxy to set a URL map for. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700577 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700578 The object takes the form of:
579
580{
Bu Sun Kim65020912020-05-20 12:08:20 -0700581 &quot;urlMap&quot;: &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700582 }
583
584 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.
585
586For 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.
587
588The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
589
590Returns:
591 An object of the form:
592
593 { # Represents an Operation resource.
594 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700595 # Google Compute Engine has three Operation resources:
596 #
597 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
598 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700599 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
600 #
601 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700602 # - For global operations, use the `globalOperations` resource.
603 # - For regional operations, use the `regionOperations` resource.
604 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700605 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700606 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Bu Sun Kim65020912020-05-20 12:08:20 -0700607 &quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
608 &quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
609 &quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is set when the operation is created.
610 &quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
611 &quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
612 &quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700613 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700614 &quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
615 &quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error. This property is optional.
616 &quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700617 },
618 ],
619 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700620 &quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
621 &quot;httpErrorStatusCode&quot;: 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.
622 &quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
623 &quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
624 &quot;kind&quot;: &quot;compute#operation&quot;, # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
625 &quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
626 &quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
627 &quot;progress&quot;: 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.
628 &quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
629 &quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
630 &quot;selfLinkWithId&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for this resource with the resource id.
631 &quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
632 &quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
633 &quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the operation.
634 &quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
635 &quot;targetLink&quot;: &quot;A String&quot;, # [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.
636 &quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example: `user@example.com`.
637 &quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
638 {
639 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
640 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key: value format. For example:
641 # &quot;data&quot;: [ { &quot;key&quot;: &quot;scope&quot;, &quot;value&quot;: &quot;zones/us-east1-d&quot; }
642 {
643 &quot;key&quot;: &quot;A String&quot;, # [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).
644 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
645 },
646 ],
647 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
648 },
649 ],
650 &quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700651 }</pre>
652</div>
653
654<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700655 <code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700656 <pre>Returns permissions that a caller has on the specified resource.
657
658Args:
659 project: string, Project ID for this request. (required)
660 region: string, The name of the region for this request. (required)
661 resource: string, Name or id of the resource for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700662 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700663 The object takes the form of:
664
665{
Bu Sun Kim65020912020-05-20 12:08:20 -0700666 &quot;permissions&quot;: [ # The set of permissions to check for the &#x27;resource&#x27;. Permissions with wildcards (such as &#x27;*&#x27; or &#x27;storage.*&#x27;) are not allowed.
667 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700668 ],
669 }
670
671
672Returns:
673 An object of the form:
674
675 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700676 &quot;permissions&quot;: [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
677 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700678 ],
679 }</pre>
680</div>
681
682</body></html>