blob: 00457fe48951407e9288c225b0d0dea545b34c48 [file] [log] [blame]
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -08001<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
Sai Cheemalapatidf613972016-10-21 13:59:49 -070075<h1><a href="compute_alpha.html">Compute Engine API</a> . <a href="compute_alpha.targetHttpsProxies.html">targetHttpsProxies</a></h1>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -080076<h2>Instance Methods</h2>
77<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070078 <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, returnPartialSuccess=None, filter=None, includeAllScopes=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070079<p class="firstline">Retrieves the list of all TargetHttpsProxy resources, regional and global, available to the specified project.</p>
80<p class="toc_element">
81 <code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p>
82<p class="firstline">Retrieves the next page of results.</p>
83<p class="toc_element">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -040084 <code><a href="#delete">delete(project, targetHttpsProxy, requestId=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -070085<p class="firstline">Deletes the specified TargetHttpsProxy resource.</p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -080086<p class="toc_element">
Sai Cheemalapatidf613972016-10-21 13:59:49 -070087 <code><a href="#get">get(project, targetHttpsProxy)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070088<p class="firstline">Returns the specified TargetHttpsProxy resource. Gets a list of available target HTTPS proxies by making a list() request.</p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -080089<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070090 <code><a href="#insert">insert(project, body=None, requestId=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -070091<p class="firstline">Creates a TargetHttpsProxy resource in the specified project using the data included in the request.</p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -080092<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070093 <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, returnPartialSuccess=None, filter=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -070094<p class="firstline">Retrieves the list of TargetHttpsProxy resources available to the specified project.</p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -080095<p class="toc_element">
96 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
97<p class="firstline">Retrieves the next page of results.</p>
98<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070099 <code><a href="#setQuicOverride">setQuicOverride(project, targetHttpsProxy, body=None, requestId=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700100<p class="firstline">Sets the QUIC override policy for TargetHttpsProxy.</p>
101<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700102 <code><a href="#setSslCertificates">setSslCertificates(project, targetHttpsProxy, body=None, requestId=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700103<p class="firstline">Replaces SslCertificates for TargetHttpsProxy.</p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800104<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700105 <code><a href="#setSslPolicy">setSslPolicy(project, targetHttpsProxy, body=None, requestId=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700106<p class="firstline">Sets the SSL policy for TargetHttpsProxy. The SSL policy specifies the server-side support for SSL features. This affects connections between clients and the HTTPS proxy load balancer. They do not affect the connection between the load balancer and the backends.</p>
107<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700108 <code><a href="#setUrlMap">setUrlMap(project, targetHttpsProxy, body=None, requestId=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700109<p class="firstline">Changes the URL map for TargetHttpsProxy.</p>
110<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700111 <code><a href="#testIamPermissions">testIamPermissions(project, resource, body=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700112<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800113<h3>Method Details</h3>
114<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700115 <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, returnPartialSuccess=None, filter=None, includeAllScopes=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700116 <pre>Retrieves the list of all TargetHttpsProxy resources, regional and global, available to the specified project.
117
118Args:
119 project: string, Name of the project scoping this request. (required)
120 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
121
Dan O'Mearadd494642020-05-01 07:42:23 -0700122You 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700123
Dan O'Mearadd494642020-05-01 07:42:23 -0700124Currently, only sorting by `name` or `creationTimestamp desc` is supported.
125 maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
126 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.
127 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.
128 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 -0700129
Dan O'Mearadd494642020-05-01 07:42:23 -0700130For 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 -0700131
Dan O'Mearadd494642020-05-01 07:42:23 -0700132You 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 -0700133
Dan O'Mearadd494642020-05-01 07:42:23 -0700134To 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) ```
135 includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700136
137Returns:
138 An object of the form:
139
140 {
141 "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.
142 "kind": "compute#targetHttpsProxyAggregatedList", # [Output Only] Type of resource. Always compute#targetHttpsProxyAggregatedList for lists of Target HTTP Proxies.
143 "items": { # A list of TargetHttpsProxiesScopedList resources.
144 "a_key": { # Name of the scope containing this set of TargetHttpsProxies.
145 "warning": { # Informational warning which replaces the list of backend services when the list is empty.
146 "message": "A String", # [Output Only] A human-readable description of the warning code.
147 "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.
148 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
149 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
150 {
151 "value": "A String", # [Output Only] A warning data value corresponding to the key.
152 "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).
153 },
154 ],
155 },
156 "targetHttpsProxies": [ # A list of TargetHttpsProxies contained in this scope.
Dan O'Mearadd494642020-05-01 07:42:23 -0700157 { # Represents a Target HTTPS Proxy resource.
158 #
159 # Google Compute Engine has two Target HTTPS Proxy resources:
160 #
161 # * [Global](/compute/docs/reference/rest/{$api_version}/targetHttpsProxies) * [Regional](/compute/docs/reference/rest/{$api_version}/regionTargetHttpsProxies)
162 #
163 # A target HTTPS proxy is a component of GCP HTTPS load balancers.
164 #
165 # * targetHttpsProxies are used by external HTTPS load balancers. * regionTargetHttpsProxies are used by internal HTTPS load balancers.
166 #
167 # 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 ==)
168 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700169 "kind": "compute#targetHttpsProxy", # [Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies.
Dan O'Mearadd494642020-05-01 07:42:23 -0700170 "certificateMap": "A String", # URL of a certificate map that identifies a certificate map associated with the given target proxy. This field can only be set for global target proxies. If set, sslCertificates will be ignored.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700171 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
172 "region": "A String", # [Output Only] URL of the region where the regional TargetHttpsProxy resides. This field is not applicable to global TargetHttpsProxies.
173 "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.
174 "A String",
175 ],
176 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
Dan O'Mearadd494642020-05-01 07:42:23 -0700177 "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.
178 "authentication": "A String", # A URL referring to a networksecurity.Authentication resource that describes how the proxy should authenticate inbound traffic. If left blank, communications between services are not encrypted (i.e., the TLS policy is set to OPEN). When terminating inbound traffic to this proxy, the TerminationTls setting of Authentication.TransportAuthentication is applied.
179 # Refer to the Authentication and Authentication.TransportAuthentication.TerminationTls resources for additional details.
180 # authentication only applies to a global TargetHttpsProxy attached to globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700181 "proxyBind": 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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700182 "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.
183 # - When quic-override is set to NONE, Google manages whether QUIC is used.
184 # - When quic-override is set to ENABLE, the load balancer uses QUIC when possible.
185 # - When quic-override is set to DISABLE, the load balancer doesn't use QUIC.
186 # - If the quic-override flag is not specified, NONE is implied.
187 # -
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700188 "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:
189 # - https://www.googleapis.compute/v1/projects/project/global/urlMaps/url-map
190 # - projects/project/global/urlMaps/url-map
191 # - global/urlMaps/url-map
192 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
193 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700194 "authorization": "A String", # A URL referring to a networksecurity.Authorization resource that describes how the proxy should authorize inbound traffic. If left blank, access will not be restricted by an authorization policy.
195 # Refer to the Authorization resource for additional details.
196 # authorization only applies to a global TargetHttpsProxy attached to globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700197 "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.
198 },
199 ],
200 },
201 },
202 "warning": { # [Output Only] Informational warning message.
203 "message": "A String", # [Output Only] A human-readable description of the warning code.
204 "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.
205 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
206 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
207 {
208 "value": "A String", # [Output Only] A warning data value corresponding to the key.
209 "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).
210 },
211 ],
212 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700213 "unreachables": [ # [Output Only] Unreachable resources.
214 "A String",
215 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700216 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
217 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
218 }</pre>
219</div>
220
221<div class="method">
222 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code>
223 <pre>Retrieves the next page of results.
224
225Args:
226 previous_request: The request for the previous page. (required)
227 previous_response: The response from the request for the previous page. (required)
228
229Returns:
230 A request object that you can call 'execute()' on to request the next
231 page. Returns None if there are no more items in the collection.
232 </pre>
233</div>
234
235<div class="method">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400236 <code class="details" id="delete">delete(project, targetHttpsProxy, requestId=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700237 <pre>Deletes the specified TargetHttpsProxy resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800238
239Args:
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700240 project: string, Project ID for this request. (required)
241 targetHttpsProxy: string, Name of the TargetHttpsProxy resource to delete. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700242 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.
243
244For 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.
245
246The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800247
248Returns:
249 An object of the form:
250
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700251 { # Represents an Operation resource.
252 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700253 # Google Compute Engine has three Operation resources:
254 #
255 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
256 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700257 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
258 #
259 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700260 # - For global operations, use the `globalOperations` resource.
261 # - For regional operations, use the `regionOperations` resource.
262 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700263 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700264 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800265 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700266 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400267 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700268 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700269 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800270 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700271 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
272 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800273 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700274 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800275 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700276 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800277 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
278 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
279 {
280 "message": "A String", # [Output Only] A human-readable description of the warning code.
281 "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.
282 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
283 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
284 {
285 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700286 "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).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800287 },
288 ],
289 },
290 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700291 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
Dan O'Mearadd494642020-05-01 07:42:23 -0700292 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800293 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700294 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
295 "name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700296 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800297 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
298 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
299 {
300 "message": "A String", # [Output Only] An optional, human-readable error message.
301 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700302 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800303 },
304 ],
305 },
306 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
307 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800308 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800309 }</pre>
310</div>
311
312<div class="method">
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700313 <code class="details" id="get">get(project, targetHttpsProxy)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700314 <pre>Returns the specified TargetHttpsProxy resource. Gets a list of available target HTTPS proxies by making a list() request.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800315
316Args:
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700317 project: string, Project ID for this request. (required)
318 targetHttpsProxy: string, Name of the TargetHttpsProxy resource to return. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800319
320Returns:
321 An object of the form:
322
Dan O'Mearadd494642020-05-01 07:42:23 -0700323 { # Represents a Target HTTPS Proxy resource.
324 #
325 # Google Compute Engine has two Target HTTPS Proxy resources:
326 #
327 # * [Global](/compute/docs/reference/rest/{$api_version}/targetHttpsProxies) * [Regional](/compute/docs/reference/rest/{$api_version}/regionTargetHttpsProxies)
328 #
329 # A target HTTPS proxy is a component of GCP HTTPS load balancers.
330 #
331 # * targetHttpsProxies are used by external HTTPS load balancers. * regionTargetHttpsProxies are used by internal HTTPS load balancers.
332 #
333 # 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 ==)
334 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700335 "kind": "compute#targetHttpsProxy", # [Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies.
Dan O'Mearadd494642020-05-01 07:42:23 -0700336 "certificateMap": "A String", # URL of a certificate map that identifies a certificate map associated with the given target proxy. This field can only be set for global target proxies. If set, sslCertificates will be ignored.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700337 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700338 "region": "A String", # [Output Only] URL of the region where the regional TargetHttpsProxy resides. This field is not applicable to global TargetHttpsProxies.
339 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700340 "A String",
341 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700342 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
Dan O'Mearadd494642020-05-01 07:42:23 -0700343 "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.
344 "authentication": "A String", # A URL referring to a networksecurity.Authentication resource that describes how the proxy should authenticate inbound traffic. If left blank, communications between services are not encrypted (i.e., the TLS policy is set to OPEN). When terminating inbound traffic to this proxy, the TerminationTls setting of Authentication.TransportAuthentication is applied.
345 # Refer to the Authentication and Authentication.TransportAuthentication.TerminationTls resources for additional details.
346 # authentication only applies to a global TargetHttpsProxy attached to globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700347 "proxyBind": 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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700348 "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.
349 # - When quic-override is set to NONE, Google manages whether QUIC is used.
350 # - When quic-override is set to ENABLE, the load balancer uses QUIC when possible.
351 # - When quic-override is set to DISABLE, the load balancer doesn't use QUIC.
352 # - If the quic-override flag is not specified, NONE is implied.
353 # -
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700354 "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:
355 # - https://www.googleapis.compute/v1/projects/project/global/urlMaps/url-map
356 # - projects/project/global/urlMaps/url-map
357 # - global/urlMaps/url-map
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800358 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700359 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700360 "authorization": "A String", # A URL referring to a networksecurity.Authorization resource that describes how the proxy should authorize inbound traffic. If left blank, access will not be restricted by an authorization policy.
361 # Refer to the Authorization resource for additional details.
362 # authorization only applies to a global TargetHttpsProxy attached to globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700363 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800364 }</pre>
365</div>
366
367<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700368 <code class="details" id="insert">insert(project, body=None, requestId=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700369 <pre>Creates a TargetHttpsProxy resource in the specified project using the data included in the request.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800370
371Args:
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700372 project: string, Project ID for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700373 body: object, The request body.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800374 The object takes the form of:
375
Dan O'Mearadd494642020-05-01 07:42:23 -0700376{ # Represents a Target HTTPS Proxy resource.
377 #
378 # Google Compute Engine has two Target HTTPS Proxy resources:
379 #
380 # * [Global](/compute/docs/reference/rest/{$api_version}/targetHttpsProxies) * [Regional](/compute/docs/reference/rest/{$api_version}/regionTargetHttpsProxies)
381 #
382 # A target HTTPS proxy is a component of GCP HTTPS load balancers.
383 #
384 # * targetHttpsProxies are used by external HTTPS load balancers. * regionTargetHttpsProxies are used by internal HTTPS load balancers.
385 #
386 # 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 ==)
387 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700388 "kind": "compute#targetHttpsProxy", # [Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies.
Dan O'Mearadd494642020-05-01 07:42:23 -0700389 "certificateMap": "A String", # URL of a certificate map that identifies a certificate map associated with the given target proxy. This field can only be set for global target proxies. If set, sslCertificates will be ignored.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700390 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700391 "region": "A String", # [Output Only] URL of the region where the regional TargetHttpsProxy resides. This field is not applicable to global TargetHttpsProxies.
392 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700393 "A String",
394 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700395 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
Dan O'Mearadd494642020-05-01 07:42:23 -0700396 "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.
397 "authentication": "A String", # A URL referring to a networksecurity.Authentication resource that describes how the proxy should authenticate inbound traffic. If left blank, communications between services are not encrypted (i.e., the TLS policy is set to OPEN). When terminating inbound traffic to this proxy, the TerminationTls setting of Authentication.TransportAuthentication is applied.
398 # Refer to the Authentication and Authentication.TransportAuthentication.TerminationTls resources for additional details.
399 # authentication only applies to a global TargetHttpsProxy attached to globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700400 "proxyBind": 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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700401 "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.
402 # - When quic-override is set to NONE, Google manages whether QUIC is used.
403 # - When quic-override is set to ENABLE, the load balancer uses QUIC when possible.
404 # - When quic-override is set to DISABLE, the load balancer doesn't use QUIC.
405 # - If the quic-override flag is not specified, NONE is implied.
406 # -
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700407 "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:
408 # - https://www.googleapis.compute/v1/projects/project/global/urlMaps/url-map
409 # - projects/project/global/urlMaps/url-map
410 # - global/urlMaps/url-map
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800411 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700412 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700413 "authorization": "A String", # A URL referring to a networksecurity.Authorization resource that describes how the proxy should authorize inbound traffic. If left blank, access will not be restricted by an authorization policy.
414 # Refer to the Authorization resource for additional details.
415 # authorization only applies to a global TargetHttpsProxy attached to globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700416 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800417 }
418
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700419 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.
420
421For 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.
422
423The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800424
425Returns:
426 An object of the form:
427
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700428 { # Represents an Operation resource.
429 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700430 # Google Compute Engine has three Operation resources:
431 #
432 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
433 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700434 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
435 #
436 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700437 # - For global operations, use the `globalOperations` resource.
438 # - For regional operations, use the `regionOperations` resource.
439 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700440 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700441 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800442 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700443 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400444 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700445 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700446 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800447 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700448 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
449 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800450 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700451 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800452 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700453 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800454 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
455 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
456 {
457 "message": "A String", # [Output Only] A human-readable description of the warning code.
458 "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.
459 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
460 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
461 {
462 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700463 "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).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800464 },
465 ],
466 },
467 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700468 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
Dan O'Mearadd494642020-05-01 07:42:23 -0700469 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800470 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700471 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
472 "name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700473 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800474 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
475 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
476 {
477 "message": "A String", # [Output Only] An optional, human-readable error message.
478 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700479 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800480 },
481 ],
482 },
483 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
484 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800485 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800486 }</pre>
487</div>
488
489<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700490 <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, returnPartialSuccess=None, filter=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700491 <pre>Retrieves the list of TargetHttpsProxy resources available to the specified project.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800492
493Args:
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700494 project: string, Project ID for this request. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800495 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
496
Dan O'Mearadd494642020-05-01 07:42:23 -0700497You 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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800498
Dan O'Mearadd494642020-05-01 07:42:23 -0700499Currently, only sorting by `name` or `creationTimestamp desc` is supported.
500 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`)
501 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.
502 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.
503 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;`.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800504
Dan O'Mearadd494642020-05-01 07:42:23 -0700505For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800506
Dan O'Mearadd494642020-05-01 07:42:23 -0700507You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800508
Dan O'Mearadd494642020-05-01 07:42:23 -0700509To 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) ```
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800510
511Returns:
512 An object of the form:
513
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700514 { # Contains a list of TargetHttpsProxy resources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800515 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700516 "kind": "compute#targetHttpsProxyList", # Type of resource. Always compute#targetHttpsProxyList for lists of target HTTPS proxies.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700517 "items": [ # A list of TargetHttpsProxy resources.
Dan O'Mearadd494642020-05-01 07:42:23 -0700518 { # Represents a Target HTTPS Proxy resource.
519 #
520 # Google Compute Engine has two Target HTTPS Proxy resources:
521 #
522 # * [Global](/compute/docs/reference/rest/{$api_version}/targetHttpsProxies) * [Regional](/compute/docs/reference/rest/{$api_version}/regionTargetHttpsProxies)
523 #
524 # A target HTTPS proxy is a component of GCP HTTPS load balancers.
525 #
526 # * targetHttpsProxies are used by external HTTPS load balancers. * regionTargetHttpsProxies are used by internal HTTPS load balancers.
527 #
528 # 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 ==)
529 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700530 "kind": "compute#targetHttpsProxy", # [Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies.
Dan O'Mearadd494642020-05-01 07:42:23 -0700531 "certificateMap": "A String", # URL of a certificate map that identifies a certificate map associated with the given target proxy. This field can only be set for global target proxies. If set, sslCertificates will be ignored.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700532 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700533 "region": "A String", # [Output Only] URL of the region where the regional TargetHttpsProxy resides. This field is not applicable to global TargetHttpsProxies.
534 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700535 "A String",
536 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700537 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
Dan O'Mearadd494642020-05-01 07:42:23 -0700538 "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.
539 "authentication": "A String", # A URL referring to a networksecurity.Authentication resource that describes how the proxy should authenticate inbound traffic. If left blank, communications between services are not encrypted (i.e., the TLS policy is set to OPEN). When terminating inbound traffic to this proxy, the TerminationTls setting of Authentication.TransportAuthentication is applied.
540 # Refer to the Authentication and Authentication.TransportAuthentication.TerminationTls resources for additional details.
541 # authentication only applies to a global TargetHttpsProxy attached to globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700542 "proxyBind": 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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700543 "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.
544 # - When quic-override is set to NONE, Google manages whether QUIC is used.
545 # - When quic-override is set to ENABLE, the load balancer uses QUIC when possible.
546 # - When quic-override is set to DISABLE, the load balancer doesn't use QUIC.
547 # - If the quic-override flag is not specified, NONE is implied.
548 # -
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700549 "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:
550 # - https://www.googleapis.compute/v1/projects/project/global/urlMaps/url-map
551 # - projects/project/global/urlMaps/url-map
552 # - global/urlMaps/url-map
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800553 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700554 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Dan O'Mearadd494642020-05-01 07:42:23 -0700555 "authorization": "A String", # A URL referring to a networksecurity.Authorization resource that describes how the proxy should authorize inbound traffic. If left blank, access will not be restricted by an authorization policy.
556 # Refer to the Authorization resource for additional details.
557 # authorization only applies to a global TargetHttpsProxy attached to globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700558 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800559 },
560 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700561 "warning": { # [Output Only] Informational warning message.
562 "message": "A String", # [Output Only] A human-readable description of the warning code.
563 "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.
564 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
565 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
566 {
567 "value": "A String", # [Output Only] A warning data value corresponding to the key.
568 "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).
569 },
570 ],
571 },
572 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700573 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800574 }</pre>
575</div>
576
577<div class="method">
578 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
579 <pre>Retrieves the next page of results.
580
581Args:
582 previous_request: The request for the previous page. (required)
583 previous_response: The response from the request for the previous page. (required)
584
585Returns:
586 A request object that you can call 'execute()' on to request the next
587 page. Returns None if there are no more items in the collection.
588 </pre>
589</div>
590
591<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700592 <code class="details" id="setQuicOverride">setQuicOverride(project, targetHttpsProxy, body=None, requestId=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700593 <pre>Sets the QUIC override policy for TargetHttpsProxy.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800594
595Args:
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700596 project: string, Project ID for this request. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700597 targetHttpsProxy: string, Name of the TargetHttpsProxy resource to set the QUIC override policy for. The name should conform to RFC1035. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700598 body: object, The request body.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800599 The object takes the form of:
600
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700601{
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700602 "quicOverride": "A String", # QUIC policy for the TargetHttpsProxy resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800603 }
604
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700605 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.
606
607For 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.
608
609The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800610
611Returns:
612 An object of the form:
613
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700614 { # Represents an Operation resource.
615 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700616 # Google Compute Engine has three Operation resources:
617 #
618 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
619 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700620 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
621 #
622 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700623 # - For global operations, use the `globalOperations` resource.
624 # - For regional operations, use the `regionOperations` resource.
625 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700626 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700627 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800628 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700629 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400630 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700631 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700632 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800633 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700634 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
635 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800636 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700637 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800638 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700639 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800640 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
641 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
642 {
643 "message": "A String", # [Output Only] A human-readable description of the warning code.
644 "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.
645 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
646 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
647 {
648 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700649 "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).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800650 },
651 ],
652 },
653 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700654 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
Dan O'Mearadd494642020-05-01 07:42:23 -0700655 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800656 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700657 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
658 "name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700659 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
660 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
661 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
662 {
663 "message": "A String", # [Output Only] An optional, human-readable error message.
664 "code": "A String", # [Output Only] The error type identifier for this error.
665 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
666 },
667 ],
668 },
669 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
670 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
671 "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.
672 }</pre>
673</div>
674
675<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700676 <code class="details" id="setSslCertificates">setSslCertificates(project, targetHttpsProxy, body=None, requestId=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700677 <pre>Replaces SslCertificates for TargetHttpsProxy.
678
679Args:
680 project: string, Project ID for this request. (required)
681 targetHttpsProxy: string, Name of the TargetHttpsProxy resource to set an SslCertificates resource for. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700682 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700683 The object takes the form of:
684
685{
686 "sslCertificates": [ # New set of SslCertificate resources to associate with this TargetHttpsProxy resource. Currently exactly one SslCertificate resource must be specified.
687 "A String",
688 ],
689 }
690
691 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.
692
693For 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.
694
695The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
696
697Returns:
698 An object of the form:
699
700 { # Represents an Operation resource.
701 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700702 # Google Compute Engine has three Operation resources:
703 #
704 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
705 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700706 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
707 #
708 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700709 # - For global operations, use the `globalOperations` resource.
710 # - For regional operations, use the `regionOperations` resource.
711 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700712 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700713 # 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 Kim715bd7f2019-06-14 16:50:42 -0700714 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
715 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
716 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700717 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700718 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
719 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700720 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
721 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700722 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700723 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700724 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700725 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700726 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
727 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
728 {
729 "message": "A String", # [Output Only] A human-readable description of the warning code.
730 "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.
731 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
732 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
733 {
734 "value": "A String", # [Output Only] A warning data value corresponding to the key.
735 "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).
736 },
737 ],
738 },
739 ],
740 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
Dan O'Mearadd494642020-05-01 07:42:23 -0700741 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700742 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700743 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
744 "name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700745 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
746 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
747 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
748 {
749 "message": "A String", # [Output Only] An optional, human-readable error message.
750 "code": "A String", # [Output Only] The error type identifier for this error.
751 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
752 },
753 ],
754 },
755 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
756 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
757 "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.
758 }</pre>
759</div>
760
761<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700762 <code class="details" id="setSslPolicy">setSslPolicy(project, targetHttpsProxy, body=None, requestId=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700763 <pre>Sets the SSL policy for TargetHttpsProxy. The SSL policy specifies the server-side support for SSL features. This affects connections between clients and the HTTPS proxy load balancer. They do not affect the connection between the load balancer and the backends.
764
765Args:
766 project: string, Project ID for this request. (required)
767 targetHttpsProxy: string, Name of the TargetHttpsProxy resource whose SSL policy is to be set. The name must be 1-63 characters long, and comply with RFC1035. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700768 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700769 The object takes the form of:
770
771{
772 "sslPolicy": "A String", # URL of the SSL policy resource. Set this to empty string to clear any existing SSL policy associated with the target proxy resource.
773 }
774
775 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.
776
777For 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.
778
779The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
780
781Returns:
782 An object of the form:
783
784 { # Represents an Operation resource.
785 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700786 # Google Compute Engine has three Operation resources:
787 #
788 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
789 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700790 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
791 #
792 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700793 # - For global operations, use the `globalOperations` resource.
794 # - For regional operations, use the `regionOperations` resource.
795 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700796 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700797 # 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 Kim715bd7f2019-06-14 16:50:42 -0700798 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
799 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
800 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700801 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700802 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
803 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700804 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
805 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700806 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700807 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700808 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700809 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700810 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
811 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
812 {
813 "message": "A String", # [Output Only] A human-readable description of the warning code.
814 "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.
815 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
816 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
817 {
818 "value": "A String", # [Output Only] A warning data value corresponding to the key.
819 "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).
820 },
821 ],
822 },
823 ],
824 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
Dan O'Mearadd494642020-05-01 07:42:23 -0700825 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700826 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700827 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
828 "name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700829 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800830 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
831 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
832 {
833 "message": "A String", # [Output Only] An optional, human-readable error message.
834 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700835 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800836 },
837 ],
838 },
839 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
840 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800841 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800842 }</pre>
843</div>
844
845<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700846 <code class="details" id="setUrlMap">setUrlMap(project, targetHttpsProxy, body=None, requestId=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700847 <pre>Changes the URL map for TargetHttpsProxy.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800848
849Args:
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700850 project: string, Project ID for this request. (required)
851 targetHttpsProxy: string, Name of the TargetHttpsProxy resource whose URL map is to be set. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700852 body: object, The request body.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800853 The object takes the form of:
854
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700855{
856 "urlMap": "A String",
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800857 }
858
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700859 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.
860
861For 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.
862
863The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800864
865Returns:
866 An object of the form:
867
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700868 { # Represents an Operation resource.
869 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700870 # Google Compute Engine has three Operation resources:
871 #
872 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
873 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700874 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
875 #
876 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700877 # - For global operations, use the `globalOperations` resource.
878 # - For regional operations, use the `regionOperations` resource.
879 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700880 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700881 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800882 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700883 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400884 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700885 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700886 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800887 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700888 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
889 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800890 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700891 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800892 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700893 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800894 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
895 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
896 {
897 "message": "A String", # [Output Only] A human-readable description of the warning code.
898 "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.
899 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
900 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
901 {
902 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700903 "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).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800904 },
905 ],
906 },
907 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700908 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
Dan O'Mearadd494642020-05-01 07:42:23 -0700909 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800910 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700911 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
912 "name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700913 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800914 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
915 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
916 {
917 "message": "A String", # [Output Only] An optional, human-readable error message.
918 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700919 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800920 },
921 ],
922 },
923 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
924 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800925 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700926 }</pre>
927</div>
928
929<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700930 <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700931 <pre>Returns permissions that a caller has on the specified resource.
932
933Args:
934 project: string, Project ID for this request. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700935 resource: string, Name or id of the resource for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700936 body: object, The request body.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700937 The object takes the form of:
938
939{
940 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
941 "A String",
942 ],
943 }
944
945
946Returns:
947 An object of the form:
948
949 {
950 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
951 "A String",
952 ],
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800953 }</pre>
954</div>
955
956</body></html>