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