com.google.cloud.compute.v1

Class RegionSslCertificateClient

java.lang.Object

com.google.cloud.compute.v1.RegionSslCertificateClient

All Implemented Interfaces:

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

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

Service Description: Creates and runs virtual machines on Google Cloud Platform.

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 (RegionSslCertificateClient regionSslCertificateClient = RegionSslCertificateClient.create()) {
   ProjectRegionSslCertificateName sslCertificate = ProjectRegionSslCertificateName.of("[PROJECT]", "[REGION]", "[SSL_CERTIFICATE]");
   Operation response = regionSslCertificateClient.deleteRegionSslCertificate(sslCertificate);
 }
 
 

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

To customize credentials:

 
 RegionSslCertificateSettings regionSslCertificateSettings =
     RegionSslCertificateSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 RegionSslCertificateClient regionSslCertificateClient =
     RegionSslCertificateClient.create(regionSslCertificateSettings);
 
 

To customize the endpoint:

 
 RegionSslCertificateSettings regionSslCertificateSettings =
     RegionSslCertificateSettings.newBuilder().setEndpoint(myEndpoint).build();
 RegionSslCertificateClient regionSslCertificateClient =
     RegionSslCertificateClient.create(regionSslCertificateSettings);
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RegionSslCertificateClient.ListRegionSslCertificatesFixedSizeCollection
static class	RegionSslCertificateClient.ListRegionSslCertificatesPage
static class	RegionSslCertificateClient.ListRegionSslCertificatesPagedResponse

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RegionSslCertificateClient(RegionSslCertificateSettings settings) Constructs an instance of RegionSslCertificateClient, using the given settings.
protected	RegionSslCertificateClient(RegionSslCertificateStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static RegionSslCertificateClient	create() Constructs an instance of RegionSslCertificateClient with default settings.
static RegionSslCertificateClient	create(RegionSslCertificateSettings settings) Constructs an instance of RegionSslCertificateClient, using the given settings.
static RegionSslCertificateClient	create(RegionSslCertificateStub stub) Constructs an instance of RegionSslCertificateClient, using the given stub for making calls.
Operation	deleteRegionSslCertificate(DeleteRegionSslCertificateHttpRequest request) Deletes the specified SslCertificate resource in the region.
Operation	deleteRegionSslCertificate(ProjectRegionSslCertificateName sslCertificate) Deletes the specified SslCertificate resource in the region.
Operation	deleteRegionSslCertificate(String sslCertificate) Deletes the specified SslCertificate resource in the region.
com.google.api.gax.rpc.UnaryCallable<DeleteRegionSslCertificateHttpRequest,Operation>	deleteRegionSslCertificateCallable() Deletes the specified SslCertificate resource in the region.
SslCertificate	getRegionSslCertificate(GetRegionSslCertificateHttpRequest request) Returns the specified SslCertificate resource in the specified region.
SslCertificate	getRegionSslCertificate(ProjectRegionSslCertificateName sslCertificate) Returns the specified SslCertificate resource in the specified region.
SslCertificate	getRegionSslCertificate(String sslCertificate) Returns the specified SslCertificate resource in the specified region.
com.google.api.gax.rpc.UnaryCallable<GetRegionSslCertificateHttpRequest,SslCertificate>	getRegionSslCertificateCallable() Returns the specified SslCertificate resource in the specified region.
RegionSslCertificateSettings	getSettings()
RegionSslCertificateStub	getStub()
Operation	insertRegionSslCertificate(InsertRegionSslCertificateHttpRequest request) Creates a SslCertificate resource in the specified project and region using the data included in the request
Operation	insertRegionSslCertificate(ProjectRegionName region, SslCertificate sslCertificateResource) Creates a SslCertificate resource in the specified project and region using the data included in the request
Operation	insertRegionSslCertificate(String region, SslCertificate sslCertificateResource) Creates a SslCertificate resource in the specified project and region using the data included in the request
com.google.api.gax.rpc.UnaryCallable<InsertRegionSslCertificateHttpRequest,Operation>	insertRegionSslCertificateCallable() Creates a SslCertificate resource in the specified project and region using the data included in the request
boolean	isShutdown()
boolean	isTerminated()
RegionSslCertificateClient.ListRegionSslCertificatesPagedResponse	listRegionSslCertificates(ListRegionSslCertificatesHttpRequest request) Retrieves the list of SslCertificate resources available to the specified project in the specified region.
RegionSslCertificateClient.ListRegionSslCertificatesPagedResponse	listRegionSslCertificates(ProjectRegionName region) Retrieves the list of SslCertificate resources available to the specified project in the specified region.
RegionSslCertificateClient.ListRegionSslCertificatesPagedResponse	listRegionSslCertificates(String region) Retrieves the list of SslCertificate resources available to the specified project in the specified region.
com.google.api.gax.rpc.UnaryCallable<ListRegionSslCertificatesHttpRequest,SslCertificateList>	listRegionSslCertificatesCallable() Retrieves the list of SslCertificate resources available to the specified project in the specified region.
com.google.api.gax.rpc.UnaryCallable<ListRegionSslCertificatesHttpRequest,RegionSslCertificateClient.ListRegionSslCertificatesPagedResponse>	listRegionSslCertificatesPagedCallable() Retrieves the list of SslCertificate resources available to the specified project in the specified region.
void	shutdown()
void	shutdownNow()

Methods inherited from class java.lang.Object

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

Constructor Detail

RegionSslCertificateClient

protected RegionSslCertificateClient(RegionSslCertificateSettings settings)
                              throws IOException

Constructs an instance of RegionSslCertificateClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Throws:

IOException

RegionSslCertificateClient

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
protected RegionSslCertificateClient(RegionSslCertificateStub stub)

Method Detail

create

public static final RegionSslCertificateClient create()
                                               throws IOException

Constructs an instance of RegionSslCertificateClient with default settings.

Throws:

IOException

create

public static final RegionSslCertificateClient create(RegionSslCertificateSettings settings)
                                               throws IOException

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

Throws:

IOException

create

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public static final RegionSslCertificateClient create(RegionSslCertificateStub stub)

Constructs an instance of RegionSslCertificateClient, using the given stub for making calls. This is for advanced usage - prefer to use RegionSslCertificateSettings}.

getSettings

public final RegionSslCertificateSettings getSettings()

getStub

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public RegionSslCertificateStub getStub()

deleteRegionSslCertificate

@BetaApi
public final Operation deleteRegionSslCertificate(ProjectRegionSslCertificateName sslCertificate)

Deletes the specified SslCertificate resource in the region.

Sample code:

 try (RegionSslCertificateClient regionSslCertificateClient = RegionSslCertificateClient.create()) {
   ProjectRegionSslCertificateName sslCertificate = ProjectRegionSslCertificateName.of("[PROJECT]", "[REGION]", "[SSL_CERTIFICATE]");
   Operation response = regionSslCertificateClient.deleteRegionSslCertificate(sslCertificate);
 }
 

Parameters:

sslCertificate - Name of the SslCertificate resource to delete.

Throws:

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

deleteRegionSslCertificate

@BetaApi
public final Operation deleteRegionSslCertificate(String sslCertificate)

Deletes the specified SslCertificate resource in the region.

Sample code:

 try (RegionSslCertificateClient regionSslCertificateClient = RegionSslCertificateClient.create()) {
   ProjectRegionSslCertificateName sslCertificate = ProjectRegionSslCertificateName.of("[PROJECT]", "[REGION]", "[SSL_CERTIFICATE]");
   Operation response = regionSslCertificateClient.deleteRegionSslCertificate(sslCertificate.toString());
 }
 

Parameters:

sslCertificate - Name of the SslCertificate resource to delete.

Throws:

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

deleteRegionSslCertificate

@BetaApi
public final Operation deleteRegionSslCertificate(DeleteRegionSslCertificateHttpRequest request)

Deletes the specified SslCertificate resource in the region.

Sample code:

 try (RegionSslCertificateClient regionSslCertificateClient = RegionSslCertificateClient.create()) {
   String formattedSslCertificate = ProjectRegionSslCertificateName.format("[PROJECT]", "[REGION]", "[SSL_CERTIFICATE]");
   DeleteRegionSslCertificateHttpRequest request = DeleteRegionSslCertificateHttpRequest.newBuilder()
     .setSslCertificate(formattedSslCertificate)
     .build();
   Operation response = regionSslCertificateClient.deleteRegionSslCertificate(request);
 }
 

Parameters:

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

Throws:

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

deleteRegionSslCertificateCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<DeleteRegionSslCertificateHttpRequest,Operation> deleteRegionSslCertificateCallable()

Deletes the specified SslCertificate resource in the region.

Sample code:

 try (RegionSslCertificateClient regionSslCertificateClient = RegionSslCertificateClient.create()) {
   String formattedSslCertificate = ProjectRegionSslCertificateName.format("[PROJECT]", "[REGION]", "[SSL_CERTIFICATE]");
   DeleteRegionSslCertificateHttpRequest request = DeleteRegionSslCertificateHttpRequest.newBuilder()
     .setSslCertificate(formattedSslCertificate)
     .build();
   ApiFuture<Operation> future = regionSslCertificateClient.deleteRegionSslCertificateCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

getRegionSslCertificate

@BetaApi
public final SslCertificate getRegionSslCertificate(ProjectRegionSslCertificateName sslCertificate)

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

Sample code:

 try (RegionSslCertificateClient regionSslCertificateClient = RegionSslCertificateClient.create()) {
   ProjectRegionSslCertificateName sslCertificate = ProjectRegionSslCertificateName.of("[PROJECT]", "[REGION]", "[SSL_CERTIFICATE]");
   SslCertificate response = regionSslCertificateClient.getRegionSslCertificate(sslCertificate);
 }
 

Parameters:

sslCertificate - Name of the SslCertificate resource to return.

Throws:

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

getRegionSslCertificate

@BetaApi
public final SslCertificate getRegionSslCertificate(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:

 try (RegionSslCertificateClient regionSslCertificateClient = RegionSslCertificateClient.create()) {
   ProjectRegionSslCertificateName sslCertificate = ProjectRegionSslCertificateName.of("[PROJECT]", "[REGION]", "[SSL_CERTIFICATE]");
   SslCertificate response = regionSslCertificateClient.getRegionSslCertificate(sslCertificate.toString());
 }
 

Parameters:

sslCertificate - Name of the SslCertificate resource to return.

Throws:

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

getRegionSslCertificate

@BetaApi
public final SslCertificate getRegionSslCertificate(GetRegionSslCertificateHttpRequest request)

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

Sample code:

 try (RegionSslCertificateClient regionSslCertificateClient = RegionSslCertificateClient.create()) {
   String formattedSslCertificate = ProjectRegionSslCertificateName.format("[PROJECT]", "[REGION]", "[SSL_CERTIFICATE]");
   GetRegionSslCertificateHttpRequest request = GetRegionSslCertificateHttpRequest.newBuilder()
     .setSslCertificate(formattedSslCertificate)
     .build();
   SslCertificate response = regionSslCertificateClient.getRegionSslCertificate(request);
 }
 

Parameters:

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

Throws:

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

getRegionSslCertificateCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<GetRegionSslCertificateHttpRequest,SslCertificate> getRegionSslCertificateCallable()

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

Sample code:

 try (RegionSslCertificateClient regionSslCertificateClient = RegionSslCertificateClient.create()) {
   String formattedSslCertificate = ProjectRegionSslCertificateName.format("[PROJECT]", "[REGION]", "[SSL_CERTIFICATE]");
   GetRegionSslCertificateHttpRequest request = GetRegionSslCertificateHttpRequest.newBuilder()
     .setSslCertificate(formattedSslCertificate)
     .build();
   ApiFuture<SslCertificate> future = regionSslCertificateClient.getRegionSslCertificateCallable().futureCall(request);
   // Do something
   SslCertificate response = future.get();
 }
 

insertRegionSslCertificate

@BetaApi
public final Operation insertRegionSslCertificate(ProjectRegionName region,
                                                           SslCertificate sslCertificateResource)

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

Sample code:

 try (RegionSslCertificateClient regionSslCertificateClient = RegionSslCertificateClient.create()) {
   ProjectRegionName region = ProjectRegionName.of("[PROJECT]", "[REGION]");
   SslCertificate sslCertificateResource = SslCertificate.newBuilder().build();
   Operation response = regionSslCertificateClient.insertRegionSslCertificate(region, sslCertificateResource);
 }
 

Parameters:

region - Name of the region scoping this request.

sslCertificateResource - Represents an SSL Certificate resource.

This SSL certificate resource also contains a private key. You can use SSL keys and certificates to secure connections to a load balancer. For more information, read Creating and Using SSL Certificates. (== resource_for beta.sslCertificates ==) (== resource_for v1.sslCertificates ==)

Throws:

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

insertRegionSslCertificate

@BetaApi
public final Operation insertRegionSslCertificate(String region,
                                                           SslCertificate sslCertificateResource)

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

Sample code:

 try (RegionSslCertificateClient regionSslCertificateClient = RegionSslCertificateClient.create()) {
   ProjectRegionName region = ProjectRegionName.of("[PROJECT]", "[REGION]");
   SslCertificate sslCertificateResource = SslCertificate.newBuilder().build();
   Operation response = regionSslCertificateClient.insertRegionSslCertificate(region.toString(), sslCertificateResource);
 }
 

Parameters:

region - Name of the region scoping this request.

sslCertificateResource - Represents an SSL Certificate resource.

This SSL certificate resource also contains a private key. You can use SSL keys and certificates to secure connections to a load balancer. For more information, read Creating and Using SSL Certificates. (== resource_for beta.sslCertificates ==) (== resource_for v1.sslCertificates ==)

Throws:

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

insertRegionSslCertificate

@BetaApi
public final Operation insertRegionSslCertificate(InsertRegionSslCertificateHttpRequest request)

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

Sample code:

 try (RegionSslCertificateClient regionSslCertificateClient = RegionSslCertificateClient.create()) {
   String formattedRegion = ProjectRegionName.format("[PROJECT]", "[REGION]");
   SslCertificate sslCertificateResource = SslCertificate.newBuilder().build();
   InsertRegionSslCertificateHttpRequest request = InsertRegionSslCertificateHttpRequest.newBuilder()
     .setRegion(formattedRegion)
     .setSslCertificateResource(sslCertificateResource)
     .build();
   Operation response = regionSslCertificateClient.insertRegionSslCertificate(request);
 }
 

Parameters:

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

Throws:

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

insertRegionSslCertificateCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<InsertRegionSslCertificateHttpRequest,Operation> insertRegionSslCertificateCallable()

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

Sample code:

 try (RegionSslCertificateClient regionSslCertificateClient = RegionSslCertificateClient.create()) {
   String formattedRegion = ProjectRegionName.format("[PROJECT]", "[REGION]");
   SslCertificate sslCertificateResource = SslCertificate.newBuilder().build();
   InsertRegionSslCertificateHttpRequest request = InsertRegionSslCertificateHttpRequest.newBuilder()
     .setRegion(formattedRegion)
     .setSslCertificateResource(sslCertificateResource)
     .build();
   ApiFuture<Operation> future = regionSslCertificateClient.insertRegionSslCertificateCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

listRegionSslCertificates

@BetaApi
public final RegionSslCertificateClient.ListRegionSslCertificatesPagedResponse listRegionSslCertificates(ProjectRegionName region)

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

Sample code:

 try (RegionSslCertificateClient regionSslCertificateClient = RegionSslCertificateClient.create()) {
   ProjectRegionName region = ProjectRegionName.of("[PROJECT]", "[REGION]");
   for (SslCertificate element : regionSslCertificateClient.listRegionSslCertificates(region).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

region - Name of the region scoping this request.

Throws:

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

listRegionSslCertificates

@BetaApi
public final RegionSslCertificateClient.ListRegionSslCertificatesPagedResponse listRegionSslCertificates(String region)

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

Sample code:

 try (RegionSslCertificateClient regionSslCertificateClient = RegionSslCertificateClient.create()) {
   ProjectRegionName region = ProjectRegionName.of("[PROJECT]", "[REGION]");
   for (SslCertificate element : regionSslCertificateClient.listRegionSslCertificates(region.toString()).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

region - Name of the region scoping this request.

Throws:

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

listRegionSslCertificates

@BetaApi
public final RegionSslCertificateClient.ListRegionSslCertificatesPagedResponse listRegionSslCertificates(ListRegionSslCertificatesHttpRequest request)

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

Sample code:

 try (RegionSslCertificateClient regionSslCertificateClient = RegionSslCertificateClient.create()) {
   String formattedRegion = ProjectRegionName.format("[PROJECT]", "[REGION]");
   ListRegionSslCertificatesHttpRequest request = ListRegionSslCertificatesHttpRequest.newBuilder()
     .setRegion(formattedRegion)
     .build();
   for (SslCertificate element : regionSslCertificateClient.listRegionSslCertificates(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

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

Throws:

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

listRegionSslCertificatesPagedCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<ListRegionSslCertificatesHttpRequest,RegionSslCertificateClient.ListRegionSslCertificatesPagedResponse> listRegionSslCertificatesPagedCallable()

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

Sample code:

 try (RegionSslCertificateClient regionSslCertificateClient = RegionSslCertificateClient.create()) {
   String formattedRegion = ProjectRegionName.format("[PROJECT]", "[REGION]");
   ListRegionSslCertificatesHttpRequest request = ListRegionSslCertificatesHttpRequest.newBuilder()
     .setRegion(formattedRegion)
     .build();
   ApiFuture<ListRegionSslCertificatesPagedResponse> future = regionSslCertificateClient.listRegionSslCertificatesPagedCallable().futureCall(request);
   // Do something
   for (SslCertificate element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listRegionSslCertificatesCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<ListRegionSslCertificatesHttpRequest,SslCertificateList> listRegionSslCertificatesCallable()

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

Sample code:

 try (RegionSslCertificateClient regionSslCertificateClient = RegionSslCertificateClient.create()) {
   String formattedRegion = ProjectRegionName.format("[PROJECT]", "[REGION]");
   ListRegionSslCertificatesHttpRequest request = ListRegionSslCertificatesHttpRequest.newBuilder()
     .setRegion(formattedRegion)
     .build();
   while (true) {
     SslCertificateList response = regionSslCertificateClient.listRegionSslCertificatesCallable().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;
     }
   }
 }
 

close

public final void close()

Specified by:

close in interface AutoCloseable

shutdown

public void shutdown()

Specified by:

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

isShutdown

public boolean isShutdown()

Specified by:

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

isTerminated

public boolean isTerminated()

Specified by:

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

shutdownNow

public void shutdownNow()

Specified by:

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

awaitTermination

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

Specified by:

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

Throws:

InterruptedException