SslCertificateClient (Google Cloud 0.119.0-alpha API)

java.lang.Object
- com.google.cloud.compute.v1.SslCertificateClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable
```
@Generated(value="by gapic-generator")
 @BetaApi
public class SslCertificateClient
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 (SslCertificateClient sslCertificateClient = SslCertificateClient.create()) {
   ProjectGlobalSslCertificateName sslCertificate = ProjectGlobalSslCertificateName.of("[PROJECT]", "[SSL_CERTIFICATE]");
   Operation response = sslCertificateClient.deleteSslCertificate(sslCertificate);
 }
 
 
```
Note: close() needs to be called on the sslCertificateClient 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 SslCertificateSettings to create(). For example:
To customize credentials:
```
 
 SslCertificateSettings sslCertificateSettings =
     SslCertificateSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 SslCertificateClient sslCertificateClient =
     SslCertificateClient.create(sslCertificateSettings);
 
 
```
To customize the endpoint:
```
 
 SslCertificateSettings sslCertificateSettings =
     SslCertificateSettings.newBuilder().setEndpoint(myEndpoint).build();
 SslCertificateClient sslCertificateClient =
     SslCertificateClient.create(sslCertificateSettings);
 
 
```

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`SslCertificateClient.AggregatedListSslCertificatesFixedSizeCollection`
`static class`	`SslCertificateClient.AggregatedListSslCertificatesPage`
`static class`	`SslCertificateClient.AggregatedListSslCertificatesPagedResponse`
`static class`	`SslCertificateClient.ListSslCertificatesFixedSizeCollection`
`static class`	`SslCertificateClient.ListSslCertificatesPage`
`static class`	`SslCertificateClient.ListSslCertificatesPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`SslCertificateClient(SslCertificateSettings settings)` Constructs an instance of SslCertificateClient, using the given settings.
`protected`	`SslCertificateClient(SslCertificateStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SslCertificateClient.AggregatedListSslCertificatesPagedResponse`	`aggregatedListSslCertificates(AggregatedListSslCertificatesHttpRequest request)` Retrieves the list of all SslCertificate resources, regional and global, available to the specified project.
`SslCertificateClient.AggregatedListSslCertificatesPagedResponse`	`aggregatedListSslCertificates(ProjectName project)` Retrieves the list of all SslCertificate resources, regional and global, available to the specified project.
`SslCertificateClient.AggregatedListSslCertificatesPagedResponse`	`aggregatedListSslCertificates(String project)` Retrieves the list of all SslCertificate resources, regional and global, available to the specified project.
`com.google.api.gax.rpc.UnaryCallable<AggregatedListSslCertificatesHttpRequest,SslCertificateAggregatedList>`	`aggregatedListSslCertificatesCallable()` Retrieves the list of all SslCertificate resources, regional and global, available to the specified project.
`com.google.api.gax.rpc.UnaryCallable<AggregatedListSslCertificatesHttpRequest,SslCertificateClient.AggregatedListSslCertificatesPagedResponse>`	`aggregatedListSslCertificatesPagedCallable()` Retrieves the list of all SslCertificate resources, regional and global, available to the specified project.
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`void`	`close()`
`static SslCertificateClient`	`create()` Constructs an instance of SslCertificateClient with default settings.
`static SslCertificateClient`	`create(SslCertificateSettings settings)` Constructs an instance of SslCertificateClient, using the given settings.
`static SslCertificateClient`	`create(SslCertificateStub stub)` Constructs an instance of SslCertificateClient, using the given stub for making calls.
`Operation`	`deleteSslCertificate(DeleteSslCertificateHttpRequest request)` Deletes the specified SslCertificate resource.
`Operation`	`deleteSslCertificate(ProjectGlobalSslCertificateName sslCertificate)` Deletes the specified SslCertificate resource.
`Operation`	`deleteSslCertificate(String sslCertificate)` Deletes the specified SslCertificate resource.
`com.google.api.gax.rpc.UnaryCallable<DeleteSslCertificateHttpRequest,Operation>`	`deleteSslCertificateCallable()` Deletes the specified SslCertificate resource.
`SslCertificateSettings`	`getSettings()`
`SslCertificate`	`getSslCertificate(GetSslCertificateHttpRequest request)` Returns the specified SslCertificate resource.
`SslCertificate`	`getSslCertificate(ProjectGlobalSslCertificateName sslCertificate)` Returns the specified SslCertificate resource.
`SslCertificate`	`getSslCertificate(String sslCertificate)` Returns the specified SslCertificate resource.
`com.google.api.gax.rpc.UnaryCallable<GetSslCertificateHttpRequest,SslCertificate>`	`getSslCertificateCallable()` Returns the specified SslCertificate resource.
`SslCertificateStub`	`getStub()`
`Operation`	`insertSslCertificate(InsertSslCertificateHttpRequest request)` Creates a SslCertificate resource in the specified project using the data included in the request.
`Operation`	`insertSslCertificate(ProjectName project, SslCertificate sslCertificateResource)` Creates a SslCertificate resource in the specified project using the data included in the request.
`Operation`	`insertSslCertificate(String project, SslCertificate sslCertificateResource)` Creates a SslCertificate resource in the specified project using the data included in the request.
`com.google.api.gax.rpc.UnaryCallable<InsertSslCertificateHttpRequest,Operation>`	`insertSslCertificateCallable()` Creates a SslCertificate resource in the specified project using the data included in the request.
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`SslCertificateClient.ListSslCertificatesPagedResponse`	`listSslCertificates(ListSslCertificatesHttpRequest request)` Retrieves the list of SslCertificate resources available to the specified project.
`SslCertificateClient.ListSslCertificatesPagedResponse`	`listSslCertificates(ProjectName project)` Retrieves the list of SslCertificate resources available to the specified project.
`SslCertificateClient.ListSslCertificatesPagedResponse`	`listSslCertificates(String project)` Retrieves the list of SslCertificate resources available to the specified project.
`com.google.api.gax.rpc.UnaryCallable<ListSslCertificatesHttpRequest,SslCertificateList>`	`listSslCertificatesCallable()` Retrieves the list of SslCertificate resources available to the specified project.
`com.google.api.gax.rpc.UnaryCallable<ListSslCertificatesHttpRequest,SslCertificateClient.ListSslCertificatesPagedResponse>`	`listSslCertificatesPagedCallable()` Retrieves the list of SslCertificate resources available to the specified project.
`void`	`shutdown()`
`void`	`shutdownNow()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- SslCertificateClient
```
protected SslCertificateClient(SslCertificateSettings settings)
                        throws IOException
```
  Constructs an instance of SslCertificateClient, 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
- SslCertificateClient
```
@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
protected SslCertificateClient(SslCertificateStub stub)
```

Method Detail

create

public static final SslCertificateClient create()
                                         throws IOException

Constructs an instance of SslCertificateClient with default settings.

Throws:: IOException

create
```
public static final SslCertificateClient create(SslCertificateSettings settings)
                                         throws IOException
```
Constructs an instance of SslCertificateClient, 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 SslCertificateClient create(SslCertificateStub stub)

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

getSettings

public final SslCertificateSettings getSettings()

getStub

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

aggregatedListSslCertificates

@BetaApi
public final SslCertificateClient.AggregatedListSslCertificatesPagedResponse aggregatedListSslCertificates(ProjectName project)

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

Sample code:


 try (SslCertificateClient sslCertificateClient = SslCertificateClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   for (SslCertificatesScopedList element : sslCertificateClient.aggregatedListSslCertificates(project).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: project - Name of the project scoping this request.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

aggregatedListSslCertificates

@BetaApi
public final SslCertificateClient.AggregatedListSslCertificatesPagedResponse aggregatedListSslCertificates(String project)

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

Sample code:


 try (SslCertificateClient sslCertificateClient = SslCertificateClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   for (SslCertificatesScopedList element : sslCertificateClient.aggregatedListSslCertificates(project.toString()).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: project - Name of the project scoping this request.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

aggregatedListSslCertificates

@BetaApi
public final SslCertificateClient.AggregatedListSslCertificatesPagedResponse aggregatedListSslCertificates(AggregatedListSslCertificatesHttpRequest request)

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

Sample code:


 try (SslCertificateClient sslCertificateClient = SslCertificateClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   AggregatedListSslCertificatesHttpRequest request = AggregatedListSslCertificatesHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   for (SslCertificatesScopedList element : sslCertificateClient.aggregatedListSslCertificates(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

aggregatedListSslCertificatesPagedCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<AggregatedListSslCertificatesHttpRequest,SslCertificateClient.AggregatedListSslCertificatesPagedResponse> aggregatedListSslCertificatesPagedCallable()

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

Sample code:


 try (SslCertificateClient sslCertificateClient = SslCertificateClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   AggregatedListSslCertificatesHttpRequest request = AggregatedListSslCertificatesHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   ApiFuture<AggregatedListSslCertificatesPagedResponse> future = sslCertificateClient.aggregatedListSslCertificatesPagedCallable().futureCall(request);
   // Do something
   for (SslCertificatesScopedList element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

aggregatedListSslCertificatesCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<AggregatedListSslCertificatesHttpRequest,SslCertificateAggregatedList> aggregatedListSslCertificatesCallable()

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

Sample code:


 try (SslCertificateClient sslCertificateClient = SslCertificateClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   AggregatedListSslCertificatesHttpRequest request = AggregatedListSslCertificatesHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   while (true) {
     SslCertificateAggregatedList response = sslCertificateClient.aggregatedListSslCertificatesCallable().call(request);
     for (SslCertificatesScopedList element : response.getItemsMap()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

deleteSslCertificate

@BetaApi
public final Operation deleteSslCertificate(ProjectGlobalSslCertificateName sslCertificate)

Deletes the specified SslCertificate resource.

Sample code:


 try (SslCertificateClient sslCertificateClient = SslCertificateClient.create()) {
   ProjectGlobalSslCertificateName sslCertificate = ProjectGlobalSslCertificateName.of("[PROJECT]", "[SSL_CERTIFICATE]");
   Operation response = sslCertificateClient.deleteSslCertificate(sslCertificate);
 }

Parameters:: sslCertificate - Name of the SslCertificate resource to delete.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

deleteSslCertificate

@BetaApi
public final Operation deleteSslCertificate(String sslCertificate)

Deletes the specified SslCertificate resource.

Sample code:


 try (SslCertificateClient sslCertificateClient = SslCertificateClient.create()) {
   ProjectGlobalSslCertificateName sslCertificate = ProjectGlobalSslCertificateName.of("[PROJECT]", "[SSL_CERTIFICATE]");
   Operation response = sslCertificateClient.deleteSslCertificate(sslCertificate.toString());
 }

Parameters:: sslCertificate - Name of the SslCertificate resource to delete.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

deleteSslCertificate

@BetaApi
public final Operation deleteSslCertificate(DeleteSslCertificateHttpRequest request)

Deletes the specified SslCertificate resource.

Sample code:


 try (SslCertificateClient sslCertificateClient = SslCertificateClient.create()) {
   String formattedSslCertificate = ProjectGlobalSslCertificateName.format("[PROJECT]", "[SSL_CERTIFICATE]");
   DeleteSslCertificateHttpRequest request = DeleteSslCertificateHttpRequest.newBuilder()
     .setSslCertificate(formattedSslCertificate)
     .build();
   Operation response = sslCertificateClient.deleteSslCertificate(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

deleteSslCertificateCallable

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

Deletes the specified SslCertificate resource.

Sample code:


 try (SslCertificateClient sslCertificateClient = SslCertificateClient.create()) {
   String formattedSslCertificate = ProjectGlobalSslCertificateName.format("[PROJECT]", "[SSL_CERTIFICATE]");
   DeleteSslCertificateHttpRequest request = DeleteSslCertificateHttpRequest.newBuilder()
     .setSslCertificate(formattedSslCertificate)
     .build();
   ApiFuture<Operation> future = sslCertificateClient.deleteSslCertificateCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }

getSslCertificate

@BetaApi
public final SslCertificate getSslCertificate(ProjectGlobalSslCertificateName sslCertificate)

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

Sample code:


 try (SslCertificateClient sslCertificateClient = SslCertificateClient.create()) {
   ProjectGlobalSslCertificateName sslCertificate = ProjectGlobalSslCertificateName.of("[PROJECT]", "[SSL_CERTIFICATE]");
   SslCertificate response = sslCertificateClient.getSslCertificate(sslCertificate);
 }

Parameters:: sslCertificate - Name of the SslCertificate resource to return.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getSslCertificate

@BetaApi
public final SslCertificate getSslCertificate(String sslCertificate)

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

Sample code:


 try (SslCertificateClient sslCertificateClient = SslCertificateClient.create()) {
   ProjectGlobalSslCertificateName sslCertificate = ProjectGlobalSslCertificateName.of("[PROJECT]", "[SSL_CERTIFICATE]");
   SslCertificate response = sslCertificateClient.getSslCertificate(sslCertificate.toString());
 }

Parameters:: sslCertificate - Name of the SslCertificate resource to return.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getSslCertificate

@BetaApi
public final SslCertificate getSslCertificate(GetSslCertificateHttpRequest request)

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

Sample code:


 try (SslCertificateClient sslCertificateClient = SslCertificateClient.create()) {
   String formattedSslCertificate = ProjectGlobalSslCertificateName.format("[PROJECT]", "[SSL_CERTIFICATE]");
   GetSslCertificateHttpRequest request = GetSslCertificateHttpRequest.newBuilder()
     .setSslCertificate(formattedSslCertificate)
     .build();
   SslCertificate response = sslCertificateClient.getSslCertificate(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

getSslCertificateCallable

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

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

Sample code:


 try (SslCertificateClient sslCertificateClient = SslCertificateClient.create()) {
   String formattedSslCertificate = ProjectGlobalSslCertificateName.format("[PROJECT]", "[SSL_CERTIFICATE]");
   GetSslCertificateHttpRequest request = GetSslCertificateHttpRequest.newBuilder()
     .setSslCertificate(formattedSslCertificate)
     .build();
   ApiFuture<SslCertificate> future = sslCertificateClient.getSslCertificateCallable().futureCall(request);
   // Do something
   SslCertificate response = future.get();
 }

insertSslCertificate
```
@BetaApi
public final Operation insertSslCertificate(ProjectName project,
                                                     SslCertificate sslCertificateResource)
```
Creates a SslCertificate resource in the specified project using the data included in the request.
Sample code:
```
 try (SslCertificateClient sslCertificateClient = SslCertificateClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   SslCertificate sslCertificateResource = SslCertificate.newBuilder().build();
   Operation response = sslCertificateClient.insertSslCertificate(project, sslCertificateResource);
 }
 
```
Parameters:

project - Project ID for 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

insertSslCertificate
```
@BetaApi
public final Operation insertSslCertificate(String project,
                                                     SslCertificate sslCertificateResource)
```
Creates a SslCertificate resource in the specified project using the data included in the request.
Sample code:
```
 try (SslCertificateClient sslCertificateClient = SslCertificateClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   SslCertificate sslCertificateResource = SslCertificate.newBuilder().build();
   Operation response = sslCertificateClient.insertSslCertificate(project.toString(), sslCertificateResource);
 }
 
```
Parameters:

project - Project ID for 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

insertSslCertificate

@BetaApi
public final Operation insertSslCertificate(InsertSslCertificateHttpRequest request)

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

Sample code:


 try (SslCertificateClient sslCertificateClient = SslCertificateClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   SslCertificate sslCertificateResource = SslCertificate.newBuilder().build();
   InsertSslCertificateHttpRequest request = InsertSslCertificateHttpRequest.newBuilder()
     .setProject(formattedProject)
     .setSslCertificateResource(sslCertificateResource)
     .build();
   Operation response = sslCertificateClient.insertSslCertificate(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

insertSslCertificateCallable

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

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

Sample code:


 try (SslCertificateClient sslCertificateClient = SslCertificateClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   SslCertificate sslCertificateResource = SslCertificate.newBuilder().build();
   InsertSslCertificateHttpRequest request = InsertSslCertificateHttpRequest.newBuilder()
     .setProject(formattedProject)
     .setSslCertificateResource(sslCertificateResource)
     .build();
   ApiFuture<Operation> future = sslCertificateClient.insertSslCertificateCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }