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