Class CertificateManagerAsyncClient (0.1.3)

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.

Returns the transport used by the client instance.

Instantiates the certificate manager client.

Returns a fully-qualified certificate_map_entry string.

Returns a fully-qualified certificate_map string.

Returns a fully-qualified certificate string.

Returns a fully-qualified billing_account string.

Returns a fully-qualified folder string.

Returns a fully-qualified location string.

Returns a fully-qualified organization string.

Returns a fully-qualified project string.

Creates a new Certificate in a given project and location.

from google.cloud import certificate_manager_v1

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

    # 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 = await operation.result()

    # Handle the response
    print(response)

Creates a new CertificateMap in a given project and location.

from google.cloud import certificate_manager_v1

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

    # 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 = await operation.result()

    # Handle the response
    print(response)

Creates a new CertificateMapEntry in a given project and location.

from google.cloud import certificate_manager_v1

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

    # 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 = await operation.result()

    # Handle the response
    print(response)

Creates a new DnsAuthorization in a given project and location.

from google.cloud import certificate_manager_v1

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

    # 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 = await operation.result()

    # Handle the response
    print(response)

Deletes a single Certificate.

from google.cloud import certificate_manager_v1

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

    # 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 = await operation.result()

    # Handle the response
    print(response)

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

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

    # 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 = await operation.result()

    # Handle the response
    print(response)

Deletes a single CertificateMapEntry.

from google.cloud import certificate_manager_v1

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

    # 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 = await operation.result()

    # Handle the response
    print(response)

Deletes a single DnsAuthorization.

from google.cloud import certificate_manager_v1

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

    # 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 = await operation.result()

    # Handle the response
    print(response)

Returns a fully-qualified dns_authorization string.

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

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

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

Gets details of a single Certificate.

from google.cloud import certificate_manager_v1

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

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

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

    # Handle the response
    print(response)

Gets details of a single CertificateMap.

from google.cloud import certificate_manager_v1

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

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

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

    # Handle the response
    print(response)

Gets details of a single CertificateMapEntry.

from google.cloud import certificate_manager_v1

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

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

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

    # Handle the response
    print(response)

Gets details of a single DnsAuthorization.

from google.cloud import certificate_manager_v1

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

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

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

    # Handle the response
    print(response)

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.

Returns an appropriate transport class.

Lists CertificateMapEntries in a given project and location.

from google.cloud import certificate_manager_v1

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

    # 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
    async for response in page_result:
        print(response)

Lists CertificateMaps in a given project and location.

from google.cloud import certificate_manager_v1

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

    # 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
    async for response in page_result:
        print(response)

Lists Certificates in a given project and location.

from google.cloud import certificate_manager_v1

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

    # 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
    async for response in page_result:
        print(response)

Lists DnsAuthorizations in a given project and location.

from google.cloud import certificate_manager_v1

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

    # 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
    async for response in page_result:
        print(response)

Parses a certificate_map_entry path into its component segments.

Parses a certificate_map path into its component segments.

Parses a certificate path into its component segments.

Parse a billing_account path into its component segments.

Parse a folder path into its component segments.

Parse a location path into its component segments.

Parse a organization path into its component segments.

Parse a project path into its component segments.

Parses a dns_authorization path into its component segments.

Parses a target_https_proxies path into its component segments.

Parses a target_ssl_proxies path into its component segments.

Returns a fully-qualified target_https_proxies string.

Returns a fully-qualified target_ssl_proxies string.

Updates a Certificate.

from google.cloud import certificate_manager_v1

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

    # 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 = await operation.result()

    # Handle the response
    print(response)

Updates a CertificateMap.

from google.cloud import certificate_manager_v1

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

    # 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 = await operation.result()

    # Handle the response
    print(response)

Updates a CertificateMapEntry.

from google.cloud import certificate_manager_v1

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

    # 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 = await operation.result()

    # Handle the response
    print(response)

Updates a DnsAuthorization.

from google.cloud import certificate_manager_v1

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

    # 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 = await operation.result()

    # Handle the response
    print(response)