blob: bc876daae89519529a6bf2736733bfaa69784d48 [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">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070078 <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
79<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">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -040090 <code><a href="#insert">insert(project, body, 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">
93 <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=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">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070099 <code><a href="#setQuicOverride">setQuicOverride(project, targetHttpsProxy, body, requestId=None)</a></code></p>
100<p class="firstline">Sets the QUIC override policy for TargetHttpsProxy.</p>
101<p class="toc_element">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400102 <code><a href="#setSslCertificates">setSslCertificates(project, targetHttpsProxy, body, 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">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700105 <code><a href="#setSslPolicy">setSslPolicy(project, targetHttpsProxy, body, requestId=None)</a></code></p>
106<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">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400108 <code><a href="#setUrlMap">setUrlMap(project, targetHttpsProxy, body, 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">
111 <code><a href="#testIamPermissions">testIamPermissions(project, resource, body)</a></code></p>
112<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">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700115 <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
116 <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
122You 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.
123
124Currently, 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 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 <.
128
129For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.
130
131You 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.
132
133To 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).
134
135Returns:
136 An object of the form:
137
138 {
139 "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.
140 "kind": "compute#targetHttpsProxyAggregatedList", # [Output Only] Type of resource. Always compute#targetHttpsProxyAggregatedList for lists of Target HTTP Proxies.
141 "items": { # A list of TargetHttpsProxiesScopedList resources.
142 "a_key": { # Name of the scope containing this set of TargetHttpsProxies.
143 "warning": { # Informational warning which replaces the list of backend services when the list is empty.
144 "message": "A String", # [Output Only] A human-readable description of the warning code.
145 "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.
146 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
147 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
148 {
149 "value": "A String", # [Output Only] A warning data value corresponding to the key.
150 "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).
151 },
152 ],
153 },
154 "targetHttpsProxies": [ # A list of TargetHttpsProxies contained in this scope.
155 { # A TargetHttpsProxy resource. This resource defines an HTTPS proxy. (== resource_for beta.targetHttpsProxies ==) (== resource_for v1.targetHttpsProxies ==)
156 "kind": "compute#targetHttpsProxy", # [Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies.
157 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
158 "region": "A String", # [Output Only] URL of the region where the regional TargetHttpsProxy resides. This field is not applicable to global TargetHttpsProxies.
159 "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.
160 "A String",
161 ],
162 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
163 "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.
164 "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.
165 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
166 "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:
167 # - https://www.googleapis.compute/v1/projects/project/global/urlMaps/url-map
168 # - projects/project/global/urlMaps/url-map
169 # - global/urlMaps/url-map
170 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
171 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
172 "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.
173 "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.
174 },
175 ],
176 },
177 },
178 "warning": { # [Output Only] Informational warning message.
179 "message": "A String", # [Output Only] A human-readable description of the warning code.
180 "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.
181 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
182 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
183 {
184 "value": "A String", # [Output Only] A warning data value corresponding to the key.
185 "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).
186 },
187 ],
188 },
189 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
190 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
191 }</pre>
192</div>
193
194<div class="method">
195 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code>
196 <pre>Retrieves the next page of results.
197
198Args:
199 previous_request: The request for the previous page. (required)
200 previous_response: The response from the request for the previous page. (required)
201
202Returns:
203 A request object that you can call 'execute()' on to request the next
204 page. Returns None if there are no more items in the collection.
205 </pre>
206</div>
207
208<div class="method">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400209 <code class="details" id="delete">delete(project, targetHttpsProxy, requestId=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700210 <pre>Deletes the specified TargetHttpsProxy resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800211
212Args:
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700213 project: string, Project ID for this request. (required)
214 targetHttpsProxy: string, Name of the TargetHttpsProxy resource to delete. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700215 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.
216
217For 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.
218
219The 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 -0800220
221Returns:
222 An object of the form:
223
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700224 { # Represents an Operation resource.
225 #
226 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
227 #
228 # Operations can be global, regional or zonal.
229 # - For global operations, use the globalOperations resource.
230 # - For regional operations, use the regionOperations resource.
231 # - For zonal operations, use the zonalOperations resource.
232 #
233 # 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 -0800234 "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 -0700235 "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 -0400236 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800237 "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 -0700238 "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 -0800239 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700240 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800241 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
242 "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.
243 "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.
244 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
245 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
246 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
247 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
248 {
249 "message": "A String", # [Output Only] A human-readable description of the warning code.
250 "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.
251 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
252 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
253 {
254 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700255 "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 -0800256 },
257 ],
258 },
259 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700260 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800261 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
262 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700263 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800264 "name": "A String", # [Output Only] Name of the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700265 "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 -0800266 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
267 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
268 {
269 "message": "A String", # [Output Only] An optional, human-readable error message.
270 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700271 "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 -0800272 },
273 ],
274 },
275 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
276 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800277 "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 -0800278 }</pre>
279</div>
280
281<div class="method">
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700282 <code class="details" id="get">get(project, targetHttpsProxy)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700283 <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 -0800284
285Args:
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700286 project: string, Project ID for this request. (required)
287 targetHttpsProxy: string, Name of the TargetHttpsProxy resource to return. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800288
289Returns:
290 An object of the form:
291
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700292 { # A TargetHttpsProxy resource. This resource defines an HTTPS proxy. (== resource_for beta.targetHttpsProxies ==) (== resource_for v1.targetHttpsProxies ==)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700293 "kind": "compute#targetHttpsProxy", # [Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies.
294 "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 -0700295 "region": "A String", # [Output Only] URL of the region where the regional TargetHttpsProxy resides. This field is not applicable to global TargetHttpsProxies.
296 "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 -0700297 "A String",
298 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700299 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
300 "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.
301 "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.
302 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700303 "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:
304 # - https://www.googleapis.compute/v1/projects/project/global/urlMaps/url-map
305 # - projects/project/global/urlMaps/url-map
306 # - global/urlMaps/url-map
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800307 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700308 "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 -0700309 "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.
310 "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 -0800311 }</pre>
312</div>
313
314<div class="method">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400315 <code class="details" id="insert">insert(project, body, requestId=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700316 <pre>Creates a TargetHttpsProxy resource in the specified project using the data included in the request.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800317
318Args:
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700319 project: string, Project ID for this request. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800320 body: object, The request body. (required)
321 The object takes the form of:
322
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700323{ # A TargetHttpsProxy resource. This resource defines an HTTPS proxy. (== resource_for beta.targetHttpsProxies ==) (== resource_for v1.targetHttpsProxies ==)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700324 "kind": "compute#targetHttpsProxy", # [Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies.
325 "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 -0700326 "region": "A String", # [Output Only] URL of the region where the regional TargetHttpsProxy resides. This field is not applicable to global TargetHttpsProxies.
327 "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 -0700328 "A String",
329 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700330 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
331 "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.
332 "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.
333 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700334 "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:
335 # - https://www.googleapis.compute/v1/projects/project/global/urlMaps/url-map
336 # - projects/project/global/urlMaps/url-map
337 # - global/urlMaps/url-map
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800338 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700339 "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 -0700340 "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.
341 "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 -0800342 }
343
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700344 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.
345
346For 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.
347
348The 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 -0800349
350Returns:
351 An object of the form:
352
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700353 { # Represents an Operation resource.
354 #
355 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
356 #
357 # Operations can be global, regional or zonal.
358 # - For global operations, use the globalOperations resource.
359 # - For regional operations, use the regionOperations resource.
360 # - For zonal operations, use the zonalOperations resource.
361 #
362 # 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 -0800363 "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 -0700364 "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 -0400365 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800366 "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 -0700367 "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 -0800368 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700369 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800370 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
371 "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.
372 "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.
373 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
374 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
375 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
376 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
377 {
378 "message": "A String", # [Output Only] A human-readable description of the warning code.
379 "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.
380 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
381 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
382 {
383 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700384 "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 -0800385 },
386 ],
387 },
388 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700389 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800390 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
391 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700392 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800393 "name": "A String", # [Output Only] Name of the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700394 "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 -0800395 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
396 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
397 {
398 "message": "A String", # [Output Only] An optional, human-readable error message.
399 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700400 "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 -0800401 },
402 ],
403 },
404 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
405 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800406 "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 -0800407 }</pre>
408</div>
409
410<div class="method">
411 <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700412 <pre>Retrieves the list of TargetHttpsProxy resources available to the specified project.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800413
414Args:
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700415 project: string, Project ID for this request. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800416 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
417
418You 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.
419
420Currently, only sorting by name or creationTimestamp desc is supported.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400421 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 -0800422 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 -0700423 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 -0800424
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700425For 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 -0800426
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700427You 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 -0800428
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700429To 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 -0800430
431Returns:
432 An object of the form:
433
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700434 { # Contains a list of TargetHttpsProxy resources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800435 "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 -0700436 "kind": "compute#targetHttpsProxyList", # Type of resource. Always compute#targetHttpsProxyList for lists of target HTTPS proxies.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700437 "items": [ # A list of TargetHttpsProxy resources.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700438 { # A TargetHttpsProxy resource. This resource defines an HTTPS proxy. (== resource_for beta.targetHttpsProxies ==) (== resource_for v1.targetHttpsProxies ==)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700439 "kind": "compute#targetHttpsProxy", # [Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies.
440 "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 -0700441 "region": "A String", # [Output Only] URL of the region where the regional TargetHttpsProxy resides. This field is not applicable to global TargetHttpsProxies.
442 "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 -0700443 "A String",
444 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700445 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
446 "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.
447 "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.
448 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700449 "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:
450 # - https://www.googleapis.compute/v1/projects/project/global/urlMaps/url-map
451 # - projects/project/global/urlMaps/url-map
452 # - global/urlMaps/url-map
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800453 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700454 "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 -0700455 "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.
456 "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 -0800457 },
458 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700459 "warning": { # [Output Only] Informational warning message.
460 "message": "A String", # [Output Only] A human-readable description of the warning code.
461 "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.
462 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
463 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
464 {
465 "value": "A String", # [Output Only] A warning data value corresponding to the key.
466 "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).
467 },
468 ],
469 },
470 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700471 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800472 }</pre>
473</div>
474
475<div class="method">
476 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
477 <pre>Retrieves the next page of results.
478
479Args:
480 previous_request: The request for the previous page. (required)
481 previous_response: The response from the request for the previous page. (required)
482
483Returns:
484 A request object that you can call 'execute()' on to request the next
485 page. Returns None if there are no more items in the collection.
486 </pre>
487</div>
488
489<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700490 <code class="details" id="setQuicOverride">setQuicOverride(project, targetHttpsProxy, body, requestId=None)</code>
491 <pre>Sets the QUIC override policy for TargetHttpsProxy.
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)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700495 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 -0800496 body: object, The request body. (required)
497 The object takes the form of:
498
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700499{
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700500 "quicOverride": "A String", # QUIC policy for the TargetHttpsProxy resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800501 }
502
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700503 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.
504
505For 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.
506
507The 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 -0800508
509Returns:
510 An object of the form:
511
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700512 { # Represents an Operation resource.
513 #
514 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
515 #
516 # Operations can be global, regional or zonal.
517 # - For global operations, use the globalOperations resource.
518 # - For regional operations, use the regionOperations resource.
519 # - For zonal operations, use the zonalOperations resource.
520 #
521 # 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 -0800522 "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 -0700523 "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 -0400524 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800525 "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 -0700526 "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 -0800527 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700528 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800529 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
530 "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.
531 "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.
532 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
533 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
534 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
535 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
536 {
537 "message": "A String", # [Output Only] A human-readable description of the warning code.
538 "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.
539 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
540 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
541 {
542 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700543 "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 -0800544 },
545 ],
546 },
547 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700548 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800549 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
550 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700551 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800552 "name": "A String", # [Output Only] Name of the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700553 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
554 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
555 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
556 {
557 "message": "A String", # [Output Only] An optional, human-readable error message.
558 "code": "A String", # [Output Only] The error type identifier for this error.
559 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
560 },
561 ],
562 },
563 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
564 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
565 "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.
566 }</pre>
567</div>
568
569<div class="method">
570 <code class="details" id="setSslCertificates">setSslCertificates(project, targetHttpsProxy, body, requestId=None)</code>
571 <pre>Replaces SslCertificates for TargetHttpsProxy.
572
573Args:
574 project: string, Project ID for this request. (required)
575 targetHttpsProxy: string, Name of the TargetHttpsProxy resource to set an SslCertificates resource for. (required)
576 body: object, The request body. (required)
577 The object takes the form of:
578
579{
580 "sslCertificates": [ # New set of SslCertificate resources to associate with this TargetHttpsProxy resource. Currently exactly one SslCertificate resource must be specified.
581 "A String",
582 ],
583 }
584
585 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.
586
587For 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.
588
589The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
590
591Returns:
592 An object of the form:
593
594 { # Represents an Operation resource.
595 #
596 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
597 #
598 # Operations can be global, regional or zonal.
599 # - For global operations, use the globalOperations resource.
600 # - For regional operations, use the regionOperations resource.
601 # - For zonal operations, use the zonalOperations resource.
602 #
603 # 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 ==)
604 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
605 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
606 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
607 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
608 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
609 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
610 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
611 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
612 "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.
613 "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.
614 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
615 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
616 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
617 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
618 {
619 "message": "A String", # [Output Only] A human-readable description of the warning code.
620 "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.
621 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
622 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
623 {
624 "value": "A String", # [Output Only] A warning data value corresponding to the key.
625 "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).
626 },
627 ],
628 },
629 ],
630 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
631 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
632 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
633 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
634 "name": "A String", # [Output Only] Name of the resource.
635 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
636 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
637 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
638 {
639 "message": "A String", # [Output Only] An optional, human-readable error message.
640 "code": "A String", # [Output Only] The error type identifier for this error.
641 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
642 },
643 ],
644 },
645 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
646 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
647 "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.
648 }</pre>
649</div>
650
651<div class="method">
652 <code class="details" id="setSslPolicy">setSslPolicy(project, targetHttpsProxy, body, requestId=None)</code>
653 <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.
654
655Args:
656 project: string, Project ID for this request. (required)
657 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)
658 body: object, The request body. (required)
659 The object takes the form of:
660
661{
662 "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.
663 }
664
665 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.
666
667For 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.
668
669The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
670
671Returns:
672 An object of the form:
673
674 { # Represents an Operation resource.
675 #
676 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
677 #
678 # Operations can be global, regional or zonal.
679 # - For global operations, use the globalOperations resource.
680 # - For regional operations, use the regionOperations resource.
681 # - For zonal operations, use the zonalOperations resource.
682 #
683 # 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 ==)
684 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
685 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
686 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
687 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
688 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
689 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
690 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
691 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
692 "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.
693 "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.
694 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
695 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
696 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
697 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
698 {
699 "message": "A String", # [Output Only] A human-readable description of the warning code.
700 "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.
701 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
702 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
703 {
704 "value": "A String", # [Output Only] A warning data value corresponding to the key.
705 "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).
706 },
707 ],
708 },
709 ],
710 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
711 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
712 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
713 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
714 "name": "A String", # [Output Only] Name of the resource.
715 "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 -0800716 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
717 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
718 {
719 "message": "A String", # [Output Only] An optional, human-readable error message.
720 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700721 "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 -0800722 },
723 ],
724 },
725 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
726 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800727 "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 -0800728 }</pre>
729</div>
730
731<div class="method">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400732 <code class="details" id="setUrlMap">setUrlMap(project, targetHttpsProxy, body, requestId=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700733 <pre>Changes the URL map for TargetHttpsProxy.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800734
735Args:
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700736 project: string, Project ID for this request. (required)
737 targetHttpsProxy: string, Name of the TargetHttpsProxy resource whose URL map is to be set. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800738 body: object, The request body. (required)
739 The object takes the form of:
740
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700741{
742 "urlMap": "A String",
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800743 }
744
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700745 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.
746
747For 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.
748
749The 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 -0800750
751Returns:
752 An object of the form:
753
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700754 { # Represents an Operation resource.
755 #
756 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
757 #
758 # Operations can be global, regional or zonal.
759 # - For global operations, use the globalOperations resource.
760 # - For regional operations, use the regionOperations resource.
761 # - For zonal operations, use the zonalOperations resource.
762 #
763 # 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 -0800764 "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 -0700765 "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 -0400766 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800767 "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 -0700768 "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 -0800769 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700770 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800771 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
772 "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.
773 "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.
774 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
775 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
776 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
777 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
778 {
779 "message": "A String", # [Output Only] A human-readable description of the warning code.
780 "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.
781 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
782 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
783 {
784 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700785 "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 -0800786 },
787 ],
788 },
789 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700790 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800791 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
792 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700793 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800794 "name": "A String", # [Output Only] Name of the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700795 "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 -0800796 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
797 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
798 {
799 "message": "A String", # [Output Only] An optional, human-readable error message.
800 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700801 "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 -0800802 },
803 ],
804 },
805 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
806 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800807 "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 -0700808 }</pre>
809</div>
810
811<div class="method">
812 <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body)</code>
813 <pre>Returns permissions that a caller has on the specified resource.
814
815Args:
816 project: string, Project ID for this request. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700817 resource: string, Name or id of the resource for this request. (required)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700818 body: object, The request body. (required)
819 The object takes the form of:
820
821{
822 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
823 "A String",
824 ],
825 }
826
827
828Returns:
829 An object of the form:
830
831 {
832 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
833 "A String",
834 ],
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800835 }</pre>
836</div>
837
838</body></html>