Class CertificateManagerClient (0.1.3)

CertificateManagerClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.certificate_manager_v1.services.certificate_manager.transports.base.CertificateManagerTransport]] = 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>)

API Overview

Certificates Manager API allows customers to see and manage all their TLS certificates.

Certificates Manager API service provides methods to manage certificates, group them into collections, and create serving configuration that can be easily applied to other Cloud resources e.g. Target Proxies.

Data Model

The Certificates Manager service exposes the following resources:

Certificate which describes a single TLS certificate.
CertificateMap which describes a collection of certificates that can be attached to a target resource.
CertificateMapEntry which describes a single configuration entry that consists of a SNI and a group of certificates. It's a subresource of CertificateMap.

Certificate, CertificateMap and CertificateMapEntry IDs have to match "^[a-z0-9-]{1,63}$" regexp, which means that

only lower case letters, digits, and hyphen are allowed
length of the resource ID has to be in [1,63] range.

Provides methods to manage Cloud Certificate Manager entities.

Properties

transport

Returns the transport used by the client instance.

Returns

Type	Description
`CertificateManagerTransport`	The transport used by the client instance.

Methods

CertificateManagerClient

CertificateManagerClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.certificate_manager_v1.services.certificate_manager.transports.base.CertificateManagerTransport]] = 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>)

Instantiates the certificate manager 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, CertificateManagerTransport]` 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

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.

certificate_map_entry_path

certificate_map_entry_path(
    project: str, location: str, certificate_map: str, certificate_map_entry: str
)

Returns a fully-qualified certificate_map_entry string.

certificate_map_path

certificate_map_path(project: str, location: str, certificate_map: str)

Returns a fully-qualified certificate_map string.

certificate_path

certificate_path(project: str, location: str, certificate: str)

Returns a fully-qualified certificate string.

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.

create_certificate

create_certificate(request: Optional[Union[google.cloud.certificate_manager_v1.types.certificate_manager.CreateCertificateRequest, dict]] = None, *, parent: Optional[str] = None, certificate: Optional[google.cloud.certificate_manager_v1.types.certificate_manager.Certificate] = None, certificate_id: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a new Certificate in a given project and location.

from google.cloud import certificate_manager_v1

def sample_create_certificate():
    # Create a client
    client = certificate_manager_v1.CertificateManagerClient()

    # Initialize request argument(s)
    request = certificate_manager_v1.CreateCertificateRequest(
        parent="parent_value",
        certificate_id="certificate_id_value",
    )

    # Make the request
    operation = client.create_certificate(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

Name	Description
`request`	`Union[google.cloud.certificate_manager_v1.types.CreateCertificateRequest, dict]` The request object. Request for the `CreateCertificate` method.
`parent`	`str` Required. The parent resource of the certificate. Must be in the format `projects//locations/`. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`certificate`	`google.cloud.certificate_manager_v1.types.Certificate` Required. A definition of the certificate to create. This corresponds to the `certificate` field on the `request` instance; if `request` is provided, this should not be set.
`certificate_id`	`str` Required. A user-provided name of the certificate. This corresponds to the `certificate_id` 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

Type	Description
`google.api_core.operation.Operation`	An object representing a long-running operation. The result type for the operation will be Certificate Defines TLS certificate.

create_certificate_map

create_certificate_map(request: Optional[Union[google.cloud.certificate_manager_v1.types.certificate_manager.CreateCertificateMapRequest, dict]] = None, *, parent: Optional[str] = None, certificate_map: Optional[google.cloud.certificate_manager_v1.types.certificate_manager.CertificateMap] = None, certificate_map_id: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a new CertificateMap in a given project and location.

from google.cloud import certificate_manager_v1

def sample_create_certificate_map():
    # Create a client
    client = certificate_manager_v1.CertificateManagerClient()

    # Initialize request argument(s)
    request = certificate_manager_v1.CreateCertificateMapRequest(
        parent="parent_value",
        certificate_map_id="certificate_map_id_value",
    )

    # Make the request
    operation = client.create_certificate_map(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

Name	Description
`request`	`Union[google.cloud.certificate_manager_v1.types.CreateCertificateMapRequest, dict]` The request object. Request for the `CreateCertificateMap` method.
`parent`	`str` Required. The parent resource of the certificate map. Must be in the format `projects//locations/`. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`certificate_map`	`google.cloud.certificate_manager_v1.types.CertificateMap` Required. A definition of the certificate map to create. This corresponds to the `certificate_map` field on the `request` instance; if `request` is provided, this should not be set.
`certificate_map_id`	`str` Required. A user-provided name of the certificate map. This corresponds to the `certificate_map_id` 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

Type	Description
`google.api_core.operation.Operation`	An object representing a long-running operation. The result type for the operation will be CertificateMap Defines a collection of certificate configurations.

create_certificate_map_entry

create_certificate_map_entry(request: Optional[Union[google.cloud.certificate_manager_v1.types.certificate_manager.CreateCertificateMapEntryRequest, dict]] = None, *, parent: Optional[str] = None, certificate_map_entry: Optional[google.cloud.certificate_manager_v1.types.certificate_manager.CertificateMapEntry] = None, certificate_map_entry_id: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a new CertificateMapEntry in a given project and location.

from google.cloud import certificate_manager_v1

def sample_create_certificate_map_entry():
    # Create a client
    client = certificate_manager_v1.CertificateManagerClient()

    # Initialize request argument(s)
    certificate_map_entry = certificate_manager_v1.CertificateMapEntry()
    certificate_map_entry.hostname = "hostname_value"

    request = certificate_manager_v1.CreateCertificateMapEntryRequest(
        parent="parent_value",
        certificate_map_entry_id="certificate_map_entry_id_value",
        certificate_map_entry=certificate_map_entry,
    )

    # Make the request
    operation = client.create_certificate_map_entry(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

Name	Description
`request`	`Union[google.cloud.certificate_manager_v1.types.CreateCertificateMapEntryRequest, dict]` The request object. Request for the `CreateCertificateMapEntry` method.
`parent`	`str` Required. The parent resource of the certificate map entry. Must be in the format `projects//locations//certificateMaps/*`. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`certificate_map_entry`	`google.cloud.certificate_manager_v1.types.CertificateMapEntry` Required. A definition of the certificate map entry to create. This corresponds to the `certificate_map_entry` field on the `request` instance; if `request` is provided, this should not be set.
`certificate_map_entry_id`	`str` Required. A user-provided name of the certificate map entry. This corresponds to the `certificate_map_entry_id` 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

Type	Description
`google.api_core.operation.Operation`	An object representing a long-running operation. The result type for the operation will be CertificateMapEntry Defines a certificate map entry.

create_dns_authorization

create_dns_authorization(request: Optional[Union[google.cloud.certificate_manager_v1.types.certificate_manager.CreateDnsAuthorizationRequest, dict]] = None, *, parent: Optional[str] = None, dns_authorization: Optional[google.cloud.certificate_manager_v1.types.certificate_manager.DnsAuthorization] = None, dns_authorization_id: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a new DnsAuthorization in a given project and location.

from google.cloud import certificate_manager_v1

def sample_create_dns_authorization():
    # Create a client
    client = certificate_manager_v1.CertificateManagerClient()

    # Initialize request argument(s)
    dns_authorization = certificate_manager_v1.DnsAuthorization()
    dns_authorization.domain = "domain_value"

    request = certificate_manager_v1.CreateDnsAuthorizationRequest(
        parent="parent_value",
        dns_authorization_id="dns_authorization_id_value",
        dns_authorization=dns_authorization,
    )

    # Make the request
    operation = client.create_dns_authorization(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

Name	Description
`request`	`Union[google.cloud.certificate_manager_v1.types.CreateDnsAuthorizationRequest, dict]` The request object. Request for the `CreateDnsAuthorization` method.
`parent`	`str` Required. The parent resource of the dns authorization. Must be in the format `projects//locations/`. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`dns_authorization`	`google.cloud.certificate_manager_v1.types.DnsAuthorization` Required. A definition of the dns authorization to create. This corresponds to the `dns_authorization` field on the `request` instance; if `request` is provided, this should not be set.
`dns_authorization_id`	`str` Required. A user-provided name of the dns authorization. This corresponds to the `dns_authorization_id` 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

Type	Description
`google.api_core.operation.Operation`	An object representing a long-running operation. The result type for the operation will be DnsAuthorization A DnsAuthorization resource describes a way to perform domain authorization for certificate issuance.

delete_certificate

delete_certificate(request: Optional[Union[google.cloud.certificate_manager_v1.types.certificate_manager.DeleteCertificateRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes a single Certificate.

from google.cloud import certificate_manager_v1

def sample_delete_certificate():
    # Create a client
    client = certificate_manager_v1.CertificateManagerClient()

    # Initialize request argument(s)
    request = certificate_manager_v1.DeleteCertificateRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_certificate(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

Name	Description
`request`	`Union[google.cloud.certificate_manager_v1.types.DeleteCertificateRequest, dict]` The request object. Request for the `DeleteCertificate` method.
`name`	`str` Required. A name of the certificate to delete. Must be in the format `projects//locations//certificates/*`. This corresponds to the `name` 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

Type Description

google.api_core.operation.Operation An object representing a long-running operation. The result type for the operation will be google.protobuf.empty_pb2.Empty A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}.

delete_certificate_map

delete_certificate_map(request: Optional[Union[google.cloud.certificate_manager_v1.types.certificate_manager.DeleteCertificateMapRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes a single CertificateMap. A Certificate Map can't be deleted if it contains Certificate Map Entries. Remove all the entries from the map before calling this method.

from google.cloud import certificate_manager_v1

def sample_delete_certificate_map():
    # Create a client
    client = certificate_manager_v1.CertificateManagerClient()

    # Initialize request argument(s)
    request = certificate_manager_v1.DeleteCertificateMapRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_certificate_map(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

Name	Description
`request`	`Union[google.cloud.certificate_manager_v1.types.DeleteCertificateMapRequest, dict]` The request object. Request for the `DeleteCertificateMap` method.
`name`	`str` Required. A name of the certificate map to delete. Must be in the format `projects//locations//certificateMaps/*`. This corresponds to the `name` 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

Type Description

delete_certificate_map_entry

delete_certificate_map_entry(request: Optional[Union[google.cloud.certificate_manager_v1.types.certificate_manager.DeleteCertificateMapEntryRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes a single CertificateMapEntry.

from google.cloud import certificate_manager_v1

def sample_delete_certificate_map_entry():
    # Create a client
    client = certificate_manager_v1.CertificateManagerClient()

    # Initialize request argument(s)
    request = certificate_manager_v1.DeleteCertificateMapEntryRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_certificate_map_entry(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

Name	Description
`request`	`Union[google.cloud.certificate_manager_v1.types.DeleteCertificateMapEntryRequest, dict]` The request object. Request for the `DeleteCertificateMapEntry` method.
`name`	`str` Required. A name of the certificate map entry to delete. Must be in the format `projects//locations//certificateMaps//certificateMapEntries/`. This corresponds to the `name` 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

Type Description

delete_dns_authorization

delete_dns_authorization(request: Optional[Union[google.cloud.certificate_manager_v1.types.certificate_manager.DeleteDnsAuthorizationRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes a single DnsAuthorization.

from google.cloud import certificate_manager_v1

def sample_delete_dns_authorization():
    # Create a client
    client = certificate_manager_v1.CertificateManagerClient()

    # Initialize request argument(s)
    request = certificate_manager_v1.DeleteDnsAuthorizationRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_dns_authorization(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

Name	Description
`request`	`Union[google.cloud.certificate_manager_v1.types.DeleteDnsAuthorizationRequest, dict]` The request object. Request for the `DeleteDnsAuthorization` method.
`name`	`str` Required. A name of the dns authorization to delete. Must be in the format `projects//locations//dnsAuthorizations/*`. This corresponds to the `name` 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

Type Description

dns_authorization_path

dns_authorization_path(project: str, location: str, dns_authorization: str)

Returns a fully-qualified dns_authorization string.

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
`CertificateManagerClient`	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
`CertificateManagerClient`	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
`CertificateManagerClient`	The constructed client.

get_certificate

get_certificate(request: Optional[Union[google.cloud.certificate_manager_v1.types.certificate_manager.GetCertificateRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets details of a single Certificate.

from google.cloud import certificate_manager_v1

def sample_get_certificate():
    # Create a client
    client = certificate_manager_v1.CertificateManagerClient()

    # Initialize request argument(s)
    request = certificate_manager_v1.GetCertificateRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_certificate(request=request)

    # Handle the response
    print(response)

Parameters

Name	Description
`request`	`Union[google.cloud.certificate_manager_v1.types.GetCertificateRequest, dict]` The request object. Request for the `GetCertificate` method.
`name`	`str` Required. A name of the certificate to describe. Must be in the format `projects//locations//certificates/*`. This corresponds to the `name` 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

Type	Description
`google.cloud.certificate_manager_v1.types.Certificate`	Defines TLS certificate.

get_certificate_map

get_certificate_map(request: Optional[Union[google.cloud.certificate_manager_v1.types.certificate_manager.GetCertificateMapRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets details of a single CertificateMap.

from google.cloud import certificate_manager_v1

def sample_get_certificate_map():
    # Create a client
    client = certificate_manager_v1.CertificateManagerClient()

    # Initialize request argument(s)
    request = certificate_manager_v1.GetCertificateMapRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_certificate_map(request=request)

    # Handle the response
    print(response)

Parameters

Name	Description
`request`	`Union[google.cloud.certificate_manager_v1.types.GetCertificateMapRequest, dict]` The request object. Request for the `GetCertificateMap` method.
`name`	`str` Required. A name of the certificate map to describe. Must be in the format `projects//locations//certificateMaps/*`. This corresponds to the `name` 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

Type	Description
`google.cloud.certificate_manager_v1.types.CertificateMap`	Defines a collection of certificate configurations.

get_certificate_map_entry

get_certificate_map_entry(request: Optional[Union[google.cloud.certificate_manager_v1.types.certificate_manager.GetCertificateMapEntryRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets details of a single CertificateMapEntry.

from google.cloud import certificate_manager_v1

def sample_get_certificate_map_entry():
    # Create a client
    client = certificate_manager_v1.CertificateManagerClient()

    # Initialize request argument(s)
    request = certificate_manager_v1.GetCertificateMapEntryRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_certificate_map_entry(request=request)

    # Handle the response
    print(response)

Parameters

Name	Description
`request`	`Union[google.cloud.certificate_manager_v1.types.GetCertificateMapEntryRequest, dict]` The request object. Request for the `GetCertificateMapEntry` method.
`name`	`str` Required. A name of the certificate map entry to describe. Must be in the format `projects//locations//certificateMaps//certificateMapEntries/`. This corresponds to the `name` 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

Type	Description
`google.cloud.certificate_manager_v1.types.CertificateMapEntry`	Defines a certificate map entry.

get_dns_authorization

get_dns_authorization(request: Optional[Union[google.cloud.certificate_manager_v1.types.certificate_manager.GetDnsAuthorizationRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets details of a single DnsAuthorization.

from google.cloud import certificate_manager_v1

def sample_get_dns_authorization():
    # Create a client
    client = certificate_manager_v1.CertificateManagerClient()

    # Initialize request argument(s)
    request = certificate_manager_v1.GetDnsAuthorizationRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_dns_authorization(request=request)

    # Handle the response
    print(response)

Parameters

Name	Description
`request`	`Union[google.cloud.certificate_manager_v1.types.GetDnsAuthorizationRequest, dict]` The request object. Request for the `GetDnsAuthorization` method.
`name`	`str` Required. A name of the dns authorization to describe. Must be in the format `projects//locations//dnsAuthorizations/*`. This corresponds to the `name` 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

Type	Description
`google.cloud.certificate_manager_v1.types.DnsAuthorization`	A DnsAuthorization resource describes a way to perform domain authorization for certificate issuance.

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 variabel 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 `api_endpoint` and `client_cert_source` properties may be used in this method.

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.

list_certificate_map_entries

list_certificate_map_entries(request: Optional[Union[google.cloud.certificate_manager_v1.types.certificate_manager.ListCertificateMapEntriesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists CertificateMapEntries in a given project and location.

from google.cloud import certificate_manager_v1

def sample_list_certificate_map_entries():
    # Create a client
    client = certificate_manager_v1.CertificateManagerClient()

    # Initialize request argument(s)
    request = certificate_manager_v1.ListCertificateMapEntriesRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_certificate_map_entries(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters

Name	Description
`request`	`Union[google.cloud.certificate_manager_v1.types.ListCertificateMapEntriesRequest, dict]` The request object. Request for the `ListCertificateMapEntries` method.
`parent`	`str` Required. The project, location and certificate map from which the certificate map entries should be listed, specified in the format `projects//locations//certificateMaps/*`. This corresponds to the `parent` 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

Type	Description
`google.cloud.certificate_manager_v1.services.certificate_manager.pagers.ListCertificateMapEntriesPager`	Response for the ListCertificateMapEntries method. Iterating over this object will yield results and resolve additional pages automatically.

list_certificate_maps

list_certificate_maps(request: Optional[Union[google.cloud.certificate_manager_v1.types.certificate_manager.ListCertificateMapsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists CertificateMaps in a given project and location.

from google.cloud import certificate_manager_v1

def sample_list_certificate_maps():
    # Create a client
    client = certificate_manager_v1.CertificateManagerClient()

    # Initialize request argument(s)
    request = certificate_manager_v1.ListCertificateMapsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_certificate_maps(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters

Name	Description
`request`	`Union[google.cloud.certificate_manager_v1.types.ListCertificateMapsRequest, dict]` The request object. Request for the `ListCertificateMaps` method.
`parent`	`str` Required. The project and location from which the certificate maps should be listed, specified in the format `projects//locations/`. This corresponds to the `parent` 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

Type	Description
`google.cloud.certificate_manager_v1.services.certificate_manager.pagers.ListCertificateMapsPager`	Response for the ListCertificateMaps method. Iterating over this object will yield results and resolve additional pages automatically.

list_certificates

list_certificates(request: Optional[Union[google.cloud.certificate_manager_v1.types.certificate_manager.ListCertificatesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists Certificates in a given project and location.

from google.cloud import certificate_manager_v1

def sample_list_certificates():
    # Create a client
    client = certificate_manager_v1.CertificateManagerClient()

    # Initialize request argument(s)
    request = certificate_manager_v1.ListCertificatesRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_certificates(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters

Name	Description
`request`	`Union[google.cloud.certificate_manager_v1.types.ListCertificatesRequest, dict]` The request object. Request for the `ListCertificates` method.
`parent`	`str` Required. The project and location from which the certificate should be listed, specified in the format `projects//locations/`. This corresponds to the `parent` 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

Type	Description
`google.cloud.certificate_manager_v1.services.certificate_manager.pagers.ListCertificatesPager`	Response for the ListCertificates method. Iterating over this object will yield results and resolve additional pages automatically.

list_dns_authorizations

list_dns_authorizations(request: Optional[Union[google.cloud.certificate_manager_v1.types.certificate_manager.ListDnsAuthorizationsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists DnsAuthorizations in a given project and location.

from google.cloud import certificate_manager_v1

def sample_list_dns_authorizations():
    # Create a client
    client = certificate_manager_v1.CertificateManagerClient()

    # Initialize request argument(s)
    request = certificate_manager_v1.ListDnsAuthorizationsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_dns_authorizations(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters

Name	Description
`request`	`Union[google.cloud.certificate_manager_v1.types.ListDnsAuthorizationsRequest, dict]` The request object. Request for the `ListDnsAuthorizations` method.
`parent`	`str` Required. The project and location from which the dns authorizations should be listed, specified in the format `projects//locations/`. This corresponds to the `parent` 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

Type	Description
`google.cloud.certificate_manager_v1.services.certificate_manager.pagers.ListDnsAuthorizationsPager`	Response for the ListDnsAuthorizations method. Iterating over this object will yield results and resolve additional pages automatically.

parse_certificate_map_entry_path

parse_certificate_map_entry_path(path: str)

Parses a certificate_map_entry path into its component segments.

parse_certificate_map_path

parse_certificate_map_path(path: str)

Parses a certificate_map path into its component segments.

parse_certificate_path

parse_certificate_path(path: str)

Parses a certificate path into its component segments.

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.

parse_dns_authorization_path

parse_dns_authorization_path(path: str)

Parses a dns_authorization path into its component segments.

parse_target_https_proxies_path

parse_target_https_proxies_path(path: str)

Parses a target_https_proxies path into its component segments.

parse_target_ssl_proxies_path

parse_target_ssl_proxies_path(path: str)

Parses a target_ssl_proxies path into its component segments.

target_https_proxies_path

target_https_proxies_path(project: str, location: str, target_https_proxy: str)

Returns a fully-qualified target_https_proxies string.

target_ssl_proxies_path

target_ssl_proxies_path(project: str, location: str, target_ssl_proxy: str)

Returns a fully-qualified target_ssl_proxies string.

update_certificate

update_certificate(request: Optional[Union[google.cloud.certificate_manager_v1.types.certificate_manager.UpdateCertificateRequest, dict]] = None, *, certificate: Optional[google.cloud.certificate_manager_v1.types.certificate_manager.Certificate] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates a Certificate.

from google.cloud import certificate_manager_v1

def sample_update_certificate():
    # Create a client
    client = certificate_manager_v1.CertificateManagerClient()

    # Initialize request argument(s)
    request = certificate_manager_v1.UpdateCertificateRequest(
    )

    # Make the request
    operation = client.update_certificate(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

Name	Description
`request`	`Union[google.cloud.certificate_manager_v1.types.UpdateCertificateRequest, dict]` The request object. Request for the `UpdateCertificate` method.
`certificate`	`google.cloud.certificate_manager_v1.types.Certificate` Required. A definition of the certificate to update. This corresponds to the `certificate` field on the `request` instance; if `request` is provided, this should not be set.
`update_mask`	`google.protobuf.field_mask_pb2.FieldMask` Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask. This corresponds to the `update_mask` 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

Type	Description
`google.api_core.operation.Operation`	An object representing a long-running operation. The result type for the operation will be Certificate Defines TLS certificate.

update_certificate_map

update_certificate_map(request: Optional[Union[google.cloud.certificate_manager_v1.types.certificate_manager.UpdateCertificateMapRequest, dict]] = None, *, certificate_map: Optional[google.cloud.certificate_manager_v1.types.certificate_manager.CertificateMap] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates a CertificateMap.

from google.cloud import certificate_manager_v1

def sample_update_certificate_map():
    # Create a client
    client = certificate_manager_v1.CertificateManagerClient()

    # Initialize request argument(s)
    request = certificate_manager_v1.UpdateCertificateMapRequest(
    )

    # Make the request
    operation = client.update_certificate_map(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

Name	Description
`request`	`Union[google.cloud.certificate_manager_v1.types.UpdateCertificateMapRequest, dict]` The request object. Request for the `UpdateCertificateMap` method.
`certificate_map`	`google.cloud.certificate_manager_v1.types.CertificateMap` Required. A definition of the certificate map to update. This corresponds to the `certificate_map` field on the `request` instance; if `request` is provided, this should not be set.
`update_mask`	`google.protobuf.field_mask_pb2.FieldMask` Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask. This corresponds to the `update_mask` 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

Type	Description
`google.api_core.operation.Operation`	An object representing a long-running operation. The result type for the operation will be CertificateMap Defines a collection of certificate configurations.

update_certificate_map_entry

update_certificate_map_entry(request: Optional[Union[google.cloud.certificate_manager_v1.types.certificate_manager.UpdateCertificateMapEntryRequest, dict]] = None, *, certificate_map_entry: Optional[google.cloud.certificate_manager_v1.types.certificate_manager.CertificateMapEntry] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates a CertificateMapEntry.

from google.cloud import certificate_manager_v1

def sample_update_certificate_map_entry():
    # Create a client
    client = certificate_manager_v1.CertificateManagerClient()

    # Initialize request argument(s)
    certificate_map_entry = certificate_manager_v1.CertificateMapEntry()
    certificate_map_entry.hostname = "hostname_value"

    request = certificate_manager_v1.UpdateCertificateMapEntryRequest(
        certificate_map_entry=certificate_map_entry,
    )

    # Make the request
    operation = client.update_certificate_map_entry(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

Name	Description
`request`	`Union[google.cloud.certificate_manager_v1.types.UpdateCertificateMapEntryRequest, dict]` The request object. Request for the `UpdateCertificateMapEntry` method.
`certificate_map_entry`	`google.cloud.certificate_manager_v1.types.CertificateMapEntry` Required. A definition of the certificate map entry to create map entry. This corresponds to the `certificate_map_entry` field on the `request` instance; if `request` is provided, this should not be set.
`update_mask`	`google.protobuf.field_mask_pb2.FieldMask` Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask. This corresponds to the `update_mask` 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

Type	Description
`google.api_core.operation.Operation`	An object representing a long-running operation. The result type for the operation will be CertificateMapEntry Defines a certificate map entry.

update_dns_authorization

update_dns_authorization(request: Optional[Union[google.cloud.certificate_manager_v1.types.certificate_manager.UpdateDnsAuthorizationRequest, dict]] = None, *, dns_authorization: Optional[google.cloud.certificate_manager_v1.types.certificate_manager.DnsAuthorization] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates a DnsAuthorization.

from google.cloud import certificate_manager_v1

def sample_update_dns_authorization():
    # Create a client
    client = certificate_manager_v1.CertificateManagerClient()

    # Initialize request argument(s)
    dns_authorization = certificate_manager_v1.DnsAuthorization()
    dns_authorization.domain = "domain_value"

    request = certificate_manager_v1.UpdateDnsAuthorizationRequest(
        dns_authorization=dns_authorization,
    )

    # Make the request
    operation = client.update_dns_authorization(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

Name	Description
`request`	`Union[google.cloud.certificate_manager_v1.types.UpdateDnsAuthorizationRequest, dict]` The request object. Request for the `UpdateDnsAuthorization` method.
`dns_authorization`	`google.cloud.certificate_manager_v1.types.DnsAuthorization` Required. A definition of the dns authorization to update. This corresponds to the `dns_authorization` field on the `request` instance; if `request` is provided, this should not be set.
`update_mask`	`google.protobuf.field_mask_pb2.FieldMask` Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask. This corresponds to the `update_mask` 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

Type	Description
`google.api_core.operation.Operation`	An object representing a long-running operation. The result type for the operation will be DnsAuthorization A DnsAuthorization resource describes a way to perform domain authorization for certificate issuance.