Class RegionSslCertificatesClient (1.13.0)

Version 1.13.0

• 1.63.0 (latest)
• 1.62.0
• 1.61.0
• 1.59.0
• 1.58.0
• 1.57.0
• 1.56.0
• 1.55.0
• 1.54.0
• 1.53.0
• 1.52.0
• 1.51.0
• 1.50.0
• 1.49.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.25.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.1
• 1.11.0
• 1.9.1
• 1.8.1
• 1.7.2
• 1.6.0-beta

public class RegionSslCertificatesClient implements BackgroundResource

Service Description: The RegionSslCertificates API.

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 (RegionSslCertificatesClient regionSslCertificatesClient =
     RegionSslCertificatesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String sslCertificate = "sslCertificate-1304941589";
   SslCertificate response = regionSslCertificatesClient.get(project, region, sslCertificate);
 }
 

Note: close() needs to be called on the RegionSslCertificatesClient 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 RegionSslCertificatesSettings 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
 RegionSslCertificatesSettings regionSslCertificatesSettings =
     RegionSslCertificatesSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 RegionSslCertificatesClient regionSslCertificatesClient =
     RegionSslCertificatesClient.create(regionSslCertificatesSettings);
 

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
 RegionSslCertificatesSettings regionSslCertificatesSettings =
     RegionSslCertificatesSettings.newBuilder().setEndpoint(myEndpoint).build();
 RegionSslCertificatesClient regionSslCertificatesClient =
     RegionSslCertificatesClient.create(regionSslCertificatesSettings);
 

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

Inheritance

java.lang.Object > RegionSslCertificatesClient

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

Constructs an instance of RegionSslCertificatesClient with default settings.

Returns

Type	Description
RegionSslCertificatesClient

Exceptions

Type	Description
IOException

create(RegionSslCertificatesSettings settings)

public static final RegionSslCertificatesClient create(RegionSslCertificatesSettings settings)

Constructs an instance of RegionSslCertificatesClient, 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	RegionSslCertificatesSettings

Returns

Type	Description
RegionSslCertificatesClient

Exceptions

Type	Description
IOException

create(RegionSslCertificatesStub stub)

public static final RegionSslCertificatesClient create(RegionSslCertificatesStub stub)

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

Parameter

Name	Description
stub	RegionSslCertificatesStub

Returns

Type	Description
RegionSslCertificatesClient

Constructors

RegionSslCertificatesClient(RegionSslCertificatesSettings settings)

protected RegionSslCertificatesClient(RegionSslCertificatesSettings settings)

Constructs an instance of RegionSslCertificatesClient, 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	RegionSslCertificatesSettings

RegionSslCertificatesClient(RegionSslCertificatesStub stub)

protected RegionSslCertificatesClient(RegionSslCertificatesStub stub)

Parameter

Name	Description
stub	RegionSslCertificatesStub

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

deleteAsync(DeleteRegionSslCertificateRequest request)

public final OperationFuture<Operation,Operation> deleteAsync(DeleteRegionSslCertificateRequest request)

Deletes the specified SslCertificate resource in the region.

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 (RegionSslCertificatesClient regionSslCertificatesClient =
     RegionSslCertificatesClient.create()) {
   DeleteRegionSslCertificateRequest request =
       DeleteRegionSslCertificateRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setSslCertificate("sslCertificate-1304941589")
           .build();
   Operation response = regionSslCertificatesClient.deleteAsync(request).get();
 }
 

Parameter

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

Returns

Type	Description
OperationFuture<Operation,Operation>

deleteAsync(String project, String region, String sslCertificate)

public final OperationFuture<Operation,Operation> deleteAsync(String project, String region, String sslCertificate)

Deletes the specified SslCertificate resource in the region.

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 (RegionSslCertificatesClient regionSslCertificatesClient =
     RegionSslCertificatesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String sslCertificate = "sslCertificate-1304941589";
   Operation response =
       regionSslCertificatesClient.deleteAsync(project, region, sslCertificate).get();
 }
 

Parameters

Name	Description
project	String Project ID for this request.
region	String Name of the region scoping this request.
sslCertificate	String Name of the SslCertificate resource to delete.

Returns

Type	Description
OperationFuture<Operation,Operation>

deleteCallable()

public final UnaryCallable<DeleteRegionSslCertificateRequest,Operation> deleteCallable()

Deletes the specified SslCertificate resource in the region.

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 (RegionSslCertificatesClient regionSslCertificatesClient =
     RegionSslCertificatesClient.create()) {
   DeleteRegionSslCertificateRequest request =
       DeleteRegionSslCertificateRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setSslCertificate("sslCertificate-1304941589")
           .build();
   ApiFuture<Operation> future =
       regionSslCertificatesClient.deleteCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<DeleteRegionSslCertificateRequest,Operation>

deleteOperationCallable()

public final OperationCallable<DeleteRegionSslCertificateRequest,Operation,Operation> deleteOperationCallable()

Deletes the specified SslCertificate resource in the region.

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 (RegionSslCertificatesClient regionSslCertificatesClient =
     RegionSslCertificatesClient.create()) {
   DeleteRegionSslCertificateRequest request =
       DeleteRegionSslCertificateRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setSslCertificate("sslCertificate-1304941589")
           .build();
   OperationFuture<Operation, Operation> future =
       regionSslCertificatesClient.deleteOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
OperationCallable<DeleteRegionSslCertificateRequest,Operation,Operation>

get(GetRegionSslCertificateRequest request)

public final SslCertificate get(GetRegionSslCertificateRequest request)

Returns the specified SslCertificate resource in the specified region. Get a list of available SSL certificates by making a list() request.

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 (RegionSslCertificatesClient regionSslCertificatesClient =
     RegionSslCertificatesClient.create()) {
   GetRegionSslCertificateRequest request =
       GetRegionSslCertificateRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setSslCertificate("sslCertificate-1304941589")
           .build();
   SslCertificate response = regionSslCertificatesClient.get(request);
 }
 

Parameter

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

Returns

Type	Description
SslCertificate

get(String project, String region, String sslCertificate)

public final SslCertificate get(String project, String region, String sslCertificate)

Returns the specified SslCertificate resource in the specified region. Get a list of available SSL certificates by making a list() request.

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 (RegionSslCertificatesClient regionSslCertificatesClient =
     RegionSslCertificatesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String sslCertificate = "sslCertificate-1304941589";
   SslCertificate response = regionSslCertificatesClient.get(project, region, sslCertificate);
 }
 

Parameters

Name	Description
project	String Project ID for this request.
region	String Name of the region scoping this request.
sslCertificate	String Name of the SslCertificate resource to return.

Returns

Type	Description
SslCertificate

getCallable()

public final UnaryCallable<GetRegionSslCertificateRequest,SslCertificate> getCallable()

Returns the specified SslCertificate resource in the specified region. Get a list of available SSL certificates by making a list() request.

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 (RegionSslCertificatesClient regionSslCertificatesClient =
     RegionSslCertificatesClient.create()) {
   GetRegionSslCertificateRequest request =
       GetRegionSslCertificateRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setSslCertificate("sslCertificate-1304941589")
           .build();
   ApiFuture<SslCertificate> future =
       regionSslCertificatesClient.getCallable().futureCall(request);
   // Do something.
   SslCertificate response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<GetRegionSslCertificateRequest,SslCertificate>

getSettings()

public final RegionSslCertificatesSettings getSettings()

Returns

Type	Description
RegionSslCertificatesSettings

getStub()

public RegionSslCertificatesStub getStub()

Returns

Type	Description
RegionSslCertificatesStub

insertAsync(InsertRegionSslCertificateRequest request)

public final OperationFuture<Operation,Operation> insertAsync(InsertRegionSslCertificateRequest request)

Creates a SslCertificate resource in the specified project and region using the data included in the request

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 (RegionSslCertificatesClient regionSslCertificatesClient =
     RegionSslCertificatesClient.create()) {
   InsertRegionSslCertificateRequest request =
       InsertRegionSslCertificateRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setSslCertificateResource(SslCertificate.newBuilder().build())
           .build();
   Operation response = regionSslCertificatesClient.insertAsync(request).get();
 }
 

Parameter

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

Returns

Type	Description
OperationFuture<Operation,Operation>

insertAsync(String project, String region, SslCertificate sslCertificateResource)

public final OperationFuture<Operation,Operation> insertAsync(String project, String region, SslCertificate sslCertificateResource)

Creates a SslCertificate resource in the specified project and region using the data included in the request

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 (RegionSslCertificatesClient regionSslCertificatesClient =
     RegionSslCertificatesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   SslCertificate sslCertificateResource = SslCertificate.newBuilder().build();
   Operation response =
       regionSslCertificatesClient.insertAsync(project, region, sslCertificateResource).get();
 }
 

Parameters

Name	Description
project	String Project ID for this request.
region	String Name of the region scoping this request.
sslCertificateResource	SslCertificate The body resource for this request

Returns

Type	Description
OperationFuture<Operation,Operation>

insertCallable()

public final UnaryCallable<InsertRegionSslCertificateRequest,Operation> insertCallable()

Creates a SslCertificate resource in the specified project and region using the data included in the request

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 (RegionSslCertificatesClient regionSslCertificatesClient =
     RegionSslCertificatesClient.create()) {
   InsertRegionSslCertificateRequest request =
       InsertRegionSslCertificateRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setSslCertificateResource(SslCertificate.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       regionSslCertificatesClient.insertCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<InsertRegionSslCertificateRequest,Operation>

insertOperationCallable()

public final OperationCallable<InsertRegionSslCertificateRequest,Operation,Operation> insertOperationCallable()

Creates a SslCertificate resource in the specified project and region using the data included in the request

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 (RegionSslCertificatesClient regionSslCertificatesClient =
     RegionSslCertificatesClient.create()) {
   InsertRegionSslCertificateRequest request =
       InsertRegionSslCertificateRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setSslCertificateResource(SslCertificate.newBuilder().build())
           .build();
   OperationFuture<Operation, Operation> future =
       regionSslCertificatesClient.insertOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
OperationCallable<InsertRegionSslCertificateRequest,Operation,Operation>

isShutdown()

public boolean isShutdown()

Returns

Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns

Type	Description
boolean

list(ListRegionSslCertificatesRequest request)

public final RegionSslCertificatesClient.ListPagedResponse list(ListRegionSslCertificatesRequest request)

Retrieves the list of SslCertificate resources available to the specified project in the specified region.

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 (RegionSslCertificatesClient regionSslCertificatesClient =
     RegionSslCertificatesClient.create()) {
   ListRegionSslCertificatesRequest request =
       ListRegionSslCertificatesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setReturnPartialSuccess(true)
           .build();
   for (SslCertificate element : regionSslCertificatesClient.list(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

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

Returns

Type	Description
RegionSslCertificatesClient.ListPagedResponse

list(String project, String region)

public final RegionSslCertificatesClient.ListPagedResponse list(String project, String region)

Retrieves the list of SslCertificate resources available to the specified project in the specified region.

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 (RegionSslCertificatesClient regionSslCertificatesClient =
     RegionSslCertificatesClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   for (SslCertificate element :
       regionSslCertificatesClient.list(project, region).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters

Name	Description
project	String Project ID for this request.
region	String Name of the region scoping this request.

Returns

Type	Description
RegionSslCertificatesClient.ListPagedResponse

listCallable()

public final UnaryCallable<ListRegionSslCertificatesRequest,SslCertificateList> listCallable()

Retrieves the list of SslCertificate resources available to the specified project in the specified region.

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 (RegionSslCertificatesClient regionSslCertificatesClient =
     RegionSslCertificatesClient.create()) {
   ListRegionSslCertificatesRequest request =
       ListRegionSslCertificatesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setReturnPartialSuccess(true)
           .build();
   while (true) {
     SslCertificateList response = regionSslCertificatesClient.listCallable().call(request);
     for (SslCertificate element : response.getItemsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns

Type	Description
UnaryCallable<ListRegionSslCertificatesRequest,SslCertificateList>

listPagedCallable()

public final UnaryCallable<ListRegionSslCertificatesRequest,RegionSslCertificatesClient.ListPagedResponse> listPagedCallable()

Retrieves the list of SslCertificate resources available to the specified project in the specified region.

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 (RegionSslCertificatesClient regionSslCertificatesClient =
     RegionSslCertificatesClient.create()) {
   ListRegionSslCertificatesRequest request =
       ListRegionSslCertificatesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setReturnPartialSuccess(true)
           .build();
   ApiFuture<SslCertificate> future =
       regionSslCertificatesClient.listPagedCallable().futureCall(request);
   // Do something.
   for (SslCertificate element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Returns

Type	Description
UnaryCallable<ListRegionSslCertificatesRequest,ListPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()