Class AuthorizedCertificatesClient (2.4.0)

public class AuthorizedCertificatesClient implements BackgroundResource

Service Description: Manages SSL certificates a user is authorized to administer. A user can administer any SSL certificates applicable to their authorized domains.

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 (AuthorizedCertificatesClient authorizedCertificatesClient =
     AuthorizedCertificatesClient.create()) {
   GetAuthorizedCertificateRequest request =
       GetAuthorizedCertificateRequest.newBuilder()
           .setName("name3373707")
           .setView(AuthorizedCertificateView.forNumber(0))
           .build();
   AuthorizedCertificate response =
       authorizedCertificatesClient.getAuthorizedCertificate(request);
 }

Note: close() needs to be called on the AuthorizedCertificatesClient 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 AuthorizedCertificatesSettings 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
 AuthorizedCertificatesSettings authorizedCertificatesSettings =
     AuthorizedCertificatesSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 AuthorizedCertificatesClient authorizedCertificatesClient =
     AuthorizedCertificatesClient.create(authorizedCertificatesSettings);

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
 AuthorizedCertificatesSettings authorizedCertificatesSettings =
     AuthorizedCertificatesSettings.newBuilder().setEndpoint(myEndpoint).build();
 AuthorizedCertificatesClient authorizedCertificatesClient =
     AuthorizedCertificatesClient.create(authorizedCertificatesSettings);

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
 AuthorizedCertificatesSettings authorizedCertificatesSettings =
     AuthorizedCertificatesSettings.newBuilder()
         .setTransportChannelProvider(
             AuthorizedCertificatesSettings.defaultHttpJsonTransportProviderBuilder().build())
         .build();
 AuthorizedCertificatesClient authorizedCertificatesClient =
     AuthorizedCertificatesClient.create(authorizedCertificatesSettings);

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

Inheritance

java.lang.Object > AuthorizedCertificatesClient

Implements

BackgroundResource

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create()

public static final AuthorizedCertificatesClient create()

Constructs an instance of AuthorizedCertificatesClient with default settings.

Returns

Type	Description
AuthorizedCertificatesClient

Exceptions

Type	Description
IOException

create(AuthorizedCertificatesSettings settings)

public static final AuthorizedCertificatesClient create(AuthorizedCertificatesSettings settings)

Constructs an instance of AuthorizedCertificatesClient, 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	`AuthorizedCertificatesSettings`

Returns

Type	Description
AuthorizedCertificatesClient

Exceptions

Type	Description
IOException

create(AuthorizedCertificatesStub stub)

public static final AuthorizedCertificatesClient create(AuthorizedCertificatesStub stub)

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

Parameter

Name	Description
stub	`AuthorizedCertificatesStub`

Returns

Type	Description
AuthorizedCertificatesClient

Constructors

AuthorizedCertificatesClient(AuthorizedCertificatesSettings settings)

protected AuthorizedCertificatesClient(AuthorizedCertificatesSettings settings)

Constructs an instance of AuthorizedCertificatesClient, 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	`AuthorizedCertificatesSettings`

AuthorizedCertificatesClient(AuthorizedCertificatesStub stub)

protected AuthorizedCertificatesClient(AuthorizedCertificatesStub stub)

Parameter

Name	Description
stub	`AuthorizedCertificatesStub`

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

createAuthorizedCertificate(CreateAuthorizedCertificateRequest request)

public final AuthorizedCertificate createAuthorizedCertificate(CreateAuthorizedCertificateRequest request)

Uploads the specified SSL certificate.

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 (AuthorizedCertificatesClient authorizedCertificatesClient =
     AuthorizedCertificatesClient.create()) {
   CreateAuthorizedCertificateRequest request =
       CreateAuthorizedCertificateRequest.newBuilder()
           .setParent("parent-995424086")
           .setCertificate(AuthorizedCertificate.newBuilder().build())
           .build();
   AuthorizedCertificate response =
       authorizedCertificatesClient.createAuthorizedCertificate(request);
 }

Parameter

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

Returns

Type	Description
AuthorizedCertificate

createAuthorizedCertificateCallable()

public final UnaryCallable<CreateAuthorizedCertificateRequest,AuthorizedCertificate> createAuthorizedCertificateCallable()

Uploads the specified SSL certificate.

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 (AuthorizedCertificatesClient authorizedCertificatesClient =
     AuthorizedCertificatesClient.create()) {
   CreateAuthorizedCertificateRequest request =
       CreateAuthorizedCertificateRequest.newBuilder()
           .setParent("parent-995424086")
           .setCertificate(AuthorizedCertificate.newBuilder().build())
           .build();
   ApiFuture<AuthorizedCertificate> future =
       authorizedCertificatesClient.createAuthorizedCertificateCallable().futureCall(request);
   // Do something.
   AuthorizedCertificate response = future.get();
 }

Returns

Type	Description
UnaryCallable<CreateAuthorizedCertificateRequest,AuthorizedCertificate>

deleteAuthorizedCertificate(DeleteAuthorizedCertificateRequest request)

public final void deleteAuthorizedCertificate(DeleteAuthorizedCertificateRequest request)

Deletes the specified SSL certificate.

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 (AuthorizedCertificatesClient authorizedCertificatesClient =
     AuthorizedCertificatesClient.create()) {
   DeleteAuthorizedCertificateRequest request =
       DeleteAuthorizedCertificateRequest.newBuilder().setName("name3373707").build();
   authorizedCertificatesClient.deleteAuthorizedCertificate(request);
 }

Parameter

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

deleteAuthorizedCertificateCallable()

public final UnaryCallable<DeleteAuthorizedCertificateRequest,Empty> deleteAuthorizedCertificateCallable()

Deletes the specified SSL certificate.

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 (AuthorizedCertificatesClient authorizedCertificatesClient =
     AuthorizedCertificatesClient.create()) {
   DeleteAuthorizedCertificateRequest request =
       DeleteAuthorizedCertificateRequest.newBuilder().setName("name3373707").build();
   ApiFuture<Empty> future =
       authorizedCertificatesClient.deleteAuthorizedCertificateCallable().futureCall(request);
   // Do something.
   future.get();
 }

Returns

Type	Description
UnaryCallable<DeleteAuthorizedCertificateRequest,Empty>

getAuthorizedCertificate(GetAuthorizedCertificateRequest request)

public final AuthorizedCertificate getAuthorizedCertificate(GetAuthorizedCertificateRequest request)

Gets the specified SSL certificate.

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 (AuthorizedCertificatesClient authorizedCertificatesClient =
     AuthorizedCertificatesClient.create()) {
   GetAuthorizedCertificateRequest request =
       GetAuthorizedCertificateRequest.newBuilder()
           .setName("name3373707")
           .setView(AuthorizedCertificateView.forNumber(0))
           .build();
   AuthorizedCertificate response =
       authorizedCertificatesClient.getAuthorizedCertificate(request);
 }

Parameter

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

Returns

Type	Description
AuthorizedCertificate

getAuthorizedCertificateCallable()

public final UnaryCallable<GetAuthorizedCertificateRequest,AuthorizedCertificate> getAuthorizedCertificateCallable()

Gets the specified SSL certificate.

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 (AuthorizedCertificatesClient authorizedCertificatesClient =
     AuthorizedCertificatesClient.create()) {
   GetAuthorizedCertificateRequest request =
       GetAuthorizedCertificateRequest.newBuilder()
           .setName("name3373707")
           .setView(AuthorizedCertificateView.forNumber(0))
           .build();
   ApiFuture<AuthorizedCertificate> future =
       authorizedCertificatesClient.getAuthorizedCertificateCallable().futureCall(request);
   // Do something.
   AuthorizedCertificate response = future.get();
 }

Returns

Type	Description
UnaryCallable<GetAuthorizedCertificateRequest,AuthorizedCertificate>

getSettings()

public final AuthorizedCertificatesSettings getSettings()

Returns

Type	Description
AuthorizedCertificatesSettings

getStub()

public AuthorizedCertificatesStub getStub()

Returns

Type	Description
AuthorizedCertificatesStub

isShutdown()

public boolean isShutdown()

Returns

Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns

Type	Description
boolean

listAuthorizedCertificates(ListAuthorizedCertificatesRequest request)

public final AuthorizedCertificatesClient.ListAuthorizedCertificatesPagedResponse listAuthorizedCertificates(ListAuthorizedCertificatesRequest request)

Lists all SSL certificates the user is authorized to administer.

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 (AuthorizedCertificatesClient authorizedCertificatesClient =
     AuthorizedCertificatesClient.create()) {
   ListAuthorizedCertificatesRequest request =
       ListAuthorizedCertificatesRequest.newBuilder()
           .setParent("parent-995424086")
           .setView(AuthorizedCertificateView.forNumber(0))
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (AuthorizedCertificate element :
       authorizedCertificatesClient.listAuthorizedCertificates(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

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

Returns

Type	Description
AuthorizedCertificatesClient.ListAuthorizedCertificatesPagedResponse

listAuthorizedCertificatesCallable()

public final UnaryCallable<ListAuthorizedCertificatesRequest,ListAuthorizedCertificatesResponse> listAuthorizedCertificatesCallable()

Lists all SSL certificates the user is authorized to administer.

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 (AuthorizedCertificatesClient authorizedCertificatesClient =
     AuthorizedCertificatesClient.create()) {
   ListAuthorizedCertificatesRequest request =
       ListAuthorizedCertificatesRequest.newBuilder()
           .setParent("parent-995424086")
           .setView(AuthorizedCertificateView.forNumber(0))
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListAuthorizedCertificatesResponse response =
         authorizedCertificatesClient.listAuthorizedCertificatesCallable().call(request);
     for (AuthorizedCertificate element : response.getCertificatesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns

Type	Description
UnaryCallable<ListAuthorizedCertificatesRequest,ListAuthorizedCertificatesResponse>

listAuthorizedCertificatesPagedCallable()

public final UnaryCallable<ListAuthorizedCertificatesRequest,AuthorizedCertificatesClient.ListAuthorizedCertificatesPagedResponse> listAuthorizedCertificatesPagedCallable()

Lists all SSL certificates the user is authorized to administer.

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 (AuthorizedCertificatesClient authorizedCertificatesClient =
     AuthorizedCertificatesClient.create()) {
   ListAuthorizedCertificatesRequest request =
       ListAuthorizedCertificatesRequest.newBuilder()
           .setParent("parent-995424086")
           .setView(AuthorizedCertificateView.forNumber(0))
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<AuthorizedCertificate> future =
       authorizedCertificatesClient
           .listAuthorizedCertificatesPagedCallable()
           .futureCall(request);
   // Do something.
   for (AuthorizedCertificate element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns

Type	Description
UnaryCallable<ListAuthorizedCertificatesRequest,ListAuthorizedCertificatesPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateAuthorizedCertificate(UpdateAuthorizedCertificateRequest request)

public final AuthorizedCertificate updateAuthorizedCertificate(UpdateAuthorizedCertificateRequest request)

Updates the specified SSL certificate. To renew a certificate and maintain its existing domain mappings, update certificate_data with a new certificate. The new certificate must be applicable to the same domains as the original certificate. The certificate display_name may also be updated.

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 (AuthorizedCertificatesClient authorizedCertificatesClient =
     AuthorizedCertificatesClient.create()) {
   UpdateAuthorizedCertificateRequest request =
       UpdateAuthorizedCertificateRequest.newBuilder()
           .setName("name3373707")
           .setCertificate(AuthorizedCertificate.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   AuthorizedCertificate response =
       authorizedCertificatesClient.updateAuthorizedCertificate(request);
 }

Parameter

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

Returns

Type	Description
AuthorizedCertificate

updateAuthorizedCertificateCallable()

public final UnaryCallable<UpdateAuthorizedCertificateRequest,AuthorizedCertificate> updateAuthorizedCertificateCallable()

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 (AuthorizedCertificatesClient authorizedCertificatesClient =
     AuthorizedCertificatesClient.create()) {
   UpdateAuthorizedCertificateRequest request =
       UpdateAuthorizedCertificateRequest.newBuilder()
           .setName("name3373707")
           .setCertificate(AuthorizedCertificate.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<AuthorizedCertificate> future =
       authorizedCertificatesClient.updateAuthorizedCertificateCallable().futureCall(request);
   // Do something.
   AuthorizedCertificate response = future.get();
 }

Returns

Type	Description
UnaryCallable<UpdateAuthorizedCertificateRequest,AuthorizedCertificate>