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_alpha.html">Compute Engine API</a> . <a href="compute_alpha.sslPolicies.html">sslPolicies</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p> 79<p class="firstline">Retrieves the list of all SslPolicy resources, regional and global, available to the specified project.</p> 80<p class="toc_element"> 81 <code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p> 82<p class="firstline">Retrieves the next page of results.</p> 83<p class="toc_element"> 84 <code><a href="#close">close()</a></code></p> 85<p class="firstline">Close httplib2 connections.</p> 86<p class="toc_element"> 87 <code><a href="#delete">delete(project, sslPolicy, requestId=None, x__xgafv=None)</a></code></p> 88<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> 89<p class="toc_element"> 90 <code><a href="#get">get(project, sslPolicy, x__xgafv=None)</a></code></p> 91<p class="firstline">Lists all of the ordered rules present in a single specified policy.</p> 92<p class="toc_element"> 93 <code><a href="#insert">insert(project, body=None, requestId=None, x__xgafv=None)</a></code></p> 94<p class="firstline">Returns the specified SSL policy resource. Gets a list of available SSL policies by making a list() request.</p> 95<p class="toc_element"> 96 <code><a href="#list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p> 97<p class="firstline">Lists all the SSL policies that have been configured for the specified project.</p> 98<p class="toc_element"> 99 <code><a href="#listAvailableFeatures">listAvailableFeatures(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p> 100<p class="firstline">Lists all features that can be specified in the SSL policy when using custom profile.</p> 101<p class="toc_element"> 102 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 103<p class="firstline">Retrieves the next page of results.</p> 104<p class="toc_element"> 105 <code><a href="#patch">patch(project, sslPolicy, body=None, requestId=None, x__xgafv=None)</a></code></p> 106<p class="firstline">Patches the specified SSL policy with the data included in the request.</p> 107<p class="toc_element"> 108 <code><a href="#testIamPermissions">testIamPermissions(project, resource, body=None, x__xgafv=None)</a></code></p> 109<p class="firstline">Returns permissions that a caller has on the specified resource.</p> 110<h3>Method Details</h3> 111<div class="method"> 112 <code class="details" id="aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code> 113 <pre>Retrieves the list of all SslPolicy resources, regional and global, available to the specified project. 114 115Args: 116 project: string, Name of the project scoping this request. (required) 117 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) ``` 118 includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. 119 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`) 120 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. 121 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. 122 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. 123 x__xgafv: string, V1 error format. 124 Allowed values 125 1 - v1 error format 126 2 - v2 error format 127 128Returns: 129 An object of the form: 130 131 { 132 "etag": "A String", 133 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 134 "items": { # A list of SslPoliciesScopedList resources. 135 "a_key": { # Name of the scope containing this set of SSL policies. 136 "sslPolicies": [ # A list of SslPolicies contained in this scope. 137 { # 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. 138 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 139 "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. 140 "A String", 141 ], 142 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 143 "enabledFeatures": [ # [Output Only] The list of features enabled in the SSL policy. 144 "A String", 145 ], 146 "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. 147 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 148 "kind": "compute#sslPolicy", # [Output only] Type of the resource. Always compute#sslPolicyfor SSL policies. 149 "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. 150 "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. 151 "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. 152 "region": "A String", # [Output Only] URL of the region where the regional SSL policy resides. This field is not applicable to global SSL policies. 153 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 154 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 155 "tlsSettings": { # The TLS settings for the server. # Security settings for the proxy. This field is only applicable to a global backend service with the loadBalancingScheme set to INTERNAL_SELF_MANAGED. 156 "proxyTlsContext": { # [Deprecated] The TLS settings for the client or server. The TLS settings for the client or server. # Configures the mechanism to obtain security certificates and identity information. 157 "certificateContext": { # [Deprecated] Defines the mechanism to obtain the client or server certificate. Defines the mechanism to obtain the client or server certificate. # Defines the mechanism to obtain the client or server certificate. 158 "certificatePaths": { # [Deprecated] The paths to the mounted TLS Certificates and private key. The paths to the mounted TLS Certificates and private key. # Specifies the certificate and private key paths. This field is applicable only if tlsCertificateSource is set to USE_PATH. 159 "certificatePath": "A String", # The path to the file holding the client or server TLS certificate to use. 160 "privateKeyPath": "A String", # The path to the file holding the client or server private key. 161 }, 162 "certificateSource": "A String", # Defines how TLS certificates are obtained. 163 "sdsConfig": { # [Deprecated] The configuration to access the SDS server. The configuration to access the SDS server. # Specifies the config to retrieve certificates through SDS. This field is applicable only if tlsCertificateSource is set to USE_SDS. 164 "grpcServiceConfig": { # [Deprecated] gRPC config to access the SDS server. gRPC config to access the SDS server. # The configuration to access the SDS server over GRPC. 165 "callCredentials": { # [Deprecated] gRPC call credentials to access the SDS server. gRPC call credentials to access the SDS server. # The call credentials to access the SDS server. 166 "callCredentialType": "A String", # The type of call credentials to use for GRPC requests to the SDS server. This field can be set to one of the following: - GCE_VM: The local GCE VM service account credentials are used to access the SDS server. - FROM_PLUGIN: Custom authenticator credentials are used to access the SDS server. 167 "fromPlugin": { # [Deprecated] Custom authenticator credentials. Custom authenticator credentials. # Custom authenticator credentials. Valid if callCredentialType is FROM_PLUGIN. 168 "name": "A String", # Plugin name. 169 "structConfig": "A String", # A text proto that conforms to a Struct type definition interpreted by the plugin. 170 }, 171 }, 172 "channelCredentials": { # [Deprecated] gRPC channel credentials to access the SDS server. gRPC channel credentials to access the SDS server. # The channel credentials to access the SDS server. 173 "certificates": { # [Deprecated] The paths to the mounted TLS Certificates and private key. The paths to the mounted TLS Certificates and private key. # The call credentials to access the SDS server. 174 "certificatePath": "A String", # The path to the file holding the client or server TLS certificate to use. 175 "privateKeyPath": "A String", # The path to the file holding the client or server private key. 176 }, 177 "channelCredentialType": "A String", # The channel credentials to access the SDS server. This field can be set to one of the following: CERTIFICATES: Use TLS certificates to access the SDS server. GCE_VM: Use local GCE VM credentials to access the SDS server. 178 }, 179 "targetUri": "A String", # The target URI of the SDS server. 180 }, 181 }, 182 }, 183 "validationContext": { # [Deprecated] Defines the mechanism to obtain the Certificate Authority certificate to validate the client/server certificate. validate the client/server certificate. # Defines the mechanism to obtain the Certificate Authority certificate to validate the client/server certificate. If omitted, the proxy will not validate the server or client certificate. 184 "certificatePath": "A String", # The path to the file holding the CA certificate to validate the client or server certificate. 185 "sdsConfig": { # [Deprecated] The configuration to access the SDS server. The configuration to access the SDS server. # Specifies the config to retrieve certificates through SDS. This field is applicable only if tlsCertificateSource is set to USE_SDS. 186 "grpcServiceConfig": { # [Deprecated] gRPC config to access the SDS server. gRPC config to access the SDS server. # The configuration to access the SDS server over GRPC. 187 "callCredentials": { # [Deprecated] gRPC call credentials to access the SDS server. gRPC call credentials to access the SDS server. # The call credentials to access the SDS server. 188 "callCredentialType": "A String", # The type of call credentials to use for GRPC requests to the SDS server. This field can be set to one of the following: - GCE_VM: The local GCE VM service account credentials are used to access the SDS server. - FROM_PLUGIN: Custom authenticator credentials are used to access the SDS server. 189 "fromPlugin": { # [Deprecated] Custom authenticator credentials. Custom authenticator credentials. # Custom authenticator credentials. Valid if callCredentialType is FROM_PLUGIN. 190 "name": "A String", # Plugin name. 191 "structConfig": "A String", # A text proto that conforms to a Struct type definition interpreted by the plugin. 192 }, 193 }, 194 "channelCredentials": { # [Deprecated] gRPC channel credentials to access the SDS server. gRPC channel credentials to access the SDS server. # The channel credentials to access the SDS server. 195 "certificates": { # [Deprecated] The paths to the mounted TLS Certificates and private key. The paths to the mounted TLS Certificates and private key. # The call credentials to access the SDS server. 196 "certificatePath": "A String", # The path to the file holding the client or server TLS certificate to use. 197 "privateKeyPath": "A String", # The path to the file holding the client or server private key. 198 }, 199 "channelCredentialType": "A String", # The channel credentials to access the SDS server. This field can be set to one of the following: CERTIFICATES: Use TLS certificates to access the SDS server. GCE_VM: Use local GCE VM credentials to access the SDS server. 200 }, 201 "targetUri": "A String", # The target URI of the SDS server. 202 }, 203 }, 204 "validationSource": "A String", # Defines how TLS certificates are obtained. 205 }, 206 }, 207 "subjectAltNames": [ # A list of alternate names to verify the subject identity in the certificate presented by the client. 208 "A String", 209 ], 210 "tlsMode": "A String", # Indicates whether connections should be secured using TLS. The value of this field determines how TLS is enforced. This field can be set to one of the following: - SIMPLE Secure connections with standard TLS semantics. - MUTUAL Secure connections to the backends using mutual TLS by presenting client certificates for authentication. 211 }, 212 "warnings": [ # [Output Only] If potential misconfigurations are detected for this SSL policy, this field will be populated with warning messages. 213 { 214 "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. 215 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 216 { 217 "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). 218 "value": "A String", # [Output Only] A warning data value corresponding to the key. 219 }, 220 ], 221 "message": "A String", # [Output Only] A human-readable description of the warning code. 222 }, 223 ], 224 }, 225 ], 226 "warning": { # Informational warning which replaces the list of SSL policies when the list is empty. 227 "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. 228 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 229 { 230 "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). 231 "value": "A String", # [Output Only] A warning data value corresponding to the key. 232 }, 233 ], 234 "message": "A String", # [Output Only] A human-readable description of the warning code. 235 }, 236 }, 237 }, 238 "kind": "compute#sslPoliciesAggregatedList", # [Output Only] Type of resource. Always compute#sslPolicyAggregatedList for lists of SSL Policies. 239 "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. 240 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 241 "unreachables": [ # [Output Only] Unreachable resources. 242 "A String", 243 ], 244 "warning": { # [Output Only] Informational warning message. 245 "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. 246 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 247 { 248 "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). 249 "value": "A String", # [Output Only] A warning data value corresponding to the key. 250 }, 251 ], 252 "message": "A String", # [Output Only] A human-readable description of the warning code. 253 }, 254}</pre> 255</div> 256 257<div class="method"> 258 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code> 259 <pre>Retrieves the next page of results. 260 261Args: 262 previous_request: The request for the previous page. (required) 263 previous_response: The response from the request for the previous page. (required) 264 265Returns: 266 A request object that you can call 'execute()' on to request the next 267 page. Returns None if there are no more items in the collection. 268 </pre> 269</div> 270 271<div class="method"> 272 <code class="details" id="close">close()</code> 273 <pre>Close httplib2 connections.</pre> 274</div> 275 276<div class="method"> 277 <code class="details" id="delete">delete(project, sslPolicy, requestId=None, x__xgafv=None)</code> 278 <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. 279 280Args: 281 project: string, Project ID for this request. (required) 282 sslPolicy: string, Name of the SSL policy to delete. The name must be 1-63 characters long, and comply with RFC1035. (required) 283 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). 284 x__xgafv: string, V1 error format. 285 Allowed values 286 1 - v1 error format 287 2 - v2 error format 288 289Returns: 290 An object of the form: 291 292 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/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. 293 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 294 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 295 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 296 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 297 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 298 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 299 { 300 "code": "A String", # [Output Only] The error type identifier for this error. 301 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 302 "message": "A String", # [Output Only] An optional, human-readable error message. 303 }, 304 ], 305 }, 306 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 307 "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. 308 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 309 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 310 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 311 "metadata": { # [Output Only] Service-specific metadata attached to this operation. 312 "a_key": "", # Properties of the object. Contains field @type with type URL. 313 }, 314 "name": "A String", # [Output Only] Name of the operation. 315 "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. 316 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 317 "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. 318 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 319 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 320 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 321 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 322 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 323 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 324 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 325 "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. 326 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 327 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 328 { 329 "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. 330 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 331 { 332 "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). 333 "value": "A String", # [Output Only] A warning data value corresponding to the key. 334 }, 335 ], 336 "message": "A String", # [Output Only] A human-readable description of the warning code. 337 }, 338 ], 339 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 340}</pre> 341</div> 342 343<div class="method"> 344 <code class="details" id="get">get(project, sslPolicy, x__xgafv=None)</code> 345 <pre>Lists all of the ordered rules present in a single specified policy. 346 347Args: 348 project: string, Project ID for this request. (required) 349 sslPolicy: string, Name of the SSL policy to update. The name must be 1-63 characters long, and comply with RFC1035. (required) 350 x__xgafv: string, V1 error format. 351 Allowed values 352 1 - v1 error format 353 2 - v2 error format 354 355Returns: 356 An object of the form: 357 358 { # 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. 359 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 360 "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. 361 "A String", 362 ], 363 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 364 "enabledFeatures": [ # [Output Only] The list of features enabled in the SSL policy. 365 "A String", 366 ], 367 "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. 368 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 369 "kind": "compute#sslPolicy", # [Output only] Type of the resource. Always compute#sslPolicyfor SSL policies. 370 "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. 371 "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. 372 "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. 373 "region": "A String", # [Output Only] URL of the region where the regional SSL policy resides. This field is not applicable to global SSL policies. 374 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 375 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 376 "tlsSettings": { # The TLS settings for the server. # Security settings for the proxy. This field is only applicable to a global backend service with the loadBalancingScheme set to INTERNAL_SELF_MANAGED. 377 "proxyTlsContext": { # [Deprecated] The TLS settings for the client or server. The TLS settings for the client or server. # Configures the mechanism to obtain security certificates and identity information. 378 "certificateContext": { # [Deprecated] Defines the mechanism to obtain the client or server certificate. Defines the mechanism to obtain the client or server certificate. # Defines the mechanism to obtain the client or server certificate. 379 "certificatePaths": { # [Deprecated] The paths to the mounted TLS Certificates and private key. The paths to the mounted TLS Certificates and private key. # Specifies the certificate and private key paths. This field is applicable only if tlsCertificateSource is set to USE_PATH. 380 "certificatePath": "A String", # The path to the file holding the client or server TLS certificate to use. 381 "privateKeyPath": "A String", # The path to the file holding the client or server private key. 382 }, 383 "certificateSource": "A String", # Defines how TLS certificates are obtained. 384 "sdsConfig": { # [Deprecated] The configuration to access the SDS server. The configuration to access the SDS server. # Specifies the config to retrieve certificates through SDS. This field is applicable only if tlsCertificateSource is set to USE_SDS. 385 "grpcServiceConfig": { # [Deprecated] gRPC config to access the SDS server. gRPC config to access the SDS server. # The configuration to access the SDS server over GRPC. 386 "callCredentials": { # [Deprecated] gRPC call credentials to access the SDS server. gRPC call credentials to access the SDS server. # The call credentials to access the SDS server. 387 "callCredentialType": "A String", # The type of call credentials to use for GRPC requests to the SDS server. This field can be set to one of the following: - GCE_VM: The local GCE VM service account credentials are used to access the SDS server. - FROM_PLUGIN: Custom authenticator credentials are used to access the SDS server. 388 "fromPlugin": { # [Deprecated] Custom authenticator credentials. Custom authenticator credentials. # Custom authenticator credentials. Valid if callCredentialType is FROM_PLUGIN. 389 "name": "A String", # Plugin name. 390 "structConfig": "A String", # A text proto that conforms to a Struct type definition interpreted by the plugin. 391 }, 392 }, 393 "channelCredentials": { # [Deprecated] gRPC channel credentials to access the SDS server. gRPC channel credentials to access the SDS server. # The channel credentials to access the SDS server. 394 "certificates": { # [Deprecated] The paths to the mounted TLS Certificates and private key. The paths to the mounted TLS Certificates and private key. # The call credentials to access the SDS server. 395 "certificatePath": "A String", # The path to the file holding the client or server TLS certificate to use. 396 "privateKeyPath": "A String", # The path to the file holding the client or server private key. 397 }, 398 "channelCredentialType": "A String", # The channel credentials to access the SDS server. This field can be set to one of the following: CERTIFICATES: Use TLS certificates to access the SDS server. GCE_VM: Use local GCE VM credentials to access the SDS server. 399 }, 400 "targetUri": "A String", # The target URI of the SDS server. 401 }, 402 }, 403 }, 404 "validationContext": { # [Deprecated] Defines the mechanism to obtain the Certificate Authority certificate to validate the client/server certificate. validate the client/server certificate. # Defines the mechanism to obtain the Certificate Authority certificate to validate the client/server certificate. If omitted, the proxy will not validate the server or client certificate. 405 "certificatePath": "A String", # The path to the file holding the CA certificate to validate the client or server certificate. 406 "sdsConfig": { # [Deprecated] The configuration to access the SDS server. The configuration to access the SDS server. # Specifies the config to retrieve certificates through SDS. This field is applicable only if tlsCertificateSource is set to USE_SDS. 407 "grpcServiceConfig": { # [Deprecated] gRPC config to access the SDS server. gRPC config to access the SDS server. # The configuration to access the SDS server over GRPC. 408 "callCredentials": { # [Deprecated] gRPC call credentials to access the SDS server. gRPC call credentials to access the SDS server. # The call credentials to access the SDS server. 409 "callCredentialType": "A String", # The type of call credentials to use for GRPC requests to the SDS server. This field can be set to one of the following: - GCE_VM: The local GCE VM service account credentials are used to access the SDS server. - FROM_PLUGIN: Custom authenticator credentials are used to access the SDS server. 410 "fromPlugin": { # [Deprecated] Custom authenticator credentials. Custom authenticator credentials. # Custom authenticator credentials. Valid if callCredentialType is FROM_PLUGIN. 411 "name": "A String", # Plugin name. 412 "structConfig": "A String", # A text proto that conforms to a Struct type definition interpreted by the plugin. 413 }, 414 }, 415 "channelCredentials": { # [Deprecated] gRPC channel credentials to access the SDS server. gRPC channel credentials to access the SDS server. # The channel credentials to access the SDS server. 416 "certificates": { # [Deprecated] The paths to the mounted TLS Certificates and private key. The paths to the mounted TLS Certificates and private key. # The call credentials to access the SDS server. 417 "certificatePath": "A String", # The path to the file holding the client or server TLS certificate to use. 418 "privateKeyPath": "A String", # The path to the file holding the client or server private key. 419 }, 420 "channelCredentialType": "A String", # The channel credentials to access the SDS server. This field can be set to one of the following: CERTIFICATES: Use TLS certificates to access the SDS server. GCE_VM: Use local GCE VM credentials to access the SDS server. 421 }, 422 "targetUri": "A String", # The target URI of the SDS server. 423 }, 424 }, 425 "validationSource": "A String", # Defines how TLS certificates are obtained. 426 }, 427 }, 428 "subjectAltNames": [ # A list of alternate names to verify the subject identity in the certificate presented by the client. 429 "A String", 430 ], 431 "tlsMode": "A String", # Indicates whether connections should be secured using TLS. The value of this field determines how TLS is enforced. This field can be set to one of the following: - SIMPLE Secure connections with standard TLS semantics. - MUTUAL Secure connections to the backends using mutual TLS by presenting client certificates for authentication. 432 }, 433 "warnings": [ # [Output Only] If potential misconfigurations are detected for this SSL policy, this field will be populated with warning messages. 434 { 435 "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. 436 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 437 { 438 "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). 439 "value": "A String", # [Output Only] A warning data value corresponding to the key. 440 }, 441 ], 442 "message": "A String", # [Output Only] A human-readable description of the warning code. 443 }, 444 ], 445}</pre> 446</div> 447 448<div class="method"> 449 <code class="details" id="insert">insert(project, body=None, requestId=None, x__xgafv=None)</code> 450 <pre>Returns the specified SSL policy resource. Gets a list of available SSL policies by making a list() request. 451 452Args: 453 project: string, Project ID for this request. (required) 454 body: object, The request body. 455 The object takes the form of: 456 457{ # 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. 458 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 459 "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. 460 "A String", 461 ], 462 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 463 "enabledFeatures": [ # [Output Only] The list of features enabled in the SSL policy. 464 "A String", 465 ], 466 "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. 467 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 468 "kind": "compute#sslPolicy", # [Output only] Type of the resource. Always compute#sslPolicyfor SSL policies. 469 "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. 470 "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. 471 "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. 472 "region": "A String", # [Output Only] URL of the region where the regional SSL policy resides. This field is not applicable to global SSL policies. 473 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 474 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 475 "tlsSettings": { # The TLS settings for the server. # Security settings for the proxy. This field is only applicable to a global backend service with the loadBalancingScheme set to INTERNAL_SELF_MANAGED. 476 "proxyTlsContext": { # [Deprecated] The TLS settings for the client or server. The TLS settings for the client or server. # Configures the mechanism to obtain security certificates and identity information. 477 "certificateContext": { # [Deprecated] Defines the mechanism to obtain the client or server certificate. Defines the mechanism to obtain the client or server certificate. # Defines the mechanism to obtain the client or server certificate. 478 "certificatePaths": { # [Deprecated] The paths to the mounted TLS Certificates and private key. The paths to the mounted TLS Certificates and private key. # Specifies the certificate and private key paths. This field is applicable only if tlsCertificateSource is set to USE_PATH. 479 "certificatePath": "A String", # The path to the file holding the client or server TLS certificate to use. 480 "privateKeyPath": "A String", # The path to the file holding the client or server private key. 481 }, 482 "certificateSource": "A String", # Defines how TLS certificates are obtained. 483 "sdsConfig": { # [Deprecated] The configuration to access the SDS server. The configuration to access the SDS server. # Specifies the config to retrieve certificates through SDS. This field is applicable only if tlsCertificateSource is set to USE_SDS. 484 "grpcServiceConfig": { # [Deprecated] gRPC config to access the SDS server. gRPC config to access the SDS server. # The configuration to access the SDS server over GRPC. 485 "callCredentials": { # [Deprecated] gRPC call credentials to access the SDS server. gRPC call credentials to access the SDS server. # The call credentials to access the SDS server. 486 "callCredentialType": "A String", # The type of call credentials to use for GRPC requests to the SDS server. This field can be set to one of the following: - GCE_VM: The local GCE VM service account credentials are used to access the SDS server. - FROM_PLUGIN: Custom authenticator credentials are used to access the SDS server. 487 "fromPlugin": { # [Deprecated] Custom authenticator credentials. Custom authenticator credentials. # Custom authenticator credentials. Valid if callCredentialType is FROM_PLUGIN. 488 "name": "A String", # Plugin name. 489 "structConfig": "A String", # A text proto that conforms to a Struct type definition interpreted by the plugin. 490 }, 491 }, 492 "channelCredentials": { # [Deprecated] gRPC channel credentials to access the SDS server. gRPC channel credentials to access the SDS server. # The channel credentials to access the SDS server. 493 "certificates": { # [Deprecated] The paths to the mounted TLS Certificates and private key. The paths to the mounted TLS Certificates and private key. # The call credentials to access the SDS server. 494 "certificatePath": "A String", # The path to the file holding the client or server TLS certificate to use. 495 "privateKeyPath": "A String", # The path to the file holding the client or server private key. 496 }, 497 "channelCredentialType": "A String", # The channel credentials to access the SDS server. This field can be set to one of the following: CERTIFICATES: Use TLS certificates to access the SDS server. GCE_VM: Use local GCE VM credentials to access the SDS server. 498 }, 499 "targetUri": "A String", # The target URI of the SDS server. 500 }, 501 }, 502 }, 503 "validationContext": { # [Deprecated] Defines the mechanism to obtain the Certificate Authority certificate to validate the client/server certificate. validate the client/server certificate. # Defines the mechanism to obtain the Certificate Authority certificate to validate the client/server certificate. If omitted, the proxy will not validate the server or client certificate. 504 "certificatePath": "A String", # The path to the file holding the CA certificate to validate the client or server certificate. 505 "sdsConfig": { # [Deprecated] The configuration to access the SDS server. The configuration to access the SDS server. # Specifies the config to retrieve certificates through SDS. This field is applicable only if tlsCertificateSource is set to USE_SDS. 506 "grpcServiceConfig": { # [Deprecated] gRPC config to access the SDS server. gRPC config to access the SDS server. # The configuration to access the SDS server over GRPC. 507 "callCredentials": { # [Deprecated] gRPC call credentials to access the SDS server. gRPC call credentials to access the SDS server. # The call credentials to access the SDS server. 508 "callCredentialType": "A String", # The type of call credentials to use for GRPC requests to the SDS server. This field can be set to one of the following: - GCE_VM: The local GCE VM service account credentials are used to access the SDS server. - FROM_PLUGIN: Custom authenticator credentials are used to access the SDS server. 509 "fromPlugin": { # [Deprecated] Custom authenticator credentials. Custom authenticator credentials. # Custom authenticator credentials. Valid if callCredentialType is FROM_PLUGIN. 510 "name": "A String", # Plugin name. 511 "structConfig": "A String", # A text proto that conforms to a Struct type definition interpreted by the plugin. 512 }, 513 }, 514 "channelCredentials": { # [Deprecated] gRPC channel credentials to access the SDS server. gRPC channel credentials to access the SDS server. # The channel credentials to access the SDS server. 515 "certificates": { # [Deprecated] The paths to the mounted TLS Certificates and private key. The paths to the mounted TLS Certificates and private key. # The call credentials to access the SDS server. 516 "certificatePath": "A String", # The path to the file holding the client or server TLS certificate to use. 517 "privateKeyPath": "A String", # The path to the file holding the client or server private key. 518 }, 519 "channelCredentialType": "A String", # The channel credentials to access the SDS server. This field can be set to one of the following: CERTIFICATES: Use TLS certificates to access the SDS server. GCE_VM: Use local GCE VM credentials to access the SDS server. 520 }, 521 "targetUri": "A String", # The target URI of the SDS server. 522 }, 523 }, 524 "validationSource": "A String", # Defines how TLS certificates are obtained. 525 }, 526 }, 527 "subjectAltNames": [ # A list of alternate names to verify the subject identity in the certificate presented by the client. 528 "A String", 529 ], 530 "tlsMode": "A String", # Indicates whether connections should be secured using TLS. The value of this field determines how TLS is enforced. This field can be set to one of the following: - SIMPLE Secure connections with standard TLS semantics. - MUTUAL Secure connections to the backends using mutual TLS by presenting client certificates for authentication. 531 }, 532 "warnings": [ # [Output Only] If potential misconfigurations are detected for this SSL policy, this field will be populated with warning messages. 533 { 534 "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. 535 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 536 { 537 "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). 538 "value": "A String", # [Output Only] A warning data value corresponding to the key. 539 }, 540 ], 541 "message": "A String", # [Output Only] A human-readable description of the warning code. 542 }, 543 ], 544} 545 546 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). 547 x__xgafv: string, V1 error format. 548 Allowed values 549 1 - v1 error format 550 2 - v2 error format 551 552Returns: 553 An object of the form: 554 555 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/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. 556 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 557 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 558 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 559 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 560 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 561 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 562 { 563 "code": "A String", # [Output Only] The error type identifier for this error. 564 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 565 "message": "A String", # [Output Only] An optional, human-readable error message. 566 }, 567 ], 568 }, 569 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 570 "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. 571 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 572 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 573 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 574 "metadata": { # [Output Only] Service-specific metadata attached to this operation. 575 "a_key": "", # Properties of the object. Contains field @type with type URL. 576 }, 577 "name": "A String", # [Output Only] Name of the operation. 578 "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. 579 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 580 "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. 581 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 582 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 583 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 584 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 585 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 586 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 587 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 588 "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. 589 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 590 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 591 { 592 "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. 593 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 594 { 595 "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). 596 "value": "A String", # [Output Only] A warning data value corresponding to the key. 597 }, 598 ], 599 "message": "A String", # [Output Only] A human-readable description of the warning code. 600 }, 601 ], 602 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 603}</pre> 604</div> 605 606<div class="method"> 607 <code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code> 608 <pre>Lists all the SSL policies that have been configured for the specified project. 609 610Args: 611 project: string, Project ID for this request. (required) 612 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) ``` 613 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`) 614 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. 615 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. 616 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. 617 x__xgafv: string, V1 error format. 618 Allowed values 619 1 - v1 error format 620 2 - v2 error format 621 622Returns: 623 An object of the form: 624 625 { 626 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 627 "items": [ # A list of SslPolicy resources. 628 { # 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. 629 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 630 "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. 631 "A String", 632 ], 633 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 634 "enabledFeatures": [ # [Output Only] The list of features enabled in the SSL policy. 635 "A String", 636 ], 637 "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. 638 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 639 "kind": "compute#sslPolicy", # [Output only] Type of the resource. Always compute#sslPolicyfor SSL policies. 640 "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. 641 "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. 642 "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. 643 "region": "A String", # [Output Only] URL of the region where the regional SSL policy resides. This field is not applicable to global SSL policies. 644 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 645 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 646 "tlsSettings": { # The TLS settings for the server. # Security settings for the proxy. This field is only applicable to a global backend service with the loadBalancingScheme set to INTERNAL_SELF_MANAGED. 647 "proxyTlsContext": { # [Deprecated] The TLS settings for the client or server. The TLS settings for the client or server. # Configures the mechanism to obtain security certificates and identity information. 648 "certificateContext": { # [Deprecated] Defines the mechanism to obtain the client or server certificate. Defines the mechanism to obtain the client or server certificate. # Defines the mechanism to obtain the client or server certificate. 649 "certificatePaths": { # [Deprecated] The paths to the mounted TLS Certificates and private key. The paths to the mounted TLS Certificates and private key. # Specifies the certificate and private key paths. This field is applicable only if tlsCertificateSource is set to USE_PATH. 650 "certificatePath": "A String", # The path to the file holding the client or server TLS certificate to use. 651 "privateKeyPath": "A String", # The path to the file holding the client or server private key. 652 }, 653 "certificateSource": "A String", # Defines how TLS certificates are obtained. 654 "sdsConfig": { # [Deprecated] The configuration to access the SDS server. The configuration to access the SDS server. # Specifies the config to retrieve certificates through SDS. This field is applicable only if tlsCertificateSource is set to USE_SDS. 655 "grpcServiceConfig": { # [Deprecated] gRPC config to access the SDS server. gRPC config to access the SDS server. # The configuration to access the SDS server over GRPC. 656 "callCredentials": { # [Deprecated] gRPC call credentials to access the SDS server. gRPC call credentials to access the SDS server. # The call credentials to access the SDS server. 657 "callCredentialType": "A String", # The type of call credentials to use for GRPC requests to the SDS server. This field can be set to one of the following: - GCE_VM: The local GCE VM service account credentials are used to access the SDS server. - FROM_PLUGIN: Custom authenticator credentials are used to access the SDS server. 658 "fromPlugin": { # [Deprecated] Custom authenticator credentials. Custom authenticator credentials. # Custom authenticator credentials. Valid if callCredentialType is FROM_PLUGIN. 659 "name": "A String", # Plugin name. 660 "structConfig": "A String", # A text proto that conforms to a Struct type definition interpreted by the plugin. 661 }, 662 }, 663 "channelCredentials": { # [Deprecated] gRPC channel credentials to access the SDS server. gRPC channel credentials to access the SDS server. # The channel credentials to access the SDS server. 664 "certificates": { # [Deprecated] The paths to the mounted TLS Certificates and private key. The paths to the mounted TLS Certificates and private key. # The call credentials to access the SDS server. 665 "certificatePath": "A String", # The path to the file holding the client or server TLS certificate to use. 666 "privateKeyPath": "A String", # The path to the file holding the client or server private key. 667 }, 668 "channelCredentialType": "A String", # The channel credentials to access the SDS server. This field can be set to one of the following: CERTIFICATES: Use TLS certificates to access the SDS server. GCE_VM: Use local GCE VM credentials to access the SDS server. 669 }, 670 "targetUri": "A String", # The target URI of the SDS server. 671 }, 672 }, 673 }, 674 "validationContext": { # [Deprecated] Defines the mechanism to obtain the Certificate Authority certificate to validate the client/server certificate. validate the client/server certificate. # Defines the mechanism to obtain the Certificate Authority certificate to validate the client/server certificate. If omitted, the proxy will not validate the server or client certificate. 675 "certificatePath": "A String", # The path to the file holding the CA certificate to validate the client or server certificate. 676 "sdsConfig": { # [Deprecated] The configuration to access the SDS server. The configuration to access the SDS server. # Specifies the config to retrieve certificates through SDS. This field is applicable only if tlsCertificateSource is set to USE_SDS. 677 "grpcServiceConfig": { # [Deprecated] gRPC config to access the SDS server. gRPC config to access the SDS server. # The configuration to access the SDS server over GRPC. 678 "callCredentials": { # [Deprecated] gRPC call credentials to access the SDS server. gRPC call credentials to access the SDS server. # The call credentials to access the SDS server. 679 "callCredentialType": "A String", # The type of call credentials to use for GRPC requests to the SDS server. This field can be set to one of the following: - GCE_VM: The local GCE VM service account credentials are used to access the SDS server. - FROM_PLUGIN: Custom authenticator credentials are used to access the SDS server. 680 "fromPlugin": { # [Deprecated] Custom authenticator credentials. Custom authenticator credentials. # Custom authenticator credentials. Valid if callCredentialType is FROM_PLUGIN. 681 "name": "A String", # Plugin name. 682 "structConfig": "A String", # A text proto that conforms to a Struct type definition interpreted by the plugin. 683 }, 684 }, 685 "channelCredentials": { # [Deprecated] gRPC channel credentials to access the SDS server. gRPC channel credentials to access the SDS server. # The channel credentials to access the SDS server. 686 "certificates": { # [Deprecated] The paths to the mounted TLS Certificates and private key. The paths to the mounted TLS Certificates and private key. # The call credentials to access the SDS server. 687 "certificatePath": "A String", # The path to the file holding the client or server TLS certificate to use. 688 "privateKeyPath": "A String", # The path to the file holding the client or server private key. 689 }, 690 "channelCredentialType": "A String", # The channel credentials to access the SDS server. This field can be set to one of the following: CERTIFICATES: Use TLS certificates to access the SDS server. GCE_VM: Use local GCE VM credentials to access the SDS server. 691 }, 692 "targetUri": "A String", # The target URI of the SDS server. 693 }, 694 }, 695 "validationSource": "A String", # Defines how TLS certificates are obtained. 696 }, 697 }, 698 "subjectAltNames": [ # A list of alternate names to verify the subject identity in the certificate presented by the client. 699 "A String", 700 ], 701 "tlsMode": "A String", # Indicates whether connections should be secured using TLS. The value of this field determines how TLS is enforced. This field can be set to one of the following: - SIMPLE Secure connections with standard TLS semantics. - MUTUAL Secure connections to the backends using mutual TLS by presenting client certificates for authentication. 702 }, 703 "warnings": [ # [Output Only] If potential misconfigurations are detected for this SSL policy, this field will be populated with warning messages. 704 { 705 "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. 706 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 707 { 708 "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). 709 "value": "A String", # [Output Only] A warning data value corresponding to the key. 710 }, 711 ], 712 "message": "A String", # [Output Only] A human-readable description of the warning code. 713 }, 714 ], 715 }, 716 ], 717 "kind": "compute#sslPoliciesList", # [Output Only] Type of the resource. Always compute#sslPoliciesList for lists of sslPolicies. 718 "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. 719 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 720 "warning": { # [Output Only] Informational warning message. 721 "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. 722 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 723 { 724 "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). 725 "value": "A String", # [Output Only] A warning data value corresponding to the key. 726 }, 727 ], 728 "message": "A String", # [Output Only] A human-readable description of the warning code. 729 }, 730}</pre> 731</div> 732 733<div class="method"> 734 <code class="details" id="listAvailableFeatures">listAvailableFeatures(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code> 735 <pre>Lists all features that can be specified in the SSL policy when using custom profile. 736 737Args: 738 project: string, Project ID for this request. (required) 739 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) ``` 740 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`) 741 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. 742 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. 743 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. 744 x__xgafv: string, V1 error format. 745 Allowed values 746 1 - v1 error format 747 2 - v2 error format 748 749Returns: 750 An object of the form: 751 752 { 753 "features": [ 754 "A String", 755 ], 756}</pre> 757</div> 758 759<div class="method"> 760 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 761 <pre>Retrieves the next page of results. 762 763Args: 764 previous_request: The request for the previous page. (required) 765 previous_response: The response from the request for the previous page. (required) 766 767Returns: 768 A request object that you can call 'execute()' on to request the next 769 page. Returns None if there are no more items in the collection. 770 </pre> 771</div> 772 773<div class="method"> 774 <code class="details" id="patch">patch(project, sslPolicy, body=None, requestId=None, x__xgafv=None)</code> 775 <pre>Patches the specified SSL policy with the data included in the request. 776 777Args: 778 project: string, Project ID for this request. (required) 779 sslPolicy: string, Name of the SSL policy to update. The name must be 1-63 characters long, and comply with RFC1035. (required) 780 body: object, The request body. 781 The object takes the form of: 782 783{ # 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. 784 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 785 "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. 786 "A String", 787 ], 788 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 789 "enabledFeatures": [ # [Output Only] The list of features enabled in the SSL policy. 790 "A String", 791 ], 792 "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. 793 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 794 "kind": "compute#sslPolicy", # [Output only] Type of the resource. Always compute#sslPolicyfor SSL policies. 795 "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. 796 "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. 797 "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. 798 "region": "A String", # [Output Only] URL of the region where the regional SSL policy resides. This field is not applicable to global SSL policies. 799 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 800 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 801 "tlsSettings": { # The TLS settings for the server. # Security settings for the proxy. This field is only applicable to a global backend service with the loadBalancingScheme set to INTERNAL_SELF_MANAGED. 802 "proxyTlsContext": { # [Deprecated] The TLS settings for the client or server. The TLS settings for the client or server. # Configures the mechanism to obtain security certificates and identity information. 803 "certificateContext": { # [Deprecated] Defines the mechanism to obtain the client or server certificate. Defines the mechanism to obtain the client or server certificate. # Defines the mechanism to obtain the client or server certificate. 804 "certificatePaths": { # [Deprecated] The paths to the mounted TLS Certificates and private key. The paths to the mounted TLS Certificates and private key. # Specifies the certificate and private key paths. This field is applicable only if tlsCertificateSource is set to USE_PATH. 805 "certificatePath": "A String", # The path to the file holding the client or server TLS certificate to use. 806 "privateKeyPath": "A String", # The path to the file holding the client or server private key. 807 }, 808 "certificateSource": "A String", # Defines how TLS certificates are obtained. 809 "sdsConfig": { # [Deprecated] The configuration to access the SDS server. The configuration to access the SDS server. # Specifies the config to retrieve certificates through SDS. This field is applicable only if tlsCertificateSource is set to USE_SDS. 810 "grpcServiceConfig": { # [Deprecated] gRPC config to access the SDS server. gRPC config to access the SDS server. # The configuration to access the SDS server over GRPC. 811 "callCredentials": { # [Deprecated] gRPC call credentials to access the SDS server. gRPC call credentials to access the SDS server. # The call credentials to access the SDS server. 812 "callCredentialType": "A String", # The type of call credentials to use for GRPC requests to the SDS server. This field can be set to one of the following: - GCE_VM: The local GCE VM service account credentials are used to access the SDS server. - FROM_PLUGIN: Custom authenticator credentials are used to access the SDS server. 813 "fromPlugin": { # [Deprecated] Custom authenticator credentials. Custom authenticator credentials. # Custom authenticator credentials. Valid if callCredentialType is FROM_PLUGIN. 814 "name": "A String", # Plugin name. 815 "structConfig": "A String", # A text proto that conforms to a Struct type definition interpreted by the plugin. 816 }, 817 }, 818 "channelCredentials": { # [Deprecated] gRPC channel credentials to access the SDS server. gRPC channel credentials to access the SDS server. # The channel credentials to access the SDS server. 819 "certificates": { # [Deprecated] The paths to the mounted TLS Certificates and private key. The paths to the mounted TLS Certificates and private key. # The call credentials to access the SDS server. 820 "certificatePath": "A String", # The path to the file holding the client or server TLS certificate to use. 821 "privateKeyPath": "A String", # The path to the file holding the client or server private key. 822 }, 823 "channelCredentialType": "A String", # The channel credentials to access the SDS server. This field can be set to one of the following: CERTIFICATES: Use TLS certificates to access the SDS server. GCE_VM: Use local GCE VM credentials to access the SDS server. 824 }, 825 "targetUri": "A String", # The target URI of the SDS server. 826 }, 827 }, 828 }, 829 "validationContext": { # [Deprecated] Defines the mechanism to obtain the Certificate Authority certificate to validate the client/server certificate. validate the client/server certificate. # Defines the mechanism to obtain the Certificate Authority certificate to validate the client/server certificate. If omitted, the proxy will not validate the server or client certificate. 830 "certificatePath": "A String", # The path to the file holding the CA certificate to validate the client or server certificate. 831 "sdsConfig": { # [Deprecated] The configuration to access the SDS server. The configuration to access the SDS server. # Specifies the config to retrieve certificates through SDS. This field is applicable only if tlsCertificateSource is set to USE_SDS. 832 "grpcServiceConfig": { # [Deprecated] gRPC config to access the SDS server. gRPC config to access the SDS server. # The configuration to access the SDS server over GRPC. 833 "callCredentials": { # [Deprecated] gRPC call credentials to access the SDS server. gRPC call credentials to access the SDS server. # The call credentials to access the SDS server. 834 "callCredentialType": "A String", # The type of call credentials to use for GRPC requests to the SDS server. This field can be set to one of the following: - GCE_VM: The local GCE VM service account credentials are used to access the SDS server. - FROM_PLUGIN: Custom authenticator credentials are used to access the SDS server. 835 "fromPlugin": { # [Deprecated] Custom authenticator credentials. Custom authenticator credentials. # Custom authenticator credentials. Valid if callCredentialType is FROM_PLUGIN. 836 "name": "A String", # Plugin name. 837 "structConfig": "A String", # A text proto that conforms to a Struct type definition interpreted by the plugin. 838 }, 839 }, 840 "channelCredentials": { # [Deprecated] gRPC channel credentials to access the SDS server. gRPC channel credentials to access the SDS server. # The channel credentials to access the SDS server. 841 "certificates": { # [Deprecated] The paths to the mounted TLS Certificates and private key. The paths to the mounted TLS Certificates and private key. # The call credentials to access the SDS server. 842 "certificatePath": "A String", # The path to the file holding the client or server TLS certificate to use. 843 "privateKeyPath": "A String", # The path to the file holding the client or server private key. 844 }, 845 "channelCredentialType": "A String", # The channel credentials to access the SDS server. This field can be set to one of the following: CERTIFICATES: Use TLS certificates to access the SDS server. GCE_VM: Use local GCE VM credentials to access the SDS server. 846 }, 847 "targetUri": "A String", # The target URI of the SDS server. 848 }, 849 }, 850 "validationSource": "A String", # Defines how TLS certificates are obtained. 851 }, 852 }, 853 "subjectAltNames": [ # A list of alternate names to verify the subject identity in the certificate presented by the client. 854 "A String", 855 ], 856 "tlsMode": "A String", # Indicates whether connections should be secured using TLS. The value of this field determines how TLS is enforced. This field can be set to one of the following: - SIMPLE Secure connections with standard TLS semantics. - MUTUAL Secure connections to the backends using mutual TLS by presenting client certificates for authentication. 857 }, 858 "warnings": [ # [Output Only] If potential misconfigurations are detected for this SSL policy, this field will be populated with warning messages. 859 { 860 "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. 861 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 862 { 863 "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). 864 "value": "A String", # [Output Only] A warning data value corresponding to the key. 865 }, 866 ], 867 "message": "A String", # [Output Only] A human-readable description of the warning code. 868 }, 869 ], 870} 871 872 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). 873 x__xgafv: string, V1 error format. 874 Allowed values 875 1 - v1 error format 876 2 - v2 error format 877 878Returns: 879 An object of the form: 880 881 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/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. 882 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 883 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 884 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 885 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 886 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 887 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 888 { 889 "code": "A String", # [Output Only] The error type identifier for this error. 890 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 891 "message": "A String", # [Output Only] An optional, human-readable error message. 892 }, 893 ], 894 }, 895 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 896 "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. 897 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 898 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 899 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 900 "metadata": { # [Output Only] Service-specific metadata attached to this operation. 901 "a_key": "", # Properties of the object. Contains field @type with type URL. 902 }, 903 "name": "A String", # [Output Only] Name of the operation. 904 "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. 905 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 906 "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. 907 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 908 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 909 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 910 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 911 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 912 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 913 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 914 "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. 915 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 916 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 917 { 918 "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. 919 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 920 { 921 "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). 922 "value": "A String", # [Output Only] A warning data value corresponding to the key. 923 }, 924 ], 925 "message": "A String", # [Output Only] A human-readable description of the warning code. 926 }, 927 ], 928 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 929}</pre> 930</div> 931 932<div class="method"> 933 <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body=None, x__xgafv=None)</code> 934 <pre>Returns permissions that a caller has on the specified resource. 935 936Args: 937 project: string, Project ID for this request. (required) 938 resource: string, Name or id of the resource for this request. (required) 939 body: object, The request body. 940 The object takes the form of: 941 942{ 943 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. 944 "A String", 945 ], 946} 947 948 x__xgafv: string, V1 error format. 949 Allowed values 950 1 - v1 error format 951 2 - v2 error format 952 953Returns: 954 An object of the form: 955 956 { 957 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. 958 "A String", 959 ], 960}</pre> 961</div> 962 963</body></html>