Class SslCertificatesClient (1.55.0)

GitHub RepositoryProduct Reference

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:


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

Methods
Method Description Method Variants

AggregatedList

Retrieves the list of all SslCertificate resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • aggregatedList(AggregatedListSslCertificatesRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • aggregatedList(String project)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • aggregatedListPagedCallable()

  • aggregatedListCallable()

Delete

Deletes the specified SslCertificate resource.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteAsync(DeleteSslCertificateRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • deleteAsync(String project, String sslCertificate)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteOperationCallable()

  • deleteCallable()

Get

Returns the specified SslCertificate resource.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • get(GetSslCertificateRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • get(String project, String sslCertificate)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getCallable()

Insert

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • insertAsync(InsertSslCertificateRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • insertAsync(String project, SslCertificate sslCertificateResource)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • insertOperationCallable()

  • insertCallable()

List

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • list(ListSslCertificatesRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • list(String project)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listPagedCallable()

  • listCallable()

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:


 // 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
 SslCertificatesSettings sslCertificatesSettings =
     SslCertificatesSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 SslCertificatesClient sslCertificatesClient =
     SslCertificatesClient.create(sslCertificatesSettings);

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

Static Methods

create()

public static final SslCertificatesClient create()

Constructs an instance of SslCertificatesClient with default settings.

Returns
Type Description
SslCertificatesClient
Exceptions
Type Description
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
Name Description
settings SslCertificatesSettings
Returns
Type Description
SslCertificatesClient
Exceptions
Type Description
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
Name Description
stub SslCertificatesStub
Returns
Type Description
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
Name Description
settings SslCertificatesSettings

SslCertificatesClient(SslCertificatesStub stub)

protected SslCertificatesClient(SslCertificatesStub stub)
Parameter
Name Description
stub SslCertificatesStub

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. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

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 (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)
           .setServiceProjectNumber(-1293855239)
           .build();
   for (Map.Entry<String, SslCertificatesScopedList> element :
       sslCertificatesClient.aggregatedList(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request AggregatedListSslCertificatesRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
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. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

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 (SslCertificatesClient sslCertificatesClient = SslCertificatesClient.create()) {
   String project = "project-309310695";
   for (Map.Entry<String, SslCertificatesScopedList> element :
       sslCertificatesClient.aggregatedList(project).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
project String

Name of the project scoping this request.
Returns
Type Description
SslCertificatesClient.AggregatedListPagedResponse

aggregatedListCallable()

public final UnaryCallable<AggregatedListSslCertificatesRequest,SslCertificateAggregatedList> aggregatedListCallable()

Retrieves the list of all SslCertificate resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

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 (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)
           .setServiceProjectNumber(-1293855239)
           .build();
   while (true) {
     SslCertificateAggregatedList response =
         sslCertificatesClient.aggregatedListCallable().call(request);
     for (Map.Entry<String, SslCertificatesScopedList> 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<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. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

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 (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)
           .setServiceProjectNumber(-1293855239)
           .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
Type Description
UnaryCallable<AggregatedListSslCertificatesRequest,AggregatedListPagedResponse>

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

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

Deletes the specified SslCertificate resource.

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 (SslCertificatesClient sslCertificatesClient = SslCertificatesClient.create()) {
   DeleteSslCertificateRequest request =
       DeleteSslCertificateRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setSslCertificate("sslCertificate-1304941589")
           .build();
   Operation response = sslCertificatesClient.deleteAsync(request).get();
 }
Parameter
Name Description
request DeleteSslCertificateRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
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:


 // 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 (SslCertificatesClient sslCertificatesClient = SslCertificatesClient.create()) {
   String project = "project-309310695";
   String sslCertificate = "sslCertificate-1304941589";
   Operation response = sslCertificatesClient.deleteAsync(project, sslCertificate).get();
 }
Parameters
Name Description
project String

Project ID for this request.
sslCertificate String

Name of the SslCertificate resource to delete.
Returns
Type Description
OperationFuture<Operation,Operation>

deleteCallable()

public final UnaryCallable<DeleteSslCertificateRequest,Operation> deleteCallable()

Deletes the specified SslCertificate resource.

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 (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
Type Description
UnaryCallable<DeleteSslCertificateRequest,Operation>

deleteOperationCallable()

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

Deletes the specified SslCertificate resource.

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 (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
Type Description
OperationCallable<DeleteSslCertificateRequest,Operation,Operation>

get(GetSslCertificateRequest request)

public final SslCertificate get(GetSslCertificateRequest request)

Returns the specified SslCertificate resource.

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 (SslCertificatesClient sslCertificatesClient = SslCertificatesClient.create()) {
   GetSslCertificateRequest request =
       GetSslCertificateRequest.newBuilder()
           .setProject("project-309310695")
           .setSslCertificate("sslCertificate-1304941589")
           .build();
   SslCertificate response = sslCertificatesClient.get(request);
 }
Parameter
Name Description
request GetSslCertificateRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
SslCertificate

get(String project, String sslCertificate)

public final SslCertificate get(String project, String sslCertificate)

Returns the specified SslCertificate resource.

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 (SslCertificatesClient sslCertificatesClient = SslCertificatesClient.create()) {
   String project = "project-309310695";
   String sslCertificate = "sslCertificate-1304941589";
   SslCertificate response = sslCertificatesClient.get(project, sslCertificate);
 }
Parameters
Name Description
project String

Project ID for this request.
sslCertificate String

Name of the SslCertificate resource to return.
Returns
Type Description
SslCertificate

getCallable()

public final UnaryCallable<GetSslCertificateRequest,SslCertificate> getCallable()

Returns the specified SslCertificate resource.

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 (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
Type Description
UnaryCallable<GetSslCertificateRequest,SslCertificate>

getSettings()

public final SslCertificatesSettings getSettings()
Returns
Type Description
SslCertificatesSettings

getStub()

public SslCertificatesStub getStub()
Returns
Type Description
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:


 // 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 (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
Name Description
request InsertSslCertificateRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
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:


 // 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 (SslCertificatesClient sslCertificatesClient = SslCertificatesClient.create()) {
   String project = "project-309310695";
   SslCertificate sslCertificateResource = SslCertificate.newBuilder().build();
   Operation response = sslCertificatesClient.insertAsync(project, sslCertificateResource).get();
 }
Parameters
Name Description
project String

Project ID for this request.
sslCertificateResource SslCertificate

The body resource for this request
Returns
Type Description
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:


 // 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 (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
Type Description
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:


 // 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 (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
Type Description
OperationCallable<InsertSslCertificateRequest,Operation,Operation>

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

list(ListSslCertificatesRequest request)

public final SslCertificatesClient.ListPagedResponse list(ListSslCertificatesRequest request)

Retrieves the list of SslCertificate resources available to the specified 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 (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
Name Description
request ListSslCertificatesRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
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:


 // 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 (SslCertificatesClient sslCertificatesClient = SslCertificatesClient.create()) {
   String project = "project-309310695";
   for (SslCertificate element : sslCertificatesClient.list(project).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
project String

Project ID for this request.
Returns
Type Description
SslCertificatesClient.ListPagedResponse

listCallable()

public final UnaryCallable<ListSslCertificatesRequest,SslCertificateList> listCallable()

Retrieves the list of SslCertificate resources available to the specified 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 (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.getItemsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<ListSslCertificatesRequest,SslCertificateList>

listPagedCallable()

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

Retrieves the list of SslCertificate resources available to the specified 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 (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
Type Description
UnaryCallable<ListSslCertificatesRequest,ListPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()