Class CertificateAuthorityServiceAsyncClient (1.0.6) 

CertificateAuthorityServiceAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.security.privateca_v1.services.certificate_authority_service.transports.base.CertificateAuthorityServiceTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/python-security-private-ca/.nox/docfx/lib/python3.9/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

[Certificate Authority Service][google.cloud.security.privateca.v1.CertificateAuthorityService] manages private certificate authorities and issued certificates.

Properties

transport

Returns the transport used by the client instance.

Returns
Type Description
CertificateAuthorityServiceTransport The transport used by the client instance.

Methods

CertificateAuthorityServiceAsyncClient

CertificateAuthorityServiceAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.security.privateca_v1.services.certificate_authority_service.transports.base.CertificateAuthorityServiceTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/python-security-private-ca/.nox/docfx/lib/python3.9/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instantiates the certificate authority service 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, .CertificateAuthorityServiceTransport]

The transport to use. If set to None, a transport is chosen automatically.
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.
Exceptions
Type Description
google.auth.exceptions.MutualTlsChannelError If mutual TLS transport creation failed for any reason.

activate_certificate_authority

activate_certificate_authority(request: Optional[google.cloud.security.privateca_v1.types.service.ActivateCertificateAuthorityRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Activate a xref_CertificateAuthority that is in state xref_AWAITING_USER_ACTIVATION and is of type xref_SUBORDINATE. After the parent Certificate Authority signs a certificate signing request from xref_FetchCertificateAuthorityCsr, this method can complete the activation process.

Parameters
Name Description
request ActivateCertificateAuthorityRequest

The request object. Request message for CertificateAuthorityService.ActivateCertificateAuthority.
name str

Required. The resource name for this CertificateAuthority in the format projects//locations//caPools//certificateAuthorities/. 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_async.AsyncOperation An object representing a long-running operation. The result type for the operation will be CertificateAuthority A CertificateAuthority represents an individual Certificate Authority. A CertificateAuthority can be used to create Certificates.

ca_pool_path

ca_pool_path(project: str, location: str, ca_pool: str)

Returns a fully-qualified ca_pool string.

certificate_authority_path

certificate_authority_path(
    project: str, location: str, ca_pool: str, certificate_authority: str
)

Returns a fully-qualified certificate_authority string.

certificate_path

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

Returns a fully-qualified certificate string.

certificate_revocation_list_path

certificate_revocation_list_path(
    project: str,
    location: str,
    ca_pool: str,
    certificate_authority: str,
    certificate_revocation_list: str,
)

Returns a fully-qualified certificate_revocation_list string.

certificate_template_path

certificate_template_path(project: str, location: str, certificate_template: str)

Returns a fully-qualified certificate_template 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_ca_pool

create_ca_pool(request: Optional[google.cloud.security.privateca_v1.types.service.CreateCaPoolRequest] = None, *, parent: Optional[str] = None, ca_pool: Optional[google.cloud.security.privateca_v1.types.resources.CaPool] = None, ca_pool_id: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Create a xref_CaPool.

Parameters
Name Description
request CreateCaPoolRequest

The request object. Request message for CertificateAuthorityService.CreateCaPool.
parent str

Required. The resource name of the location associated with the CaPool, in the format projects//locations/. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
ca_pool CaPool

Required. A CaPool with initial field values. This corresponds to the ca_pool field on the request instance; if request is provided, this should not be set.
ca_pool_id str

Required. It must be unique within a location and match the regular expression [a-zA-Z0-9_-]{1,63} This corresponds to the ca_pool_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_async.AsyncOperation An object representing a long-running operation. The result type for the operation will be CaPool A CaPool represents a group of CertificateAuthorities that form a trust anchor. A CaPool can be used to manage issuance policies for one or more CertificateAuthority resources and to rotate CA certificates in and out of the trust anchor.

create_certificate

create_certificate(request: Optional[google.cloud.security.privateca_v1.types.service.CreateCertificateRequest] = None, *, parent: Optional[str] = None, certificate: Optional[google.cloud.security.privateca_v1.types.resources.Certificate] = None, certificate_id: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Create a new xref_Certificate in a given Project, Location from a particular xref_CaPool.

Parameters
Name Description
request CreateCertificateRequest

The request object. Request message for CertificateAuthorityService.CreateCertificate.
parent str

Required. The resource name of the CaPool associated with the Certificate, in the format projects//locations//caPools/*. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
certificate Certificate

Required. A Certificate with initial field values. This corresponds to the certificate field on the request instance; if request is provided, this should not be set.
certificate_id str

Optional. It must be unique within a location and match the regular expression [a-zA-Z0-9_-]{1,63}. This field is required when using a CertificateAuthority in the Enterprise [CertificateAuthority.Tier][], but is optional and its value is ignored otherwise. 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.cloud.security.privateca_v1.types.Certificate A Certificate corresponds to a signed X.509 certificate issued by a CertificateAuthority.

create_certificate_authority

create_certificate_authority(request: Optional[google.cloud.security.privateca_v1.types.service.CreateCertificateAuthorityRequest] = None, *, parent: Optional[str] = None, certificate_authority: Optional[google.cloud.security.privateca_v1.types.resources.CertificateAuthority] = None, certificate_authority_id: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Create a new xref_CertificateAuthority in a given Project and Location.

Parameters
Name Description
request CreateCertificateAuthorityRequest

The request object. Request message for CertificateAuthorityService.CreateCertificateAuthority.
parent str

Required. The resource name of the CaPool associated with the CertificateAuthorities, in the format projects//locations//caPools/*. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
certificate_authority CertificateAuthority

Required. A CertificateAuthority with initial field values. This corresponds to the certificate_authority field on the request instance; if request is provided, this should not be set.
certificate_authority_id str

Required. It must be unique within a location and match the regular expression [a-zA-Z0-9_-]{1,63} This corresponds to the certificate_authority_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_async.AsyncOperation An object representing a long-running operation. The result type for the operation will be CertificateAuthority A CertificateAuthority represents an individual Certificate Authority. A CertificateAuthority can be used to create Certificates.

create_certificate_template

create_certificate_template(request: Optional[google.cloud.security.privateca_v1.types.service.CreateCertificateTemplateRequest] = None, *, parent: Optional[str] = None, certificate_template: Optional[google.cloud.security.privateca_v1.types.resources.CertificateTemplate] = None, certificate_template_id: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Create a new xref_CertificateTemplate in a given Project and Location.

Parameters
Name Description
request CreateCertificateTemplateRequest

The request object. Request message for CertificateAuthorityService.CreateCertificateTemplate.
parent str

Required. The resource name of the location associated with the CertificateTemplate, 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_template CertificateTemplate

Required. A CertificateTemplate with initial field values. This corresponds to the certificate_template field on the request instance; if request is provided, this should not be set.
certificate_template_id str

Required. It must be unique within a location and match the regular expression [a-zA-Z0-9_-]{1,63} This corresponds to the certificate_template_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_async.AsyncOperation An object representing a long-running operation. The result type for the operation will be CertificateTemplate A CertificateTemplate refers to a managed template for certificate issuance.

delete_ca_pool

delete_ca_pool(request: Optional[google.cloud.security.privateca_v1.types.service.DeleteCaPoolRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Delete a xref_CaPool.

Parameters
Name Description
request DeleteCaPoolRequest

The request object. Request message for CertificateAuthorityService.DeleteCaPool.
name str

Required. The resource name for this CaPool in the format projects//locations//caPools/*. 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_async.AsyncOperation 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_authority

delete_certificate_authority(request: Optional[google.cloud.security.privateca_v1.types.service.DeleteCertificateAuthorityRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Delete a xref_CertificateAuthority.

Parameters
Name Description
request DeleteCertificateAuthorityRequest

The request object. Request message for CertificateAuthorityService.DeleteCertificateAuthority.
name str

Required. The resource name for this CertificateAuthority in the format projects//locations//caPools//certificateAuthorities/. 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_async.AsyncOperation An object representing a long-running operation. The result type for the operation will be CertificateAuthority A CertificateAuthority represents an individual Certificate Authority. A CertificateAuthority can be used to create Certificates.

delete_certificate_template

delete_certificate_template(request: Optional[google.cloud.security.privateca_v1.types.service.DeleteCertificateTemplateRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

DeleteCertificateTemplate deletes a xref_CertificateTemplate.

Parameters
Name Description
request DeleteCertificateTemplateRequest

The request object. Request message for CertificateAuthorityService.DeleteCertificateTemplate.
name str

Required. The resource name for this CertificateTemplate in the format projects//locations//certificateTemplates/*. 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_async.AsyncOperation 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 {}.

disable_certificate_authority

disable_certificate_authority(request: Optional[google.cloud.security.privateca_v1.types.service.DisableCertificateAuthorityRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Disable a xref_CertificateAuthority.

Parameters
Name Description
request DisableCertificateAuthorityRequest

The request object. Request message for CertificateAuthorityService.DisableCertificateAuthority.
name str

Required. The resource name for this CertificateAuthority in the format projects//locations//caPools//certificateAuthorities/. 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_async.AsyncOperation An object representing a long-running operation. The result type for the operation will be CertificateAuthority A CertificateAuthority represents an individual Certificate Authority. A CertificateAuthority can be used to create Certificates.

enable_certificate_authority

enable_certificate_authority(request: Optional[google.cloud.security.privateca_v1.types.service.EnableCertificateAuthorityRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Enable a xref_CertificateAuthority.

Parameters
Name Description
request EnableCertificateAuthorityRequest

The request object. Request message for CertificateAuthorityService.EnableCertificateAuthority.
name str

Required. The resource name for this CertificateAuthority in the format projects//locations//caPools//certificateAuthorities/. 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_async.AsyncOperation An object representing a long-running operation. The result type for the operation will be CertificateAuthority A CertificateAuthority represents an individual Certificate Authority. A CertificateAuthority can be used to create Certificates.

fetch_ca_certs

fetch_ca_certs(request: Optional[google.cloud.security.privateca_v1.types.service.FetchCaCertsRequest] = None, *, ca_pool: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

FetchCaCerts returns the current trust anchor for the xref_CaPool. This will include CA certificate chains for all ACTIVE xref_CertificateAuthority resources in the xref_CaPool.

Parameters
Name Description
request FetchCaCertsRequest

The request object. Request message for CertificateAuthorityService.FetchCaCerts.
ca_pool str

Required. The resource name for the CaPool in the format projects//locations//caPools/*. This corresponds to the ca_pool 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.security.privateca_v1.types.FetchCaCertsResponse Response message for CertificateAuthorityService.FetchCaCerts.

fetch_certificate_authority_csr

fetch_certificate_authority_csr(request: Optional[google.cloud.security.privateca_v1.types.service.FetchCertificateAuthorityCsrRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Fetch a certificate signing request (CSR) from a xref_CertificateAuthority that is in state xref_AWAITING_USER_ACTIVATION and is of type xref_SUBORDINATE. The CSR must then be signed by the desired parent Certificate Authority, which could be another xref_CertificateAuthority resource, or could be an on-prem certificate authority. See also xref_ActivateCertificateAuthority.

Parameters
Name Description
request FetchCertificateAuthorityCsrRequest

The request object. Request message for CertificateAuthorityService.FetchCertificateAuthorityCsr.
name str

Required. The resource name for this CertificateAuthority in the format projects//locations//caPools//certificateAuthorities/. 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.security.privateca_v1.types.FetchCertificateAuthorityCsrResponse Response message for CertificateAuthorityService.FetchCertificateAuthorityCsr.

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

get_ca_pool

get_ca_pool(request: Optional[google.cloud.security.privateca_v1.types.service.GetCaPoolRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Returns a xref_CaPool.

Parameters
Name Description
request GetCaPoolRequest

The request object. Request message for CertificateAuthorityService.GetCaPool.
name str

Required. The name of the CaPool to get. 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.security.privateca_v1.types.CaPool A CaPool represents a group of CertificateAuthorities that form a trust anchor. A CaPool can be used to manage issuance policies for one or more CertificateAuthority resources and to rotate CA certificates in and out of the trust anchor.

get_certificate

get_certificate(request: Optional[google.cloud.security.privateca_v1.types.service.GetCertificateRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Returns a xref_Certificate.

Parameters
Name Description
request GetCertificateRequest

The request object. Request message for CertificateAuthorityService.GetCertificate.
name str

Required. The name of the Certificate to get. 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.security.privateca_v1.types.Certificate A Certificate corresponds to a signed X.509 certificate issued by a CertificateAuthority.

get_certificate_authority

get_certificate_authority(request: Optional[google.cloud.security.privateca_v1.types.service.GetCertificateAuthorityRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Returns a xref_CertificateAuthority.

Parameters
Name Description
request GetCertificateAuthorityRequest

The request object. Request message for CertificateAuthorityService.GetCertificateAuthority.
name str

Required. The name of the CertificateAuthority to get. 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.security.privateca_v1.types.CertificateAuthority A CertificateAuthority represents an individual Certificate Authority. A CertificateAuthority can be used to create Certificates.

get_certificate_revocation_list

get_certificate_revocation_list(request: Optional[google.cloud.security.privateca_v1.types.service.GetCertificateRevocationListRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Returns a xref_CertificateRevocationList.

Parameters
Name Description
request GetCertificateRevocationListRequest

The request object. Request message for CertificateAuthorityService.GetCertificateRevocationList.
name str

Required. The name of the CertificateRevocationList to get. 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.security.privateca_v1.types.CertificateRevocationList A CertificateRevocationList corresponds to a signed X.509 certificate Revocation List (CRL). A CRL contains the serial numbers of certificates that should no longer be trusted.

get_certificate_template

get_certificate_template(request: Optional[google.cloud.security.privateca_v1.types.service.GetCertificateTemplateRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Returns a xref_CertificateTemplate.

Parameters
Name Description
request GetCertificateTemplateRequest

The request object. Request message for CertificateAuthorityService.GetCertificateTemplate.
name str

Required. The name of the CertificateTemplate to get. 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.security.privateca_v1.types.CertificateTemplate A CertificateTemplate refers to a managed template for certificate issuance.

get_transport_class

get_transport_class()

Returns an appropriate transport class.

list_ca_pools

list_ca_pools(request: Optional[google.cloud.security.privateca_v1.types.service.ListCaPoolsRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists xref_CaPools.

Parameters
Name Description
request ListCaPoolsRequest

The request object. Request message for CertificateAuthorityService.ListCaPools.
parent str

Required. The resource name of the location associated with the CaPools, 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.security.privateca_v1.services.certificate_authority_service.pagers.ListCaPoolsAsyncPager Response message for CertificateAuthorityService.ListCaPools. Iterating over this object will yield results and resolve additional pages automatically.

list_certificate_authorities

list_certificate_authorities(request: Optional[google.cloud.security.privateca_v1.types.service.ListCertificateAuthoritiesRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists xref_CertificateAuthorities.

Parameters
Name Description
request ListCertificateAuthoritiesRequest

The request object. Request message for CertificateAuthorityService.ListCertificateAuthorities.
parent str

Required. The resource name of the CaPool associated with the CertificateAuthorities, in the format projects//locations//caPools/*. 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.security.privateca_v1.services.certificate_authority_service.pagers.ListCertificateAuthoritiesAsyncPager Response message for CertificateAuthorityService.ListCertificateAuthorities. Iterating over this object will yield results and resolve additional pages automatically.

list_certificate_revocation_lists

list_certificate_revocation_lists(request: Optional[google.cloud.security.privateca_v1.types.service.ListCertificateRevocationListsRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists xref_CertificateRevocationLists.

Parameters
Name Description
request ListCertificateRevocationListsRequest

The request object. Request message for CertificateAuthorityService.ListCertificateRevocationLists.
parent str

Required. The resource name of the location associated with the CertificateRevocationLists, in the format projects//locations//caPools//certificateAuthorities/. 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.security.privateca_v1.services.certificate_authority_service.pagers.ListCertificateRevocationListsAsyncPager Response message for CertificateAuthorityService.ListCertificateRevocationLists. Iterating over this object will yield results and resolve additional pages automatically.

list_certificate_templates

list_certificate_templates(request: Optional[google.cloud.security.privateca_v1.types.service.ListCertificateTemplatesRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists xref_CertificateTemplates.

Parameters
Name Description
request ListCertificateTemplatesRequest

The request object. Request message for CertificateAuthorityService.ListCertificateTemplates.
parent str

Required. The resource name of the location associated with the CertificateTemplates, 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.security.privateca_v1.services.certificate_authority_service.pagers.ListCertificateTemplatesAsyncPager Response message for CertificateAuthorityService.ListCertificateTemplates. Iterating over this object will yield results and resolve additional pages automatically.

list_certificates

list_certificates(request: Optional[google.cloud.security.privateca_v1.types.service.ListCertificatesRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists xref_Certificates.

Parameters
Name Description
request ListCertificatesRequest

The request object. Request message for CertificateAuthorityService.ListCertificates.
parent str

Required. The resource name of the location associated with the Certificates, in the format projects//locations//caPools/*. 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.security.privateca_v1.services.certificate_authority_service.pagers.ListCertificatesAsyncPager Response message for CertificateAuthorityService.ListCertificates. Iterating over this object will yield results and resolve additional pages automatically.

parse_ca_pool_path

parse_ca_pool_path(path: str)

Parses a ca_pool path into its component segments.

parse_certificate_authority_path

parse_certificate_authority_path(path: str)

Parses a certificate_authority path into its component segments.

parse_certificate_path

parse_certificate_path(path: str)

Parses a certificate path into its component segments.

parse_certificate_revocation_list_path

parse_certificate_revocation_list_path(path: str)

Parses a certificate_revocation_list path into its component segments.

parse_certificate_template_path

parse_certificate_template_path(path: str)

Parses a certificate_template 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.

revoke_certificate

revoke_certificate(request: Optional[google.cloud.security.privateca_v1.types.service.RevokeCertificateRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Revoke a xref_Certificate.

Parameters
Name Description
request RevokeCertificateRequest

The request object. Request message for CertificateAuthorityService.RevokeCertificate.
name str

Required. The resource name for this Certificate in the format projects//locations//caPools//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.security.privateca_v1.types.Certificate A Certificate corresponds to a signed X.509 certificate issued by a CertificateAuthority.

undelete_certificate_authority

undelete_certificate_authority(request: Optional[google.cloud.security.privateca_v1.types.service.UndeleteCertificateAuthorityRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Undelete a xref_CertificateAuthority that has been deleted.

Parameters
Name Description
request UndeleteCertificateAuthorityRequest

The request object. Request message for CertificateAuthorityService.UndeleteCertificateAuthority.
name str

Required. The resource name for this CertificateAuthority in the format projects//locations//caPools//certificateAuthorities/. 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_async.AsyncOperation An object representing a long-running operation. The result type for the operation will be CertificateAuthority A CertificateAuthority represents an individual Certificate Authority. A CertificateAuthority can be used to create Certificates.

update_ca_pool

update_ca_pool(request: Optional[google.cloud.security.privateca_v1.types.service.UpdateCaPoolRequest] = None, *, ca_pool: Optional[google.cloud.security.privateca_v1.types.resources.CaPool] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Update a xref_CaPool.

Parameters
Name Description
request UpdateCaPoolRequest

The request object. Request message for CertificateAuthorityService.UpdateCaPool.
ca_pool CaPool

Required. CaPool with updated values. This corresponds to the ca_pool field on the request instance; if request is provided, this should not be set.
update_mask google.protobuf.field_mask_pb2.FieldMask

Required. A list of fields to be updated in this request. 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_async.AsyncOperation An object representing a long-running operation. The result type for the operation will be CaPool A CaPool represents a group of CertificateAuthorities that form a trust anchor. A CaPool can be used to manage issuance policies for one or more CertificateAuthority resources and to rotate CA certificates in and out of the trust anchor.

update_certificate

update_certificate(request: Optional[google.cloud.security.privateca_v1.types.service.UpdateCertificateRequest] = None, *, certificate: Optional[google.cloud.security.privateca_v1.types.resources.Certificate] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Update a xref_Certificate. Currently, the only field you can update is the xref_labels field.

Parameters
Name Description
request UpdateCertificateRequest

The request object. Request message for CertificateAuthorityService.UpdateCertificate.
certificate Certificate

Required. Certificate with updated values. 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. A list of fields to be updated in this request. 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.cloud.security.privateca_v1.types.Certificate A Certificate corresponds to a signed X.509 certificate issued by a CertificateAuthority.

update_certificate_authority

update_certificate_authority(request: Optional[google.cloud.security.privateca_v1.types.service.UpdateCertificateAuthorityRequest] = None, *, certificate_authority: Optional[google.cloud.security.privateca_v1.types.resources.CertificateAuthority] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Update a xref_CertificateAuthority.

Parameters
Name Description
request UpdateCertificateAuthorityRequest

The request object. Request message for CertificateAuthorityService.UpdateCertificateAuthority.
certificate_authority CertificateAuthority

Required. CertificateAuthority with updated values. This corresponds to the certificate_authority field on the request instance; if request is provided, this should not be set.
update_mask google.protobuf.field_mask_pb2.FieldMask

Required. A list of fields to be updated in this request. 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_async.AsyncOperation An object representing a long-running operation. The result type for the operation will be CertificateAuthority A CertificateAuthority represents an individual Certificate Authority. A CertificateAuthority can be used to create Certificates.

update_certificate_revocation_list

update_certificate_revocation_list(request: Optional[google.cloud.security.privateca_v1.types.service.UpdateCertificateRevocationListRequest] = None, *, certificate_revocation_list: Optional[google.cloud.security.privateca_v1.types.resources.CertificateRevocationList] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Update a xref_CertificateRevocationList.

Parameters
Name Description
request UpdateCertificateRevocationListRequest

The request object. Request message for CertificateAuthorityService.UpdateCertificateRevocationList.
certificate_revocation_list CertificateRevocationList

Required. CertificateRevocationList with updated values. This corresponds to the certificate_revocation_list field on the request instance; if request is provided, this should not be set.
update_mask google.protobuf.field_mask_pb2.FieldMask

Required. A list of fields to be updated in this request. 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_async.AsyncOperation An object representing a long-running operation. The result type for the operation will be CertificateRevocationList A CertificateRevocationList corresponds to a signed X.509 certificate Revocation List (CRL). A CRL contains the serial numbers of certificates that should no longer be trusted.

update_certificate_template

update_certificate_template(request: Optional[google.cloud.security.privateca_v1.types.service.UpdateCertificateTemplateRequest] = None, *, certificate_template: Optional[google.cloud.security.privateca_v1.types.resources.CertificateTemplate] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Update a xref_CertificateTemplate.

Parameters
Name Description
request UpdateCertificateTemplateRequest

The request object. Request message for CertificateAuthorityService.UpdateCertificateTemplate.
certificate_template CertificateTemplate

Required. CertificateTemplate with updated values. This corresponds to the certificate_template field on the request instance; if request is provided, this should not be set.
update_mask google.protobuf.field_mask_pb2.FieldMask

Required. A list of fields to be updated in this request. 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_async.AsyncOperation An object representing a long-running operation. The result type for the operation will be CertificateTemplate A CertificateTemplate refers to a managed template for certificate issuance.