Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 3bf2781e29cb828409f3a8a21939323286524569 / . / docs / dyn / compute_v1.targetHttpsProxies.html
blob: 933299dcbb1ed25d8c6a9f7acfc5f3e7fcc48240 [file] [log] [blame]
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="compute_v1.html">Compute Engine API</a> . <a href="compute_v1.targetHttpsProxies.html">targetHttpsProxies</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]78 <code><a href="#delete">delete(project, targetHttpsProxy, requestId=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]79<p class="firstline">Deletes the specified TargetHttpsProxy resource.</p>
80<p class="toc_element">
81 <code><a href="#get">get(project, targetHttpsProxy)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]82<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 -0800[diff] [blame]83<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]84 <code><a href="#insert">insert(project, body, requestId=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]85<p class="firstline">Creates a TargetHttpsProxy resource in the specified project using the data included in the request.</p>
86<p class="toc_element">
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]87 <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]88<p class="firstline">Retrieves the list of TargetHttpsProxy resources available to the specified project.</p>
89<p class="toc_element">
90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]93 <code><a href="#setQuicOverride">setQuicOverride(project, targetHttpsProxy, body, requestId=None)</a></code></p>
94<p class="firstline">Sets the QUIC override policy for TargetHttpsProxy.</p>
95<p class="toc_element">
96 <code><a href="#setSslCertificates">setSslCertificates(project, targetHttpsProxy, body, requestId=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]97<p class="firstline">Replaces SslCertificates for TargetHttpsProxy.</p>
98<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]99 <code><a href="#setSslPolicy">setSslPolicy(project, targetHttpsProxy, body, requestId=None)</a></code></p>
100<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>
101<p class="toc_element">
102 <code><a href="#setUrlMap">setUrlMap(project, targetHttpsProxy, body, requestId=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]103<p class="firstline">Changes the URL map for TargetHttpsProxy.</p>
104<h3>Method Details</h3>
105<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]106 <code class="details" id="delete">delete(project, targetHttpsProxy, requestId=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]107 <pre>Deletes the specified TargetHttpsProxy resource.
108
109Args:
110 project: string, Project ID for this request. (required)
111 targetHttpsProxy: string, Name of the TargetHttpsProxy resource to delete. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]112 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.
113
114For 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.
115
116The 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 -0800[diff] [blame]117
118Returns:
119 An object of the form:
120
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]121 { # Represents an Operation resource.
122 #
123 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
124 #
125 # Operations can be global, regional or zonal.
126 # - For global operations, use the globalOperations resource.
127 # - For regional operations, use the regionOperations resource.
128 # - For zonal operations, use the zonalOperations resource.
129 #
130 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]131 "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 -0700[diff] [blame]132 "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 -0400[diff] [blame]133 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]134 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]135 "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 -0800[diff] [blame]136 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
137 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
138 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
139 "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.
140 "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.
141 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
142 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
143 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
144 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
145 {
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.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]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).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]153 },
154 ],
155 },
156 ],
157 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
158 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
159 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
160 "name": "A String", # [Output Only] Name of the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]161 "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 -0800[diff] [blame]162 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
163 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
164 {
165 "message": "A String", # [Output Only] An optional, human-readable error message.
166 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]167 "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 -0800[diff] [blame]168 },
169 ],
170 },
171 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
172 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]173 "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 -0800[diff] [blame]174 }</pre>
175</div>
176
177<div class="method">
178 <code class="details" id="get">get(project, targetHttpsProxy)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]179 <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 -0800[diff] [blame]180
181Args:
182 project: string, Project ID for this request. (required)
183 targetHttpsProxy: string, Name of the TargetHttpsProxy resource to return. (required)
184
185Returns:
186 An object of the form:
187
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]188 { # A TargetHttpsProxy resource. This resource defines an HTTPS proxy. (== resource_for beta.targetHttpsProxies ==) (== resource_for v1.targetHttpsProxies ==)
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]189 "kind": "compute#targetHttpsProxy", # [Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]190 "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 -0700[diff] [blame]191 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]192 "A String",
193 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]194 "sslPolicy": "A String", # URL of SslPolicy resource that will be associated with the TargetHttpsProxy resource. If not set, the TargetHttpsProxy resource will not have any SSL policy configured.
195 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]196 "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:
197 # - https://www.googleapis.compute/v1/projects/project/global/urlMaps/url-map
198 # - projects/project/global/urlMaps/url-map
199 # - global/urlMaps/url-map
200 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
201 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]202 "quicOverride": "A String", # Specifies the QUIC override policy for this TargetHttpsProxy resource. This determines whether the load balancer will attempt to negotiate QUIC with clients or not. Can specify one of NONE, ENABLE, or DISABLE. Specify ENABLE to always enable QUIC, Enables QUIC when set to ENABLE, and disables QUIC when set to DISABLE. If NONE is specified, uses the QUIC policy with no user overrides, which is equivalent to DISABLE. Not specifying this field is equivalent to specifying NONE.
203 "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 -0800[diff] [blame]204 }</pre>
205</div>
206
207<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]208 <code class="details" id="insert">insert(project, body, requestId=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]209 <pre>Creates a TargetHttpsProxy resource in the specified project using the data included in the request.
210
211Args:
212 project: string, Project ID for this request. (required)
213 body: object, The request body. (required)
214 The object takes the form of:
215
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]216{ # A TargetHttpsProxy resource. This resource defines an HTTPS proxy. (== resource_for beta.targetHttpsProxies ==) (== resource_for v1.targetHttpsProxies ==)
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]217 "kind": "compute#targetHttpsProxy", # [Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]218 "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 -0700[diff] [blame]219 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]220 "A String",
221 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]222 "sslPolicy": "A String", # URL of SslPolicy resource that will be associated with the TargetHttpsProxy resource. If not set, the TargetHttpsProxy resource will not have any SSL policy configured.
223 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]224 "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:
225 # - https://www.googleapis.compute/v1/projects/project/global/urlMaps/url-map
226 # - projects/project/global/urlMaps/url-map
227 # - global/urlMaps/url-map
228 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
229 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]230 "quicOverride": "A String", # Specifies the QUIC override policy for this TargetHttpsProxy resource. This determines whether the load balancer will attempt to negotiate QUIC with clients or not. Can specify one of NONE, ENABLE, or DISABLE. Specify ENABLE to always enable QUIC, Enables QUIC when set to ENABLE, and disables QUIC when set to DISABLE. If NONE is specified, uses the QUIC policy with no user overrides, which is equivalent to DISABLE. Not specifying this field is equivalent to specifying NONE.
231 "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 -0800[diff] [blame]232 }
233
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]234 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.
235
236For 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.
237
238The 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 -0800[diff] [blame]239
240Returns:
241 An object of the form:
242
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]243 { # Represents an Operation resource.
244 #
245 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
246 #
247 # Operations can be global, regional or zonal.
248 # - For global operations, use the globalOperations resource.
249 # - For regional operations, use the regionOperations resource.
250 # - For zonal operations, use the zonalOperations resource.
251 #
252 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]253 "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 -0700[diff] [blame]254 "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 -0400[diff] [blame]255 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]256 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]257 "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 -0800[diff] [blame]258 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
259 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
260 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
261 "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.
262 "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.
263 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
264 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
265 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
266 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
267 {
268 "message": "A String", # [Output Only] A human-readable description of the warning code.
269 "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.
270 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
271 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
272 {
273 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]274 "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 -0800[diff] [blame]275 },
276 ],
277 },
278 ],
279 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
280 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
281 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
282 "name": "A String", # [Output Only] Name of the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]283 "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 -0800[diff] [blame]284 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
285 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
286 {
287 "message": "A String", # [Output Only] An optional, human-readable error message.
288 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]289 "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 -0800[diff] [blame]290 },
291 ],
292 },
293 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
294 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]295 "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 -0800[diff] [blame]296 }</pre>
297</div>
298
299<div class="method">
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]300 <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]301 <pre>Retrieves the list of TargetHttpsProxy resources available to the specified project.
302
303Args:
304 project: string, Project ID for this request. (required)
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]305 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
306
307You 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.
308
309Currently, only sorting by name or creationTimestamp desc is supported.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]310 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)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]311 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]312 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]313
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]314For 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 -0800[diff] [blame]315
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]316You 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 -0800[diff] [blame]317
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]318To 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 -0800[diff] [blame]319
320Returns:
321 An object of the form:
322
323 { # Contains a list of TargetHttpsProxy resources.
324 "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 -0700[diff] [blame]325 "kind": "compute#targetHttpsProxyList", # Type of resource. Always compute#targetHttpsProxyList for lists of target HTTPS proxies.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]326 "items": [ # A list of TargetHttpsProxy resources.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]327 { # A TargetHttpsProxy resource. This resource defines an HTTPS proxy. (== resource_for beta.targetHttpsProxies ==) (== resource_for v1.targetHttpsProxies ==)
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]328 "kind": "compute#targetHttpsProxy", # [Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]329 "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 -0700[diff] [blame]330 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]331 "A String",
332 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]333 "sslPolicy": "A String", # URL of SslPolicy resource that will be associated with the TargetHttpsProxy resource. If not set, the TargetHttpsProxy resource will not have any SSL policy configured.
334 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]335 "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:
336 # - https://www.googleapis.compute/v1/projects/project/global/urlMaps/url-map
337 # - projects/project/global/urlMaps/url-map
338 # - global/urlMaps/url-map
339 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
340 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]341 "quicOverride": "A String", # Specifies the QUIC override policy for this TargetHttpsProxy resource. This determines whether the load balancer will attempt to negotiate QUIC with clients or not. Can specify one of NONE, ENABLE, or DISABLE. Specify ENABLE to always enable QUIC, Enables QUIC when set to ENABLE, and disables QUIC when set to DISABLE. If NONE is specified, uses the QUIC policy with no user overrides, which is equivalent to DISABLE. Not specifying this field is equivalent to specifying NONE.
342 "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 -0800[diff] [blame]343 },
344 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]345 "warning": { # [Output Only] Informational warning message.
346 "message": "A String", # [Output Only] A human-readable description of the warning code.
347 "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.
348 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
349 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
350 {
351 "value": "A String", # [Output Only] A warning data value corresponding to the key.
352 "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).
353 },
354 ],
355 },
356 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]357 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
358 }</pre>
359</div>
360
361<div class="method">
362 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
363 <pre>Retrieves the next page of results.
364
365Args:
366 previous_request: The request for the previous page. (required)
367 previous_response: The response from the request for the previous page. (required)
368
369Returns:
370 A request object that you can call 'execute()' on to request the next
371 page. Returns None if there are no more items in the collection.
372 </pre>
373</div>
374
375<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]376 <code class="details" id="setQuicOverride">setQuicOverride(project, targetHttpsProxy, body, requestId=None)</code>
377 <pre>Sets the QUIC override policy for TargetHttpsProxy.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]378
379Args:
380 project: string, Project ID for this request. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]381 targetHttpsProxy: string, Name of the TargetHttpsProxy resource to set the QUIC override policy for. The name should conform to RFC1035. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]382 body: object, The request body. (required)
383 The object takes the form of:
384
385{
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]386 "quicOverride": "A String", # QUIC policy for the TargetHttpsProxy resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]387 }
388
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]389 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.
390
391For 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.
392
393The 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 -0800[diff] [blame]394
395Returns:
396 An object of the form:
397
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]398 { # Represents an Operation resource.
399 #
400 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
401 #
402 # Operations can be global, regional or zonal.
403 # - For global operations, use the globalOperations resource.
404 # - For regional operations, use the regionOperations resource.
405 # - For zonal operations, use the zonalOperations resource.
406 #
407 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]408 "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 -0700[diff] [blame]409 "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 -0400[diff] [blame]410 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]411 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]412 "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 -0800[diff] [blame]413 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
414 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
415 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
416 "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.
417 "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.
418 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
419 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
420 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
421 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
422 {
423 "message": "A String", # [Output Only] A human-readable description of the warning code.
424 "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.
425 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
426 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
427 {
428 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]429 "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 -0800[diff] [blame]430 },
431 ],
432 },
433 ],
434 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
435 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
436 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
437 "name": "A String", # [Output Only] Name of the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]438 "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 -0800[diff] [blame]439 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
440 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
441 {
442 "message": "A String", # [Output Only] An optional, human-readable error message.
443 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]444 "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 -0800[diff] [blame]445 },
446 ],
447 },
448 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
449 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]450 "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 -0800[diff] [blame]451 }</pre>
452</div>
453
454<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]455 <code class="details" id="setSslCertificates">setSslCertificates(project, targetHttpsProxy, body, requestId=None)</code>
456 <pre>Replaces SslCertificates for TargetHttpsProxy.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]457
458Args:
459 project: string, Project ID for this request. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]460 targetHttpsProxy: string, Name of the TargetHttpsProxy resource to set an SslCertificates resource for. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]461 body: object, The request body. (required)
462 The object takes the form of:
463
464{
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]465 "sslCertificates": [ # New set of SslCertificate resources to associate with this TargetHttpsProxy resource. Currently exactly one SslCertificate resource must be specified.
466 "A String",
467 ],
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]468 }
469
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]470 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.
471
472For 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.
473
474The 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 -0800[diff] [blame]475
476Returns:
477 An object of the form:
478
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]479 { # Represents an Operation resource.
480 #
481 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
482 #
483 # Operations can be global, regional or zonal.
484 # - For global operations, use the globalOperations resource.
485 # - For regional operations, use the regionOperations resource.
486 # - For zonal operations, use the zonalOperations resource.
487 #
488 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]489 "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 -0700[diff] [blame]490 "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 -0400[diff] [blame]491 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]492 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]493 "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 -0800[diff] [blame]494 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
495 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
496 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
497 "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.
498 "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.
499 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
500 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
501 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
502 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
503 {
504 "message": "A String", # [Output Only] A human-readable description of the warning code.
505 "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.
506 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
507 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
508 {
509 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]510 "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 -0800[diff] [blame]511 },
512 ],
513 },
514 ],
515 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
516 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
517 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
518 "name": "A String", # [Output Only] Name of the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]519 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
520 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
521 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
522 {
523 "message": "A String", # [Output Only] An optional, human-readable error message.
524 "code": "A String", # [Output Only] The error type identifier for this error.
525 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
526 },
527 ],
528 },
529 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
530 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
531 "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.
532 }</pre>
533</div>
534
535<div class="method">
536 <code class="details" id="setSslPolicy">setSslPolicy(project, targetHttpsProxy, body, requestId=None)</code>
537 <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.
538
539Args:
540 project: string, Project ID for this request. (required)
541 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)
542 body: object, The request body. (required)
543 The object takes the form of:
544
545{
546 "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.
547 }
548
549 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.
550
551For 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.
552
553The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
554
555Returns:
556 An object of the form:
557
558 { # Represents an Operation resource.
559 #
560 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
561 #
562 # Operations can be global, regional or zonal.
563 # - For global operations, use the globalOperations resource.
564 # - For regional operations, use the regionOperations resource.
565 # - For zonal operations, use the zonalOperations resource.
566 #
567 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)
568 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
569 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
570 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
571 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
572 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
573 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
574 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
575 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
576 "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.
577 "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.
578 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
579 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
580 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
581 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
582 {
583 "message": "A String", # [Output Only] A human-readable description of the warning code.
584 "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.
585 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
586 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
587 {
588 "value": "A String", # [Output Only] A warning data value corresponding to the key.
589 "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).
590 },
591 ],
592 },
593 ],
594 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
595 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
596 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
597 "name": "A String", # [Output Only] Name of the resource.
598 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
599 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
600 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
601 {
602 "message": "A String", # [Output Only] An optional, human-readable error message.
603 "code": "A String", # [Output Only] The error type identifier for this error.
604 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
605 },
606 ],
607 },
608 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
609 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
610 "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.
611 }</pre>
612</div>
613
614<div class="method">
615 <code class="details" id="setUrlMap">setUrlMap(project, targetHttpsProxy, body, requestId=None)</code>
616 <pre>Changes the URL map for TargetHttpsProxy.
617
618Args:
619 project: string, Project ID for this request. (required)
620 targetHttpsProxy: string, Name of the TargetHttpsProxy resource whose URL map is to be set. (required)
621 body: object, The request body. (required)
622 The object takes the form of:
623
624{
625 "urlMap": "A String",
626 }
627
628 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.
629
630For 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.
631
632The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
633
634Returns:
635 An object of the form:
636
637 { # Represents an Operation resource.
638 #
639 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
640 #
641 # Operations can be global, regional or zonal.
642 # - For global operations, use the globalOperations resource.
643 # - For regional operations, use the regionOperations resource.
644 # - For zonal operations, use the zonalOperations resource.
645 #
646 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)
647 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
648 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
649 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
650 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
651 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
652 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
653 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
654 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
655 "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.
656 "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.
657 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
658 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
659 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
660 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
661 {
662 "message": "A String", # [Output Only] A human-readable description of the warning code.
663 "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.
664 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
665 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
666 {
667 "value": "A String", # [Output Only] A warning data value corresponding to the key.
668 "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).
669 },
670 ],
671 },
672 ],
673 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
674 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
675 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
676 "name": "A String", # [Output Only] Name of the resource.
677 "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 -0800[diff] [blame]678 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
679 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
680 {
681 "message": "A String", # [Output Only] An optional, human-readable error message.
682 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]683 "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 -0800[diff] [blame]684 },
685 ],
686 },
687 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
688 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]689 "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 -0800[diff] [blame]690 }</pre>
691</div>
692
693</body></html>