Package com.google.cloud.security.privateca.v1beta1 (2.13.0)

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()) {
   CertificateAuthorityName parent =
       CertificateAuthorityName.of("[PROJECT]", "[LOCATION]", "[CERTIFICATE_AUTHORITY]");
   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.v1beta1.ActivateCertificateAuthorityRequest

ActivateCertificateAuthorityRequest.Builder

Request message for CertificateAuthorityService.ActivateCertificateAuthority.

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

Certificate

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

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

Certificate.Builder

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

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

Certificate.RevocationDetails

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

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

Certificate.RevocationDetails.Builder

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

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

CertificateAuthority

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

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

CertificateAuthority.AccessUrls

URLs where a CertificateAuthority will publish content.

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

CertificateAuthority.AccessUrls.Builder

URLs where a CertificateAuthority will publish content.

Protobuf type google.cloud.security.privateca.v1beta1.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.v1beta1.CertificateAuthority

CertificateAuthority.CertificateAuthorityPolicy

The issuing policy for a CertificateAuthority. Certificates will not be successfully issued from this CertificateAuthority if they violate the policy.

Protobuf type google.cloud.security.privateca.v1beta1.CertificateAuthority.CertificateAuthorityPolicy

CertificateAuthority.CertificateAuthorityPolicy.AllowedConfigList

Protobuf type google.cloud.security.privateca.v1beta1.CertificateAuthority.CertificateAuthorityPolicy.AllowedConfigList

CertificateAuthority.CertificateAuthorityPolicy.AllowedConfigList.Builder

Protobuf type google.cloud.security.privateca.v1beta1.CertificateAuthority.CertificateAuthorityPolicy.AllowedConfigList

CertificateAuthority.CertificateAuthorityPolicy.AllowedSubjectAltNames

AllowedSubjectAltNames specifies the allowed values for SubjectAltNames by the CertificateAuthority when issuing Certificates.

Protobuf type google.cloud.security.privateca.v1beta1.CertificateAuthority.CertificateAuthorityPolicy.AllowedSubjectAltNames

CertificateAuthority.CertificateAuthorityPolicy.AllowedSubjectAltNames.Builder

AllowedSubjectAltNames specifies the allowed values for SubjectAltNames by the CertificateAuthority when issuing Certificates.

Protobuf type google.cloud.security.privateca.v1beta1.CertificateAuthority.CertificateAuthorityPolicy.AllowedSubjectAltNames

CertificateAuthority.CertificateAuthorityPolicy.Builder

The issuing policy for a CertificateAuthority. Certificates will not be successfully issued from this CertificateAuthority if they violate the policy.

Protobuf type google.cloud.security.privateca.v1beta1.CertificateAuthority.CertificateAuthorityPolicy

CertificateAuthority.CertificateAuthorityPolicy.IssuanceModes

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

Protobuf type google.cloud.security.privateca.v1beta1.CertificateAuthority.CertificateAuthorityPolicy.IssuanceModes

CertificateAuthority.CertificateAuthorityPolicy.IssuanceModes.Builder

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

Protobuf type google.cloud.security.privateca.v1beta1.CertificateAuthority.CertificateAuthorityPolicy.IssuanceModes

CertificateAuthority.IssuingOptions

Options that affect all certificates issued by a CertificateAuthority.

Protobuf type google.cloud.security.privateca.v1beta1.CertificateAuthority.IssuingOptions

CertificateAuthority.IssuingOptions.Builder

Options that affect all certificates issued by a CertificateAuthority.

Protobuf type google.cloud.security.privateca.v1beta1.CertificateAuthority.IssuingOptions

CertificateAuthority.KeyVersionSpec

A Cloud KMS key configuration that a CertificateAuthority will use.

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

CertificateAuthority.KeyVersionSpec.Builder

A Cloud KMS key configuration that a CertificateAuthority will use.

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

CertificateAuthorityName.Builder

Builder for projects/{project}/locations/{location}/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()) {
   CertificateAuthorityName parent =
       CertificateAuthorityName.of("[PROJECT]", "[LOCATION]", "[CERTIFICATE_AUTHORITY]");
   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.ListCertificateAuthoritiesFixedSizeCollection

CertificateAuthorityServiceClient.ListCertificateAuthoritiesPage

CertificateAuthorityServiceClient.ListCertificateAuthoritiesPagedResponse

CertificateAuthorityServiceClient.ListCertificateRevocationListsFixedSizeCollection

CertificateAuthorityServiceClient.ListCertificateRevocationListsPage

CertificateAuthorityServiceClient.ListCertificateRevocationListsPagedResponse

CertificateAuthorityServiceClient.ListCertificatesFixedSizeCollection

CertificateAuthorityServiceClient.ListCertificatesPage

CertificateAuthorityServiceClient.ListCertificatesPagedResponse