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