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

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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 CertificateAuthorityServiceSettings certificateAuthorityServiceSettings =
     CertificateAuthorityServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 CertificateAuthorityServiceClient certificateAuthorityServiceClient =
     CertificateAuthorityServiceClient.create(certificateAuthorityServiceSettings);

To customize the endpoint:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 CertificateAuthorityServiceSettings certificateAuthorityServiceSettings =
     CertificateAuthorityServiceSettings.newBuilder()
         .setTransportChannelProvider(
             CertificateAuthorityServiceSettings.defaultHttpJsonTransportProviderBuilder()
                 .build())
         .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