| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, 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 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, 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"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 78 | <code><a href="#close">close()</a></code></p> |
| 79 | <p class="firstline">Close httplib2 connections.</p> |
| 80 | <p class="toc_element"> |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame^] | 81 | <code><a href="#delete">delete(project, sslPolicy, requestId=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 82 | <p class="firstline">Deletes the specified SSL policy. The SSL policy resource can be deleted only if it is not in use by any TargetHttpsProxy or TargetSslProxy resources.</p> |
| 83 | <p class="toc_element"> |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame^] | 84 | <code><a href="#get">get(project, sslPolicy, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 85 | <p class="firstline">Lists all of the ordered rules present in a single specified policy.</p> |
| 86 | <p class="toc_element"> |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame^] | 87 | <code><a href="#insert">insert(project, body=None, requestId=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 88 | <p class="firstline">Returns the specified SSL policy resource. Gets a list of available SSL policies by making a list() request.</p> |
| 89 | <p class="toc_element"> |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame^] | 90 | <code><a href="#list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 91 | <p class="firstline">Lists all the SSL policies that have been configured for the specified project.</p> |
| 92 | <p class="toc_element"> |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame^] | 93 | <code><a href="#listAvailableFeatures">listAvailableFeatures(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 94 | <p class="firstline">Lists all features that can be specified in the SSL policy when using custom profile.</p> |
| 95 | <p class="toc_element"> |
| 96 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 97 | <p class="firstline">Retrieves the next page of results.</p> |
| 98 | <p class="toc_element"> |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame^] | 99 | <code><a href="#patch">patch(project, sslPolicy, body=None, requestId=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 100 | <p class="firstline">Patches the specified SSL policy with the data included in the request.</p> |
| 101 | <p class="toc_element"> |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame^] | 102 | <code><a href="#testIamPermissions">testIamPermissions(project, resource, body=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 103 | <p class="firstline">Returns permissions that a caller has on the specified resource.</p> |
| 104 | <h3>Method Details</h3> |
| 105 | <div class="method"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 106 | <code class="details" id="close">close()</code> |
| 107 | <pre>Close httplib2 connections.</pre> |
| 108 | </div> |
| 109 | |
| 110 | <div class="method"> |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame^] | 111 | <code class="details" id="delete">delete(project, sslPolicy, requestId=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 112 | <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. |
| 113 | |
| 114 | Args: |
| 115 | project: string, Project ID for this request. (required) |
| 116 | sslPolicy: string, Name of the SSL policy to delete. The name must be 1-63 characters long, and comply with RFC1035. (required) |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame^] | 117 | 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). |
| 118 | x__xgafv: string, V1 error format. |
| 119 | Allowed values |
| 120 | 1 - v1 error format |
| 121 | 2 - v2 error format |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 122 | |
| 123 | Returns: |
| 124 | An object of the form: |
| 125 | |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame^] | 126 | { # 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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 127 | "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. |
| 128 | "creationTimestamp": "A String", # [Deprecated] This field is deprecated. |
| 129 | "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. |
| 130 | "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. |
| 131 | "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. |
| 132 | "errors": [ # [Output Only] The array of errors encountered while processing this operation. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 133 | { |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 134 | "code": "A String", # [Output Only] The error type identifier for this error. |
| 135 | "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. |
| 136 | "message": "A String", # [Output Only] An optional, human-readable error message. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 137 | }, |
| 138 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 139 | }, |
| 140 | "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. |
| 141 | "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. |
| 142 | "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. |
| 143 | "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. |
| 144 | "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. |
| 145 | "name": "A String", # [Output Only] Name of the operation. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 146 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 147 | "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. |
| 148 | "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. |
| 149 | "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. |
| 150 | "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| 151 | "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. |
| 152 | "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. |
| 153 | "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. |
| 154 | "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. |
| 155 | "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. |
| 156 | "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. |
| 157 | "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`. |
| 158 | "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. |
| 159 | { |
| 160 | "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. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame^] | 161 | "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 162 | { |
| 163 | "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). |
| 164 | "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| 165 | }, |
| 166 | ], |
| 167 | "message": "A String", # [Output Only] A human-readable description of the warning code. |
| 168 | }, |
| 169 | ], |
| 170 | "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. |
| 171 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 172 | </div> |
| 173 | |
| 174 | <div class="method"> |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame^] | 175 | <code class="details" id="get">get(project, sslPolicy, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 176 | <pre>Lists all of the ordered rules present in a single specified policy. |
| 177 | |
| 178 | Args: |
| 179 | project: string, Project ID for this request. (required) |
| 180 | sslPolicy: string, Name of the SSL policy to update. The name must be 1-63 characters long, and comply with RFC1035. (required) |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame^] | 181 | x__xgafv: string, V1 error format. |
| 182 | Allowed values |
| 183 | 1 - v1 error format |
| 184 | 2 - v2 error format |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 185 | |
| 186 | Returns: |
| 187 | An object of the form: |
| 188 | |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame^] | 189 | { # 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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 190 | "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame^] | 191 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 192 | "A String", |
| 193 | ], |
| 194 | "description": "A String", # An optional description of this resource. Provide this property when you create the resource. |
| 195 | "enabledFeatures": [ # [Output Only] The list of features enabled in the SSL policy. |
| 196 | "A String", |
| 197 | ], |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame^] | 198 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 199 | "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. |
| 200 | "kind": "compute#sslPolicy", # [Output only] Type of the resource. Always compute#sslPolicyfor SSL policies. |
| 201 | "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. |
| 202 | "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. |
| 203 | "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. |
| 204 | "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| 205 | "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. |
| 206 | "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. |
| 207 | "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. |
| 208 | "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. |
| 209 | "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. |
| 210 | "certificatePath": "A String", # The path to the file holding the client or server TLS certificate to use. |
| 211 | "privateKeyPath": "A String", # The path to the file holding the client or server private key. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 212 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 213 | "certificateSource": "A String", # Defines how TLS certificates are obtained. |
| 214 | "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. |
| 215 | "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. |
| 216 | "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. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame^] | 217 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 218 | "fromPlugin": { # [Deprecated] Custom authenticator credentials. Custom authenticator credentials. # Custom authenticator credentials. Valid if callCredentialType is FROM_PLUGIN. |
| 219 | "name": "A String", # Plugin name. |
| 220 | "structConfig": "A String", # A text proto that conforms to a Struct type definition interpreted by the plugin. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 221 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 222 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 223 | "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. |
| 224 | "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. |
| 225 | "certificatePath": "A String", # The path to the file holding the client or server TLS certificate to use. |
| 226 | "privateKeyPath": "A String", # The path to the file holding the client or server private key. |
| 227 | }, |
| 228 | "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. |
| 229 | }, |
| 230 | "targetUri": "A String", # The target URI of the SDS server. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 231 | }, |
| 232 | }, |
| 233 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 234 | "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. |
| 235 | "certificatePath": "A String", # The path to the file holding the CA certificate to validate the client or server certificate. |
| 236 | "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. |
| 237 | "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. |
| 238 | "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. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame^] | 239 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 240 | "fromPlugin": { # [Deprecated] Custom authenticator credentials. Custom authenticator credentials. # Custom authenticator credentials. Valid if callCredentialType is FROM_PLUGIN. |
| 241 | "name": "A String", # Plugin name. |
| 242 | "structConfig": "A String", # A text proto that conforms to a Struct type definition interpreted by the plugin. |
| 243 | }, |
| 244 | }, |
| 245 | "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. |
| 246 | "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. |
| 247 | "certificatePath": "A String", # The path to the file holding the client or server TLS certificate to use. |
| 248 | "privateKeyPath": "A String", # The path to the file holding the client or server private key. |
| 249 | }, |
| 250 | "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. |
| 251 | }, |
| 252 | "targetUri": "A String", # The target URI of the SDS server. |
| 253 | }, |
| 254 | }, |
| 255 | "validationSource": "A String", # Defines how TLS certificates are obtained. |
| 256 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 257 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 258 | "subjectAltNames": [ # A list of alternate names to verify the subject identity in the certificate presented by the client. |
| 259 | "A String", |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 260 | ], |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame^] | 261 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 262 | }, |
| 263 | "warnings": [ # [Output Only] If potential misconfigurations are detected for this SSL policy, this field will be populated with warning messages. |
| 264 | { |
| 265 | "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. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame^] | 266 | "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 267 | { |
| 268 | "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). |
| 269 | "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| 270 | }, |
| 271 | ], |
| 272 | "message": "A String", # [Output Only] A human-readable description of the warning code. |
| 273 | }, |
| 274 | ], |
| 275 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 276 | </div> |
| 277 | |
| 278 | <div class="method"> |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame^] | 279 | <code class="details" id="insert">insert(project, body=None, requestId=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 280 | <pre>Returns the specified SSL policy resource. Gets a list of available SSL policies by making a list() request. |
| 281 | |
| 282 | Args: |
| 283 | project: string, Project ID for this request. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 284 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 285 | The object takes the form of: |
| 286 | |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame^] | 287 | { # 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. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 288 | "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame^] | 289 | "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. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 290 | "A String", |
| 291 | ], |
| 292 | "description": "A String", # An optional description of this resource. Provide this property when you create the resource. |
| 293 | "enabledFeatures": [ # [Output Only] The list of features enabled in the SSL policy. |
| 294 | "A String", |
| 295 | ], |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame^] | 296 | "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. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 297 | "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. |
| 298 | "kind": "compute#sslPolicy", # [Output only] Type of the resource. Always compute#sslPolicyfor SSL policies. |
| 299 | "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. |
| 300 | "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. |
| 301 | "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. |
| 302 | "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| 303 | "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. |
| 304 | "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. |
| 305 | "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. |
| 306 | "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. |
| 307 | "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. |
| 308 | "certificatePath": "A String", # The path to the file holding the client or server TLS certificate to use. |
| 309 | "privateKeyPath": "A String", # The path to the file holding the client or server private key. |
| 310 | }, |
| 311 | "certificateSource": "A String", # Defines how TLS certificates are obtained. |
| 312 | "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. |
| 313 | "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. |
| 314 | "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. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame^] | 315 | "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. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 316 | "fromPlugin": { # [Deprecated] Custom authenticator credentials. Custom authenticator credentials. # Custom authenticator credentials. Valid if callCredentialType is FROM_PLUGIN. |
| 317 | "name": "A String", # Plugin name. |
| 318 | "structConfig": "A String", # A text proto that conforms to a Struct type definition interpreted by the plugin. |
| 319 | }, |
| 320 | }, |
| 321 | "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. |
| 322 | "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. |
| 323 | "certificatePath": "A String", # The path to the file holding the client or server TLS certificate to use. |
| 324 | "privateKeyPath": "A String", # The path to the file holding the client or server private key. |
| 325 | }, |
| 326 | "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. |
| 327 | }, |
| 328 | "targetUri": "A String", # The target URI of the SDS server. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 329 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 330 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 331 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 332 | "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. |
| 333 | "certificatePath": "A String", # The path to the file holding the CA certificate to validate the client or server certificate. |
| 334 | "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. |
| 335 | "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. |
| 336 | "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. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame^] | 337 | "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. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 338 | "fromPlugin": { # [Deprecated] Custom authenticator credentials. Custom authenticator credentials. # Custom authenticator credentials. Valid if callCredentialType is FROM_PLUGIN. |
| 339 | "name": "A String", # Plugin name. |
| 340 | "structConfig": "A String", # A text proto that conforms to a Struct type definition interpreted by the plugin. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 341 | }, |
| 342 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 343 | "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. |
| 344 | "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. |
| 345 | "certificatePath": "A String", # The path to the file holding the client or server TLS certificate to use. |
| 346 | "privateKeyPath": "A String", # The path to the file holding the client or server private key. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 347 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 348 | "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. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 349 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 350 | "targetUri": "A String", # The target URI of the SDS server. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 351 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 352 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 353 | "validationSource": "A String", # Defines how TLS certificates are obtained. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 354 | }, |
| 355 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 356 | "subjectAltNames": [ # A list of alternate names to verify the subject identity in the certificate presented by the client. |
| 357 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 358 | ], |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame^] | 359 | "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. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 360 | }, |
| 361 | "warnings": [ # [Output Only] If potential misconfigurations are detected for this SSL policy, this field will be populated with warning messages. |
| 362 | { |
| 363 | "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. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame^] | 364 | "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 365 | { |
| 366 | "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). |
| 367 | "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| 368 | }, |
| 369 | ], |
| 370 | "message": "A String", # [Output Only] A human-readable description of the warning code. |
| 371 | }, |
| 372 | ], |
| 373 | } |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 374 | |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame^] | 375 | 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). |
| 376 | x__xgafv: string, V1 error format. |
| 377 | Allowed values |
| 378 | 1 - v1 error format |
| 379 | 2 - v2 error format |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 380 | |
| 381 | Returns: |
| 382 | An object of the form: |
| 383 | |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame^] | 384 | { # 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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 385 | "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. |
| 386 | "creationTimestamp": "A String", # [Deprecated] This field is deprecated. |
| 387 | "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. |
| 388 | "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. |
| 389 | "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. |
| 390 | "errors": [ # [Output Only] The array of errors encountered while processing this operation. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 391 | { |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 392 | "code": "A String", # [Output Only] The error type identifier for this error. |
| 393 | "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. |
| 394 | "message": "A String", # [Output Only] An optional, human-readable error message. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 395 | }, |
| 396 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 397 | }, |
| 398 | "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. |
| 399 | "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. |
| 400 | "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. |
| 401 | "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. |
| 402 | "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. |
| 403 | "name": "A String", # [Output Only] Name of the operation. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 404 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 405 | "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. |
| 406 | "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. |
| 407 | "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. |
| 408 | "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| 409 | "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. |
| 410 | "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. |
| 411 | "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. |
| 412 | "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. |
| 413 | "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. |
| 414 | "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. |
| 415 | "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`. |
| 416 | "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. |
| 417 | { |
| 418 | "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. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame^] | 419 | "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 420 | { |
| 421 | "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). |
| 422 | "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| 423 | }, |
| 424 | ], |
| 425 | "message": "A String", # [Output Only] A human-readable description of the warning code. |
| 426 | }, |
| 427 | ], |
| 428 | "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. |
| 429 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 430 | </div> |
| 431 | |
| 432 | <div class="method"> |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame^] | 433 | <code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 434 | <pre>Lists all the SSL policies that have been configured for the specified project. |
| 435 | |
| 436 | Args: |
| 437 | project: string, Project ID for this request. (required) |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame^] | 438 | filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. 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) ``` |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 439 | 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`) |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame^] | 440 | 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. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 441 | 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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 442 | returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame^] | 443 | x__xgafv: string, V1 error format. |
| 444 | Allowed values |
| 445 | 1 - v1 error format |
| 446 | 2 - v2 error format |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 447 | |
| 448 | Returns: |
| 449 | An object of the form: |
| 450 | |
| 451 | { |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 452 | "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. |
| 453 | "items": [ # A list of SslPolicy resources. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame^] | 454 | { # 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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 455 | "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame^] | 456 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 457 | "A String", |
| 458 | ], |
| 459 | "description": "A String", # An optional description of this resource. Provide this property when you create the resource. |
| 460 | "enabledFeatures": [ # [Output Only] The list of features enabled in the SSL policy. |
| 461 | "A String", |
| 462 | ], |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame^] | 463 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 464 | "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. |
| 465 | "kind": "compute#sslPolicy", # [Output only] Type of the resource. Always compute#sslPolicyfor SSL policies. |
| 466 | "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. |
| 467 | "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. |
| 468 | "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. |
| 469 | "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| 470 | "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. |
| 471 | "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. |
| 472 | "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. |
| 473 | "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. |
| 474 | "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. |
| 475 | "certificatePath": "A String", # The path to the file holding the client or server TLS certificate to use. |
| 476 | "privateKeyPath": "A String", # The path to the file holding the client or server private key. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 477 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 478 | "certificateSource": "A String", # Defines how TLS certificates are obtained. |
| 479 | "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. |
| 480 | "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. |
| 481 | "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. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame^] | 482 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 483 | "fromPlugin": { # [Deprecated] Custom authenticator credentials. Custom authenticator credentials. # Custom authenticator credentials. Valid if callCredentialType is FROM_PLUGIN. |
| 484 | "name": "A String", # Plugin name. |
| 485 | "structConfig": "A String", # A text proto that conforms to a Struct type definition interpreted by the plugin. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 486 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 487 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 488 | "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. |
| 489 | "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. |
| 490 | "certificatePath": "A String", # The path to the file holding the client or server TLS certificate to use. |
| 491 | "privateKeyPath": "A String", # The path to the file holding the client or server private key. |
| 492 | }, |
| 493 | "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. |
| 494 | }, |
| 495 | "targetUri": "A String", # The target URI of the SDS server. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 496 | }, |
| 497 | }, |
| 498 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 499 | "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. |
| 500 | "certificatePath": "A String", # The path to the file holding the CA certificate to validate the client or server certificate. |
| 501 | "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. |
| 502 | "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. |
| 503 | "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. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame^] | 504 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 505 | "fromPlugin": { # [Deprecated] Custom authenticator credentials. Custom authenticator credentials. # Custom authenticator credentials. Valid if callCredentialType is FROM_PLUGIN. |
| 506 | "name": "A String", # Plugin name. |
| 507 | "structConfig": "A String", # A text proto that conforms to a Struct type definition interpreted by the plugin. |
| 508 | }, |
| 509 | }, |
| 510 | "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. |
| 511 | "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. |
| 512 | "certificatePath": "A String", # The path to the file holding the client or server TLS certificate to use. |
| 513 | "privateKeyPath": "A String", # The path to the file holding the client or server private key. |
| 514 | }, |
| 515 | "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. |
| 516 | }, |
| 517 | "targetUri": "A String", # The target URI of the SDS server. |
| 518 | }, |
| 519 | }, |
| 520 | "validationSource": "A String", # Defines how TLS certificates are obtained. |
| 521 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 522 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 523 | "subjectAltNames": [ # A list of alternate names to verify the subject identity in the certificate presented by the client. |
| 524 | "A String", |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 525 | ], |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame^] | 526 | "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. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 527 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 528 | "warnings": [ # [Output Only] If potential misconfigurations are detected for this SSL policy, this field will be populated with warning messages. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 529 | { |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 530 | "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. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame^] | 531 | "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 532 | { |
| 533 | "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). |
| 534 | "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| 535 | }, |
| 536 | ], |
| 537 | "message": "A String", # [Output Only] A human-readable description of the warning code. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 538 | }, |
| 539 | ], |
| 540 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 541 | ], |
| 542 | "kind": "compute#sslPoliciesList", # [Output Only] Type of the resource. Always compute#sslPoliciesList for lists of sslPolicies. |
| 543 | "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. |
| 544 | "selfLink": "A String", # [Output Only] Server-defined URL for this resource. |
| 545 | "warning": { # [Output Only] Informational warning message. |
| 546 | "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. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame^] | 547 | "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 548 | { |
| 549 | "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). |
| 550 | "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| 551 | }, |
| 552 | ], |
| 553 | "message": "A String", # [Output Only] A human-readable description of the warning code. |
| 554 | }, |
| 555 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 556 | </div> |
| 557 | |
| 558 | <div class="method"> |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame^] | 559 | <code class="details" id="listAvailableFeatures">listAvailableFeatures(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 560 | <pre>Lists all features that can be specified in the SSL policy when using custom profile. |
| 561 | |
| 562 | Args: |
| 563 | project: string, Project ID for this request. (required) |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame^] | 564 | filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. 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) ``` |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 565 | 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`) |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame^] | 566 | 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. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 567 | 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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 568 | returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame^] | 569 | x__xgafv: string, V1 error format. |
| 570 | Allowed values |
| 571 | 1 - v1 error format |
| 572 | 2 - v2 error format |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 573 | |
| 574 | Returns: |
| 575 | An object of the form: |
| 576 | |
| 577 | { |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 578 | "features": [ |
| 579 | "A String", |
| 580 | ], |
| 581 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 582 | </div> |
| 583 | |
| 584 | <div class="method"> |
| 585 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 586 | <pre>Retrieves the next page of results. |
| 587 | |
| 588 | Args: |
| 589 | previous_request: The request for the previous page. (required) |
| 590 | previous_response: The response from the request for the previous page. (required) |
| 591 | |
| 592 | Returns: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 593 | A request object that you can call 'execute()' on to request the next |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 594 | page. Returns None if there are no more items in the collection. |
| 595 | </pre> |
| 596 | </div> |
| 597 | |
| 598 | <div class="method"> |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame^] | 599 | <code class="details" id="patch">patch(project, sslPolicy, body=None, requestId=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 600 | <pre>Patches the specified SSL policy with the data included in the request. |
| 601 | |
| 602 | Args: |
| 603 | project: string, Project ID for this request. (required) |
| 604 | sslPolicy: string, Name of the SSL policy to update. The name must be 1-63 characters long, and comply with RFC1035. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 605 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 606 | The object takes the form of: |
| 607 | |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame^] | 608 | { # 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. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 609 | "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame^] | 610 | "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. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 611 | "A String", |
| 612 | ], |
| 613 | "description": "A String", # An optional description of this resource. Provide this property when you create the resource. |
| 614 | "enabledFeatures": [ # [Output Only] The list of features enabled in the SSL policy. |
| 615 | "A String", |
| 616 | ], |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame^] | 617 | "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. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 618 | "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. |
| 619 | "kind": "compute#sslPolicy", # [Output only] Type of the resource. Always compute#sslPolicyfor SSL policies. |
| 620 | "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. |
| 621 | "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. |
| 622 | "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. |
| 623 | "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| 624 | "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. |
| 625 | "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. |
| 626 | "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. |
| 627 | "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. |
| 628 | "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. |
| 629 | "certificatePath": "A String", # The path to the file holding the client or server TLS certificate to use. |
| 630 | "privateKeyPath": "A String", # The path to the file holding the client or server private key. |
| 631 | }, |
| 632 | "certificateSource": "A String", # Defines how TLS certificates are obtained. |
| 633 | "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. |
| 634 | "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. |
| 635 | "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. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame^] | 636 | "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. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 637 | "fromPlugin": { # [Deprecated] Custom authenticator credentials. Custom authenticator credentials. # Custom authenticator credentials. Valid if callCredentialType is FROM_PLUGIN. |
| 638 | "name": "A String", # Plugin name. |
| 639 | "structConfig": "A String", # A text proto that conforms to a Struct type definition interpreted by the plugin. |
| 640 | }, |
| 641 | }, |
| 642 | "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. |
| 643 | "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. |
| 644 | "certificatePath": "A String", # The path to the file holding the client or server TLS certificate to use. |
| 645 | "privateKeyPath": "A String", # The path to the file holding the client or server private key. |
| 646 | }, |
| 647 | "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. |
| 648 | }, |
| 649 | "targetUri": "A String", # The target URI of the SDS server. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 650 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 651 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 652 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 653 | "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. |
| 654 | "certificatePath": "A String", # The path to the file holding the CA certificate to validate the client or server certificate. |
| 655 | "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. |
| 656 | "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. |
| 657 | "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. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame^] | 658 | "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. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 659 | "fromPlugin": { # [Deprecated] Custom authenticator credentials. Custom authenticator credentials. # Custom authenticator credentials. Valid if callCredentialType is FROM_PLUGIN. |
| 660 | "name": "A String", # Plugin name. |
| 661 | "structConfig": "A String", # A text proto that conforms to a Struct type definition interpreted by the plugin. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 662 | }, |
| 663 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 664 | "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. |
| 665 | "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. |
| 666 | "certificatePath": "A String", # The path to the file holding the client or server TLS certificate to use. |
| 667 | "privateKeyPath": "A String", # The path to the file holding the client or server private key. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 668 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 669 | "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. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 670 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 671 | "targetUri": "A String", # The target URI of the SDS server. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 672 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 673 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 674 | "validationSource": "A String", # Defines how TLS certificates are obtained. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 675 | }, |
| 676 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 677 | "subjectAltNames": [ # A list of alternate names to verify the subject identity in the certificate presented by the client. |
| 678 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 679 | ], |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame^] | 680 | "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. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 681 | }, |
| 682 | "warnings": [ # [Output Only] If potential misconfigurations are detected for this SSL policy, this field will be populated with warning messages. |
| 683 | { |
| 684 | "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame^] | 685 | "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 686 | { |
| 687 | "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). |
| 688 | "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| 689 | }, |
| 690 | ], |
| 691 | "message": "A String", # [Output Only] A human-readable description of the warning code. |
| 692 | }, |
| 693 | ], |
| 694 | } |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 695 | |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame^] | 696 | 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). |
| 697 | x__xgafv: string, V1 error format. |
| 698 | Allowed values |
| 699 | 1 - v1 error format |
| 700 | 2 - v2 error format |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 701 | |
| 702 | Returns: |
| 703 | An object of the form: |
| 704 | |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame^] | 705 | { # 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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 706 | "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. |
| 707 | "creationTimestamp": "A String", # [Deprecated] This field is deprecated. |
| 708 | "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. |
| 709 | "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. |
| 710 | "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. |
| 711 | "errors": [ # [Output Only] The array of errors encountered while processing this operation. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 712 | { |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 713 | "code": "A String", # [Output Only] The error type identifier for this error. |
| 714 | "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. |
| 715 | "message": "A String", # [Output Only] An optional, human-readable error message. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 716 | }, |
| 717 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 718 | }, |
| 719 | "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. |
| 720 | "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. |
| 721 | "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. |
| 722 | "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. |
| 723 | "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. |
| 724 | "name": "A String", # [Output Only] Name of the operation. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 725 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 726 | "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. |
| 727 | "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. |
| 728 | "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. |
| 729 | "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| 730 | "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. |
| 731 | "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. |
| 732 | "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. |
| 733 | "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. |
| 734 | "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. |
| 735 | "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. |
| 736 | "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`. |
| 737 | "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. |
| 738 | { |
| 739 | "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. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame^] | 740 | "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 741 | { |
| 742 | "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). |
| 743 | "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| 744 | }, |
| 745 | ], |
| 746 | "message": "A String", # [Output Only] A human-readable description of the warning code. |
| 747 | }, |
| 748 | ], |
| 749 | "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. |
| 750 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 751 | </div> |
| 752 | |
| 753 | <div class="method"> |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame^] | 754 | <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 755 | <pre>Returns permissions that a caller has on the specified resource. |
| 756 | |
| 757 | Args: |
| 758 | project: string, Project ID for this request. (required) |
| 759 | resource: string, Name or id of the resource for this request. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 760 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 761 | The object takes the form of: |
| 762 | |
| 763 | { |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 764 | "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. |
| 765 | "A String", |
| 766 | ], |
| 767 | } |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 768 | |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame^] | 769 | x__xgafv: string, V1 error format. |
| 770 | Allowed values |
| 771 | 1 - v1 error format |
| 772 | 2 - v2 error format |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 773 | |
| 774 | Returns: |
| 775 | An object of the form: |
| 776 | |
| 777 | { |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 778 | "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. |
| 779 | "A String", |
| 780 | ], |
| 781 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 782 | </div> |
| 783 | |
| 784 | </body></html> |