SslPoliciesClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.compute_v1.services.ssl_policies.transports.base.SslPoliciesTransport]] = None, client_options: Optional[Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)The SslPolicies API.
Properties
transport
Returns the transport used by the client instance.
| Returns | |
|---|---|
| Type | Description |
SslPoliciesTransport | The transport used by the client instance. |
Methods
SslPoliciesClient
SslPoliciesClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.compute_v1.services.ssl_policies.transports.base.SslPoliciesTransport]] = None, client_options: Optional[Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)Instantiates the ssl policies client.
| Parameters | |
|---|---|
| Name | Description |
credentials |
Optional[google.auth.credentials.Credentials]
The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment. |
transport |
Union[str, SslPoliciesTransport]
The transport to use. If set to None, a transport is chosen automatically. NOTE: "rest" transport functionality is currently in a beta state (preview). We welcome your feedback via an issue in this library's source repository. |
client_options |
Optional[Union[google.api_core.client_options.ClientOptions, dict]]
Custom options for the client. It won't take effect if a |
client_info |
google.api_core.gapic_v1.client_info.ClientInfo
The client info used to send a user-agent string along with API requests. If |
| Exceptions | |
|---|---|
| Type | Description |
google.auth.exceptions.MutualTLSChannelError | If mutual TLS transport creation failed for any reason. |
__exit__
__exit__(type, value, traceback)Releases underlying transport's resources.
aggregated_list
aggregated_list(request: Optional[Union[google.cloud.compute_v1.types.compute.AggregatedListSslPoliciesRequest, dict]] = None, *, project: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())Retrieves the list of all SslPolicy resources, regional and global, available to the specified project.
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.compute_v1.types.AggregatedListSslPoliciesRequest, dict]
The request object. A request message for SslPolicies.AggregatedList. See the method description for details. |
project |
str
Name of the project scoping this request. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.cloud.compute_v1.services.ssl_policies.pagers.AggregatedListPager | Iterating over this object will yield results and resolve additional pages automatically. |
common_billing_account_path
common_billing_account_path(billing_account: str)Returns a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str)Returns a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str)Returns a fully-qualified location string.
common_organization_path
common_organization_path(organization: str)Returns a fully-qualified organization string.
common_project_path
common_project_path(project: str)Returns a fully-qualified project string.
delete
delete(request: Optional[Union[google.cloud.compute_v1.types.compute.DeleteSslPolicyRequest, dict]] = None, *, project: Optional[str] = None, ssl_policy: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())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.
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.compute_v1.types.DeleteSslPolicyRequest, dict]
The request object. A request message for SslPolicies.Delete. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
ssl_policy |
str
Name of the SSL policy to delete. The name must be 1-63 characters long, and comply with RFC1035. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.api_core.extended_operation.ExtendedOperation | An object representing a extended long-running operation. |
delete_unary
delete_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.DeleteSslPolicyRequest, dict]] = None, *, project: Optional[str] = None, ssl_policy: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())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.
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.compute_v1.types.DeleteSslPolicyRequest, dict]
The request object. A request message for SslPolicies.Delete. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
ssl_policy |
str
Name of the SSL policy to delete. The name must be 1-63 characters long, and comply with RFC1035. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.api_core.extended_operation.ExtendedOperation | An object representing a extended long-running operation. |
from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)Creates an instance of this client using the provided credentials file.
| Parameter | |
|---|---|
| Name | Description |
filename |
str
The path to the service account private key json file. |
| Returns | |
|---|---|
| Type | Description |
SslPoliciesClient | The constructed client. |
from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)Creates an instance of this client using the provided credentials info.
| Parameter | |
|---|---|
| Name | Description |
info |
dict
The service account private key info. |
| Returns | |
|---|---|
| Type | Description |
SslPoliciesClient | The constructed client. |
from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)Creates an instance of this client using the provided credentials file.
| Parameter | |
|---|---|
| Name | Description |
filename |
str
The path to the service account private key json file. |
| Returns | |
|---|---|
| Type | Description |
SslPoliciesClient | The constructed client. |
get
get(request: Optional[Union[google.cloud.compute_v1.types.compute.GetSslPolicyRequest, dict]] = None, *, project: Optional[str] = None, ssl_policy: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())Lists all of the ordered rules present in a single specified policy.
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.compute_v1.types.GetSslPolicyRequest, dict]
The request object. A request message for SslPolicies.Get. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
ssl_policy |
str
Name of the SSL policy to update. The name must be 1-63 characters long, and comply with RFC1035. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.cloud.compute_v1.types.SslPolicy | 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. |
get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: Optional[google.api_core.client_options.ClientOptions] = None,
)Return the API endpoint and client cert source for mutual TLS.
The client cert source is determined in the following order:
(1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not "true", the
client cert source is None.
(2) if client_options.client_cert_source is provided, use the provided one; if the
default client cert source exists, use the default one; otherwise the client cert
source is None.
The API endpoint is determined in the following order:
(1) if client_options.api_endpoint if provided, use the provided one.
(2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "always", use the
default mTLS endpoint; if the environment variable is "never", use the default API
endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise
use the default API endpoint.
More details can be found at https://google.aip.dev/auth/4114.
| Parameter | |
|---|---|
| Name | Description |
client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. Only the |
| Exceptions | |
|---|---|
| Type | Description |
google.auth.exceptions.MutualTLSChannelError | If any errors happen. |
| Returns | |
|---|---|
| Type | Description |
Tuple[str, Callable[[], Tuple[bytes, bytes]]] | returns the API endpoint and the client cert source to use. |
insert
insert(request: Optional[Union[google.cloud.compute_v1.types.compute.InsertSslPolicyRequest, dict]] = None, *, project: Optional[str] = None, ssl_policy_resource: Optional[google.cloud.compute_v1.types.compute.SslPolicy] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())Returns the specified SSL policy resource.
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.compute_v1.types.InsertSslPolicyRequest, dict]
The request object. A request message for SslPolicies.Insert. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
ssl_policy_resource |
google.cloud.compute_v1.types.SslPolicy
The body resource for this request This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.api_core.extended_operation.ExtendedOperation | An object representing a extended long-running operation. |
insert_unary
insert_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.InsertSslPolicyRequest, dict]] = None, *, project: Optional[str] = None, ssl_policy_resource: Optional[google.cloud.compute_v1.types.compute.SslPolicy] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())Returns the specified SSL policy resource.
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.compute_v1.types.InsertSslPolicyRequest, dict]
The request object. A request message for SslPolicies.Insert. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
ssl_policy_resource |
google.cloud.compute_v1.types.SslPolicy
The body resource for this request This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.api_core.extended_operation.ExtendedOperation | An object representing a extended long-running operation. |
list
list(request: Optional[Union[google.cloud.compute_v1.types.compute.ListSslPoliciesRequest, dict]] = None, *, project: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())Lists all the SSL policies that have been configured for the specified project.
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.compute_v1.types.ListSslPoliciesRequest, dict]
The request object. A request message for SslPolicies.List. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.cloud.compute_v1.services.ssl_policies.pagers.ListPager | Iterating over this object will yield results and resolve additional pages automatically. |
list_available_features
list_available_features(request: Optional[Union[google.cloud.compute_v1.types.compute.ListAvailableFeaturesSslPoliciesRequest, dict]] = None, *, project: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())Lists all features that can be specified in the SSL policy when using custom profile.
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.compute_v1.types.ListAvailableFeaturesSslPoliciesRequest, dict]
The request object. A request message for SslPolicies.ListAvailableFeatures. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
parse_common_billing_account_path
parse_common_billing_account_path(path: str)Parse a billing_account path into its component segments.
parse_common_folder_path
parse_common_folder_path(path: str)Parse a folder path into its component segments.
parse_common_location_path
parse_common_location_path(path: str)Parse a location path into its component segments.
parse_common_organization_path
parse_common_organization_path(path: str)Parse a organization path into its component segments.
parse_common_project_path
parse_common_project_path(path: str)Parse a project path into its component segments.
patch
patch(request: Optional[Union[google.cloud.compute_v1.types.compute.PatchSslPolicyRequest, dict]] = None, *, project: Optional[str] = None, ssl_policy: Optional[str] = None, ssl_policy_resource: Optional[google.cloud.compute_v1.types.compute.SslPolicy] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())Patches the specified SSL policy with the data included in the request.
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.compute_v1.types.PatchSslPolicyRequest, dict]
The request object. A request message for SslPolicies.Patch. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
ssl_policy |
str
Name of the SSL policy to update. The name must be 1-63 characters long, and comply with RFC1035. This corresponds to the |
ssl_policy_resource |
google.cloud.compute_v1.types.SslPolicy
The body resource for this request This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.api_core.extended_operation.ExtendedOperation | An object representing a extended long-running operation. |
patch_unary
patch_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.PatchSslPolicyRequest, dict]] = None, *, project: Optional[str] = None, ssl_policy: Optional[str] = None, ssl_policy_resource: Optional[google.cloud.compute_v1.types.compute.SslPolicy] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())Patches the specified SSL policy with the data included in the request.
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.compute_v1.types.PatchSslPolicyRequest, dict]
The request object. A request message for SslPolicies.Patch. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
ssl_policy |
str
Name of the SSL policy to update. The name must be 1-63 characters long, and comply with RFC1035. This corresponds to the |
ssl_policy_resource |
google.cloud.compute_v1.types.SslPolicy
The body resource for this request This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.api_core.extended_operation.ExtendedOperation | An object representing a extended long-running operation. |