Class SslPoliciesClient (0.2.1)

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[google.api_core.client_options.ClientOptions] = 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

Return the transport used by the client instance.

Returns
TypeDescription
SslPoliciesTransportThe 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[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instantiate the ssl policies client.

Parameters
NameDescription
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.

client_options google.api_core.client_options.ClientOptions

Custom options for the client. It won't take effect if a transport instance is provided. (1) The api_endpoint property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the api_endpoint property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the client_cert_source property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used.

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 None, then default info will be used. Generally, you only need to set this if you're developing your own client library.

Exceptions
TypeDescription
google.auth.exceptions.MutualTLSChannelErrorIf mutual TLS transport creation failed for any reason.

common_billing_account_path

common_billing_account_path(billing_account: str)

Return a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str)

Return a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str)

Return a fully-qualified location string.

common_organization_path

common_organization_path(organization: str)

Return a fully-qualified organization string.

common_project_path

common_project_path(project: str)

Return a fully-qualified project string.

delete

delete(request: Optional[google.cloud.compute_v1.types.compute.DeleteSslPolicyRequest] = None, *, project: Optional[str] = None, ssl_policy: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, 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
NameDescription
request google.cloud.compute_v1.types.DeleteSslPolicyRequest

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 project field on the request instance; if request is provided, this should not be set.

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 ssl_policy field on the request instance; if request is provided, this should not be set.

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
TypeDescription
google.cloud.compute_v1.types.OperationRepresents an Operation resource. Google Compute Engine has three Operation resources: - [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) \* [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) \* [Zonal](/compute/docs/reference/rest/{$api_version}/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. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
NameDescription
filename str

The path to the service account private key json file.

Returns
TypeDescription
SslPoliciesClientThe 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
NameDescription
info dict

The service account private key info.

Returns
TypeDescription
SslPoliciesClientThe 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
NameDescription
filename str

The path to the service account private key json file.

Returns
TypeDescription
SslPoliciesClientThe constructed client.

get

get(request: Optional[google.cloud.compute_v1.types.compute.GetSslPolicyRequest] = None, *, project: Optional[str] = None, ssl_policy: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists all of the ordered rules present in a single specified policy.

Parameters
NameDescription
request google.cloud.compute_v1.types.GetSslPolicyRequest

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 project field on the request instance; if request is provided, this should not be set.

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 field on the request instance; if request is provided, this should not be set.

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
TypeDescription
google.cloud.compute_v1.types.SslPolicyRepresents 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. (== resource_for {$api_version}.sslPolicies ==)

insert

insert(request: Optional[google.cloud.compute_v1.types.compute.InsertSslPolicyRequest] = None, *, project: Optional[str] = None, ssl_policy_resource: Optional[google.cloud.compute_v1.types.compute.SslPolicy] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Returns the specified SSL policy resource. Gets a list of available SSL policies by making a list() request.

Parameters
NameDescription
request google.cloud.compute_v1.types.InsertSslPolicyRequest

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 project field on the request instance; if request is provided, this should not be set.

ssl_policy_resource google.cloud.compute_v1.types.SslPolicy

The body resource for this request This corresponds to the ssl_policy_resource field on the request instance; if request is provided, this should not be set.

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
TypeDescription
google.cloud.compute_v1.types.OperationRepresents an Operation resource. Google Compute Engine has three Operation resources: - [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) \* [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) \* [Zonal](/compute/docs/reference/rest/{$api_version}/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. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

list

list(request: Optional[google.cloud.compute_v1.types.compute.ListSslPoliciesRequest] = None, *, project: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists all the SSL policies that have been configured for the specified project.

Parameters
NameDescription
request google.cloud.compute_v1.types.ListSslPoliciesRequest

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 project field on the request instance; if request is provided, this should not be set.

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
TypeDescription
google.cloud.compute_v1.services.ssl_policies.pagers.ListPagerIterating over this object will yield results and resolve additional pages automatically.

list_available_features

list_available_features(request: Optional[google.cloud.compute_v1.types.compute.ListAvailableFeaturesSslPoliciesRequest] = None, *, project: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists all features that can be specified in the SSL policy when using custom profile.

Parameters
NameDescription
request google.cloud.compute_v1.types.ListAvailableFeaturesSslPoliciesRequest

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 project field on the request instance; if request is provided, this should not be set.

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[google.cloud.compute_v1.types.compute.PatchSslPolicyRequest] = None, *, project: Optional[str] = None, ssl_policy: Optional[str] = None, ssl_policy_resource: Optional[google.cloud.compute_v1.types.compute.SslPolicy] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Patches the specified SSL policy with the data included in the request.

Parameters
NameDescription
request google.cloud.compute_v1.types.PatchSslPolicyRequest

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 project field on the request instance; if request is provided, this should not be set.

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 field on the request instance; if request is provided, this should not be set.

ssl_policy_resource google.cloud.compute_v1.types.SslPolicy

The body resource for this request This corresponds to the ssl_policy_resource field on the request instance; if request is provided, this should not be set.

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
TypeDescription
google.cloud.compute_v1.types.OperationRepresents an Operation resource. Google Compute Engine has three Operation resources: - [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) \* [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) \* [Zonal](/compute/docs/reference/rest/{$api_version}/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. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)