Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / compute_alpha.targetSslProxies.html
blob: 3fd3764f04b0a9514812d0ca32225d73e3f25a4f [file] [log] [blame]
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[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_alpha.html">Compute Engine API</a> . <a href="compute_alpha.targetSslProxies.html">targetSslProxies</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]78 <code><a href="#delete">delete(project, targetSslProxy, requestId=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]79<p class="firstline">Deletes the specified TargetSslProxy resource.</p>
80<p class="toc_element">
81 <code><a href="#get">get(project, targetSslProxy)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]82<p class="firstline">Returns the specified TargetSslProxy resource. Gets a list of available target SSL proxies by making a list() request.</p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]83<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]84 <code><a href="#insert">insert(project, body=None, requestId=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]85<p class="firstline">Creates a TargetSslProxy resource in the specified project using the data included in the request.</p>
86<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]87 <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, returnPartialSuccess=None, filter=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]88<p class="firstline">Retrieves the list of TargetSslProxy 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">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]93 <code><a href="#setBackendService">setBackendService(project, targetSslProxy, body=None, requestId=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]94<p class="firstline">Changes the BackendService for TargetSslProxy.</p>
95<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]96 <code><a href="#setProxyHeader">setProxyHeader(project, targetSslProxy, body=None, requestId=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]97<p class="firstline">Changes the ProxyHeaderType for TargetSslProxy.</p>
98<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]99 <code><a href="#setSslCertificates">setSslCertificates(project, targetSslProxy, body=None, requestId=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]100<p class="firstline">Changes SslCertificates for TargetSslProxy.</p>
101<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]102 <code><a href="#setSslPolicy">setSslPolicy(project, targetSslProxy, body=None, requestId=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]103<p class="firstline">Sets the SSL policy for TargetSslProxy. The SSL policy specifies the server-side support for SSL features. This affects connections between clients and the SSL proxy load balancer. They do not affect the connection between the load balancer and the backends.</p>
104<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]105 <code><a href="#testIamPermissions">testIamPermissions(project, resource, body=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]106<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
107<h3>Method Details</h3>
108<div class="method">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]109 <code class="details" id="delete">delete(project, targetSslProxy, requestId=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]110 <pre>Deletes the specified TargetSslProxy resource.
111
112Args:
113 project: string, Project ID for this request. (required)
114 targetSslProxy: string, Name of the TargetSslProxy resource to delete. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]115 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
116
117For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
118
119The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]120
121Returns:
122 An object of the form:
123
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]124 { # Represents an Operation resource.
125 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]126 # Google Compute Engine has three Operation resources:
127 #
128 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
129 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]130 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
131 #
132 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]133 # - For global operations, use the `globalOperations` resource.
134 # - For regional operations, use the `regionOperations` resource.
135 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]136 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]137 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]138 "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]139 "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]140 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]141 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]142 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]143 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]144 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
145 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]146 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]147 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]148 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]149 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]150 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
151 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
152 {
153 "message": "A String", # [Output Only] A human-readable description of the warning code.
154 "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.
155 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
156 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
157 {
158 "value": "A String", # [Output Only] A warning data value corresponding to the key.
159 "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).
160 },
161 ],
162 },
163 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]164 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]165 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]166 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]167 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
168 "name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]169 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]170 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
171 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
172 {
173 "message": "A String", # [Output Only] An optional, human-readable error message.
174 "code": "A String", # [Output Only] The error type identifier for this error.
175 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
176 },
177 ],
178 },
179 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
180 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]181 "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 -0700[diff] [blame]182 }</pre>
183</div>
184
185<div class="method">
186 <code class="details" id="get">get(project, targetSslProxy)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]187 <pre>Returns the specified TargetSslProxy resource. Gets a list of available target SSL proxies by making a list() request.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]188
189Args:
190 project: string, Project ID for this request. (required)
191 targetSslProxy: string, Name of the TargetSslProxy resource to return. (required)
192
193Returns:
194 An object of the form:
195
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]196 { # Represents a Target SSL Proxy resource.
197 #
198 # A target SSL proxy is a component of a SSL Proxy load balancer. Global forwarding rules reference a target SSL proxy, and the target proxy then references an external backend service. For more information, read Using Target Proxies. (== resource_for {$api_version}.targetSslProxies ==)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]199 "kind": "compute#targetSslProxy", # [Output Only] Type of the resource. Always compute#targetSslProxy for target SSL proxies.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]200 "certificateMap": "A String", # URL of a certificate map that identifies a certificate map associated with the given target proxy. This field can only be set for global target proxies. If set, sslCertificates will be ignored.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]201 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
202 "service": "A String", # URL to the BackendService resource.
203 "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]204 "sslCertificates": [ # URLs to SslCertificate resources that are used to authenticate connections to Backends. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]205 "A String",
206 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]207 "sslPolicy": "A String", # URL of SslPolicy resource that will be associated with the TargetSslProxy resource. If not set, the TargetSslProxy resource will not have any SSL policy configured.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]208 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
209 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
210 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]211 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]212 }</pre>
213</div>
214
215<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]216 <code class="details" id="insert">insert(project, body=None, requestId=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]217 <pre>Creates a TargetSslProxy resource in the specified project using the data included in the request.
218
219Args:
220 project: string, Project ID for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]221 body: object, The request body.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]222 The object takes the form of:
223
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]224{ # Represents a Target SSL Proxy resource.
225 #
226 # A target SSL proxy is a component of a SSL Proxy load balancer. Global forwarding rules reference a target SSL proxy, and the target proxy then references an external backend service. For more information, read Using Target Proxies. (== resource_for {$api_version}.targetSslProxies ==)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]227 "kind": "compute#targetSslProxy", # [Output Only] Type of the resource. Always compute#targetSslProxy for target SSL proxies.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]228 "certificateMap": "A String", # URL of a certificate map that identifies a certificate map associated with the given target proxy. This field can only be set for global target proxies. If set, sslCertificates will be ignored.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]229 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
230 "service": "A String", # URL to the BackendService resource.
231 "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]232 "sslCertificates": [ # URLs to SslCertificate resources that are used to authenticate connections to Backends. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]233 "A String",
234 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]235 "sslPolicy": "A String", # URL of SslPolicy resource that will be associated with the TargetSslProxy resource. If not set, the TargetSslProxy resource will not have any SSL policy configured.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]236 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
237 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
238 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]239 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]240 }
241
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]242 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
243
244For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
245
246The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]247
248Returns:
249 An object of the form:
250
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]251 { # Represents an Operation resource.
252 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]253 # Google Compute Engine has three Operation resources:
254 #
255 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
256 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]257 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
258 #
259 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]260 # - For global operations, use the `globalOperations` resource.
261 # - For regional operations, use the `regionOperations` resource.
262 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]263 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]264 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]265 "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]266 "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]267 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]268 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]269 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]270 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]271 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
272 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]273 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]274 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]275 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]276 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]277 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
278 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
279 {
280 "message": "A String", # [Output Only] A human-readable description of the warning code.
281 "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
282 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
283 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
284 {
285 "value": "A String", # [Output Only] A warning data value corresponding to the key.
286 "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).
287 },
288 ],
289 },
290 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]291 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]292 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]293 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]294 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
295 "name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]296 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]297 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
298 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
299 {
300 "message": "A String", # [Output Only] An optional, human-readable error message.
301 "code": "A String", # [Output Only] The error type identifier for this error.
302 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
303 },
304 ],
305 },
306 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
307 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]308 "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 -0700[diff] [blame]309 }</pre>
310</div>
311
312<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]313 <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, returnPartialSuccess=None, filter=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]314 <pre>Retrieves the list of TargetSslProxy resources available to the specified project.
315
316Args:
317 project: string, Project ID for this request. (required)
318 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
319
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]320You 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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]321
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]322Currently, only sorting by `name` or `creationTimestamp desc` is supported.
323 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`)
324 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.
325 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.
326 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `&gt;`, or `&lt;`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]327
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]328For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]329
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]330You 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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]331
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]332To 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) ```
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]333
334Returns:
335 An object of the form:
336
337 { # Contains a list of TargetSslProxy resources.
338 "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]339 "kind": "compute#targetSslProxyList", # Type of resource.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]340 "items": [ # A list of TargetSslProxy resources.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]341 { # Represents a Target SSL Proxy resource.
342 #
343 # A target SSL proxy is a component of a SSL Proxy load balancer. Global forwarding rules reference a target SSL proxy, and the target proxy then references an external backend service. For more information, read Using Target Proxies. (== resource_for {$api_version}.targetSslProxies ==)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]344 "kind": "compute#targetSslProxy", # [Output Only] Type of the resource. Always compute#targetSslProxy for target SSL proxies.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]345 "certificateMap": "A String", # URL of a certificate map that identifies a certificate map associated with the given target proxy. This field can only be set for global target proxies. If set, sslCertificates will be ignored.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]346 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
347 "service": "A String", # URL to the BackendService resource.
348 "proxyHeader": "A String", # Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]349 "sslCertificates": [ # URLs to SslCertificate resources that are used to authenticate connections to Backends. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]350 "A String",
351 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]352 "sslPolicy": "A String", # URL of SslPolicy resource that will be associated with the TargetSslProxy resource. If not set, the TargetSslProxy resource will not have any SSL policy configured.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]353 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
354 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
355 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]356 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]357 },
358 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]359 "warning": { # [Output Only] Informational warning message.
360 "message": "A String", # [Output Only] A human-readable description of the warning code.
361 "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.
362 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
363 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
364 {
365 "value": "A String", # [Output Only] A warning data value corresponding to the key.
366 "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).
367 },
368 ],
369 },
370 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]371 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
372 }</pre>
373</div>
374
375<div class="method">
376 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
377 <pre>Retrieves the next page of results.
378
379Args:
380 previous_request: The request for the previous page. (required)
381 previous_response: The response from the request for the previous page. (required)
382
383Returns:
384 A request object that you can call 'execute()' on to request the next
385 page. Returns None if there are no more items in the collection.
386 </pre>
387</div>
388
389<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]390 <code class="details" id="setBackendService">setBackendService(project, targetSslProxy, body=None, requestId=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]391 <pre>Changes the BackendService for TargetSslProxy.
392
393Args:
394 project: string, Project ID for this request. (required)
395 targetSslProxy: string, Name of the TargetSslProxy resource whose BackendService resource is to be set. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]396 body: object, The request body.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]397 The object takes the form of:
398
399{
400 "service": "A String", # The URL of the new BackendService resource for the targetSslProxy.
401 }
402
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]403 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.
404
405For 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.
406
407The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]408
409Returns:
410 An object of the form:
411
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]412 { # Represents an Operation resource.
413 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]414 # Google Compute Engine has three Operation resources:
415 #
416 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
417 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]418 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
419 #
420 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]421 # - For global operations, use the `globalOperations` resource.
422 # - For regional operations, use the `regionOperations` resource.
423 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]424 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]425 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]426 "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]427 "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]428 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]429 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]430 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]431 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]432 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
433 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]434 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]435 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]436 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]437 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]438 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
439 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
440 {
441 "message": "A String", # [Output Only] A human-readable description of the warning code.
442 "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.
443 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
444 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
445 {
446 "value": "A String", # [Output Only] A warning data value corresponding to the key.
447 "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).
448 },
449 ],
450 },
451 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]452 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]453 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]454 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]455 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
456 "name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]457 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]458 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
459 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
460 {
461 "message": "A String", # [Output Only] An optional, human-readable error message.
462 "code": "A String", # [Output Only] The error type identifier for this error.
463 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
464 },
465 ],
466 },
467 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
468 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]469 "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 -0700[diff] [blame]470 }</pre>
471</div>
472
473<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]474 <code class="details" id="setProxyHeader">setProxyHeader(project, targetSslProxy, body=None, requestId=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]475 <pre>Changes the ProxyHeaderType for TargetSslProxy.
476
477Args:
478 project: string, Project ID for this request. (required)
479 targetSslProxy: string, Name of the TargetSslProxy resource whose ProxyHeader is to be set. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]480 body: object, The request body.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]481 The object takes the form of:
482
483{
484 "proxyHeader": "A String", # The new type of proxy header to append before sending data to the backend. NONE or PROXY_V1 are allowed.
485 }
486
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]487 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.
488
489For 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.
490
491The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]492
493Returns:
494 An object of the form:
495
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]496 { # Represents an Operation resource.
497 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]498 # Google Compute Engine has three Operation resources:
499 #
500 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
501 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]502 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
503 #
504 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]505 # - For global operations, use the `globalOperations` resource.
506 # - For regional operations, use the `regionOperations` resource.
507 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]508 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]509 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]510 "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]511 "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]512 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]513 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]514 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]515 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]516 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
517 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]518 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]519 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]520 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]521 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]522 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
523 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
524 {
525 "message": "A String", # [Output Only] A human-readable description of the warning code.
526 "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.
527 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
528 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
529 {
530 "value": "A String", # [Output Only] A warning data value corresponding to the key.
531 "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).
532 },
533 ],
534 },
535 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]536 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]537 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]538 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]539 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
540 "name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]541 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]542 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
543 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
544 {
545 "message": "A String", # [Output Only] An optional, human-readable error message.
546 "code": "A String", # [Output Only] The error type identifier for this error.
547 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
548 },
549 ],
550 },
551 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
552 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]553 "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 -0700[diff] [blame]554 }</pre>
555</div>
556
557<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]558 <code class="details" id="setSslCertificates">setSslCertificates(project, targetSslProxy, body=None, requestId=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]559 <pre>Changes SslCertificates for TargetSslProxy.
560
561Args:
562 project: string, Project ID for this request. (required)
563 targetSslProxy: string, Name of the TargetSslProxy resource whose SslCertificate resource is to be set. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]564 body: object, The request body.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]565 The object takes the form of:
566
567{
568 "sslCertificates": [ # New set of URLs to SslCertificate resources to associate with this TargetSslProxy. Currently exactly one ssl certificate must be specified.
569 "A String",
570 ],
571 }
572
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]573 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.
574
575For 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.
576
577The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]578
579Returns:
580 An object of the form:
581
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]582 { # Represents an Operation resource.
583 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]584 # Google Compute Engine has three Operation resources:
585 #
586 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
587 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]588 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
589 #
590 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]591 # - For global operations, use the `globalOperations` resource.
592 # - For regional operations, use the `regionOperations` resource.
593 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]594 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]595 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]596 "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]597 "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]598 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]599 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]600 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]601 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]602 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
603 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]604 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]605 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]606 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]607 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]608 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
609 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
610 {
611 "message": "A String", # [Output Only] A human-readable description of the warning code.
612 "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.
613 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
614 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
615 {
616 "value": "A String", # [Output Only] A warning data value corresponding to the key.
617 "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).
618 },
619 ],
620 },
621 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]622 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]623 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]624 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]625 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
626 "name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]627 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
628 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
629 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
630 {
631 "message": "A String", # [Output Only] An optional, human-readable error message.
632 "code": "A String", # [Output Only] The error type identifier for this error.
633 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
634 },
635 ],
636 },
637 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
638 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
639 "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.
640 }</pre>
641</div>
642
643<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]644 <code class="details" id="setSslPolicy">setSslPolicy(project, targetSslProxy, body=None, requestId=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]645 <pre>Sets the SSL policy for TargetSslProxy. The SSL policy specifies the server-side support for SSL features. This affects connections between clients and the SSL proxy load balancer. They do not affect the connection between the load balancer and the backends.
646
647Args:
648 project: string, Project ID for this request. (required)
649 targetSslProxy: string, Name of the TargetSslProxy resource whose SSL policy is to be set. The name must be 1-63 characters long, and comply with RFC1035. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]650 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]651 The object takes the form of:
652
653{
654 "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.
655 }
656
657 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.
658
659For 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.
660
661The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
662
663Returns:
664 An object of the form:
665
666 { # Represents an Operation resource.
667 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]668 # Google Compute Engine has three Operation resources:
669 #
670 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
671 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]672 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
673 #
674 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]675 # - For global operations, use the `globalOperations` resource.
676 # - For regional operations, use the `regionOperations` resource.
677 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]678 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]679 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]680 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
681 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
682 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]683 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]684 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
685 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]686 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
687 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]688 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]689 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]690 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]691 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]692 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
693 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
694 {
695 "message": "A String", # [Output Only] A human-readable description of the warning code.
696 "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.
697 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
698 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
699 {
700 "value": "A String", # [Output Only] A warning data value corresponding to the key.
701 "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).
702 },
703 ],
704 },
705 ],
706 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]707 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]708 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]709 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
710 "name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]711 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]712 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
713 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
714 {
715 "message": "A String", # [Output Only] An optional, human-readable error message.
716 "code": "A String", # [Output Only] The error type identifier for this error.
717 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
718 },
719 ],
720 },
721 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
722 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]723 "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 -0700[diff] [blame]724 }</pre>
725</div>
726
727<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]728 <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]729 <pre>Returns permissions that a caller has on the specified resource.
730
731Args:
732 project: string, Project ID for this request. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]733 resource: string, Name or id of the resource for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]734 body: object, The request body.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]735 The object takes the form of:
736
737{
738 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
739 "A String",
740 ],
741 }
742
743
744Returns:
745 An object of the form:
746
747 {
748 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
749 "A String",
750 ],
751 }</pre>
752</div>
753
754</body></html>