Class SslCertificatesClient (1.9.1)

public class SslCertificatesClient implements BackgroundResource

Service Description: The SslCertificates 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:


 try (SslCertificatesClient sslCertificatesClient = SslCertificatesClient.create()) {
   String project = "project-309310695";
   String sslCertificate = "sslCertificate-1304941589";
   SslCertificate response = sslCertificatesClient.get(project, sslCertificate);
 }
 

Note: close() needs to be called on the SslCertificatesClient 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 SslCertificatesSettings to create(). For example:

To customize credentials:


 SslCertificatesSettings sslCertificatesSettings =
     SslCertificatesSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 SslCertificatesClient sslCertificatesClient =
     SslCertificatesClient.create(sslCertificatesSettings);
 

To customize the endpoint:


 SslCertificatesSettings sslCertificatesSettings =
     SslCertificatesSettings.newBuilder().setEndpoint(myEndpoint).build();
 SslCertificatesClient sslCertificatesClient =
     SslCertificatesClient.create(sslCertificatesSettings);
 

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

Inheritance

java.lang.Object > SslCertificatesClient

Implements

BackgroundResource

Static Methods

create()

public static final SslCertificatesClient create()

Constructs an instance of SslCertificatesClient with default settings.

Returns
TypeDescription
SslCertificatesClient
Exceptions
TypeDescription
IOException

create(SslCertificatesSettings settings)

public static final SslCertificatesClient create(SslCertificatesSettings settings)

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

Parameter
NameDescription
settingsSslCertificatesSettings
Returns
TypeDescription
SslCertificatesClient
Exceptions
TypeDescription
IOException

create(SslCertificatesStub stub)

public static final SslCertificatesClient create(SslCertificatesStub stub)

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

Parameter
NameDescription
stubSslCertificatesStub
Returns
TypeDescription
SslCertificatesClient

Constructors

SslCertificatesClient(SslCertificatesSettings settings)

protected SslCertificatesClient(SslCertificatesSettings settings)

Constructs an instance of SslCertificatesClient, 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
NameDescription
settingsSslCertificatesSettings

SslCertificatesClient(SslCertificatesStub stub)

protected SslCertificatesClient(SslCertificatesStub stub)
Parameter
NameDescription
stubSslCertificatesStub

Methods

aggregatedList(AggregatedListSslCertificatesRequest request)

public final SslCertificatesClient.AggregatedListPagedResponse aggregatedList(AggregatedListSslCertificatesRequest request)

Retrieves the list of all SslCertificate resources, regional and global, available to the specified project.

Sample code:


 try (SslCertificatesClient sslCertificatesClient = SslCertificatesClient.create()) {
   AggregatedListSslCertificatesRequest request =
       AggregatedListSslCertificatesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setIncludeAllScopes(true)
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   for (Map.Entry<String, SslCertificatesScopedList> element :
       sslCertificatesClient.aggregatedList(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
requestAggregatedListSslCertificatesRequest

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

Returns
TypeDescription
SslCertificatesClient.AggregatedListPagedResponse

aggregatedList(String project)

public final SslCertificatesClient.AggregatedListPagedResponse aggregatedList(String project)

Retrieves the list of all SslCertificate resources, regional and global, available to the specified project.

Sample code:


 try (SslCertificatesClient sslCertificatesClient = SslCertificatesClient.create()) {
   String project = "project-309310695";
   for (Map.Entry<String, SslCertificatesScopedList> element :
       sslCertificatesClient.aggregatedList(project).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
projectString

Name of the project scoping this request.

Returns
TypeDescription
SslCertificatesClient.AggregatedListPagedResponse

aggregatedListCallable()

public final UnaryCallable<AggregatedListSslCertificatesRequest,SslCertificateAggregatedList> aggregatedListCallable()

Retrieves the list of all SslCertificate resources, regional and global, available to the specified project.

Sample code:


 try (SslCertificatesClient sslCertificatesClient = SslCertificatesClient.create()) {
   AggregatedListSslCertificatesRequest request =
       AggregatedListSslCertificatesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setIncludeAllScopes(true)
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   while (true) {
     SslCertificateAggregatedList response =
         sslCertificatesClient.aggregatedListCallable().call(request);
     for (Map.Entry<String, SslCertificatesScopedList> element : response.getResponsesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
TypeDescription
UnaryCallable<AggregatedListSslCertificatesRequest,SslCertificateAggregatedList>

aggregatedListPagedCallable()

public final UnaryCallable<AggregatedListSslCertificatesRequest,SslCertificatesClient.AggregatedListPagedResponse> aggregatedListPagedCallable()

Retrieves the list of all SslCertificate resources, regional and global, available to the specified project.

Sample code:


 try (SslCertificatesClient sslCertificatesClient = SslCertificatesClient.create()) {
   AggregatedListSslCertificatesRequest request =
       AggregatedListSslCertificatesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setIncludeAllScopes(true)
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   ApiFuture<Map.Entry<String, SslCertificatesScopedList>> future =
       sslCertificatesClient.aggregatedListPagedCallable().futureCall(request);
   // Do something.
   for (Map.Entry<String, SslCertificatesScopedList> element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
TypeDescription
UnaryCallable<AggregatedListSslCertificatesRequest,AggregatedListPagedResponse>

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
NameDescription
durationlong
unitTimeUnit
Returns
TypeDescription
boolean
Exceptions
TypeDescription
InterruptedException

close()

public final void close()

deleteAsync(DeleteSslCertificateRequest request)

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

Deletes the specified SslCertificate resource.

Sample code:


 try (SslCertificatesClient sslCertificatesClient = SslCertificatesClient.create()) {
   DeleteSslCertificateRequest request =
       DeleteSslCertificateRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setSslCertificate("sslCertificate-1304941589")
           .build();
   Operation response = sslCertificatesClient.deleteAsync(request).get();
 }
 
Parameter
NameDescription
requestDeleteSslCertificateRequest

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

Returns
TypeDescription
OperationFuture<Operation,Operation>

deleteAsync(String project, String sslCertificate)

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

Deletes the specified SslCertificate resource.

Sample code:


 try (SslCertificatesClient sslCertificatesClient = SslCertificatesClient.create()) {
   String project = "project-309310695";
   String sslCertificate = "sslCertificate-1304941589";
   Operation response = sslCertificatesClient.deleteAsync(project, sslCertificate).get();
 }
 
Parameters
NameDescription
projectString

Project ID for this request.

sslCertificateString

Name of the SslCertificate resource to delete.

Returns
TypeDescription
OperationFuture<Operation,Operation>

deleteCallable()

public final UnaryCallable<DeleteSslCertificateRequest,Operation> deleteCallable()

Deletes the specified SslCertificate resource.

Sample code:


 try (SslCertificatesClient sslCertificatesClient = SslCertificatesClient.create()) {
   DeleteSslCertificateRequest request =
       DeleteSslCertificateRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setSslCertificate("sslCertificate-1304941589")
           .build();
   ApiFuture<Operation> future = sslCertificatesClient.deleteCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<DeleteSslCertificateRequest,Operation>

deleteOperationCallable()

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

Deletes the specified SslCertificate resource.

Sample code:


 try (SslCertificatesClient sslCertificatesClient = SslCertificatesClient.create()) {
   DeleteSslCertificateRequest request =
       DeleteSslCertificateRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setSslCertificate("sslCertificate-1304941589")
           .build();
   OperationFuture<Operation, Operation> future =
       sslCertificatesClient.deleteOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
OperationCallable<DeleteSslCertificateRequest,Operation,Operation>

get(GetSslCertificateRequest request)

public final SslCertificate get(GetSslCertificateRequest request)

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

Sample code:


 try (SslCertificatesClient sslCertificatesClient = SslCertificatesClient.create()) {
   GetSslCertificateRequest request =
       GetSslCertificateRequest.newBuilder()
           .setProject("project-309310695")
           .setSslCertificate("sslCertificate-1304941589")
           .build();
   SslCertificate response = sslCertificatesClient.get(request);
 }
 
Parameter
NameDescription
requestGetSslCertificateRequest

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

Returns
TypeDescription
SslCertificate

get(String project, String sslCertificate)

public final SslCertificate get(String project, String sslCertificate)

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

Sample code:


 try (SslCertificatesClient sslCertificatesClient = SslCertificatesClient.create()) {
   String project = "project-309310695";
   String sslCertificate = "sslCertificate-1304941589";
   SslCertificate response = sslCertificatesClient.get(project, sslCertificate);
 }
 
Parameters
NameDescription
projectString

Project ID for this request.

sslCertificateString

Name of the SslCertificate resource to return.

Returns
TypeDescription
SslCertificate

getCallable()

public final UnaryCallable<GetSslCertificateRequest,SslCertificate> getCallable()

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

Sample code:


 try (SslCertificatesClient sslCertificatesClient = SslCertificatesClient.create()) {
   GetSslCertificateRequest request =
       GetSslCertificateRequest.newBuilder()
           .setProject("project-309310695")
           .setSslCertificate("sslCertificate-1304941589")
           .build();
   ApiFuture<SslCertificate> future = sslCertificatesClient.getCallable().futureCall(request);
   // Do something.
   SslCertificate response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<GetSslCertificateRequest,SslCertificate>

getSettings()

public final SslCertificatesSettings getSettings()
Returns
TypeDescription
SslCertificatesSettings

getStub()

public SslCertificatesStub getStub()
Returns
TypeDescription
SslCertificatesStub

insertAsync(InsertSslCertificateRequest request)

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

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

Sample code:


 try (SslCertificatesClient sslCertificatesClient = SslCertificatesClient.create()) {
   InsertSslCertificateRequest request =
       InsertSslCertificateRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setSslCertificateResource(SslCertificate.newBuilder().build())
           .build();
   Operation response = sslCertificatesClient.insertAsync(request).get();
 }
 
Parameter
NameDescription
requestInsertSslCertificateRequest

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

Returns
TypeDescription
OperationFuture<Operation,Operation>

insertAsync(String project, SslCertificate sslCertificateResource)

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

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

Sample code:


 try (SslCertificatesClient sslCertificatesClient = SslCertificatesClient.create()) {
   String project = "project-309310695";
   SslCertificate sslCertificateResource = SslCertificate.newBuilder().build();
   Operation response = sslCertificatesClient.insertAsync(project, sslCertificateResource).get();
 }
 
Parameters
NameDescription
projectString

Project ID for this request.

sslCertificateResourceSslCertificate

The body resource for this request

Returns
TypeDescription
OperationFuture<Operation,Operation>

insertCallable()

public final UnaryCallable<InsertSslCertificateRequest,Operation> insertCallable()

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

Sample code:


 try (SslCertificatesClient sslCertificatesClient = SslCertificatesClient.create()) {
   InsertSslCertificateRequest request =
       InsertSslCertificateRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setSslCertificateResource(SslCertificate.newBuilder().build())
           .build();
   ApiFuture<Operation> future = sslCertificatesClient.insertCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<InsertSslCertificateRequest,Operation>

insertOperationCallable()

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

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

Sample code:


 try (SslCertificatesClient sslCertificatesClient = SslCertificatesClient.create()) {
   InsertSslCertificateRequest request =
       InsertSslCertificateRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setSslCertificateResource(SslCertificate.newBuilder().build())
           .build();
   OperationFuture<Operation, Operation> future =
       sslCertificatesClient.insertOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
OperationCallable<InsertSslCertificateRequest,Operation,Operation>

isShutdown()

public boolean isShutdown()
Returns
TypeDescription
boolean

isTerminated()

public boolean isTerminated()
Returns
TypeDescription
boolean

list(ListSslCertificatesRequest request)

public final SslCertificatesClient.ListPagedResponse list(ListSslCertificatesRequest request)

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

Sample code:


 try (SslCertificatesClient sslCertificatesClient = SslCertificatesClient.create()) {
   ListSslCertificatesRequest request =
       ListSslCertificatesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   for (SslCertificate element : sslCertificatesClient.list(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
requestListSslCertificatesRequest

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

Returns
TypeDescription
SslCertificatesClient.ListPagedResponse

list(String project)

public final SslCertificatesClient.ListPagedResponse list(String project)

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

Sample code:


 try (SslCertificatesClient sslCertificatesClient = SslCertificatesClient.create()) {
   String project = "project-309310695";
   for (SslCertificate element : sslCertificatesClient.list(project).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
projectString

Project ID for this request.

Returns
TypeDescription
SslCertificatesClient.ListPagedResponse

listCallable()

public final UnaryCallable<ListSslCertificatesRequest,SslCertificateList> listCallable()

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

Sample code:


 try (SslCertificatesClient sslCertificatesClient = SslCertificatesClient.create()) {
   ListSslCertificatesRequest request =
       ListSslCertificatesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   while (true) {
     SslCertificateList response = sslCertificatesClient.listCallable().call(request);
     for (SslCertificate element : response.getResponsesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
TypeDescription
UnaryCallable<ListSslCertificatesRequest,SslCertificateList>

listPagedCallable()

public final UnaryCallable<ListSslCertificatesRequest,SslCertificatesClient.ListPagedResponse> listPagedCallable()

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

Sample code:


 try (SslCertificatesClient sslCertificatesClient = SslCertificatesClient.create()) {
   ListSslCertificatesRequest request =
       ListSslCertificatesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   ApiFuture<SslCertificate> future =
       sslCertificatesClient.listPagedCallable().futureCall(request);
   // Do something.
   for (SslCertificate element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
TypeDescription
UnaryCallable<ListSslCertificatesRequest,ListPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()