Class PublicCertificateAuthorityServiceClient (0.27.0)

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:

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 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.

Inheritance

java.lang.Object > PublicCertificateAuthorityServiceClient

Static Methods

create()

public static final PublicCertificateAuthorityServiceClient create()

Constructs an instance of PublicCertificateAuthorityServiceClient with default settings.

Returns
Type	Description
`PublicCertificateAuthorityServiceClient`

Exceptions
Type	Description
`IOException`

create(PublicCertificateAuthorityServiceSettings settings)

public static final PublicCertificateAuthorityServiceClient create(PublicCertificateAuthorityServiceSettings settings)

Constructs an instance of PublicCertificateAuthorityServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Parameter
Name	Description
`settings`	`PublicCertificateAuthorityServiceSettings`

Returns
Type	Description
`PublicCertificateAuthorityServiceClient`

Exceptions
Type	Description
`IOException`

create(PublicCertificateAuthorityServiceStub stub)

public static final PublicCertificateAuthorityServiceClient create(PublicCertificateAuthorityServiceStub stub)

Constructs an instance of PublicCertificateAuthorityServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(PublicCertificateAuthorityServiceSettings).

Parameter
Name	Description
`stub`	`PublicCertificateAuthorityServiceStub`

Returns
Type	Description
`PublicCertificateAuthorityServiceClient`

Constructors

PublicCertificateAuthorityServiceClient(PublicCertificateAuthorityServiceSettings settings)

protected PublicCertificateAuthorityServiceClient(PublicCertificateAuthorityServiceSettings settings)

Constructs an instance of PublicCertificateAuthorityServiceClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Parameter
Name	Description
`settings`	`PublicCertificateAuthorityServiceSettings`

PublicCertificateAuthorityServiceClient(PublicCertificateAuthorityServiceStub stub)

protected PublicCertificateAuthorityServiceClient(PublicCertificateAuthorityServiceStub stub)

Parameter
Name	Description
`stub`	`PublicCertificateAuthorityServiceStub`

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)

Parameters
Name	Description
`duration`	`long`
`unit`	`TimeUnit`

Returns
Type	Description
`boolean`

Exceptions
Type	Description
`InterruptedException`

close()

public final void close()

createExternalAccountKey(CreateExternalAccountKeyRequest request)

public final ExternalAccountKey createExternalAccountKey(CreateExternalAccountKeyRequest request)

Creates a new ExternalAccountKey bound to the project.

Sample code:


 // 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()) {
   CreateExternalAccountKeyRequest request =
       CreateExternalAccountKeyRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setExternalAccountKey(ExternalAccountKey.newBuilder().build())
           .build();
   ExternalAccountKey response =
       publicCertificateAuthorityServiceClient.createExternalAccountKey(request);
 }

Parameter
Name	Description
`request`	`CreateExternalAccountKeyRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`ExternalAccountKey`

createExternalAccountKey(LocationName parent, ExternalAccountKey externalAccountKey)

public final ExternalAccountKey createExternalAccountKey(LocationName parent, ExternalAccountKey externalAccountKey)

Creates a new ExternalAccountKey bound to the project.

Sample code:


 // 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);
 }

Parameters
Name	Description
`parent`	`LocationName` Required. The parent resource where this external_account_key will be created. Format: projects/[project_id]/locations/[location]. At present only the "global" location is supported.
`externalAccountKey`	`ExternalAccountKey` Required. The external account key to create. This field only exists to future-proof the API. At present, all fields in ExternalAccountKey are output only and all values are ignored. For the purpose of the CreateExternalAccountKeyRequest, set it to a default/empty value.

Returns
Type	Description
`ExternalAccountKey`

createExternalAccountKey(String parent, ExternalAccountKey externalAccountKey)

public final ExternalAccountKey createExternalAccountKey(String parent, ExternalAccountKey externalAccountKey)

Creates a new ExternalAccountKey bound to the project.

Sample code:


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

Parameters
Name	Description
`parent`	`String` Required. The parent resource where this external_account_key will be created. Format: projects/[project_id]/locations/[location]. At present only the "global" location is supported.
`externalAccountKey`	`ExternalAccountKey` Required. The external account key to create. This field only exists to future-proof the API. At present, all fields in ExternalAccountKey are output only and all values are ignored. For the purpose of the CreateExternalAccountKeyRequest, set it to a default/empty value.

Returns
Type	Description
`ExternalAccountKey`

createExternalAccountKeyCallable()

public final UnaryCallable<CreateExternalAccountKeyRequest,ExternalAccountKey> createExternalAccountKeyCallable()

Creates a new ExternalAccountKey bound to the project.

Sample code:


 // 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()) {
   CreateExternalAccountKeyRequest request =
       CreateExternalAccountKeyRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setExternalAccountKey(ExternalAccountKey.newBuilder().build())
           .build();
   ApiFuture<ExternalAccountKey> future =
       publicCertificateAuthorityServiceClient
           .createExternalAccountKeyCallable()
           .futureCall(request);
   // Do something.
   ExternalAccountKey response = future.get();
 }

Returns
Type	Description
`UnaryCallable<CreateExternalAccountKeyRequest,ExternalAccountKey>`

getSettings()

public final PublicCertificateAuthorityServiceSettings getSettings()

Returns
Type	Description
`PublicCertificateAuthorityServiceSettings`

getStub()

public PublicCertificateAuthorityServiceStub getStub()

Returns
Type	Description
`PublicCertificateAuthorityServiceStub`

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
Type	Description
`boolean`

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()