1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="compute_v1.html">Compute Engine API</a> . <a href="compute_v1.sslPolicies.html">sslPolicies</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#delete">delete(project, sslPolicy, requestId=None, x__xgafv=None)</a></code></p> 82<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> 83<p class="toc_element"> 84 <code><a href="#get">get(project, sslPolicy, x__xgafv=None)</a></code></p> 85<p class="firstline">Lists all of the ordered rules present in a single specified policy.</p> 86<p class="toc_element"> 87 <code><a href="#insert">insert(project, body=None, requestId=None, x__xgafv=None)</a></code></p> 88<p class="firstline">Returns the specified SSL policy resource. Gets a list of available SSL policies by making a list() request.</p> 89<p class="toc_element"> 90 <code><a href="#list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p> 91<p class="firstline">Lists all the SSL policies that have been configured for the specified project.</p> 92<p class="toc_element"> 93 <code><a href="#listAvailableFeatures">listAvailableFeatures(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p> 94<p class="firstline">Lists all features that can be specified in the SSL policy when using custom profile.</p> 95<p class="toc_element"> 96 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 97<p class="firstline">Retrieves the next page of results.</p> 98<p class="toc_element"> 99 <code><a href="#patch">patch(project, sslPolicy, body=None, requestId=None, x__xgafv=None)</a></code></p> 100<p class="firstline">Patches the specified SSL policy with the data included in the request.</p> 101<h3>Method Details</h3> 102<div class="method"> 103 <code class="details" id="close">close()</code> 104 <pre>Close httplib2 connections.</pre> 105</div> 106 107<div class="method"> 108 <code class="details" id="delete">delete(project, sslPolicy, requestId=None, x__xgafv=None)</code> 109 <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. 110 111Args: 112 project: string, Project ID for this request. (required) 113 sslPolicy: string, Name of the SSL policy to delete. The name must be 1-63 characters long, and comply with RFC1035. (required) 114 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. For 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 115 x__xgafv: string, V1 error format. 116 Allowed values 117 1 - v1 error format 118 2 - v2 error format 119 120Returns: 121 An object of the form: 122 123 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 124 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 125 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 126 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 127 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 128 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 129 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 130 { 131 "code": "A String", # [Output Only] The error type identifier for this error. 132 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 133 "message": "A String", # [Output Only] An optional, human-readable error message. 134 }, 135 ], 136 }, 137 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 138 "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. 139 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 140 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 141 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 142 "name": "A String", # [Output Only] Name of the operation. 143 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 144 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 145 "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. 146 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 147 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 148 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 149 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 150 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 151 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 152 "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. 153 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 154 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 155 { 156 "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. 157 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 158 { 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). 160 "value": "A String", # [Output Only] A warning data value corresponding to the key. 161 }, 162 ], 163 "message": "A String", # [Output Only] A human-readable description of the warning code. 164 }, 165 ], 166 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 167}</pre> 168</div> 169 170<div class="method"> 171 <code class="details" id="get">get(project, sslPolicy, x__xgafv=None)</code> 172 <pre>Lists all of the ordered rules present in a single specified policy. 173 174Args: 175 project: string, Project ID for this request. (required) 176 sslPolicy: string, Name of the SSL policy to update. The name must be 1-63 characters long, and comply with RFC1035. (required) 177 x__xgafv: string, V1 error format. 178 Allowed values 179 1 - v1 error format 180 2 - v2 error format 181 182Returns: 183 An object of the form: 184 185 { # Represents an SSL Policy resource. Use SSL policies to control the SSL features, such as versions and cipher suites, offered by an HTTPS or SSL Proxy load balancer. For more information, read SSL Policy Concepts. 186 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 187 "customFeatures": [ # A list of features enabled when the selected profile is CUSTOM. The method returns the set of features that can be specified in this list. This field must be empty if the profile is not CUSTOM. 188 "A String", 189 ], 190 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 191 "enabledFeatures": [ # [Output Only] The list of features enabled in the SSL policy. 192 "A String", 193 ], 194 "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. To see the latest fingerprint, make a get() request to retrieve an SslPolicy. 195 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 196 "kind": "compute#sslPolicy", # [Output only] Type of the resource. Always compute#sslPolicyfor SSL policies. 197 "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. 198 "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. 199 "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. 200 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 201 "warnings": [ # [Output Only] If potential misconfigurations are detected for this SSL policy, this field will be populated with warning messages. 202 { 203 "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. 204 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 205 { 206 "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). 207 "value": "A String", # [Output Only] A warning data value corresponding to the key. 208 }, 209 ], 210 "message": "A String", # [Output Only] A human-readable description of the warning code. 211 }, 212 ], 213}</pre> 214</div> 215 216<div class="method"> 217 <code class="details" id="insert">insert(project, body=None, requestId=None, x__xgafv=None)</code> 218 <pre>Returns the specified SSL policy resource. Gets a list of available SSL policies by making a list() request. 219 220Args: 221 project: string, Project ID for this request. (required) 222 body: object, The request body. 223 The object takes the form of: 224 225{ # Represents an SSL Policy resource. Use SSL policies to control the SSL features, such as versions and cipher suites, offered by an HTTPS or SSL Proxy load balancer. For more information, read SSL Policy Concepts. 226 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 227 "customFeatures": [ # A list of features enabled when the selected profile is CUSTOM. The method returns the set of features that can be specified in this list. This field must be empty if the profile is not CUSTOM. 228 "A String", 229 ], 230 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 231 "enabledFeatures": [ # [Output Only] The list of features enabled in the SSL policy. 232 "A String", 233 ], 234 "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. To see the latest fingerprint, make a get() request to retrieve an SslPolicy. 235 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 236 "kind": "compute#sslPolicy", # [Output only] Type of the resource. Always compute#sslPolicyfor SSL policies. 237 "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. 238 "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. 239 "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. 240 "selfLink": "A String", # [Output Only] Server-defined URL for 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 "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. 244 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 245 { 246 "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). 247 "value": "A String", # [Output Only] A warning data value corresponding to the key. 248 }, 249 ], 250 "message": "A String", # [Output Only] A human-readable description of the warning code. 251 }, 252 ], 253} 254 255 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. For 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 256 x__xgafv: string, V1 error format. 257 Allowed values 258 1 - v1 error format 259 2 - v2 error format 260 261Returns: 262 An object of the form: 263 264 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 265 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 266 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 267 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 268 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 269 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 270 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 271 { 272 "code": "A String", # [Output Only] The error type identifier for this error. 273 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 274 "message": "A String", # [Output Only] An optional, human-readable error message. 275 }, 276 ], 277 }, 278 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 279 "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. 280 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 281 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 282 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 283 "name": "A String", # [Output Only] Name of the operation. 284 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 285 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 286 "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. 287 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 288 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 289 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 290 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 291 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 292 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 293 "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. 294 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 295 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 296 { 297 "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. 298 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 299 { 300 "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). 301 "value": "A String", # [Output Only] A warning data value corresponding to the key. 302 }, 303 ], 304 "message": "A String", # [Output Only] A human-readable description of the warning code. 305 }, 306 ], 307 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 308}</pre> 309</div> 310 311<div class="method"> 312 <code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code> 313 <pre>Lists all the SSL policies that have been configured for the specified project. 314 315Args: 316 project: string, Project ID for this request. (required) 317 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You 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. To 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) ``` 318 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`) 319 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You 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. Currently, only sorting by `name` or `creationTimestamp desc` is supported. 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 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. 322 x__xgafv: string, V1 error format. 323 Allowed values 324 1 - v1 error format 325 2 - v2 error format 326 327Returns: 328 An object of the form: 329 330 { 331 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 332 "items": [ # A list of SslPolicy resources. 333 { # Represents an SSL Policy resource. Use SSL policies to control the SSL features, such as versions and cipher suites, offered by an HTTPS or SSL Proxy load balancer. For more information, read SSL Policy Concepts. 334 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 335 "customFeatures": [ # A list of features enabled when the selected profile is CUSTOM. The method returns the set of features that can be specified in this list. This field must be empty if the profile is not CUSTOM. 336 "A String", 337 ], 338 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 339 "enabledFeatures": [ # [Output Only] The list of features enabled in the SSL policy. 340 "A String", 341 ], 342 "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. To see the latest fingerprint, make a get() request to retrieve an SslPolicy. 343 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 344 "kind": "compute#sslPolicy", # [Output only] Type of the resource. Always compute#sslPolicyfor SSL policies. 345 "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. 346 "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. 347 "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. 348 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 349 "warnings": [ # [Output Only] If potential misconfigurations are detected for this SSL policy, this field will be populated with warning messages. 350 { 351 "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. 352 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 353 { 354 "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). 355 "value": "A String", # [Output Only] A warning data value corresponding to the key. 356 }, 357 ], 358 "message": "A String", # [Output Only] A human-readable description of the warning code. 359 }, 360 ], 361 }, 362 ], 363 "kind": "compute#sslPoliciesList", # [Output Only] Type of the resource. Always compute#sslPoliciesList for lists of sslPolicies. 364 "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. 365 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 366 "warning": { # [Output Only] Informational warning message. 367 "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. 368 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 369 { 370 "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). 371 "value": "A String", # [Output Only] A warning data value corresponding to the key. 372 }, 373 ], 374 "message": "A String", # [Output Only] A human-readable description of the warning code. 375 }, 376}</pre> 377</div> 378 379<div class="method"> 380 <code class="details" id="listAvailableFeatures">listAvailableFeatures(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code> 381 <pre>Lists all features that can be specified in the SSL policy when using custom profile. 382 383Args: 384 project: string, Project ID for this request. (required) 385 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You 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. To 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) ``` 386 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`) 387 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You 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. Currently, only sorting by `name` or `creationTimestamp desc` is supported. 388 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. 389 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. 390 x__xgafv: string, V1 error format. 391 Allowed values 392 1 - v1 error format 393 2 - v2 error format 394 395Returns: 396 An object of the form: 397 398 { 399 "features": [ 400 "A String", 401 ], 402}</pre> 403</div> 404 405<div class="method"> 406 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 407 <pre>Retrieves the next page of results. 408 409Args: 410 previous_request: The request for the previous page. (required) 411 previous_response: The response from the request for the previous page. (required) 412 413Returns: 414 A request object that you can call 'execute()' on to request the next 415 page. Returns None if there are no more items in the collection. 416 </pre> 417</div> 418 419<div class="method"> 420 <code class="details" id="patch">patch(project, sslPolicy, body=None, requestId=None, x__xgafv=None)</code> 421 <pre>Patches the specified SSL policy with the data included in the request. 422 423Args: 424 project: string, Project ID for this request. (required) 425 sslPolicy: string, Name of the SSL policy to update. The name must be 1-63 characters long, and comply with RFC1035. (required) 426 body: object, The request body. 427 The object takes the form of: 428 429{ # Represents an SSL Policy resource. Use SSL policies to control the SSL features, such as versions and cipher suites, offered by an HTTPS or SSL Proxy load balancer. For more information, read SSL Policy Concepts. 430 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 431 "customFeatures": [ # A list of features enabled when the selected profile is CUSTOM. The method returns the set of features that can be specified in this list. This field must be empty if the profile is not CUSTOM. 432 "A String", 433 ], 434 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 435 "enabledFeatures": [ # [Output Only] The list of features enabled in the SSL policy. 436 "A String", 437 ], 438 "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. To see the latest fingerprint, make a get() request to retrieve an SslPolicy. 439 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 440 "kind": "compute#sslPolicy", # [Output only] Type of the resource. Always compute#sslPolicyfor SSL policies. 441 "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. 442 "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. 443 "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. 444 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 445 "warnings": [ # [Output Only] If potential misconfigurations are detected for this SSL policy, this field will be populated with warning messages. 446 { 447 "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. 448 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 449 { 450 "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). 451 "value": "A String", # [Output Only] A warning data value corresponding to the key. 452 }, 453 ], 454 "message": "A String", # [Output Only] A human-readable description of the warning code. 455 }, 456 ], 457} 458 459 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 460 x__xgafv: string, V1 error format. 461 Allowed values 462 1 - v1 error format 463 2 - v2 error format 464 465Returns: 466 An object of the form: 467 468 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 469 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 470 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 471 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 472 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 473 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 474 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 475 { 476 "code": "A String", # [Output Only] The error type identifier for this error. 477 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 478 "message": "A String", # [Output Only] An optional, human-readable error message. 479 }, 480 ], 481 }, 482 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 483 "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. 484 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 485 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 486 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 487 "name": "A String", # [Output Only] Name of the operation. 488 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 489 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 490 "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. 491 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 492 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 493 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 494 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 495 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 496 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 497 "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. 498 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 499 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 500 { 501 "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. 502 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 503 { 504 "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). 505 "value": "A String", # [Output Only] A warning data value corresponding to the key. 506 }, 507 ], 508 "message": "A String", # [Output Only] A human-readable description of the warning code. 509 }, 510 ], 511 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 512}</pre> 513</div> 514 515</body></html>