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