com.google.cloud.security.publicca.v1beta1

Class PublicCertificateAuthorityServiceClient

java.lang.Object

com.google.cloud.security.publicca.v1beta1.PublicCertificateAuthorityServiceClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable

@BetaApi
 @Generated(value="by gapic-generator-java")
public class PublicCertificateAuthorityServiceClient
extends Object
implements com.google.api.gax.core.BackgroundResource

Service Description: Manages the resources required for ACME [external account binding](https://tools.ietf.org/html/rfc8555#section-7.3.4) 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().

Methods

Method	Description	Method Variants
CreateExternalAccountKey	Creates a new [ExternalAccountKey][google.cloud.security.publicca.v1beta1.ExternalAccountKey] bound to the project.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createExternalAccountKey(CreateExternalAccountKeyRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. createExternalAccountKey(LocationName parent, ExternalAccountKey externalAccountKey) createExternalAccountKey(String parent, ExternalAccountKey externalAccountKey) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createExternalAccountKeyCallable()

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.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PublicCertificateAuthorityServiceClient(PublicCertificateAuthorityServiceSettings settings) Constructs an instance of PublicCertificateAuthorityServiceClient, using the given settings.
protected	PublicCertificateAuthorityServiceClient(PublicCertificateAuthorityServiceStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static PublicCertificateAuthorityServiceClient	create() Constructs an instance of PublicCertificateAuthorityServiceClient with default settings.
static PublicCertificateAuthorityServiceClient	create(PublicCertificateAuthorityServiceSettings settings) Constructs an instance of PublicCertificateAuthorityServiceClient, using the given settings.
static PublicCertificateAuthorityServiceClient	create(PublicCertificateAuthorityServiceStub stub) Constructs an instance of PublicCertificateAuthorityServiceClient, using the given stub for making calls.
ExternalAccountKey	createExternalAccountKey(CreateExternalAccountKeyRequest request) Creates a new [ExternalAccountKey][google.cloud.security.publicca.v1beta1.ExternalAccountKey] bound to the project.
ExternalAccountKey	createExternalAccountKey(LocationName parent, ExternalAccountKey externalAccountKey) Creates a new [ExternalAccountKey][google.cloud.security.publicca.v1beta1.ExternalAccountKey] bound to the project.
ExternalAccountKey	createExternalAccountKey(String parent, ExternalAccountKey externalAccountKey) Creates a new [ExternalAccountKey][google.cloud.security.publicca.v1beta1.ExternalAccountKey] bound to the project.
com.google.api.gax.rpc.UnaryCallable<CreateExternalAccountKeyRequest,ExternalAccountKey>	createExternalAccountKeyCallable() Creates a new [ExternalAccountKey][google.cloud.security.publicca.v1beta1.ExternalAccountKey] bound to the project.
PublicCertificateAuthorityServiceSettings	getSettings()
PublicCertificateAuthorityServiceStub	getStub()
boolean	isShutdown()
boolean	isTerminated()
void	shutdown()
void	shutdownNow()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PublicCertificateAuthorityServiceClient

protected PublicCertificateAuthorityServiceClient(PublicCertificateAuthorityServiceSettings settings)
                                           throws IOException

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.

Throws:

IOException

PublicCertificateAuthorityServiceClient

protected PublicCertificateAuthorityServiceClient(PublicCertificateAuthorityServiceStub stub)

Method Detail

create

public static final PublicCertificateAuthorityServiceClient create()
                                                            throws IOException

Constructs an instance of PublicCertificateAuthorityServiceClient with default settings.

Throws:

IOException

create

public static final PublicCertificateAuthorityServiceClient create(PublicCertificateAuthorityServiceSettings settings)
                                                            throws IOException

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.

Throws:

IOException

create

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

getSettings

public final PublicCertificateAuthorityServiceSettings getSettings()

getStub

public PublicCertificateAuthorityServiceStub getStub()

createExternalAccountKey

public final ExternalAccountKey createExternalAccountKey(LocationName parent,
                                                         ExternalAccountKey externalAccountKey)

Creates a new [ExternalAccountKey][google.cloud.security.publicca.v1beta1.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:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createExternalAccountKey

public final ExternalAccountKey createExternalAccountKey(String parent,
                                                         ExternalAccountKey externalAccountKey)

Creates a new [ExternalAccountKey][google.cloud.security.publicca.v1beta1.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:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createExternalAccountKey

public final ExternalAccountKey createExternalAccountKey(CreateExternalAccountKeyRequest request)

Creates a new [ExternalAccountKey][google.cloud.security.publicca.v1beta1.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);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createExternalAccountKeyCallable

public final com.google.api.gax.rpc.UnaryCallable<CreateExternalAccountKeyRequest,ExternalAccountKey> createExternalAccountKeyCallable()

Creates a new [ExternalAccountKey][google.cloud.security.publicca.v1beta1.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();
 }
 

close

public final void close()

Specified by:

close in interface AutoCloseable

shutdown

public void shutdown()

Specified by:

shutdown in interface com.google.api.gax.core.BackgroundResource

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface com.google.api.gax.core.BackgroundResource

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface com.google.api.gax.core.BackgroundResource

shutdownNow

public void shutdownNow()

Specified by:

shutdownNow in interface com.google.api.gax.core.BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:

awaitTermination in interface com.google.api.gax.core.BackgroundResource

Throws:

InterruptedException