Class CertificateAuthorityServiceAsyncClient (0.1.1)

CertificateAuthorityServiceAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.security.privateca_v1beta1.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.v1beta1.CertificateAuthorityService] manages private certificate authorities and issued certificates.

Methods

CertificateAuthorityServiceAsyncClient

CertificateAuthorityServiceAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.security.privateca_v1beta1.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>)

Instantiate 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_v1beta1.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_PENDING_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`	`.service.ActivateCertificateAuthorityRequest` The request object. Request message for CertificateAuthorityService.ActivateCertificateAuthority.
`name`	`str` Required. The resource name for this CertificateAuthority in the format `projects//locations//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
`.operation_async.AsyncOperation`	An object representing a long-running operation. The result type for the operation will be .resources.CertificateAuthority : A CertificateAuthority represents an individual Certificate Authority. A CertificateAuthority can be used to create Certificates.

certificate_authority_path

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

Return a fully-qualified certificate_authority string.

certificate_path

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

Return a fully-qualified certificate string.

certificate_revocation_list_path

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

Return a fully-qualified certificate_revocation_list string.

create_certificate

create_certificate(request: Optional[google.cloud.security.privateca_v1beta1.types.service.CreateCertificateRequest] = None, *, parent: Optional[str] = None, certificate: Optional[google.cloud.security.privateca_v1beta1.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_CertificateAuthority.

Parameters
Name	Description
`request`	`.service.CreateCertificateRequest` The request object. Request message for CertificateAuthorityService.CreateCertificate.
`parent`	`str` Required. The resource name of the location and CertificateAuthority associated with the Certificate, in the format `projects//locations//certificateAuthorities/*`. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`certificate`	`.resources.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
`.resources.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_v1beta1.types.service.CreateCertificateAuthorityRequest] = None, *, parent: Optional[str] = None, certificate_authority: Optional[google.cloud.security.privateca_v1beta1.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`	`.service.CreateCertificateAuthorityRequest` The request object. Request message for CertificateAuthorityService.CreateCertificateAuthority.
`parent`	`str` Required. The resource name of the location associated with the CertificateAuthorities, 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_authority`	`.resources.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
`.operation_async.AsyncOperation`	An object representing a long-running operation. The result type for the operation will be .resources.CertificateAuthority : A CertificateAuthority represents an individual Certificate Authority. A CertificateAuthority can be used to create Certificates.

create_certificate_revocation_list

create_certificate_revocation_list(request: Optional[google.cloud.security.privateca_v1beta1.types.service.CreateCertificateRevocationListRequest] = None, *, parent: Optional[str] = None, certificate_revocation_list: Optional[google.cloud.security.privateca_v1beta1.types.resources.CertificateRevocationList] = None, certificate_revocation_list_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_CertificateRevocationList in a given Project, Location for a particular xref_CertificateAuthority.

Parameters
Name	Description
`request`	`.service.CreateCertificateRevocationListRequest` The request object. Request message for CertificateAuthorityService.CreateCertificateRevocationList.
`parent`	`str` Required. The resource name of the location and CertificateAuthority associated with the CertificateRevocationList, in the format `projects//locations//certificateAuthorities/*`. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`certificate_revocation_list`	`.resources.CertificateRevocationList` Required. A CertificateRevocationList with initial field values. This corresponds to the `certificate_revocation_list` field on the `request` instance; if `request` is provided, this should not be set.
`certificate_revocation_list_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_revocation_list_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
`.operation_async.AsyncOperation`	An object representing a long-running operation. The result type for the operation will be .resources.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.

create_reusable_config

create_reusable_config(request: Optional[google.cloud.security.privateca_v1beta1.types.service.CreateReusableConfigRequest] = None, *, parent: Optional[str] = None, reusable_config: Optional[google.cloud.security.privateca_v1beta1.types.resources.ReusableConfig] = None, reusable_config_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_ReusableConfig in a given Project and Location.

Parameters
Name	Description
`request`	`.service.CreateReusableConfigRequest` The request object. Request message for CertificateAuthorityService.CreateReusableConfig.
`parent`	`str` Required. The resource name of the location associated with the ReusableConfig, in the format `projects//locations/`. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`reusable_config`	`.resources.ReusableConfig` Required. A ReusableConfig with initial field values. This corresponds to the `reusable_config` field on the `request` instance; if `request` is provided, this should not be set.
`reusable_config_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 `reusable_config_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
`.operation_async.AsyncOperation`	An object representing a long-running operation. The result type for the operation will be .resources.ReusableConfig : A ReusableConfig refers to a managed ReusableConfigValues. Those, in turn, are used to describe certain fields of an X.509 certificate, such as the key usage fields, fields specific to CA certificates, certificate policy extensions and custom extensions.

delete_reusable_config

delete_reusable_config(request: Optional[google.cloud.security.privateca_v1beta1.types.service.DeleteReusableConfigRequest] = 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]] = ())

DeleteReusableConfig deletes a xref_ReusableConfig.

Parameters
Name	Description
`request`	`.service.DeleteReusableConfigRequest` The request object. Request message for CertificateAuthorityService.DeleteReusableConfig.
`name`	`str` Required. The resource name for this ReusableConfig in the format `projects//locations//reusableConfigs/*`. 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

.operation_async.AsyncOperation

An object representing a long-running operation. The result type for the operation will be

.empty.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_v1beta1.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`	`.service.DisableCertificateAuthorityRequest` The request object. Request message for CertificateAuthorityService.DisableCertificateAuthority.
`name`	`str` Required. The resource name for this CertificateAuthority in the format `projects//locations//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
`.operation_async.AsyncOperation`	An object representing a long-running operation. The result type for the operation will be .resources.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_v1beta1.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`	`.service.EnableCertificateAuthorityRequest` The request object. Request message for CertificateAuthorityService.EnableCertificateAuthority.
`name`	`str` Required. The resource name for this CertificateAuthority in the format `projects//locations//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
`.operation_async.AsyncOperation`	An object representing a long-running operation. The result type for the operation will be .resources.CertificateAuthority : A CertificateAuthority represents an individual Certificate Authority. A CertificateAuthority can be used to create Certificates.

fetch_certificate_authority_csr

fetch_certificate_authority_csr(request: Optional[google.cloud.security.privateca_v1beta1.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_PENDING_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`	`.service.FetchCertificateAuthorityCsrRequest` The request object. Request message for CertificateAuthorityService.FetchCertificateAuthorityCsr.
`name`	`str` Required. The resource name for this CertificateAuthority in the format `projects//locations//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
`.service.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
`{@api.name}`	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
`{@api.name}`	The constructed client.

get_certificate

get_certificate(request: Optional[google.cloud.security.privateca_v1beta1.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`	`.service.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
`.resources.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_v1beta1.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`	`.service.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
`.resources.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_v1beta1.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`	`.service.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
`.resources.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_reusable_config

get_reusable_config(request: Optional[google.cloud.security.privateca_v1beta1.types.service.GetReusableConfigRequest] = 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_ReusableConfig.

Parameters
Name	Description
`request`	`.service.GetReusableConfigRequest` The request object. Request message for CertificateAuthorityService.GetReusableConfig.
`name`	`str` Required. The `name][ReusableConfigs.name]` of the [ReusableConfigs][] 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
`.resources.ReusableConfig`	A ReusableConfig refers to a managed ReusableConfigValues. Those, in turn, are used to describe certain fields of an X.509 certificate, such as the key usage fields, fields specific to CA certificates, certificate policy extensions and custom extensions.

get_transport_class

get_transport_class()

Return an appropriate transport class.

list_certificate_authorities

list_certificate_authorities(request: Optional[google.cloud.security.privateca_v1beta1.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`	`.service.ListCertificateAuthoritiesRequest` The request object. Request message for CertificateAuthorityService.ListCertificateAuthorities.
`parent`	`str` Required. The resource name of the location associated with the CertificateAuthorities, 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
`.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_v1beta1.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`	`.service.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//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
`.pagers.ListCertificateRevocationListsAsyncPager`	Response message for CertificateAuthorityService.ListCertificateRevocationLists. Iterating over this object will yield results and resolve additional pages automatically.

list_certificates

list_certificates(request: Optional[google.cloud.security.privateca_v1beta1.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`	`.service.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//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
`.pagers.ListCertificatesAsyncPager`	Response message for CertificateAuthorityService.ListCertificates. Iterating over this object will yield results and resolve additional pages automatically.

list_reusable_configs

list_reusable_configs(request: Optional[google.cloud.security.privateca_v1beta1.types.service.ListReusableConfigsRequest] = 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_ReusableConfigs.

Parameters
Name	Description
`request`	`.service.ListReusableConfigsRequest` The request object. Request message for CertificateAuthorityService.ListReusableConfigs.
`parent`	`str` Required. The resource name of the location associated with the ReusableConfigs, 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
`.pagers.ListReusableConfigsAsyncPager`	Response message for CertificateAuthorityService.ListReusableConfigs. Iterating over this object will yield results and resolve additional pages automatically.

parse_certificate_authority_path

parse_certificate_authority_path(path: str)

Parse a certificate_authority path into its component segments.

parse_certificate_path

parse_certificate_path(path: str)

Parse a certificate path into its component segments.

parse_certificate_revocation_list_path

parse_certificate_revocation_list_path(path: str)

Parse a certificate_revocation_list path into its component segments.

parse_reusable_config_path

parse_reusable_config_path(path: str)

Parse a reusable_config path into its component segments.

restore_certificate_authority

restore_certificate_authority(request: Optional[google.cloud.security.privateca_v1beta1.types.service.RestoreCertificateAuthorityRequest] = 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]] = ())

Restore a xref_CertificateAuthority that is scheduled for deletion.

Parameters
Name	Description
`request`	`.service.RestoreCertificateAuthorityRequest` The request object. Request message for CertificateAuthorityService.RestoreCertificateAuthority.
`name`	`str` Required. The resource name for this CertificateAuthority in the format `projects//locations//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
`.operation_async.AsyncOperation`	An object representing a long-running operation. The result type for the operation will be .resources.CertificateAuthority : A CertificateAuthority represents an individual Certificate Authority. A CertificateAuthority can be used to create Certificates.

reusable_config_path

reusable_config_path(project: str, location: str, reusable_config: str)

Return a fully-qualified reusable_config string.

revoke_certificate

revoke_certificate(request: Optional[google.cloud.security.privateca_v1beta1.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`	`.service.RevokeCertificateRequest` The request object. Request message for CertificateAuthorityService.RevokeCertificate.
`name`	`str` Required. The resource name for this Certificate in the format `projects//locations//certificateAuthorities//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
`.resources.Certificate`	A Certificate corresponds to a signed X.509 certificate issued by a CertificateAuthority.

schedule_delete_certificate_authority

schedule_delete_certificate_authority(request: Optional[google.cloud.security.privateca_v1beta1.types.service.ScheduleDeleteCertificateAuthorityRequest] = 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]] = ())

Schedule a xref_CertificateAuthority for deletion.

Parameters
Name	Description
`request`	`.service.ScheduleDeleteCertificateAuthorityRequest` The request object. Request message for CertificateAuthorityService.ScheduleDeleteCertificateAuthority.
`name`	`str` Required. The resource name for this CertificateAuthority in the format `projects//locations//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
`.operation_async.AsyncOperation`	An object representing a long-running operation. The result type for the operation will be .resources.CertificateAuthority : A CertificateAuthority represents an individual Certificate Authority. A CertificateAuthority can be used to create Certificates.

update_certificate

update_certificate(request: Optional[google.cloud.security.privateca_v1beta1.types.service.UpdateCertificateRequest] = None, *, certificate: Optional[google.cloud.security.privateca_v1beta1.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.

Parameters
Name	Description
`request`	`.service.UpdateCertificateRequest` The request object. Request message for CertificateAuthorityService.UpdateCertificate.
`certificate`	`.resources.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`	`.field_mask.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
`.resources.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_v1beta1.types.service.UpdateCertificateAuthorityRequest] = None, *, certificate_authority: Optional[google.cloud.security.privateca_v1beta1.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`	`.service.UpdateCertificateAuthorityRequest` The request object. Request message for CertificateAuthorityService.UpdateCertificateAuthority.
`certificate_authority`	`.resources.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`	`.field_mask.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
`.operation_async.AsyncOperation`	An object representing a long-running operation. The result type for the operation will be .resources.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_v1beta1.types.service.UpdateCertificateRevocationListRequest] = None, *, certificate_revocation_list: Optional[google.cloud.security.privateca_v1beta1.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`	`.service.UpdateCertificateRevocationListRequest` The request object. Request message for CertificateAuthorityService.UpdateCertificateRevocationList.
`certificate_revocation_list`	`.resources.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`	`.field_mask.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
`.operation_async.AsyncOperation`	An object representing a long-running operation. The result type for the operation will be .resources.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_reusable_config

update_reusable_config(request: Optional[google.cloud.security.privateca_v1beta1.types.service.UpdateReusableConfigRequest] = None, *, reusable_config: Optional[google.cloud.security.privateca_v1beta1.types.resources.ReusableConfig] = 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_ReusableConfig.

Parameters
Name	Description
`request`	`.service.UpdateReusableConfigRequest` The request object. Request message for CertificateAuthorityService.UpdateReusableConfig.
`reusable_config`	`.resources.ReusableConfig` Required. ReusableConfig with updated values. This corresponds to the `reusable_config` field on the `request` instance; if `request` is provided, this should not be set.
`update_mask`	`.field_mask.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
`.operation_async.AsyncOperation`	An object representing a long-running operation. The result type for the operation will be .resources.ReusableConfig : A ReusableConfig refers to a managed ReusableConfigValues. Those, in turn, are used to describe certain fields of an X.509 certificate, such as the key usage fields, fields specific to CA certificates, certificate policy extensions and custom extensions.