Class CertificateAuthorityServiceClient (1.14.0)

Version latest

• 1.14.0 (latest)
• 1.13.1
• 1.12.2
• 1.11.0
• 1.10.3
• 1.9.0
• 1.8.1
• 1.7.1
• 1.6.1
• 1.5.0
• 1.4.3
• 1.3.2
• 1.2.4
• 1.1.0
• 1.0.6
• 0.4.0
• 0.3.0
• 0.1.1

CertificateAuthorityServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.security.privateca_v1.services.certificate_authority_service.transports.base.CertificateAuthorityServiceTransport, typing.Callable[[...], google.cloud.security.privateca_v1.services.certificate_authority_service.transports.base.CertificateAuthorityServiceTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = 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

api_endpoint

Return the API endpoint used by the client instance.

Returns
Type	Description
str	The API endpoint used by the client instance.

transport

Returns the transport used by the client instance.

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

universe_domain

Return the universe domain used by the client instance.

Returns
Type	Description
str	The universe domain used by the client instance.

Methods

CertificateAuthorityServiceClient

CertificateAuthorityServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.security.privateca_v1.services.certificate_authority_service.transports.base.CertificateAuthorityServiceTransport, typing.Callable[[...], google.cloud.security.privateca_v1.services.certificate_authority_service.transports.base.CertificateAuthorityServiceTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = 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	Optional[Union[str,CertificateAuthorityServiceTransport,Callable[..., CertificateAuthorityServiceTransport]]] The transport to use, or a Callable that constructs and returns a new transport. If a Callable is given, it will be called with the same set of initialization arguments as used in the CertificateAuthorityServiceTransport constructor. If set to None, a transport is chosen automatically.
client_options	Optional[Union[google.api_core.client_options.ClientOptions, dict]] Custom options for the client. 1. The api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: "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). 2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the client_cert_source property can be used to provide a client certificate for mTLS 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. 3. The universe_domain property can be used to override the default "googleapis.com" universe. Note that the api_endpoint property still takes precedence; and universe_domain is currently not supported for mTLS.
client_info	google.api_core.gapic_v1.client_info.ClientInfo The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you're developing your own client library.

Exceptions
Type	Description
google.auth.exceptions.MutualTLSChannelError	If mutual TLS transport creation failed for any reason.

__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

Warning: ONLY use as a context manager if the transport is NOT shared with other clients! Exiting the with block will CLOSE the transport and may cause errors in other clients!

activate_certificate_authority

activate_certificate_authority(
    request: typing.Optional[
        typing.Union[
            google.cloud.security.privateca_v1.types.service.ActivateCertificateAuthorityRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud.security import privateca_v1

def sample_activate_certificate_authority():
    # Create a client
    client = privateca_v1.CertificateAuthorityServiceClient()

    # Initialize request argument(s)
    subordinate_config = privateca_v1.SubordinateConfig()
    subordinate_config.certificate_authority = "certificate_authority_value"

    request = privateca_v1.ActivateCertificateAuthorityRequest(
        name="name_value",
        pem_ca_certificate="pem_ca_certificate_value",
        subordinate_config=subordinate_config,
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.security.privateca_v1.types.ActivateCertificateAuthorityRequest, dict] 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, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
google.api_core.operation.Operation	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) -> str

Returns a fully-qualified ca_pool string.

cancel_operation

cancel_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.CancelOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

Starts asynchronous cancellation on a long-running operation.

The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters
Name	Description
request	.operations_pb2.CancelOperationRequest The request object. Request message for CancelOperation method.
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, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

certificate_authority_path

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

Returns a fully-qualified certificate_authority string.

certificate_path

certificate_path(
    project: str, location: str, ca_pool: str, certificate: str
) -> 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,
) -> str

Returns a fully-qualified certificate_revocation_list string.

certificate_template_path

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

Returns a fully-qualified certificate_template string.

common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

create_ca_pool

create_ca_pool(
    request: typing.Optional[
        typing.Union[
            google.cloud.security.privateca_v1.types.service.CreateCaPoolRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    ca_pool: typing.Optional[
        google.cloud.security.privateca_v1.types.resources.CaPool
    ] = None,
    ca_pool_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Create a xref_CaPool.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud.security import privateca_v1

def sample_create_ca_pool():
    # Create a client
    client = privateca_v1.CertificateAuthorityServiceClient()

    # Initialize request argument(s)
    ca_pool = privateca_v1.CaPool()
    ca_pool.tier = "DEVOPS"

    request = privateca_v1.CreateCaPoolRequest(
        parent="parent_value",
        ca_pool_id="ca_pool_id_value",
        ca_pool=ca_pool,
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.security.privateca_v1.types.CreateCaPoolRequest, dict] 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	google.cloud.security.privateca_v1.types.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, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
google.api_core.operation.Operation	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: typing.Optional[
        typing.Union[
            google.cloud.security.privateca_v1.types.service.CreateCertificateRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    certificate: typing.Optional[
        google.cloud.security.privateca_v1.types.resources.Certificate
    ] = None,
    certificate_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.security.privateca_v1.types.resources.Certificate

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud.security import privateca_v1

def sample_create_certificate():
    # Create a client
    client = privateca_v1.CertificateAuthorityServiceClient()

    # Initialize request argument(s)
    certificate = privateca_v1.Certificate()
    certificate.pem_csr = "pem_csr_value"

    request = privateca_v1.CreateCertificateRequest(
        parent="parent_value",
        certificate=certificate,
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.security.privateca_v1.types.CreateCertificateRequest, dict] 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	google.cloud.security.privateca_v1.types.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, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

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: typing.Optional[
        typing.Union[
            google.cloud.security.privateca_v1.types.service.CreateCertificateAuthorityRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    certificate_authority: typing.Optional[
        google.cloud.security.privateca_v1.types.resources.CertificateAuthority
    ] = None,
    certificate_authority_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Create a new xref_CertificateAuthority in a given Project and Location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud.security import privateca_v1

def sample_create_certificate_authority():
    # Create a client
    client = privateca_v1.CertificateAuthorityServiceClient()

    # Initialize request argument(s)
    certificate_authority = privateca_v1.CertificateAuthority()
    certificate_authority.type_ = "SUBORDINATE"
    certificate_authority.key_spec.cloud_kms_key_version = "cloud_kms_key_version_value"

    request = privateca_v1.CreateCertificateAuthorityRequest(
        parent="parent_value",
        certificate_authority_id="certificate_authority_id_value",
        certificate_authority=certificate_authority,
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.security.privateca_v1.types.CreateCertificateAuthorityRequest, dict] 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	google.cloud.security.privateca_v1.types.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, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
google.api_core.operation.Operation	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: typing.Optional[
        typing.Union[
            google.cloud.security.privateca_v1.types.service.CreateCertificateTemplateRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    certificate_template: typing.Optional[
        google.cloud.security.privateca_v1.types.resources.CertificateTemplate
    ] = None,
    certificate_template_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Create a new xref_CertificateTemplate in a given Project and Location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud.security import privateca_v1

def sample_create_certificate_template():
    # Create a client
    client = privateca_v1.CertificateAuthorityServiceClient()

    # Initialize request argument(s)
    request = privateca_v1.CreateCertificateTemplateRequest(
        parent="parent_value",
        certificate_template_id="certificate_template_id_value",
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.security.privateca_v1.types.CreateCertificateTemplateRequest, dict] 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	google.cloud.security.privateca_v1.types.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, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
google.api_core.operation.Operation	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: typing.Optional[
        typing.Union[
            google.cloud.security.privateca_v1.types.service.DeleteCaPoolRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Delete a xref_CaPool.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud.security import privateca_v1

def sample_delete_ca_pool():
    # Create a client
    client = privateca_v1.CertificateAuthorityServiceClient()

    # Initialize request argument(s)
    request = privateca_v1.DeleteCaPoolRequest(
        name="name_value",
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.security.privateca_v1.types.DeleteCaPoolRequest, dict] 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, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

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

delete_certificate_authority

delete_certificate_authority(
    request: typing.Optional[
        typing.Union[
            google.cloud.security.privateca_v1.types.service.DeleteCertificateAuthorityRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Delete a xref_CertificateAuthority.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud.security import privateca_v1

def sample_delete_certificate_authority():
    # Create a client
    client = privateca_v1.CertificateAuthorityServiceClient()

    # Initialize request argument(s)
    request = privateca_v1.DeleteCertificateAuthorityRequest(
        name="name_value",
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.security.privateca_v1.types.DeleteCertificateAuthorityRequest, dict] 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, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
google.api_core.operation.Operation	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: typing.Optional[
        typing.Union[
            google.cloud.security.privateca_v1.types.service.DeleteCertificateTemplateRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

DeleteCertificateTemplate deletes a xref_CertificateTemplate.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud.security import privateca_v1

def sample_delete_certificate_template():
    # Create a client
    client = privateca_v1.CertificateAuthorityServiceClient()

    # Initialize request argument(s)
    request = privateca_v1.DeleteCertificateTemplateRequest(
        name="name_value",
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.security.privateca_v1.types.DeleteCertificateTemplateRequest, dict] 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, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

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

delete_operation

delete_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.DeleteOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

Deletes a long-running operation.

This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters
Name	Description
request	.operations_pb2.DeleteOperationRequest The request object. Request message for DeleteOperation method.
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, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

disable_certificate_authority

disable_certificate_authority(
    request: typing.Optional[
        typing.Union[
            google.cloud.security.privateca_v1.types.service.DisableCertificateAuthorityRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Disable a xref_CertificateAuthority.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud.security import privateca_v1

def sample_disable_certificate_authority():
    # Create a client
    client = privateca_v1.CertificateAuthorityServiceClient()

    # Initialize request argument(s)
    request = privateca_v1.DisableCertificateAuthorityRequest(
        name="name_value",
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.security.privateca_v1.types.DisableCertificateAuthorityRequest, dict] 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, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
google.api_core.operation.Operation	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: typing.Optional[
        typing.Union[
            google.cloud.security.privateca_v1.types.service.EnableCertificateAuthorityRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Enable a xref_CertificateAuthority.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud.security import privateca_v1

def sample_enable_certificate_authority():
    # Create a client
    client = privateca_v1.CertificateAuthorityServiceClient()

    # Initialize request argument(s)
    request = privateca_v1.EnableCertificateAuthorityRequest(
        name="name_value",
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.security.privateca_v1.types.EnableCertificateAuthorityRequest, dict] 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, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
google.api_core.operation.Operation	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: typing.Optional[
        typing.Union[
            google.cloud.security.privateca_v1.types.service.FetchCaCertsRequest, dict
        ]
    ] = None,
    *,
    ca_pool: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.security.privateca_v1.types.service.FetchCaCertsResponse

FetchCaCerts returns the current trust anchor for the xref_CaPool. This will include CA certificate chains for all certificate authorities in the ENABLED, DISABLED, or STAGED states.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud.security import privateca_v1

def sample_fetch_ca_certs():
    # Create a client
    client = privateca_v1.CertificateAuthorityServiceClient()

    # Initialize request argument(s)
    request = privateca_v1.FetchCaCertsRequest(
        ca_pool="ca_pool_value",
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.security.privateca_v1.types.FetchCaCertsRequest, dict] 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, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
google.cloud.security.privateca_v1.types.FetchCaCertsResponse	Response message for CertificateAuthorityService.FetchCaCerts.

fetch_certificate_authority_csr

fetch_certificate_authority_csr(
    request: typing.Optional[
        typing.Union[
            google.cloud.security.privateca_v1.types.service.FetchCertificateAuthorityCsrRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
    google.cloud.security.privateca_v1.types.service.FetchCertificateAuthorityCsrResponse
)

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud.security import privateca_v1

def sample_fetch_certificate_authority_csr():
    # Create a client
    client = privateca_v1.CertificateAuthorityServiceClient()

    # Initialize request argument(s)
    request = privateca_v1.FetchCertificateAuthorityCsrRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.security.privateca_v1.types.FetchCertificateAuthorityCsrRequest, dict] 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, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

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

get_ca_pool

get_ca_pool(
    request: typing.Optional[
        typing.Union[
            google.cloud.security.privateca_v1.types.service.GetCaPoolRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.security.privateca_v1.types.resources.CaPool

Returns a xref_CaPool.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud.security import privateca_v1

def sample_get_ca_pool():
    # Create a client
    client = privateca_v1.CertificateAuthorityServiceClient()

    # Initialize request argument(s)
    request = privateca_v1.GetCaPoolRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.security.privateca_v1.types.GetCaPoolRequest, dict] 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, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

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: typing.Optional[
        typing.Union[
            google.cloud.security.privateca_v1.types.service.GetCertificateRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.security.privateca_v1.types.resources.Certificate

Returns a xref_Certificate.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud.security import privateca_v1

def sample_get_certificate():
    # Create a client
    client = privateca_v1.CertificateAuthorityServiceClient()

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

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

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.security.privateca_v1.types.GetCertificateRequest, dict] 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, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

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: typing.Optional[
        typing.Union[
            google.cloud.security.privateca_v1.types.service.GetCertificateAuthorityRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.security.privateca_v1.types.resources.CertificateAuthority

Returns a xref_CertificateAuthority.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud.security import privateca_v1

def sample_get_certificate_authority():
    # Create a client
    client = privateca_v1.CertificateAuthorityServiceClient()

    # Initialize request argument(s)
    request = privateca_v1.GetCertificateAuthorityRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.security.privateca_v1.types.GetCertificateAuthorityRequest, dict] 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, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

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: typing.Optional[
        typing.Union[
            google.cloud.security.privateca_v1.types.service.GetCertificateRevocationListRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.security.privateca_v1.types.resources.CertificateRevocationList

Returns a xref_CertificateRevocationList.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud.security import privateca_v1

def sample_get_certificate_revocation_list():
    # Create a client
    client = privateca_v1.CertificateAuthorityServiceClient()

    # Initialize request argument(s)
    request = privateca_v1.GetCertificateRevocationListRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.security.privateca_v1.types.GetCertificateRevocationListRequest, dict] 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, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

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: typing.Optional[
        typing.Union[
            google.cloud.security.privateca_v1.types.service.GetCertificateTemplateRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.security.privateca_v1.types.resources.CertificateTemplate

Returns a xref_CertificateTemplate.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud.security import privateca_v1

def sample_get_certificate_template():
    # Create a client
    client = privateca_v1.CertificateAuthorityServiceClient()

    # Initialize request argument(s)
    request = privateca_v1.GetCertificateTemplateRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.security.privateca_v1.types.GetCertificateTemplateRequest, dict] 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, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
google.cloud.security.privateca_v1.types.CertificateTemplate	A CertificateTemplate refers to a managed template for certificate issuance.

get_iam_policy

get_iam_policy(
    request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.iam.v1.policy_pb2.Policy

Gets the IAM access control policy for a function.

Returns an empty policy if the function exists and does not have a policy set.

Parameters
Name	Description
request	.iam_policy_pb2.GetIamPolicyRequest The request object. Request message for GetIamPolicy method.
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, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
.policy_pb2.Policy	Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions (defined by IAM or configured by users). A binding can optionally specify a condition, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource. **JSON Example** :: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:[e-mail]", "group:[e-mail]", "domain:google.com", "serviceAccount:[e-mail]" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:[e-mail]"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01t00:00:00.000z')",="" }="" }="" ]="" }="" **yaml="" example**="" ::="" bindings:="" -="" members:="" -="" user:[e-mail]="" -="" group:[e-mail]="" -="" domain:google.com="" -="" serviceaccount:[e-mail]="" role:="" roles/resourcemanager.organizationadmin="" -="" members:="" -="" user:[e-mail]="" role:="" roles/resourcemanager.organizationviewer="" condition:="" title:="" expirable="" access="" description:="" does="" not="" grant="" access="" after="" sep="" 2020="" expression:="" request.time="">< timestamp('2020-10-01t00:00:00.000z')="" for="" a="" description="" of="" iam="" and="" its="" features,="" see="" the="">IAM developer's guide __.

get_location

get_location(
    request: typing.Optional[
        google.cloud.location.locations_pb2.GetLocationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.location.locations_pb2.Location

Gets information about a location.

Parameters
Name	Description
request	.location_pb2.GetLocationRequest The request object. Request message for GetLocation method.
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, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
.location_pb2.Location	Location object.

get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Deprecated. 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 variable is "never", use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameter
Name	Description
client_options	google.api_core.client_options.ClientOptions Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.

Exceptions
Type	Description
google.auth.exceptions.MutualTLSChannelError	If any errors happen.

Returns
Type	Description
Tuple[str, Callable[[], Tuple[bytes, bytes]]]	returns the API endpoint and the client cert source to use.

get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

Parameters
Name	Description
request	.operations_pb2.GetOperationRequest The request object. Request message for GetOperation method.
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, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
.operations_pb2.Operation	An Operation object.

list_ca_pools

list_ca_pools(
    request: typing.Optional[
        typing.Union[
            google.cloud.security.privateca_v1.types.service.ListCaPoolsRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
    google.cloud.security.privateca_v1.services.certificate_authority_service.pagers.ListCaPoolsPager
)

Lists xref_CaPools.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud.security import privateca_v1

def sample_list_ca_pools():
    # Create a client
    client = privateca_v1.CertificateAuthorityServiceClient()

    # Initialize request argument(s)
    request = privateca_v1.ListCaPoolsRequest(
        parent="parent_value",
    )

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

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

Parameters
Name	Description
request	Union[google.cloud.security.privateca_v1.types.ListCaPoolsRequest, dict] 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, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
google.cloud.security.privateca_v1.services.certificate_authority_service.pagers.ListCaPoolsPager	Response message for CertificateAuthorityService.ListCaPools. Iterating over this object will yield results and resolve additional pages automatically.

list_certificate_authorities

list_certificate_authorities(
    request: typing.Optional[
        typing.Union[
            google.cloud.security.privateca_v1.types.service.ListCertificateAuthoritiesRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
    google.cloud.security.privateca_v1.services.certificate_authority_service.pagers.ListCertificateAuthoritiesPager
)

Lists xref_CertificateAuthorities.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud.security import privateca_v1

def sample_list_certificate_authorities():
    # Create a client
    client = privateca_v1.CertificateAuthorityServiceClient()

    # Initialize request argument(s)
    request = privateca_v1.ListCertificateAuthoritiesRequest(
        parent="parent_value",
    )

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

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

Parameters
Name	Description
request	Union[google.cloud.security.privateca_v1.types.ListCertificateAuthoritiesRequest, dict] 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, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
google.cloud.security.privateca_v1.services.certificate_authority_service.pagers.ListCertificateAuthoritiesPager	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: typing.Optional[
        typing.Union[
            google.cloud.security.privateca_v1.types.service.ListCertificateRevocationListsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
    google.cloud.security.privateca_v1.services.certificate_authority_service.pagers.ListCertificateRevocationListsPager
)

Lists xref_CertificateRevocationLists.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud.security import privateca_v1

def sample_list_certificate_revocation_lists():
    # Create a client
    client = privateca_v1.CertificateAuthorityServiceClient()

    # Initialize request argument(s)
    request = privateca_v1.ListCertificateRevocationListsRequest(
        parent="parent_value",
    )

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

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

Parameters
Name	Description
request	Union[google.cloud.security.privateca_v1.types.ListCertificateRevocationListsRequest, dict] 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, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
google.cloud.security.privateca_v1.services.certificate_authority_service.pagers.ListCertificateRevocationListsPager	Response message for CertificateAuthorityService.ListCertificateRevocationLists. Iterating over this object will yield results and resolve additional pages automatically.

list_certificate_templates

list_certificate_templates(
    request: typing.Optional[
        typing.Union[
            google.cloud.security.privateca_v1.types.service.ListCertificateTemplatesRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
    google.cloud.security.privateca_v1.services.certificate_authority_service.pagers.ListCertificateTemplatesPager
)

Lists xref_CertificateTemplates.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud.security import privateca_v1

def sample_list_certificate_templates():
    # Create a client
    client = privateca_v1.CertificateAuthorityServiceClient()

    # Initialize request argument(s)
    request = privateca_v1.ListCertificateTemplatesRequest(
        parent="parent_value",
    )

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

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

Parameters
Name	Description
request	Union[google.cloud.security.privateca_v1.types.ListCertificateTemplatesRequest, dict] 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, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
google.cloud.security.privateca_v1.services.certificate_authority_service.pagers.ListCertificateTemplatesPager	Response message for CertificateAuthorityService.ListCertificateTemplates. Iterating over this object will yield results and resolve additional pages automatically.

list_certificates

list_certificates(
    request: typing.Optional[
        typing.Union[
            google.cloud.security.privateca_v1.types.service.ListCertificatesRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
    google.cloud.security.privateca_v1.services.certificate_authority_service.pagers.ListCertificatesPager
)

Lists xref_Certificates.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud.security import privateca_v1

def sample_list_certificates():
    # Create a client
    client = privateca_v1.CertificateAuthorityServiceClient()

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

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

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

Parameters
Name	Description
request	Union[google.cloud.security.privateca_v1.types.ListCertificatesRequest, dict] 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, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
google.cloud.security.privateca_v1.services.certificate_authority_service.pagers.ListCertificatesPager	Response message for CertificateAuthorityService.ListCertificates. Iterating over this object will yield results and resolve additional pages automatically.

list_locations

list_locations(
    request: typing.Optional[
        google.cloud.location.locations_pb2.ListLocationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse

Lists information about the supported locations for this service.

Parameters
Name	Description
request	.location_pb2.ListLocationsRequest The request object. Request message for ListLocations method.
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, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
.location_pb2.ListLocationsResponse	Response message for ListLocations method.

list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

Parameters
Name	Description
request	.operations_pb2.ListOperationsRequest The request object. Request message for ListOperations method.
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, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
.operations_pb2.ListOperationsResponse	Response message for ListOperations method.

parse_ca_pool_path

parse_ca_pool_path(path: str) -> typing.Dict[str, str]

Parses a ca_pool path into its component segments.

parse_certificate_authority_path

parse_certificate_authority_path(path: str) -> typing.Dict[str, str]

Parses a certificate_authority path into its component segments.

parse_certificate_path

parse_certificate_path(path: str) -> typing.Dict[str, str]

Parses a certificate path into its component segments.

parse_certificate_revocation_list_path

parse_certificate_revocation_list_path(path: str) -> typing.Dict[str, str]

Parses a certificate_revocation_list path into its component segments.

parse_certificate_template_path

parse_certificate_template_path(path: str) -> typing.Dict[str, str]

Parses a certificate_template path into its component segments.

parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

revoke_certificate

revoke_certificate(
    request: typing.Optional[
        typing.Union[
            google.cloud.security.privateca_v1.types.service.RevokeCertificateRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.security.privateca_v1.types.resources.Certificate

Revoke a xref_Certificate.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud.security import privateca_v1

def sample_revoke_certificate():
    # Create a client
    client = privateca_v1.CertificateAuthorityServiceClient()

    # Initialize request argument(s)
    request = privateca_v1.RevokeCertificateRequest(
        name="name_value",
        reason="ATTRIBUTE_AUTHORITY_COMPROMISE",
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.security.privateca_v1.types.RevokeCertificateRequest, dict] 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, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
google.cloud.security.privateca_v1.types.Certificate	A Certificate corresponds to a signed X.509 certificate issued by a CertificateAuthority.

set_iam_policy

set_iam_policy(
    request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.iam.v1.policy_pb2.Policy

Sets the IAM access control policy on the specified function.

Replaces any existing policy.

Parameters
Name	Description
request	.iam_policy_pb2.SetIamPolicyRequest The request object. Request message for SetIamPolicy method.
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, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
.policy_pb2.Policy	Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions (defined by IAM or configured by users). A binding can optionally specify a condition, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource. **JSON Example** :: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:[e-mail]", "group:[e-mail]", "domain:google.com", "serviceAccount:[e-mail]" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:[e-mail]"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01t00:00:00.000z')",="" }="" }="" ]="" }="" **yaml="" example**="" ::="" bindings:="" -="" members:="" -="" user:[e-mail]="" -="" group:[e-mail]="" -="" domain:google.com="" -="" serviceaccount:[e-mail]="" role:="" roles/resourcemanager.organizationadmin="" -="" members:="" -="" user:[e-mail]="" role:="" roles/resourcemanager.organizationviewer="" condition:="" title:="" expirable="" access="" description:="" does="" not="" grant="" access="" after="" sep="" 2020="" expression:="" request.time="">< timestamp('2020-10-01t00:00:00.000z')="" for="" a="" description="" of="" iam="" and="" its="" features,="" see="" the="">IAM developer's guide __.

test_iam_permissions

test_iam_permissions(
    request: typing.Optional[
        google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse

Tests the specified IAM permissions against the IAM access control policy for a function.

If the function does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Parameters
Name	Description
request	.iam_policy_pb2.TestIamPermissionsRequest The request object. Request message for TestIamPermissions method.
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, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
.iam_policy_pb2.TestIamPermissionsResponse	Response message for TestIamPermissions method.

undelete_certificate_authority

undelete_certificate_authority(
    request: typing.Optional[
        typing.Union[
            google.cloud.security.privateca_v1.types.service.UndeleteCertificateAuthorityRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Undelete a xref_CertificateAuthority that has been deleted.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud.security import privateca_v1

def sample_undelete_certificate_authority():
    # Create a client
    client = privateca_v1.CertificateAuthorityServiceClient()

    # Initialize request argument(s)
    request = privateca_v1.UndeleteCertificateAuthorityRequest(
        name="name_value",
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.security.privateca_v1.types.UndeleteCertificateAuthorityRequest, dict] 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, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
google.api_core.operation.Operation	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: typing.Optional[
        typing.Union[
            google.cloud.security.privateca_v1.types.service.UpdateCaPoolRequest, dict
        ]
    ] = None,
    *,
    ca_pool: typing.Optional[
        google.cloud.security.privateca_v1.types.resources.CaPool
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Update a xref_CaPool.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud.security import privateca_v1

def sample_update_ca_pool():
    # Create a client
    client = privateca_v1.CertificateAuthorityServiceClient()

    # Initialize request argument(s)
    ca_pool = privateca_v1.CaPool()
    ca_pool.tier = "DEVOPS"

    request = privateca_v1.UpdateCaPoolRequest(
        ca_pool=ca_pool,
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.security.privateca_v1.types.UpdateCaPoolRequest, dict] The request object. Request message for CertificateAuthorityService.UpdateCaPool.
ca_pool	google.cloud.security.privateca_v1.types.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, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
google.api_core.operation.Operation	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: typing.Optional[
        typing.Union[
            google.cloud.security.privateca_v1.types.service.UpdateCertificateRequest,
            dict,
        ]
    ] = None,
    *,
    certificate: typing.Optional[
        google.cloud.security.privateca_v1.types.resources.Certificate
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.security.privateca_v1.types.resources.Certificate

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud.security import privateca_v1

def sample_update_certificate():
    # Create a client
    client = privateca_v1.CertificateAuthorityServiceClient()

    # Initialize request argument(s)
    certificate = privateca_v1.Certificate()
    certificate.pem_csr = "pem_csr_value"

    request = privateca_v1.UpdateCertificateRequest(
        certificate=certificate,
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.security.privateca_v1.types.UpdateCertificateRequest, dict] The request object. Request message for CertificateAuthorityService.UpdateCertificate.
certificate	google.cloud.security.privateca_v1.types.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, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

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: typing.Optional[
        typing.Union[
            google.cloud.security.privateca_v1.types.service.UpdateCertificateAuthorityRequest,
            dict,
        ]
    ] = None,
    *,
    certificate_authority: typing.Optional[
        google.cloud.security.privateca_v1.types.resources.CertificateAuthority
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Update a xref_CertificateAuthority.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud.security import privateca_v1

def sample_update_certificate_authority():
    # Create a client
    client = privateca_v1.CertificateAuthorityServiceClient()

    # Initialize request argument(s)
    certificate_authority = privateca_v1.CertificateAuthority()
    certificate_authority.type_ = "SUBORDINATE"
    certificate_authority.key_spec.cloud_kms_key_version = "cloud_kms_key_version_value"

    request = privateca_v1.UpdateCertificateAuthorityRequest(
        certificate_authority=certificate_authority,
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.security.privateca_v1.types.UpdateCertificateAuthorityRequest, dict] The request object. Request message for CertificateAuthorityService.UpdateCertificateAuthority.
certificate_authority	google.cloud.security.privateca_v1.types.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, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
google.api_core.operation.Operation	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: typing.Optional[
        typing.Union[
            google.cloud.security.privateca_v1.types.service.UpdateCertificateRevocationListRequest,
            dict,
        ]
    ] = None,
    *,
    certificate_revocation_list: typing.Optional[
        google.cloud.security.privateca_v1.types.resources.CertificateRevocationList
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Update a xref_CertificateRevocationList.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud.security import privateca_v1

def sample_update_certificate_revocation_list():
    # Create a client
    client = privateca_v1.CertificateAuthorityServiceClient()

    # Initialize request argument(s)
    request = privateca_v1.UpdateCertificateRevocationListRequest(
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.security.privateca_v1.types.UpdateCertificateRevocationListRequest, dict] The request object. Request message for CertificateAuthorityService.UpdateCertificateRevocationList.
certificate_revocation_list	google.cloud.security.privateca_v1.types.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, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
google.api_core.operation.Operation	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: typing.Optional[
        typing.Union[
            google.cloud.security.privateca_v1.types.service.UpdateCertificateTemplateRequest,
            dict,
        ]
    ] = None,
    *,
    certificate_template: typing.Optional[
        google.cloud.security.privateca_v1.types.resources.CertificateTemplate
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Update a xref_CertificateTemplate.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud.security import privateca_v1

def sample_update_certificate_template():
    # Create a client
    client = privateca_v1.CertificateAuthorityServiceClient()

    # Initialize request argument(s)
    request = privateca_v1.UpdateCertificateTemplateRequest(
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.security.privateca_v1.types.UpdateCertificateTemplateRequest, dict] The request object. Request message for CertificateAuthorityService.UpdateCertificateTemplate.
certificate_template	google.cloud.security.privateca_v1.types.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, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
google.api_core.operation.Operation	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.