blob: b8ba3eb22e08bcd598c19d157e5c3bccc3a4523f [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001<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_beta.html">Compute Engine API</a> . <a href="compute_beta.sslPolicies.html">sslPolicies</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#delete">delete(project, sslPolicy, requestId=None)</a></code></p>
79<p class="firstline">Deletes the specified SSL policy. The SSL policy resource can be deleted only if it is not in use by any TargetHttpsProxy or TargetSslProxy resources.</p>
80<p class="toc_element">
81 <code><a href="#get">get(project, sslPolicy)</a></code></p>
82<p class="firstline">Lists all of the ordered rules present in a single specified policy.</p>
83<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070084 <code><a href="#insert">insert(project, body=None, requestId=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070085<p class="firstline">Returns the specified SSL policy resource. Gets a list of available SSL policies by making a list() 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">Lists all the SSL policies that have been configured for the specified project.</p>
89<p class="toc_element">
90 <code><a href="#listAvailableFeatures">listAvailableFeatures(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
91<p class="firstline">Lists all features that can be specified in the SSL policy when using custom profile.</p>
92<p class="toc_element">
93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
94<p class="firstline">Retrieves the next page of results.</p>
95<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070096 <code><a href="#patch">patch(project, sslPolicy, body=None, requestId=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070097<p class="firstline">Patches the specified SSL policy with the data included in the request.</p>
98<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070099 <code><a href="#testIamPermissions">testIamPermissions(project, resource, body=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700100<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
101<h3>Method Details</h3>
102<div class="method">
103 <code class="details" id="delete">delete(project, sslPolicy, requestId=None)</code>
104 <pre>Deletes the specified SSL policy. The SSL policy resource can be deleted only if it is not in use by any TargetHttpsProxy or TargetSslProxy resources.
105
106Args:
107 project: string, Project ID for this request. (required)
108 sslPolicy: string, Name of the SSL policy to delete. The name must be 1-63 characters long, and comply with RFC1035. (required)
109 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.
110
111For 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.
112
113The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
114
115Returns:
116 An object of the form:
117
118 { # Represents an Operation resource.
119 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700120 # Google Compute Engine has three Operation resources:
121 #
122 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
123 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700124 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
125 #
126 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700127 # - For global operations, use the `globalOperations` resource.
128 # - For regional operations, use the `regionOperations` resource.
129 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700130 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700131 # 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 -0700132 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
133 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
134 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700135 "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 -0700136 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
137 "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 -0700138 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
139 "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 -0700140 "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 -0700141 "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 -0700142 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700143 "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 -0700144 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
145 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
146 {
147 "message": "A String", # [Output Only] A human-readable description of the warning code.
148 "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.
149 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
150 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
151 {
152 "value": "A String", # [Output Only] A warning data value corresponding to the key.
153 "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).
154 },
155 ],
156 },
157 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700158 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700159 "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 -0700160 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
161 "name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700162 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
163 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
164 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
165 {
166 "message": "A String", # [Output Only] An optional, human-readable error message.
167 "code": "A String", # [Output Only] The error type identifier for this error.
168 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
169 },
170 ],
171 },
172 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
173 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
174 "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.
175 }</pre>
176</div>
177
178<div class="method">
179 <code class="details" id="get">get(project, sslPolicy)</code>
180 <pre>Lists all of the ordered rules present in a single specified policy.
181
182Args:
183 project: string, Project ID for this request. (required)
184 sslPolicy: string, Name of the SSL policy to update. The name must be 1-63 characters long, and comply with RFC1035. (required)
185
186Returns:
187 An object of the form:
188
Dan O'Mearadd494642020-05-01 07:42:23 -0700189 { # Represents a Cloud Armor Security Policy resource.
190 #
191 # Only external backend services used by HTTP or HTTPS load balancers can reference a Security Policy. For more information, read read Cloud Armor Security Policy Concepts. (== resource_for {$api_version}.sslPolicies ==)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700192 "profile": "A String", # Profile specifies the set of SSL features that can be used by the load balancer when negotiating SSL with clients. This can be one of COMPATIBLE, MODERN, RESTRICTED, or CUSTOM. If using CUSTOM, the set of SSL features to enable must be specified in the customFeatures field.
193 "kind": "compute#sslPolicy", # [Output only] Type of the resource. Always compute#sslPolicyfor SSL policies.
194 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
195 "warnings": [ # [Output Only] If potential misconfigurations are detected for this SSL policy, this field will be populated with warning messages.
196 {
197 "message": "A String", # [Output Only] A human-readable description of the warning code.
198 "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.
199 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
200 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
201 {
202 "value": "A String", # [Output Only] A warning data value corresponding to the key.
203 "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).
204 },
205 ],
206 },
207 ],
208 "minTlsVersion": "A String", # The minimum version of SSL protocol that can be used by the clients to establish a connection with the load balancer. This can be one of TLS_1_0, TLS_1_1, TLS_1_2.
209 "name": "A String", # Name of the resource. 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.
210 "customFeatures": [ # A list of features enabled when the selected profile is CUSTOM. The
211 # - method returns the set of features that can be specified in this list. This field must be empty if the profile is not CUSTOM.
212 "A String",
213 ],
214 "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a SslPolicy. An up-to-date fingerprint must be provided in order to update the SslPolicy, otherwise the request will fail with error 412 conditionNotMet.
215 #
216 # To see the latest fingerprint, make a get() request to retrieve an SslPolicy.
217 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
218 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
219 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
220 "enabledFeatures": [ # [Output Only] The list of features enabled in the SSL policy.
221 "A String",
222 ],
223 }</pre>
224</div>
225
226<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700227 <code class="details" id="insert">insert(project, body=None, requestId=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700228 <pre>Returns the specified SSL policy resource. Gets a list of available SSL policies by making a list() request.
229
230Args:
231 project: string, Project ID for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700232 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700233 The object takes the form of:
234
Dan O'Mearadd494642020-05-01 07:42:23 -0700235{ # Represents a Cloud Armor Security Policy resource.
236 #
237 # Only external backend services used by HTTP or HTTPS load balancers can reference a Security Policy. For more information, read read Cloud Armor Security Policy Concepts. (== resource_for {$api_version}.sslPolicies ==)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700238 "profile": "A String", # Profile specifies the set of SSL features that can be used by the load balancer when negotiating SSL with clients. This can be one of COMPATIBLE, MODERN, RESTRICTED, or CUSTOM. If using CUSTOM, the set of SSL features to enable must be specified in the customFeatures field.
239 "kind": "compute#sslPolicy", # [Output only] Type of the resource. Always compute#sslPolicyfor SSL policies.
240 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
241 "warnings": [ # [Output Only] If potential misconfigurations are detected for this SSL policy, this field will be populated with warning messages.
242 {
243 "message": "A String", # [Output Only] A human-readable description of the warning code.
244 "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.
245 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
246 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
247 {
248 "value": "A String", # [Output Only] A warning data value corresponding to the key.
249 "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).
250 },
251 ],
252 },
253 ],
254 "minTlsVersion": "A String", # The minimum version of SSL protocol that can be used by the clients to establish a connection with the load balancer. This can be one of TLS_1_0, TLS_1_1, TLS_1_2.
255 "name": "A String", # Name of the resource. 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.
256 "customFeatures": [ # A list of features enabled when the selected profile is CUSTOM. The
257 # - method returns the set of features that can be specified in this list. This field must be empty if the profile is not CUSTOM.
258 "A String",
259 ],
260 "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a SslPolicy. An up-to-date fingerprint must be provided in order to update the SslPolicy, otherwise the request will fail with error 412 conditionNotMet.
261 #
262 # To see the latest fingerprint, make a get() request to retrieve an SslPolicy.
263 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
264 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
265 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
266 "enabledFeatures": [ # [Output Only] The list of features enabled in the SSL policy.
267 "A String",
268 ],
269 }
270
271 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.
272
273For 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.
274
275The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
276
277Returns:
278 An object of the form:
279
280 { # Represents an Operation resource.
281 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700282 # Google Compute Engine has three Operation resources:
283 #
284 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
285 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700286 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
287 #
288 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700289 # - For global operations, use the `globalOperations` resource.
290 # - For regional operations, use the `regionOperations` resource.
291 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700292 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700293 # 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 -0700294 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
295 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
296 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700297 "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 -0700298 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
299 "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 -0700300 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
301 "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 -0700302 "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 -0700303 "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 -0700304 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700305 "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 -0700306 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
307 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
308 {
309 "message": "A String", # [Output Only] A human-readable description of the warning code.
310 "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.
311 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
312 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
313 {
314 "value": "A String", # [Output Only] A warning data value corresponding to the key.
315 "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).
316 },
317 ],
318 },
319 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700320 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700321 "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 -0700322 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
323 "name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700324 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
325 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
326 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
327 {
328 "message": "A String", # [Output Only] An optional, human-readable error message.
329 "code": "A String", # [Output Only] The error type identifier for this error.
330 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
331 },
332 ],
333 },
334 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
335 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
336 "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.
337 }</pre>
338</div>
339
340<div class="method">
341 <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
342 <pre>Lists all the SSL policies that have been configured for the specified project.
343
344Args:
345 project: string, Project ID for this request. (required)
346 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
347
Dan O'Mearadd494642020-05-01 07:42:23 -0700348You 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700349
Dan O'Mearadd494642020-05-01 07:42:23 -0700350Currently, only sorting by `name` or `creationTimestamp desc` is supported.
351 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`)
352 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.
353 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;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700354
Dan O'Mearadd494642020-05-01 07:42:23 -0700355For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700356
Dan O'Mearadd494642020-05-01 07:42:23 -0700357You 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700358
Dan O'Mearadd494642020-05-01 07:42:23 -0700359To 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) ```
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700360
361Returns:
362 An object of the form:
363
364 {
365 "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.
366 "kind": "compute#sslPoliciesList", # [Output Only] Type of the resource. Always compute#sslPoliciesList for lists of sslPolicies.
367 "items": [ # A list of SslPolicy resources.
Dan O'Mearadd494642020-05-01 07:42:23 -0700368 { # Represents a Cloud Armor Security Policy resource.
369 #
370 # Only external backend services used by HTTP or HTTPS load balancers can reference a Security Policy. For more information, read read Cloud Armor Security Policy Concepts. (== resource_for {$api_version}.sslPolicies ==)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700371 "profile": "A String", # Profile specifies the set of SSL features that can be used by the load balancer when negotiating SSL with clients. This can be one of COMPATIBLE, MODERN, RESTRICTED, or CUSTOM. If using CUSTOM, the set of SSL features to enable must be specified in the customFeatures field.
372 "kind": "compute#sslPolicy", # [Output only] Type of the resource. Always compute#sslPolicyfor SSL policies.
373 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
374 "warnings": [ # [Output Only] If potential misconfigurations are detected for this SSL policy, this field will be populated with warning messages.
375 {
376 "message": "A String", # [Output Only] A human-readable description of the warning code.
377 "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.
378 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
379 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
380 {
381 "value": "A String", # [Output Only] A warning data value corresponding to the key.
382 "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).
383 },
384 ],
385 },
386 ],
387 "minTlsVersion": "A String", # The minimum version of SSL protocol that can be used by the clients to establish a connection with the load balancer. This can be one of TLS_1_0, TLS_1_1, TLS_1_2.
388 "name": "A String", # Name of the resource. 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.
389 "customFeatures": [ # A list of features enabled when the selected profile is CUSTOM. The
390 # - method returns the set of features that can be specified in this list. This field must be empty if the profile is not CUSTOM.
391 "A String",
392 ],
393 "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a SslPolicy. An up-to-date fingerprint must be provided in order to update the SslPolicy, otherwise the request will fail with error 412 conditionNotMet.
394 #
395 # To see the latest fingerprint, make a get() request to retrieve an SslPolicy.
396 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
397 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
398 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
399 "enabledFeatures": [ # [Output Only] The list of features enabled in the SSL policy.
400 "A String",
401 ],
402 },
403 ],
404 "warning": { # [Output Only] Informational warning message.
405 "message": "A String", # [Output Only] A human-readable description of the warning code.
406 "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.
407 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
408 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
409 {
410 "value": "A String", # [Output Only] A warning data value corresponding to the key.
411 "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).
412 },
413 ],
414 },
415 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
416 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
417 }</pre>
418</div>
419
420<div class="method">
421 <code class="details" id="listAvailableFeatures">listAvailableFeatures(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
422 <pre>Lists all features that can be specified in the SSL policy when using custom profile.
423
424Args:
425 project: string, Project ID for this request. (required)
426 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
427
Dan O'Mearadd494642020-05-01 07:42:23 -0700428You 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700429
Dan O'Mearadd494642020-05-01 07:42:23 -0700430Currently, only sorting by `name` or `creationTimestamp desc` is supported.
431 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`)
432 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.
433 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;`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700434
Dan O'Mearadd494642020-05-01 07:42:23 -0700435For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700436
Dan O'Mearadd494642020-05-01 07:42:23 -0700437You 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700438
Dan O'Mearadd494642020-05-01 07:42:23 -0700439To 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) ```
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700440
441Returns:
442 An object of the form:
443
444 {
445 "features": [
446 "A String",
447 ],
448 }</pre>
449</div>
450
451<div class="method">
452 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
453 <pre>Retrieves the next page of results.
454
455Args:
456 previous_request: The request for the previous page. (required)
457 previous_response: The response from the request for the previous page. (required)
458
459Returns:
460 A request object that you can call 'execute()' on to request the next
461 page. Returns None if there are no more items in the collection.
462 </pre>
463</div>
464
465<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700466 <code class="details" id="patch">patch(project, sslPolicy, body=None, requestId=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700467 <pre>Patches the specified SSL policy with the data included in the request.
468
469Args:
470 project: string, Project ID for this request. (required)
471 sslPolicy: string, Name of the SSL policy to update. The name must be 1-63 characters long, and comply with RFC1035. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700472 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700473 The object takes the form of:
474
Dan O'Mearadd494642020-05-01 07:42:23 -0700475{ # Represents a Cloud Armor Security Policy resource.
476 #
477 # Only external backend services used by HTTP or HTTPS load balancers can reference a Security Policy. For more information, read read Cloud Armor Security Policy Concepts. (== resource_for {$api_version}.sslPolicies ==)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700478 "profile": "A String", # Profile specifies the set of SSL features that can be used by the load balancer when negotiating SSL with clients. This can be one of COMPATIBLE, MODERN, RESTRICTED, or CUSTOM. If using CUSTOM, the set of SSL features to enable must be specified in the customFeatures field.
479 "kind": "compute#sslPolicy", # [Output only] Type of the resource. Always compute#sslPolicyfor SSL policies.
480 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
481 "warnings": [ # [Output Only] If potential misconfigurations are detected for this SSL policy, this field will be populated with warning messages.
482 {
483 "message": "A String", # [Output Only] A human-readable description of the warning code.
484 "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.
485 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
486 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
487 {
488 "value": "A String", # [Output Only] A warning data value corresponding to the key.
489 "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).
490 },
491 ],
492 },
493 ],
494 "minTlsVersion": "A String", # The minimum version of SSL protocol that can be used by the clients to establish a connection with the load balancer. This can be one of TLS_1_0, TLS_1_1, TLS_1_2.
495 "name": "A String", # Name of the resource. 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.
496 "customFeatures": [ # A list of features enabled when the selected profile is CUSTOM. The
497 # - method returns the set of features that can be specified in this list. This field must be empty if the profile is not CUSTOM.
498 "A String",
499 ],
500 "fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a SslPolicy. An up-to-date fingerprint must be provided in order to update the SslPolicy, otherwise the request will fail with error 412 conditionNotMet.
501 #
502 # To see the latest fingerprint, make a get() request to retrieve an SslPolicy.
503 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
504 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
505 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
506 "enabledFeatures": [ # [Output Only] The list of features enabled in the SSL policy.
507 "A String",
508 ],
509 }
510
511 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.
512
513For 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.
514
515The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
516
517Returns:
518 An object of the form:
519
520 { # Represents an Operation resource.
521 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700522 # Google Compute Engine has three Operation resources:
523 #
524 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
525 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700526 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
527 #
528 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700529 # - For global operations, use the `globalOperations` resource.
530 # - For regional operations, use the `regionOperations` resource.
531 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700532 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700533 # 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 -0700534 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
535 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
536 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700537 "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 -0700538 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
539 "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 -0700540 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
541 "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 -0700542 "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 -0700543 "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 -0700544 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700545 "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 -0700546 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
547 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
548 {
549 "message": "A String", # [Output Only] A human-readable description of the warning code.
550 "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.
551 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
552 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
553 {
554 "value": "A String", # [Output Only] A warning data value corresponding to the key.
555 "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).
556 },
557 ],
558 },
559 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700560 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700561 "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 -0700562 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
563 "name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700564 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
565 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
566 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
567 {
568 "message": "A String", # [Output Only] An optional, human-readable error message.
569 "code": "A String", # [Output Only] The error type identifier for this error.
570 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
571 },
572 ],
573 },
574 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
575 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
576 "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.
577 }</pre>
578</div>
579
580<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700581 <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700582 <pre>Returns permissions that a caller has on the specified resource.
583
584Args:
585 project: string, Project ID for this request. (required)
586 resource: string, Name or id of the resource for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700587 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700588 The object takes the form of:
589
590{
591 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
592 "A String",
593 ],
594 }
595
596
597Returns:
598 An object of the form:
599
600 {
601 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
602 "A String",
603 ],
604 }</pre>
605</div>
606
607</body></html>