Package com.google.cloud.security.privateca.v1 (2.25.0)

A client to Certificate Authority API

The interfaces provided are listed below, along with usage samples.

CertificateAuthorityServiceClient

Service Description: Certificate Authority Service manages private certificate authorities and issued certificates.

Sample for CertificateAuthorityServiceClient:


 // 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CertificateAuthorityServiceClient certificateAuthorityServiceClient =
     CertificateAuthorityServiceClient.create()) {
   CaPoolName parent = CaPoolName.of("[PROJECT]", "[LOCATION]", "[CA_POOL]");
   Certificate certificate = Certificate.newBuilder().build();
   String certificateId = "certificateId-644529902";
   Certificate response =
       certificateAuthorityServiceClient.createCertificate(parent, certificate, certificateId);
 }

Classes

ActivateCertificateAuthorityRequest

Request message for CertificateAuthorityService.ActivateCertificateAuthority.

Protobuf type google.cloud.security.privateca.v1.ActivateCertificateAuthorityRequest

ActivateCertificateAuthorityRequest.Builder

Request message for CertificateAuthorityService.ActivateCertificateAuthority.

Protobuf type google.cloud.security.privateca.v1.ActivateCertificateAuthorityRequest

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.

Protobuf type google.cloud.security.privateca.v1.CaPool

CaPool.Builder

Protobuf type google.cloud.security.privateca.v1.CaPool

CaPool.IssuancePolicy

Defines controls over all certificate issuance within a CaPool.

Protobuf type google.cloud.security.privateca.v1.CaPool.IssuancePolicy

CaPool.IssuancePolicy.AllowedKeyType

Describes a "type" of key that may be used in a Certificate issued from a CaPool. Note that a single AllowedKeyType may refer to either a fully-qualified key algorithm, such as RSA 4096, or a family of key algorithms, such as any RSA key.

Protobuf type google.cloud.security.privateca.v1.CaPool.IssuancePolicy.AllowedKeyType

CaPool.IssuancePolicy.AllowedKeyType.Builder

Protobuf type google.cloud.security.privateca.v1.CaPool.IssuancePolicy.AllowedKeyType

CaPool.IssuancePolicy.AllowedKeyType.EcKeyType

Describes an Elliptic Curve key that may be used in a Certificate issued from a CaPool.

Protobuf type google.cloud.security.privateca.v1.CaPool.IssuancePolicy.AllowedKeyType.EcKeyType

CaPool.IssuancePolicy.AllowedKeyType.EcKeyType.Builder

Describes an Elliptic Curve key that may be used in a Certificate issued from a CaPool.

Protobuf type google.cloud.security.privateca.v1.CaPool.IssuancePolicy.AllowedKeyType.EcKeyType

CaPool.IssuancePolicy.AllowedKeyType.RsaKeyType

Describes an RSA key that may be used in a Certificate issued from a CaPool.

Protobuf type google.cloud.security.privateca.v1.CaPool.IssuancePolicy.AllowedKeyType.RsaKeyType

CaPool.IssuancePolicy.AllowedKeyType.RsaKeyType.Builder

Describes an RSA key that may be used in a Certificate issued from a CaPool.

Protobuf type google.cloud.security.privateca.v1.CaPool.IssuancePolicy.AllowedKeyType.RsaKeyType

CaPool.IssuancePolicy.Builder

Defines controls over all certificate issuance within a CaPool.

Protobuf type google.cloud.security.privateca.v1.CaPool.IssuancePolicy

CaPool.IssuancePolicy.IssuanceModes

IssuanceModes specifies the allowed ways in which Certificates may be requested from this CaPool.

Protobuf type google.cloud.security.privateca.v1.CaPool.IssuancePolicy.IssuanceModes

CaPool.IssuancePolicy.IssuanceModes.Builder

IssuanceModes specifies the allowed ways in which Certificates may be requested from this CaPool.

Protobuf type google.cloud.security.privateca.v1.CaPool.IssuancePolicy.IssuanceModes

CaPool.PublishingOptions

Options relating to the publication of each CertificateAuthority's CA certificate and CRLs and their inclusion as extensions in issued Certificates. The options set here apply to certificates issued by any CertificateAuthority in the CaPool.

Protobuf type google.cloud.security.privateca.v1.CaPool.PublishingOptions

CaPool.PublishingOptions.Builder

Protobuf type google.cloud.security.privateca.v1.CaPool.PublishingOptions

CaPoolName

CaPoolName.Builder

Builder for projects/{project}/locations/{location}/caPools/{ca_pool}.

Certificate

A Certificate corresponds to a signed X.509 certificate issued by a CertificateAuthority.

Protobuf type google.cloud.security.privateca.v1.Certificate

Certificate.Builder

A Certificate corresponds to a signed X.509 certificate issued by a CertificateAuthority.

Protobuf type google.cloud.security.privateca.v1.Certificate

Certificate.RevocationDetails

Describes fields that are relavent to the revocation of a Certificate.

Protobuf type google.cloud.security.privateca.v1.Certificate.RevocationDetails

Certificate.RevocationDetails.Builder

Describes fields that are relavent to the revocation of a Certificate.

Protobuf type google.cloud.security.privateca.v1.Certificate.RevocationDetails

CertificateAuthority

A CertificateAuthority represents an individual Certificate Authority. A CertificateAuthority can be used to create Certificates.

Protobuf type google.cloud.security.privateca.v1.CertificateAuthority

CertificateAuthority.AccessUrls

URLs where a CertificateAuthority will publish content.

Protobuf type google.cloud.security.privateca.v1.CertificateAuthority.AccessUrls

CertificateAuthority.AccessUrls.Builder

URLs where a CertificateAuthority will publish content.

Protobuf type google.cloud.security.privateca.v1.CertificateAuthority.AccessUrls

CertificateAuthority.Builder

A CertificateAuthority represents an individual Certificate Authority. A CertificateAuthority can be used to create Certificates.

Protobuf type google.cloud.security.privateca.v1.CertificateAuthority

CertificateAuthority.KeyVersionSpec

A Cloud KMS key configuration that a CertificateAuthority will use.

Protobuf type google.cloud.security.privateca.v1.CertificateAuthority.KeyVersionSpec

CertificateAuthority.KeyVersionSpec.Builder

A Cloud KMS key configuration that a CertificateAuthority will use.

Protobuf type google.cloud.security.privateca.v1.CertificateAuthority.KeyVersionSpec

CertificateAuthorityName

CertificateAuthorityName.Builder

Builder for projects/{project}/locations/{location}/caPools/{ca_pool}/certificateAuthorities/{certificate_authority}.

CertificateAuthorityServiceClient

Service Description: Certificate Authority Service manages private certificate authorities and issued certificates.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 // 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (CertificateAuthorityServiceClient certificateAuthorityServiceClient =
     CertificateAuthorityServiceClient.create()) {
   CaPoolName parent = CaPoolName.of("[PROJECT]", "[LOCATION]", "[CA_POOL]");
   Certificate certificate = Certificate.newBuilder().build();
   String certificateId = "certificateId-644529902";
   Certificate response =
       certificateAuthorityServiceClient.createCertificate(parent, certificate, certificateId);
 }

Note: close() needs to be called on the CertificateAuthorityServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of CertificateAuthorityServiceSettings to create(). For example:

To customize credentials:


 // 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 CertificateAuthorityServiceSettings certificateAuthorityServiceSettings =
     CertificateAuthorityServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 CertificateAuthorityServiceClient certificateAuthorityServiceClient =
     CertificateAuthorityServiceClient.create(certificateAuthorityServiceSettings);

To customize the endpoint:


 // 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 CertificateAuthorityServiceSettings certificateAuthorityServiceSettings =
     CertificateAuthorityServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 CertificateAuthorityServiceClient certificateAuthorityServiceClient =
     CertificateAuthorityServiceClient.create(certificateAuthorityServiceSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 CertificateAuthorityServiceSettings certificateAuthorityServiceSettings =
     CertificateAuthorityServiceSettings.newHttpJsonBuilder().build();
 CertificateAuthorityServiceClient certificateAuthorityServiceClient =
     CertificateAuthorityServiceClient.create(certificateAuthorityServiceSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

CertificateAuthorityServiceClient.ListCaPoolsFixedSizeCollection

CertificateAuthorityServiceClient.ListCaPoolsPage

CertificateAuthorityServiceClient.ListCaPoolsPagedResponse

CertificateAuthorityServiceClient.ListCertificateAuthoritiesFixedSizeCollection

CertificateAuthorityServiceClient.ListCertificateAuthoritiesPage

CertificateAuthorityServiceClient.ListCertificateAuthoritiesPagedResponse

CertificateAuthorityServiceClient.ListCertificateRevocationListsFixedSizeCollection

CertificateAuthorityServiceClient.ListCertificateRevocationListsPage

CertificateAuthorityServiceClient.ListCertificateRevocationListsPagedResponse

CertificateAuthorityServiceClient.ListCertificateTemplatesFixedSizeCollection

CertificateAuthorityServiceClient.ListCertificateTemplatesPage

CertificateAuthorityServiceClient.ListCertificateTemplatesPagedResponse

CertificateAuthorityServiceClient.ListCertificatesFixedSizeCollection

CertificateAuthorityServiceClient.ListCertificatesPage

CertificateAuthorityServiceClient.ListCertificatesPagedResponse

CertificateAuthorityServiceClient.ListLocationsFixedSizeCollection

CertificateAuthorityServiceClient.ListLocationsPage

CertificateAuthorityServiceClient.ListLocationsPagedResponse

CertificateAuthorityServiceGrpc

Certificate Authority Service manages private certificate authorities and issued certificates.

CertificateAuthorityServiceGrpc.CertificateAuthorityServiceBlockingStub

A stub to allow clients to do synchronous rpc calls to service CertificateAuthorityService.

Certificate Authority Service manages private certificate authorities and issued certificates.

CertificateAuthorityServiceGrpc.CertificateAuthorityServiceFutureStub

A stub to allow clients to do ListenableFuture-style rpc calls to service CertificateAuthorityService.

Certificate Authority Service manages private certificate authorities and issued certificates.

CertificateAuthorityServiceGrpc.CertificateAuthorityServiceImplBase

Base class for the server implementation of the service CertificateAuthorityService.

Certificate Authority Service manages private certificate authorities and issued certificates.

CertificateAuthorityServiceGrpc.CertificateAuthorityServiceStub

A stub to allow clients to do asynchronous rpc calls to service CertificateAuthorityService.

Certificate Authority Service manages private certificate authorities and issued certificates.

CertificateAuthorityServiceSettings

Settings class to configure an instance of CertificateAuthorityServiceClient.

The default instance has everything set to sensible defaults:

The default service address (privateca.googleapis.com) and default port (443) are used.
Credentials are acquired automatically through Application Default Credentials.
Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of createCertificate to 30 seconds:


 // 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 CertificateAuthorityServiceSettings.Builder certificateAuthorityServiceSettingsBuilder =
     CertificateAuthorityServiceSettings.newBuilder();
 certificateAuthorityServiceSettingsBuilder
     .createCertificateSettings()
     .setRetrySettings(
         certificateAuthorityServiceSettingsBuilder
             .createCertificateSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 CertificateAuthorityServiceSettings certificateAuthorityServiceSettings =
     certificateAuthorityServiceSettingsBuilder.build();

CertificateAuthorityServiceSettings.Builder

Builder for CertificateAuthorityServiceSettings.

CertificateConfig

A CertificateConfig describes an X.509 certificate or CSR that is to be created, as an alternative to using ASN.1.

Protobuf type google.cloud.security.privateca.v1.CertificateConfig

CertificateConfig.Builder

A CertificateConfig describes an X.509 certificate or CSR that is to be created, as an alternative to using ASN.1.

Protobuf type google.cloud.security.privateca.v1.CertificateConfig

CertificateConfig.SubjectConfig

These values are used to create the distinguished name and subject alternative name fields in an X.509 certificate.

Protobuf type google.cloud.security.privateca.v1.CertificateConfig.SubjectConfig

CertificateConfig.SubjectConfig.Builder

These values are used to create the distinguished name and subject alternative name fields in an X.509 certificate.

Protobuf type google.cloud.security.privateca.v1.CertificateConfig.SubjectConfig

CertificateDescription

A CertificateDescription describes an X.509 certificate or CSR that has been issued, as an alternative to using ASN.1 / X.509.

Protobuf type google.cloud.security.privateca.v1.CertificateDescription

CertificateDescription.Builder

A CertificateDescription describes an X.509 certificate or CSR that has been issued, as an alternative to using ASN.1 / X.509.

Protobuf type google.cloud.security.privateca.v1.CertificateDescription

CertificateDescription.CertificateFingerprint

A group of fingerprints for the x509 certificate.

Protobuf type google.cloud.security.privateca.v1.CertificateDescription.CertificateFingerprint

CertificateDescription.CertificateFingerprint.Builder

A group of fingerprints for the x509 certificate.

Protobuf type google.cloud.security.privateca.v1.CertificateDescription.CertificateFingerprint

CertificateDescription.KeyId

A KeyId identifies a specific public key, usually by hashing the public key.

Protobuf type google.cloud.security.privateca.v1.CertificateDescription.KeyId

CertificateDescription.KeyId.Builder

A KeyId identifies a specific public key, usually by hashing the public key.

Protobuf type google.cloud.security.privateca.v1.CertificateDescription.KeyId

CertificateDescription.SubjectDescription

These values describe fields in an issued X.509 certificate such as the distinguished name, subject alternative names, serial number, and lifetime.

Protobuf type google.cloud.security.privateca.v1.CertificateDescription.SubjectDescription

CertificateDescription.SubjectDescription.Builder

These values describe fields in an issued X.509 certificate such as the distinguished name, subject alternative names, serial number, and lifetime.

Protobuf type google.cloud.security.privateca.v1.CertificateDescription.SubjectDescription

CertificateExtensionConstraints

Describes a set of X.509 extensions that may be part of some certificate issuance controls.

Protobuf type google.cloud.security.privateca.v1.CertificateExtensionConstraints

CertificateExtensionConstraints.Builder

Describes a set of X.509 extensions that may be part of some certificate issuance controls.

Protobuf type google.cloud.security.privateca.v1.CertificateExtensionConstraints

CertificateIdentityConstraints

Describes constraints on a Certificate's Subject and SubjectAltNames.

Protobuf type google.cloud.security.privateca.v1.CertificateIdentityConstraints

CertificateIdentityConstraints.Builder

Describes constraints on a Certificate's Subject and SubjectAltNames.

Protobuf type google.cloud.security.privateca.v1.CertificateIdentityConstraints

CertificateName

CertificateName.Builder

Builder for projects/{project}/locations/{location}/caPools/{ca_pool}/certificates/{certificate}.

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.

Protobuf type google.cloud.security.privateca.v1.CertificateRevocationList

CertificateRevocationList.Builder

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.

Protobuf type google.cloud.security.privateca.v1.CertificateRevocationList

CertificateRevocationList.RevokedCertificate

Describes a revoked Certificate.

Protobuf type google.cloud.security.privateca.v1.CertificateRevocationList.RevokedCertificate

CertificateRevocationList.RevokedCertificate.Builder

Describes a revoked Certificate.

Protobuf type google.cloud.security.privateca.v1.CertificateRevocationList.RevokedCertificate

CertificateRevocationListName

CertificateRevocationListName.Builder

Builder for projects/{project}/locations/{location}/caPools/{ca_pool}/certificateAuthorities/{certificate_authority}/certificateRevocationLists/{certificate_revocation_list}.

CertificateTemplate

A CertificateTemplate refers to a managed template for certificate issuance.

Protobuf type google.cloud.security.privateca.v1.CertificateTemplate

CertificateTemplate.Builder

A CertificateTemplate refers to a managed template for certificate issuance.

Protobuf type google.cloud.security.privateca.v1.CertificateTemplate

CertificateTemplateName

CertificateTemplateName.Builder

Builder for projects/{project}/locations/{location}/certificateTemplates/{certificate_template}.

CreateCaPoolRequest

Request message for CertificateAuthorityService.CreateCaPool.

Protobuf type google.cloud.security.privateca.v1.CreateCaPoolRequest

CreateCaPoolRequest.Builder

Request message for CertificateAuthorityService.CreateCaPool.

Protobuf type google.cloud.security.privateca.v1.CreateCaPoolRequest

CreateCertificateAuthorityRequest

Request message for CertificateAuthorityService.CreateCertificateAuthority.

Protobuf type google.cloud.security.privateca.v1.CreateCertificateAuthorityRequest

CreateCertificateAuthorityRequest.Builder

Request message for CertificateAuthorityService.CreateCertificateAuthority.

Protobuf type google.cloud.security.privateca.v1.CreateCertificateAuthorityRequest

CreateCertificateRequest

Request message for CertificateAuthorityService.CreateCertificate.

Protobuf type google.cloud.security.privateca.v1.CreateCertificateRequest

CreateCertificateRequest.Builder

Request message for CertificateAuthorityService.CreateCertificate.

Protobuf type google.cloud.security.privateca.v1.CreateCertificateRequest

CreateCertificateTemplateRequest

Request message for CertificateAuthorityService.CreateCertificateTemplate.

Protobuf type google.cloud.security.privateca.v1.CreateCertificateTemplateRequest

CreateCertificateTemplateRequest.Builder

Request message for CertificateAuthorityService.CreateCertificateTemplate.

Protobuf type google.cloud.security.privateca.v1.CreateCertificateTemplateRequest

DeleteCaPoolRequest

Request message for CertificateAuthorityService.DeleteCaPool.

Protobuf type google.cloud.security.privateca.v1.DeleteCaPoolRequest

DeleteCaPoolRequest.Builder

Request message for CertificateAuthorityService.DeleteCaPool.

Protobuf type google.cloud.security.privateca.v1.DeleteCaPoolRequest

DeleteCertificateAuthorityRequest

Request message for CertificateAuthorityService.DeleteCertificateAuthority.

Protobuf type google.cloud.security.privateca.v1.DeleteCertificateAuthorityRequest

DeleteCertificateAuthorityRequest.Builder

Request message for CertificateAuthorityService.DeleteCertificateAuthority.

Protobuf type google.cloud.security.privateca.v1.DeleteCertificateAuthorityRequest

DeleteCertificateTemplateRequest

Request message for CertificateAuthorityService.DeleteCertificateTemplate.

Protobuf type google.cloud.security.privateca.v1.DeleteCertificateTemplateRequest

DeleteCertificateTemplateRequest.Builder

Request message for CertificateAuthorityService.DeleteCertificateTemplate.

Protobuf type google.cloud.security.privateca.v1.DeleteCertificateTemplateRequest

DisableCertificateAuthorityRequest

Request message for CertificateAuthorityService.DisableCertificateAuthority.

Protobuf type google.cloud.security.privateca.v1.DisableCertificateAuthorityRequest

DisableCertificateAuthorityRequest.Builder

Request message for CertificateAuthorityService.DisableCertificateAuthority.

Protobuf type google.cloud.security.privateca.v1.DisableCertificateAuthorityRequest

EnableCertificateAuthorityRequest

Request message for CertificateAuthorityService.EnableCertificateAuthority.

Protobuf type google.cloud.security.privateca.v1.EnableCertificateAuthorityRequest

EnableCertificateAuthorityRequest.Builder

Request message for CertificateAuthorityService.EnableCertificateAuthority.

Protobuf type google.cloud.security.privateca.v1.EnableCertificateAuthorityRequest

FetchCaCertsRequest

Request message for CertificateAuthorityService.FetchCaCerts.

Protobuf type google.cloud.security.privateca.v1.FetchCaCertsRequest

FetchCaCertsRequest.Builder

Request message for CertificateAuthorityService.FetchCaCerts.

Protobuf type google.cloud.security.privateca.v1.FetchCaCertsRequest

FetchCaCertsResponse

Response message for CertificateAuthorityService.FetchCaCerts.

Protobuf type google.cloud.security.privateca.v1.FetchCaCertsResponse

FetchCaCertsResponse.Builder

Response message for CertificateAuthorityService.FetchCaCerts.

Protobuf type google.cloud.security.privateca.v1.FetchCaCertsResponse

FetchCaCertsResponse.CertChain

Protobuf type google.cloud.security.privateca.v1.FetchCaCertsResponse.CertChain

FetchCaCertsResponse.CertChain.Builder

Protobuf type google.cloud.security.privateca.v1.FetchCaCertsResponse.CertChain

FetchCertificateAuthorityCsrRequest

Request message for CertificateAuthorityService.FetchCertificateAuthorityCsr.

Protobuf type google.cloud.security.privateca.v1.FetchCertificateAuthorityCsrRequest

FetchCertificateAuthorityCsrRequest.Builder

Request message for CertificateAuthorityService.FetchCertificateAuthorityCsr.

Protobuf type google.cloud.security.privateca.v1.FetchCertificateAuthorityCsrRequest

FetchCertificateAuthorityCsrResponse

Response message for CertificateAuthorityService.FetchCertificateAuthorityCsr.

Protobuf type google.cloud.security.privateca.v1.FetchCertificateAuthorityCsrResponse

FetchCertificateAuthorityCsrResponse.Builder

Response message for CertificateAuthorityService.FetchCertificateAuthorityCsr.

Protobuf type google.cloud.security.privateca.v1.FetchCertificateAuthorityCsrResponse

GetCaPoolRequest

Request message for CertificateAuthorityService.GetCaPool.

Protobuf type google.cloud.security.privateca.v1.GetCaPoolRequest

GetCaPoolRequest.Builder

Request message for CertificateAuthorityService.GetCaPool.

Protobuf type google.cloud.security.privateca.v1.GetCaPoolRequest

GetCertificateAuthorityRequest

Request message for CertificateAuthorityService.GetCertificateAuthority.

Protobuf type google.cloud.security.privateca.v1.GetCertificateAuthorityRequest

GetCertificateAuthorityRequest.Builder

Request message for CertificateAuthorityService.GetCertificateAuthority.

Protobuf type google.cloud.security.privateca.v1.GetCertificateAuthorityRequest

GetCertificateRequest

Request message for CertificateAuthorityService.GetCertificate.

Protobuf type google.cloud.security.privateca.v1.GetCertificateRequest

GetCertificateRequest.Builder

Request message for CertificateAuthorityService.GetCertificate.

Protobuf type google.cloud.security.privateca.v1.GetCertificateRequest

GetCertificateRevocationListRequest

Request message for CertificateAuthorityService.GetCertificateRevocationList.

Protobuf type google.cloud.security.privateca.v1.GetCertificateRevocationListRequest

GetCertificateRevocationListRequest.Builder

Request message for CertificateAuthorityService.GetCertificateRevocationList.

Protobuf type google.cloud.security.privateca.v1.GetCertificateRevocationListRequest

GetCertificateTemplateRequest

Request message for CertificateAuthorityService.GetCertificateTemplate.

Protobuf type google.cloud.security.privateca.v1.GetCertificateTemplateRequest

GetCertificateTemplateRequest.Builder

Request message for CertificateAuthorityService.GetCertificateTemplate.

Protobuf type google.cloud.security.privateca.v1.GetCertificateTemplateRequest

KeyUsage

A KeyUsage describes key usage values that may appear in an X.509 certificate.

Protobuf type google.cloud.security.privateca.v1.KeyUsage

KeyUsage.Builder

A KeyUsage describes key usage values that may appear in an X.509 certificate.

Protobuf type google.cloud.security.privateca.v1.KeyUsage

KeyUsage.ExtendedKeyUsageOptions

KeyUsage.ExtendedKeyUsageOptions has fields that correspond to certain common OIDs that could be specified as an extended key usage value.

Protobuf type google.cloud.security.privateca.v1.KeyUsage.ExtendedKeyUsageOptions

KeyUsage.ExtendedKeyUsageOptions.Builder

KeyUsage.ExtendedKeyUsageOptions has fields that correspond to certain common OIDs that could be specified as an extended key usage value.

Protobuf type google.cloud.security.privateca.v1.KeyUsage.ExtendedKeyUsageOptions

KeyUsage.KeyUsageOptions

KeyUsage.KeyUsageOptions corresponds to the key usage values described in https://tools.ietf.org/html/rfc5280#section-4.2.1.3.

Protobuf type google.cloud.security.privateca.v1.KeyUsage.KeyUsageOptions

KeyUsage.KeyUsageOptions.Builder

KeyUsage.KeyUsageOptions corresponds to the key usage values described in https://tools.ietf.org/html/rfc5280#section-4.2.1.3.

Protobuf type google.cloud.security.privateca.v1.KeyUsage.KeyUsageOptions

ListCaPoolsRequest

Request message for CertificateAuthorityService.ListCaPools.

Protobuf type google.cloud.security.privateca.v1.ListCaPoolsRequest

ListCaPoolsRequest.Builder

Request message for CertificateAuthorityService.ListCaPools.

Protobuf type google.cloud.security.privateca.v1.ListCaPoolsRequest

ListCaPoolsResponse

Response message for CertificateAuthorityService.ListCaPools.

Protobuf type google.cloud.security.privateca.v1.ListCaPoolsResponse

ListCaPoolsResponse.Builder

Response message for CertificateAuthorityService.ListCaPools.

Protobuf type google.cloud.security.privateca.v1.ListCaPoolsResponse

ListCertificateAuthoritiesRequest

Request message for CertificateAuthorityService.ListCertificateAuthorities.

Protobuf type google.cloud.security.privateca.v1.ListCertificateAuthoritiesRequest

ListCertificateAuthoritiesRequest.Builder

Request message for CertificateAuthorityService.ListCertificateAuthorities.

Protobuf type google.cloud.security.privateca.v1.ListCertificateAuthoritiesRequest

ListCertificateAuthoritiesResponse

Response message for CertificateAuthorityService.ListCertificateAuthorities.

Protobuf type google.cloud.security.privateca.v1.ListCertificateAuthoritiesResponse

ListCertificateAuthoritiesResponse.Builder

Response message for CertificateAuthorityService.ListCertificateAuthorities.

Protobuf type google.cloud.security.privateca.v1.ListCertificateAuthoritiesResponse

ListCertificateRevocationListsRequest

Request message for CertificateAuthorityService.ListCertificateRevocationLists.

Protobuf type google.cloud.security.privateca.v1.ListCertificateRevocationListsRequest

ListCertificateRevocationListsRequest.Builder

Request message for CertificateAuthorityService.ListCertificateRevocationLists.

Protobuf type google.cloud.security.privateca.v1.ListCertificateRevocationListsRequest

ListCertificateRevocationListsResponse

Response message for CertificateAuthorityService.ListCertificateRevocationLists.

Protobuf type google.cloud.security.privateca.v1.ListCertificateRevocationListsResponse

ListCertificateRevocationListsResponse.Builder

Response message for CertificateAuthorityService.ListCertificateRevocationLists.

Protobuf type google.cloud.security.privateca.v1.ListCertificateRevocationListsResponse

ListCertificateTemplatesRequest

Request message for CertificateAuthorityService.ListCertificateTemplates.

Protobuf type google.cloud.security.privateca.v1.ListCertificateTemplatesRequest

ListCertificateTemplatesRequest.Builder

Request message for CertificateAuthorityService.ListCertificateTemplates.

Protobuf type google.cloud.security.privateca.v1.ListCertificateTemplatesRequest

ListCertificateTemplatesResponse

Response message for CertificateAuthorityService.ListCertificateTemplates.

Protobuf type google.cloud.security.privateca.v1.ListCertificateTemplatesResponse

ListCertificateTemplatesResponse.Builder

Response message for CertificateAuthorityService.ListCertificateTemplates.

Protobuf type google.cloud.security.privateca.v1.ListCertificateTemplatesResponse

ListCertificatesRequest

Request message for CertificateAuthorityService.ListCertificates.

Protobuf type google.cloud.security.privateca.v1.ListCertificatesRequest

ListCertificatesRequest.Builder

Request message for CertificateAuthorityService.ListCertificates.

Protobuf type google.cloud.security.privateca.v1.ListCertificatesRequest

ListCertificatesResponse

Response message for CertificateAuthorityService.ListCertificates.

Protobuf type google.cloud.security.privateca.v1.ListCertificatesResponse

ListCertificatesResponse.Builder

Response message for CertificateAuthorityService.ListCertificates.

Protobuf type google.cloud.security.privateca.v1.ListCertificatesResponse

LocationName

LocationName.Builder

Builder for projects/{project}/locations/{location}.

ObjectId

An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages.

Protobuf type google.cloud.security.privateca.v1.ObjectId

ObjectId.Builder

An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages.

Protobuf type google.cloud.security.privateca.v1.ObjectId

OperationMetadata

Represents the metadata of the long-running operation.

Protobuf type google.cloud.security.privateca.v1.OperationMetadata

OperationMetadata.Builder

Represents the metadata of the long-running operation.

Protobuf type google.cloud.security.privateca.v1.OperationMetadata

PrivateCaProto

PrivateCaResourcesProto

PublicKey

A PublicKey describes a public key.

Protobuf type google.cloud.security.privateca.v1.PublicKey

PublicKey.Builder

A PublicKey describes a public key.

Protobuf type google.cloud.security.privateca.v1.PublicKey

RevokeCertificateRequest

Request message for CertificateAuthorityService.RevokeCertificate.

Protobuf type google.cloud.security.privateca.v1.RevokeCertificateRequest

RevokeCertificateRequest.Builder

Request message for CertificateAuthorityService.RevokeCertificate.

Protobuf type google.cloud.security.privateca.v1.RevokeCertificateRequest

Subject

Subject describes parts of a distinguished name that, in turn, describes the subject of the certificate.

Protobuf type google.cloud.security.privateca.v1.Subject

Subject.Builder

Subject describes parts of a distinguished name that, in turn, describes the subject of the certificate.

Protobuf type google.cloud.security.privateca.v1.Subject

SubjectAltNames

SubjectAltNames corresponds to a more modern way of listing what the asserted identity is in a certificate (i.e., compared to the "common name" in the distinguished name).

Protobuf type google.cloud.security.privateca.v1.SubjectAltNames

SubjectAltNames.Builder

SubjectAltNames corresponds to a more modern way of listing what the asserted identity is in a certificate (i.e., compared to the "common name" in the distinguished name).

Protobuf type google.cloud.security.privateca.v1.SubjectAltNames

SubordinateConfig

Describes a subordinate CA's issuers. This is either a resource name to a known issuing CertificateAuthority, or a PEM issuer certificate chain.

Protobuf type google.cloud.security.privateca.v1.SubordinateConfig

SubordinateConfig.Builder

Describes a subordinate CA's issuers. This is either a resource name to a known issuing CertificateAuthority, or a PEM issuer certificate chain.

Protobuf type google.cloud.security.privateca.v1.SubordinateConfig

SubordinateConfig.SubordinateConfigChain

This message describes a subordinate CA's issuer certificate chain. This wrapper exists for compatibility reasons.

Protobuf type google.cloud.security.privateca.v1.SubordinateConfig.SubordinateConfigChain

SubordinateConfig.SubordinateConfigChain.Builder

This message describes a subordinate CA's issuer certificate chain. This wrapper exists for compatibility reasons.

Protobuf type google.cloud.security.privateca.v1.SubordinateConfig.SubordinateConfigChain

UndeleteCertificateAuthorityRequest

Request message for CertificateAuthorityService.UndeleteCertificateAuthority.

Protobuf type google.cloud.security.privateca.v1.UndeleteCertificateAuthorityRequest

UndeleteCertificateAuthorityRequest.Builder

Request message for CertificateAuthorityService.UndeleteCertificateAuthority.

Protobuf type google.cloud.security.privateca.v1.UndeleteCertificateAuthorityRequest

UpdateCaPoolRequest

Request message for CertificateAuthorityService.UpdateCaPool.

Protobuf type google.cloud.security.privateca.v1.UpdateCaPoolRequest

UpdateCaPoolRequest.Builder

Request message for CertificateAuthorityService.UpdateCaPool.

Protobuf type google.cloud.security.privateca.v1.UpdateCaPoolRequest

UpdateCertificateAuthorityRequest

Request message for CertificateAuthorityService.UpdateCertificateAuthority.

Protobuf type google.cloud.security.privateca.v1.UpdateCertificateAuthorityRequest

UpdateCertificateAuthorityRequest.Builder

Request message for CertificateAuthorityService.UpdateCertificateAuthority.

Protobuf type google.cloud.security.privateca.v1.UpdateCertificateAuthorityRequest

UpdateCertificateRequest

Request message for CertificateAuthorityService.UpdateCertificate.

Protobuf type google.cloud.security.privateca.v1.UpdateCertificateRequest

UpdateCertificateRequest.Builder

Request message for CertificateAuthorityService.UpdateCertificate.

Protobuf type google.cloud.security.privateca.v1.UpdateCertificateRequest

UpdateCertificateRevocationListRequest

Request message for CertificateAuthorityService.UpdateCertificateRevocationList.

Protobuf type google.cloud.security.privateca.v1.UpdateCertificateRevocationListRequest

UpdateCertificateRevocationListRequest.Builder

Request message for CertificateAuthorityService.UpdateCertificateRevocationList.

Protobuf type google.cloud.security.privateca.v1.UpdateCertificateRevocationListRequest

UpdateCertificateTemplateRequest

Request message for CertificateAuthorityService.UpdateCertificateTemplate.

Protobuf type google.cloud.security.privateca.v1.UpdateCertificateTemplateRequest

UpdateCertificateTemplateRequest.Builder

Request message for CertificateAuthorityService.UpdateCertificateTemplate.

Protobuf type google.cloud.security.privateca.v1.UpdateCertificateTemplateRequest

X509Extension

An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs.

Protobuf type google.cloud.security.privateca.v1.X509Extension

X509Extension.Builder

An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs.

Protobuf type google.cloud.security.privateca.v1.X509Extension

X509Parameters

An X509Parameters is used to describe certain fields of an X.509 certificate, such as the key usage fields, fields specific to CA certificates, certificate policy extensions and custom extensions.

Protobuf type google.cloud.security.privateca.v1.X509Parameters

X509Parameters.Builder

An X509Parameters is used to describe certain fields of an X.509 certificate, such as the key usage fields, fields specific to CA certificates, certificate policy extensions and custom extensions.

Protobuf type google.cloud.security.privateca.v1.X509Parameters

X509Parameters.CaOptions

Describes values that are relevant in a CA certificate.

Protobuf type google.cloud.security.privateca.v1.X509Parameters.CaOptions

X509Parameters.CaOptions.Builder

Describes values that are relevant in a CA certificate.

Protobuf type google.cloud.security.privateca.v1.X509Parameters.CaOptions

X509Parameters.NameConstraints

Describes the X.509 name constraints extension, per https://tools.ietf.org/html/rfc5280#section-4.2.1.10

Protobuf type google.cloud.security.privateca.v1.X509Parameters.NameConstraints

X509Parameters.NameConstraints.Builder

Describes the X.509 name constraints extension, per https://tools.ietf.org/html/rfc5280#section-4.2.1.10

Protobuf type google.cloud.security.privateca.v1.X509Parameters.NameConstraints

Interfaces

ActivateCertificateAuthorityRequestOrBuilder

CaPool.IssuancePolicy.AllowedKeyType.EcKeyTypeOrBuilder

CaPool.IssuancePolicy.AllowedKeyType.RsaKeyTypeOrBuilder

CaPool.IssuancePolicy.AllowedKeyTypeOrBuilder

CaPool.IssuancePolicy.IssuanceModesOrBuilder

CaPool.IssuancePolicyOrBuilder

CaPool.PublishingOptionsOrBuilder

CaPoolOrBuilder

Certificate.RevocationDetailsOrBuilder

CertificateAuthority.AccessUrlsOrBuilder

CertificateAuthority.KeyVersionSpecOrBuilder

CertificateAuthorityOrBuilder

CertificateAuthorityServiceGrpc.AsyncService

Certificate Authority Service manages private certificate authorities and issued certificates.

CertificateConfig.SubjectConfigOrBuilder

CertificateConfigOrBuilder

CertificateDescription.CertificateFingerprintOrBuilder

CertificateDescription.KeyIdOrBuilder

CertificateDescription.SubjectDescriptionOrBuilder

CertificateDescriptionOrBuilder

CertificateExtensionConstraintsOrBuilder

CertificateIdentityConstraintsOrBuilder

CertificateOrBuilder

CertificateRevocationList.RevokedCertificateOrBuilder

CertificateRevocationListOrBuilder

CertificateTemplateOrBuilder

CreateCaPoolRequestOrBuilder

CreateCertificateAuthorityRequestOrBuilder

CreateCertificateRequestOrBuilder

CreateCertificateTemplateRequestOrBuilder

DeleteCaPoolRequestOrBuilder

DeleteCertificateAuthorityRequestOrBuilder

DeleteCertificateTemplateRequestOrBuilder

DisableCertificateAuthorityRequestOrBuilder

EnableCertificateAuthorityRequestOrBuilder

FetchCaCertsRequestOrBuilder

FetchCaCertsResponse.CertChainOrBuilder

FetchCaCertsResponseOrBuilder

FetchCertificateAuthorityCsrRequestOrBuilder

FetchCertificateAuthorityCsrResponseOrBuilder

GetCaPoolRequestOrBuilder

GetCertificateAuthorityRequestOrBuilder

GetCertificateRequestOrBuilder

GetCertificateRevocationListRequestOrBuilder

GetCertificateTemplateRequestOrBuilder

KeyUsage.ExtendedKeyUsageOptionsOrBuilder

KeyUsage.KeyUsageOptionsOrBuilder

KeyUsageOrBuilder

ListCaPoolsRequestOrBuilder

ListCaPoolsResponseOrBuilder

ListCertificateAuthoritiesRequestOrBuilder

ListCertificateAuthoritiesResponseOrBuilder

ListCertificateRevocationListsRequestOrBuilder

ListCertificateRevocationListsResponseOrBuilder

ListCertificateTemplatesRequestOrBuilder

ListCertificateTemplatesResponseOrBuilder

ListCertificatesRequestOrBuilder

ListCertificatesResponseOrBuilder

ObjectIdOrBuilder

OperationMetadataOrBuilder

PublicKeyOrBuilder

RevokeCertificateRequestOrBuilder

SubjectAltNamesOrBuilder

SubjectOrBuilder

SubordinateConfig.SubordinateConfigChainOrBuilder

SubordinateConfigOrBuilder

UndeleteCertificateAuthorityRequestOrBuilder

UpdateCaPoolRequestOrBuilder

UpdateCertificateAuthorityRequestOrBuilder

UpdateCertificateRequestOrBuilder

UpdateCertificateRevocationListRequestOrBuilder

UpdateCertificateTemplateRequestOrBuilder

X509ExtensionOrBuilder

X509Parameters.CaOptionsOrBuilder

X509Parameters.NameConstraintsOrBuilder

X509ParametersOrBuilder

Enums

CaPool.IssuancePolicy.AllowedKeyType.EcKeyType.EcSignatureAlgorithm

Describes an elliptic curve-based signature algorithm that may be used in a Certificate issued from a CaPool.

Protobuf enum google.cloud.security.privateca.v1.CaPool.IssuancePolicy.AllowedKeyType.EcKeyType.EcSignatureAlgorithm

CaPool.IssuancePolicy.AllowedKeyType.KeyTypeCase

CaPool.Tier

The tier of a CaPool, indicating its supported functionality and/or billing SKU.

Protobuf enum google.cloud.security.privateca.v1.CaPool.Tier

Certificate.CertificateConfigCase

CertificateAuthority.KeyVersionSpec.KeyVersionCase

CertificateAuthority.SignHashAlgorithm

The algorithm of a Cloud KMS CryptoKeyVersion of a CryptoKey with the CryptoKeyPurpose value ASYMMETRIC_SIGN. These values correspond to the CryptoKeyVersionAlgorithm values. For RSA signing algorithms, the PSS algorithms should be preferred, use PKCS1 algorithms if required for compatibility. For further recommendations, see https://cloud.google.com/kms/docs/algorithms#algorithm_recommendations.

Protobuf enum google.cloud.security.privateca.v1.CertificateAuthority.SignHashAlgorithm

CertificateAuthority.State

The state of a CertificateAuthority, indicating if it can be used.

Protobuf enum google.cloud.security.privateca.v1.CertificateAuthority.State

CertificateAuthority.Type

The type of a CertificateAuthority, indicating its issuing chain.

Protobuf enum google.cloud.security.privateca.v1.CertificateAuthority.Type

CertificateExtensionConstraints.KnownCertificateExtension

Describes well-known X.509 extensions that can appear in a Certificate, not including the SubjectAltNames extension.

Protobuf enum google.cloud.security.privateca.v1.CertificateExtensionConstraints.KnownCertificateExtension

CertificateRevocationList.State

The state of a CertificateRevocationList, indicating if it is current.

Protobuf enum google.cloud.security.privateca.v1.CertificateRevocationList.State

PublicKey.KeyFormat

Types of public keys formats that are supported. Currently, only PEM format is supported.

Protobuf enum google.cloud.security.privateca.v1.PublicKey.KeyFormat

RevocationReason

A RevocationReason indicates whether a Certificate has been revoked, and the reason for revocation. These correspond to standard revocation reasons from RFC 5280. Note that the enum labels and values in this definition are not the same ASN.1 values defined in RFC 5280. These values will be translated to the correct ASN.1 values when a CRL is created.

Protobuf enum google.cloud.security.privateca.v1.RevocationReason

SubjectRequestMode

Describes the way in which a Certificate's Subject and/or SubjectAltNames will be resolved.

Protobuf enum google.cloud.security.privateca.v1.SubjectRequestMode