SslPolicyClient (Google Cloud 0.89.0-alpha API)

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

All Implemented Interfaces:

BackgroundResource, AutoCloseable
```
@Generated(value="by gapic-generator")
 @BetaApi
public class SslPolicyClient
extends Object
implements 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 (SslPolicyClient sslPolicyClient = SslPolicyClient.create()) {
   ProjectGlobalSslPolicyName sslPolicy = ProjectGlobalSslPolicyName.of("[PROJECT]", "[SSL_POLICY]");
   Operation response = sslPolicyClient.deleteSslPolicy(sslPolicy);
 }
 
 
```
Note: close() needs to be called on the sslPolicyClient 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 SslPolicySettings to create(). For example:
To customize credentials:
```
 
 SslPolicySettings sslPolicySettings =
     SslPolicySettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 SslPolicyClient sslPolicyClient =
     SslPolicyClient.create(sslPolicySettings);
 
 
```
To customize the endpoint:
```
 
 SslPolicySettings sslPolicySettings =
     SslPolicySettings.newBuilder().setEndpoint(myEndpoint).build();
 SslPolicyClient sslPolicyClient =
     SslPolicyClient.create(sslPolicySettings);
 
 
```

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`SslPolicyClient.ListSslPoliciesFixedSizeCollection`
`static class`	`SslPolicyClient.ListSslPoliciesPage`
`static class`	`SslPolicyClient.ListSslPoliciesPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`SslPolicyClient(SslPolicySettings settings)` Constructs an instance of SslPolicyClient, using the given settings.
`protected`	`SslPolicyClient(SslPolicyStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`void`	`close()`
`static SslPolicyClient`	`create()` Constructs an instance of SslPolicyClient with default settings.
`static SslPolicyClient`	`create(SslPolicySettings settings)` Constructs an instance of SslPolicyClient, using the given settings.
`static SslPolicyClient`	`create(SslPolicyStub stub)` Constructs an instance of SslPolicyClient, using the given stub for making calls.
`Operation`	`deleteSslPolicy(DeleteSslPolicyHttpRequest request)` Deletes the specified SSL policy.
`Operation`	`deleteSslPolicy(ProjectGlobalSslPolicyName sslPolicy)` Deletes the specified SSL policy.
`Operation`	`deleteSslPolicy(String sslPolicy)` Deletes the specified SSL policy.
`UnaryCallable<DeleteSslPolicyHttpRequest,Operation>`	`deleteSslPolicyCallable()` Deletes the specified SSL policy.
`SslPolicySettings`	`getSettings()`
`SslPolicy`	`getSslPolicy(GetSslPolicyHttpRequest request)` Lists all of the ordered rules present in a single specified policy.
`SslPolicy`	`getSslPolicy(ProjectGlobalSslPolicyName sslPolicy)` Lists all of the ordered rules present in a single specified policy.
`SslPolicy`	`getSslPolicy(String sslPolicy)` Lists all of the ordered rules present in a single specified policy.
`UnaryCallable<GetSslPolicyHttpRequest,SslPolicy>`	`getSslPolicyCallable()` Lists all of the ordered rules present in a single specified policy.
`SslPolicyStub`	`getStub()`
`Operation`	`insertSslPolicy(InsertSslPolicyHttpRequest request)` Returns the specified SSL policy resource.
`Operation`	`insertSslPolicy(ProjectName project, SslPolicy sslPolicyResource)` Returns the specified SSL policy resource.
`Operation`	`insertSslPolicy(String project, SslPolicy sslPolicyResource)` Returns the specified SSL policy resource.
`UnaryCallable<InsertSslPolicyHttpRequest,Operation>`	`insertSslPolicyCallable()` Returns the specified SSL policy resource.
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`SslPoliciesListAvailableFeaturesResponse`	`listAvailableFeaturesSslPolicies(ListAvailableFeaturesSslPoliciesHttpRequest request)` Lists all features that can be specified in the SSL policy when using custom profile.
`SslPoliciesListAvailableFeaturesResponse`	`listAvailableFeaturesSslPolicies(ProjectName project)` Lists all features that can be specified in the SSL policy when using custom profile.
`SslPoliciesListAvailableFeaturesResponse`	`listAvailableFeaturesSslPolicies(String project)` Lists all features that can be specified in the SSL policy when using custom profile.
`UnaryCallable<ListAvailableFeaturesSslPoliciesHttpRequest,SslPoliciesListAvailableFeaturesResponse>`	`listAvailableFeaturesSslPoliciesCallable()` Lists all features that can be specified in the SSL policy when using custom profile.
`SslPolicyClient.ListSslPoliciesPagedResponse`	`listSslPolicies(ListSslPoliciesHttpRequest request)` Lists all the SSL policies that have been configured for the specified project.
`SslPolicyClient.ListSslPoliciesPagedResponse`	`listSslPolicies(ProjectName project)` Lists all the SSL policies that have been configured for the specified project.
`SslPolicyClient.ListSslPoliciesPagedResponse`	`listSslPolicies(String project)` Lists all the SSL policies that have been configured for the specified project.
`UnaryCallable<ListSslPoliciesHttpRequest,SslPoliciesList>`	`listSslPoliciesCallable()` Lists all the SSL policies that have been configured for the specified project.
`UnaryCallable<ListSslPoliciesHttpRequest,SslPolicyClient.ListSslPoliciesPagedResponse>`	`listSslPoliciesPagedCallable()` Lists all the SSL policies that have been configured for the specified project.
`Operation`	`patchSslPolicy(PatchSslPolicyHttpRequest request)` Patches the specified SSL policy with the data included in the request.
`Operation`	`patchSslPolicy(ProjectGlobalSslPolicyName sslPolicy, SslPolicy sslPolicyResource, List<String> fieldMask)` Patches the specified SSL policy with the data included in the request.
`Operation`	`patchSslPolicy(String sslPolicy, SslPolicy sslPolicyResource, List<String> fieldMask)` Patches the specified SSL policy with the data included in the request.
`UnaryCallable<PatchSslPolicyHttpRequest,Operation>`	`patchSslPolicyCallable()` Patches the specified SSL policy with the data included in the request.
`void`	`shutdown()`
`void`	`shutdownNow()`

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

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

Method Detail

create

public static final SslPolicyClient create()
                                    throws IOException

Constructs an instance of SslPolicyClient with default settings.

Throws:: IOException

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

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

getSettings

public final SslPolicySettings getSettings()

getStub

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

deleteSslPolicy
```
@BetaApi
public final Operation deleteSslPolicy(ProjectGlobalSslPolicyName sslPolicy)
```
Deletes the specified SSL policy. The SSL policy resource can be deleted only if it is not in use by any TargetHttpsProxy or TargetSslProxy resources.
Sample code:
```
 try (SslPolicyClient sslPolicyClient = SslPolicyClient.create()) {
   ProjectGlobalSslPolicyName sslPolicy = ProjectGlobalSslPolicyName.of("[PROJECT]", "[SSL_POLICY]");
   Operation response = sslPolicyClient.deleteSslPolicy(sslPolicy);
 }
 
```
Parameters:

sslPolicy - Name of the SSL policy to delete. The name must be 1-63 characters long, and comply with RFC1035.

Throws:

ApiException - if the remote call fails

deleteSslPolicy
```
@BetaApi
public final Operation deleteSslPolicy(String sslPolicy)
```
Deletes the specified SSL policy. The SSL policy resource can be deleted only if it is not in use by any TargetHttpsProxy or TargetSslProxy resources.
Sample code:
```
 try (SslPolicyClient sslPolicyClient = SslPolicyClient.create()) {
   ProjectGlobalSslPolicyName sslPolicy = ProjectGlobalSslPolicyName.of("[PROJECT]", "[SSL_POLICY]");
   Operation response = sslPolicyClient.deleteSslPolicy(sslPolicy.toString());
 }
 
```
Parameters:

sslPolicy - Name of the SSL policy to delete. The name must be 1-63 characters long, and comply with RFC1035.

Throws:

ApiException - if the remote call fails

deleteSslPolicy

@BetaApi
public final Operation deleteSslPolicy(DeleteSslPolicyHttpRequest request)

Deletes the specified SSL policy. The SSL policy resource can be deleted only if it is not in use by any TargetHttpsProxy or TargetSslProxy resources.

Sample code:


 try (SslPolicyClient sslPolicyClient = SslPolicyClient.create()) {
   String formattedSslPolicy = ProjectGlobalSslPolicyName.format("[PROJECT]", "[SSL_POLICY]");
   DeleteSslPolicyHttpRequest request = DeleteSslPolicyHttpRequest.newBuilder()
     .setSslPolicy(formattedSslPolicy)
     .build();
   Operation response = sslPolicyClient.deleteSslPolicy(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: ApiException - if the remote call fails

deleteSslPolicyCallable

@BetaApi
public final UnaryCallable<DeleteSslPolicyHttpRequest,Operation> deleteSslPolicyCallable()

Deletes the specified SSL policy. The SSL policy resource can be deleted only if it is not in use by any TargetHttpsProxy or TargetSslProxy resources.

Sample code:


 try (SslPolicyClient sslPolicyClient = SslPolicyClient.create()) {
   String formattedSslPolicy = ProjectGlobalSslPolicyName.format("[PROJECT]", "[SSL_POLICY]");
   DeleteSslPolicyHttpRequest request = DeleteSslPolicyHttpRequest.newBuilder()
     .setSslPolicy(formattedSslPolicy)
     .build();
   ApiFuture<Operation> future = sslPolicyClient.deleteSslPolicyCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }

getSslPolicy

@BetaApi
public final SslPolicy getSslPolicy(ProjectGlobalSslPolicyName sslPolicy)

Lists all of the ordered rules present in a single specified policy.

Sample code:


 try (SslPolicyClient sslPolicyClient = SslPolicyClient.create()) {
   ProjectGlobalSslPolicyName sslPolicy = ProjectGlobalSslPolicyName.of("[PROJECT]", "[SSL_POLICY]");
   SslPolicy response = sslPolicyClient.getSslPolicy(sslPolicy);
 }

Parameters:: sslPolicy - Name of the SSL policy to update. The name must be 1-63 characters long, and comply with RFC1035.
Throws:: ApiException - if the remote call fails

getSslPolicy

@BetaApi
public final SslPolicy getSslPolicy(String sslPolicy)

Lists all of the ordered rules present in a single specified policy.

Sample code:


 try (SslPolicyClient sslPolicyClient = SslPolicyClient.create()) {
   ProjectGlobalSslPolicyName sslPolicy = ProjectGlobalSslPolicyName.of("[PROJECT]", "[SSL_POLICY]");
   SslPolicy response = sslPolicyClient.getSslPolicy(sslPolicy.toString());
 }

Parameters:: sslPolicy - Name of the SSL policy to update. The name must be 1-63 characters long, and comply with RFC1035.
Throws:: ApiException - if the remote call fails

getSslPolicy

@BetaApi
public final SslPolicy getSslPolicy(GetSslPolicyHttpRequest request)

Lists all of the ordered rules present in a single specified policy.

Sample code:


 try (SslPolicyClient sslPolicyClient = SslPolicyClient.create()) {
   String formattedSslPolicy = ProjectGlobalSslPolicyName.format("[PROJECT]", "[SSL_POLICY]");
   GetSslPolicyHttpRequest request = GetSslPolicyHttpRequest.newBuilder()
     .setSslPolicy(formattedSslPolicy)
     .build();
   SslPolicy response = sslPolicyClient.getSslPolicy(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: ApiException - if the remote call fails

getSslPolicyCallable

@BetaApi
public final UnaryCallable<GetSslPolicyHttpRequest,SslPolicy> getSslPolicyCallable()

Lists all of the ordered rules present in a single specified policy.

Sample code:


 try (SslPolicyClient sslPolicyClient = SslPolicyClient.create()) {
   String formattedSslPolicy = ProjectGlobalSslPolicyName.format("[PROJECT]", "[SSL_POLICY]");
   GetSslPolicyHttpRequest request = GetSslPolicyHttpRequest.newBuilder()
     .setSslPolicy(formattedSslPolicy)
     .build();
   ApiFuture<SslPolicy> future = sslPolicyClient.getSslPolicyCallable().futureCall(request);
   // Do something
   SslPolicy response = future.get();
 }

insertSslPolicy
```
@BetaApi
public final Operation insertSslPolicy(ProjectName project,
                                                SslPolicy sslPolicyResource)
```
Returns the specified SSL policy resource. Gets a list of available SSL policies by making a list() request.
Sample code:
```
 try (SslPolicyClient sslPolicyClient = SslPolicyClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   SslPolicy sslPolicyResource = SslPolicy.newBuilder().build();
   Operation response = sslPolicyClient.insertSslPolicy(project, sslPolicyResource);
 }
 
```
Parameters:

project - Project ID for this request.

sslPolicyResource - A SSL policy specifies the server-side support for SSL features. This can be attached to a TargetHttpsProxy or a TargetSslProxy. This affects connections between clients and the HTTPS or SSL proxy load balancer. They do not affect the connection between the load balancers and the backends.

Throws:

ApiException - if the remote call fails

insertSslPolicy
```
@BetaApi
public final Operation insertSslPolicy(String project,
                                                SslPolicy sslPolicyResource)
```
Returns the specified SSL policy resource. Gets a list of available SSL policies by making a list() request.
Sample code:
```
 try (SslPolicyClient sslPolicyClient = SslPolicyClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   SslPolicy sslPolicyResource = SslPolicy.newBuilder().build();
   Operation response = sslPolicyClient.insertSslPolicy(project.toString(), sslPolicyResource);
 }
 
```
Parameters:

project - Project ID for this request.

sslPolicyResource - A SSL policy specifies the server-side support for SSL features. This can be attached to a TargetHttpsProxy or a TargetSslProxy. This affects connections between clients and the HTTPS or SSL proxy load balancer. They do not affect the connection between the load balancers and the backends.

Throws:

ApiException - if the remote call fails

insertSslPolicy

@BetaApi
public final Operation insertSslPolicy(InsertSslPolicyHttpRequest request)

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

Sample code:


 try (SslPolicyClient sslPolicyClient = SslPolicyClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   SslPolicy sslPolicyResource = SslPolicy.newBuilder().build();
   InsertSslPolicyHttpRequest request = InsertSslPolicyHttpRequest.newBuilder()
     .setProject(formattedProject)
     .setSslPolicyResource(sslPolicyResource)
     .build();
   Operation response = sslPolicyClient.insertSslPolicy(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: ApiException - if the remote call fails

insertSslPolicyCallable

@BetaApi
public final UnaryCallable<InsertSslPolicyHttpRequest,Operation> insertSslPolicyCallable()

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

Sample code:


 try (SslPolicyClient sslPolicyClient = SslPolicyClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   SslPolicy sslPolicyResource = SslPolicy.newBuilder().build();
   InsertSslPolicyHttpRequest request = InsertSslPolicyHttpRequest.newBuilder()
     .setProject(formattedProject)
     .setSslPolicyResource(sslPolicyResource)
     .build();
   ApiFuture<Operation> future = sslPolicyClient.insertSslPolicyCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }