Package com.google.cloud.security.publicca.v1beta1 (0.4.0)

A client to Public Certificate Authority API

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

PublicCertificateAuthorityServiceClient

Service Description: Manages the resources required for ACME external account binding for the public certificate authority service.

Sample for PublicCertificateAuthorityServiceClient:


 // 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 (PublicCertificateAuthorityServiceClient publicCertificateAuthorityServiceClient =
     PublicCertificateAuthorityServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   ExternalAccountKey externalAccountKey = ExternalAccountKey.newBuilder().build();
   ExternalAccountKey response =
       publicCertificateAuthorityServiceClient.createExternalAccountKey(
           parent, externalAccountKey);
 }

Classes

CreateExternalAccountKeyRequest

Creates a new ExternalAccountKey in a given project.

Protobuf type google.cloud.security.publicca.v1beta1.CreateExternalAccountKeyRequest

CreateExternalAccountKeyRequest.Builder

Creates a new ExternalAccountKey in a given project.

Protobuf type google.cloud.security.publicca.v1beta1.CreateExternalAccountKeyRequest

ExternalAccountKey

A representation of an ExternalAccountKey used for external account binding within ACME.

Protobuf type google.cloud.security.publicca.v1beta1.ExternalAccountKey

ExternalAccountKey.Builder

A representation of an ExternalAccountKey used for external account binding within ACME.

Protobuf type google.cloud.security.publicca.v1beta1.ExternalAccountKey

ExternalAccountKeyName

ExternalAccountKeyName.Builder

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

LocationName

LocationName.Builder

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

PublicCertificateAuthorityServiceClient

Service Description: Manages the resources required for ACME external account binding for the public certificate authority service.

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 (PublicCertificateAuthorityServiceClient publicCertificateAuthorityServiceClient =
     PublicCertificateAuthorityServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   ExternalAccountKey externalAccountKey = ExternalAccountKey.newBuilder().build();
   ExternalAccountKey response =
       publicCertificateAuthorityServiceClient.createExternalAccountKey(
           parent, externalAccountKey);
 }

Note: close() needs to be called on the PublicCertificateAuthorityServiceClient 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:

  1. 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.
  2. 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.
  3. 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 PublicCertificateAuthorityServiceSettings 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
 PublicCertificateAuthorityServiceSettings publicCertificateAuthorityServiceSettings =
     PublicCertificateAuthorityServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 PublicCertificateAuthorityServiceClient publicCertificateAuthorityServiceClient =
     PublicCertificateAuthorityServiceClient.create(publicCertificateAuthorityServiceSettings);

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
 PublicCertificateAuthorityServiceSettings publicCertificateAuthorityServiceSettings =
     PublicCertificateAuthorityServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 PublicCertificateAuthorityServiceClient publicCertificateAuthorityServiceClient =
     PublicCertificateAuthorityServiceClient.create(publicCertificateAuthorityServiceSettings);

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
 PublicCertificateAuthorityServiceSettings publicCertificateAuthorityServiceSettings =
     PublicCertificateAuthorityServiceSettings.newHttpJsonBuilder().build();
 PublicCertificateAuthorityServiceClient publicCertificateAuthorityServiceClient =
     PublicCertificateAuthorityServiceClient.create(publicCertificateAuthorityServiceSettings);

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

PublicCertificateAuthorityServiceGrpc

Manages the resources required for ACME external account binding for the public certificate authority service.

PublicCertificateAuthorityServiceGrpc.PublicCertificateAuthorityServiceBlockingStub

Manages the resources required for ACME external account binding for the public certificate authority service.

PublicCertificateAuthorityServiceGrpc.PublicCertificateAuthorityServiceFutureStub

Manages the resources required for ACME external account binding for the public certificate authority service.

PublicCertificateAuthorityServiceGrpc.PublicCertificateAuthorityServiceImplBase

Manages the resources required for ACME external account binding for the public certificate authority service.

PublicCertificateAuthorityServiceGrpc.PublicCertificateAuthorityServiceStub

Manages the resources required for ACME external account binding for the public certificate authority service.

PublicCertificateAuthorityServiceSettings

Settings class to configure an instance of PublicCertificateAuthorityServiceClient.

The default instance has everything set to sensible defaults:

  • The default service address (publicca.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 createExternalAccountKey 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
 PublicCertificateAuthorityServiceSettings.Builder
     publicCertificateAuthorityServiceSettingsBuilder =
         PublicCertificateAuthorityServiceSettings.newBuilder();
 publicCertificateAuthorityServiceSettingsBuilder
     .createExternalAccountKeySettings()
     .setRetrySettings(
         publicCertificateAuthorityServiceSettingsBuilder
             .createExternalAccountKeySettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 PublicCertificateAuthorityServiceSettings publicCertificateAuthorityServiceSettings =
     publicCertificateAuthorityServiceSettingsBuilder.build();

PublicCertificateAuthorityServiceSettings.Builder

Builder for PublicCertificateAuthorityServiceSettings.

ResourcesProto

ServiceProto

Interfaces

CreateExternalAccountKeyRequestOrBuilder

ExternalAccountKeyOrBuilder