Class SslPoliciesClient (1.62.0)

GitHub RepositoryProduct Reference

Service Description: The SslPolicies 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 (SslPoliciesClient sslPoliciesClient = SslPoliciesClient.create()) {
   String project = "project-309310695";
   String sslPolicy = "sslPolicy618174046";
   SslPolicy response = sslPoliciesClient.get(project, sslPolicy);
 }

Note: close() needs to be called on the SslPoliciesClient 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 SslPolicy 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(AggregatedListSslPoliciesRequest 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 SSL policy. The SSL policy resource can be deleted only if it is not in use by any TargetHttpsProxy or TargetSslProxy resources.

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

  • deleteAsync(DeleteSslPolicyRequest 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 sslPolicy)

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

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

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

  • get(GetSslPolicyRequest 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 sslPolicy)

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

Returns the specified SSL policy resource.

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

  • insertAsync(InsertSslPolicyRequest 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, SslPolicy sslPolicyResource)

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

Lists all the SSL policies that have been configured for the specified project.

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

  • list(ListSslPoliciesRequest 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()

ListAvailableFeatures

Lists all features that can be specified in the SSL policy when using custom profile.

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

  • listAvailableFeatures(ListAvailableFeaturesSslPoliciesRequest request)

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

  • listAvailableFeatures(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.

  • listAvailableFeaturesCallable()

Patch

Patches the specified SSL policy with the data included in the request.

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

  • patchAsync(PatchSslPolicyRequest request)

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

  • patchAsync(String project, String sslPolicy, SslPolicy sslPolicyResource)

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

  • patchOperationCallable()

  • patchCallable()

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 SslPoliciesSettings 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
 SslPoliciesSettings sslPoliciesSettings =
     SslPoliciesSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 SslPoliciesClient sslPoliciesClient = SslPoliciesClient.create(sslPoliciesSettings);

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
 SslPoliciesSettings sslPoliciesSettings =
     SslPoliciesSettings.newBuilder().setEndpoint(myEndpoint).build();
 SslPoliciesClient sslPoliciesClient = SslPoliciesClient.create(sslPoliciesSettings);

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

Inheritance

java.lang.Object > SslPoliciesClient

Static Methods

create()

public static final SslPoliciesClient create()

Constructs an instance of SslPoliciesClient with default settings.

Returns
Type Description
SslPoliciesClient
Exceptions
Type Description
IOException

create(SslPoliciesSettings settings)

public static final SslPoliciesClient create(SslPoliciesSettings settings)

Constructs an instance of SslPoliciesClient, 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 SslPoliciesSettings
Returns
Type Description
SslPoliciesClient
Exceptions
Type Description
IOException

create(SslPoliciesStub stub)

public static final SslPoliciesClient create(SslPoliciesStub stub)

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

Parameter
Name Description
stub SslPoliciesStub
Returns
Type Description
SslPoliciesClient

Constructors

SslPoliciesClient(SslPoliciesSettings settings)

protected SslPoliciesClient(SslPoliciesSettings settings)

Constructs an instance of SslPoliciesClient, 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 SslPoliciesSettings

SslPoliciesClient(SslPoliciesStub stub)

protected SslPoliciesClient(SslPoliciesStub stub)
Parameter
Name Description
stub SslPoliciesStub

Methods

aggregatedList(AggregatedListSslPoliciesRequest request)

public final SslPoliciesClient.AggregatedListPagedResponse aggregatedList(AggregatedListSslPoliciesRequest request)

Retrieves the list of all SslPolicy 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 (SslPoliciesClient sslPoliciesClient = SslPoliciesClient.create()) {
   AggregatedListSslPoliciesRequest request =
       AggregatedListSslPoliciesRequest.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, SslPoliciesScopedList> element :
       sslPoliciesClient.aggregatedList(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request AggregatedListSslPoliciesRequest

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

aggregatedList(String project)

public final SslPoliciesClient.AggregatedListPagedResponse aggregatedList(String project)

Retrieves the list of all SslPolicy 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 (SslPoliciesClient sslPoliciesClient = SslPoliciesClient.create()) {
   String project = "project-309310695";
   for (Map.Entry<String, SslPoliciesScopedList> element :
       sslPoliciesClient.aggregatedList(project).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
project String

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

aggregatedListCallable()

public final UnaryCallable<AggregatedListSslPoliciesRequest,SslPoliciesAggregatedList> aggregatedListCallable()

Retrieves the list of all SslPolicy 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 (SslPoliciesClient sslPoliciesClient = SslPoliciesClient.create()) {
   AggregatedListSslPoliciesRequest request =
       AggregatedListSslPoliciesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setIncludeAllScopes(true)
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .setServiceProjectNumber(-1293855239)
           .build();
   while (true) {
     SslPoliciesAggregatedList response =
         sslPoliciesClient.aggregatedListCallable().call(request);
     for (Map.Entry<String, SslPoliciesScopedList> 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<AggregatedListSslPoliciesRequest,SslPoliciesAggregatedList>

aggregatedListPagedCallable()

public final UnaryCallable<AggregatedListSslPoliciesRequest,SslPoliciesClient.AggregatedListPagedResponse> aggregatedListPagedCallable()

Retrieves the list of all SslPolicy 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 (SslPoliciesClient sslPoliciesClient = SslPoliciesClient.create()) {
   AggregatedListSslPoliciesRequest request =
       AggregatedListSslPoliciesRequest.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, SslPoliciesScopedList>> future =
       sslPoliciesClient.aggregatedListPagedCallable().futureCall(request);
   // Do something.
   for (Map.Entry<String, SslPoliciesScopedList> element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<AggregatedListSslPoliciesRequest,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(DeleteSslPolicyRequest request)

public final OperationFuture<Operation,Operation> deleteAsync(DeleteSslPolicyRequest 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:


 // 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 (SslPoliciesClient sslPoliciesClient = SslPoliciesClient.create()) {
   DeleteSslPolicyRequest request =
       DeleteSslPolicyRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setSslPolicy("sslPolicy618174046")
           .build();
   Operation response = sslPoliciesClient.deleteAsync(request).get();
 }
Parameter
Name Description
request DeleteSslPolicyRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<Operation,Operation>

deleteAsync(String project, String sslPolicy)

public final OperationFuture<Operation,Operation> deleteAsync(String project, 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:


 // 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 (SslPoliciesClient sslPoliciesClient = SslPoliciesClient.create()) {
   String project = "project-309310695";
   String sslPolicy = "sslPolicy618174046";
   Operation response = sslPoliciesClient.deleteAsync(project, sslPolicy).get();
 }
Parameters
Name Description
project String

Project ID for this request.
sslPolicy String

Name of the SSL policy to delete. The name must be 1-63 characters long, and comply with RFC1035.
Returns
Type Description
OperationFuture<Operation,Operation>

deleteCallable()

public final UnaryCallable<DeleteSslPolicyRequest,Operation> deleteCallable()

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:


 // 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 (SslPoliciesClient sslPoliciesClient = SslPoliciesClient.create()) {
   DeleteSslPolicyRequest request =
       DeleteSslPolicyRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setSslPolicy("sslPolicy618174046")
           .build();
   ApiFuture<Operation> future = sslPoliciesClient.deleteCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<DeleteSslPolicyRequest,Operation>

deleteOperationCallable()

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

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:


 // 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 (SslPoliciesClient sslPoliciesClient = SslPoliciesClient.create()) {
   DeleteSslPolicyRequest request =
       DeleteSslPolicyRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setSslPolicy("sslPolicy618174046")
           .build();
   OperationFuture<Operation, Operation> future =
       sslPoliciesClient.deleteOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
OperationCallable<DeleteSslPolicyRequest,Operation,Operation>

get(GetSslPolicyRequest request)

public final SslPolicy get(GetSslPolicyRequest request)

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

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 (SslPoliciesClient sslPoliciesClient = SslPoliciesClient.create()) {
   GetSslPolicyRequest request =
       GetSslPolicyRequest.newBuilder()
           .setProject("project-309310695")
           .setSslPolicy("sslPolicy618174046")
           .build();
   SslPolicy response = sslPoliciesClient.get(request);
 }
Parameter
Name Description
request GetSslPolicyRequest

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

get(String project, String sslPolicy)

public final SslPolicy get(String project, String sslPolicy)

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

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 (SslPoliciesClient sslPoliciesClient = SslPoliciesClient.create()) {
   String project = "project-309310695";
   String sslPolicy = "sslPolicy618174046";
   SslPolicy response = sslPoliciesClient.get(project, sslPolicy);
 }
Parameters
Name Description
project String

Project ID for this request.
sslPolicy String

Name of the SSL policy to update. The name must be 1-63 characters long, and comply with RFC1035.
Returns
Type Description
SslPolicy

getCallable()

public final UnaryCallable<GetSslPolicyRequest,SslPolicy> getCallable()

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

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 (SslPoliciesClient sslPoliciesClient = SslPoliciesClient.create()) {
   GetSslPolicyRequest request =
       GetSslPolicyRequest.newBuilder()
           .setProject("project-309310695")
           .setSslPolicy("sslPolicy618174046")
           .build();
   ApiFuture<SslPolicy> future = sslPoliciesClient.getCallable().futureCall(request);
   // Do something.
   SslPolicy response = future.get();
 }
Returns
Type Description
UnaryCallable<GetSslPolicyRequest,SslPolicy>

getSettings()

public final SslPoliciesSettings getSettings()
Returns
Type Description
SslPoliciesSettings

getStub()

public SslPoliciesStub getStub()
Returns
Type Description
SslPoliciesStub

insertAsync(InsertSslPolicyRequest request)

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

Returns the specified SSL policy 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 (SslPoliciesClient sslPoliciesClient = SslPoliciesClient.create()) {
   InsertSslPolicyRequest request =
       InsertSslPolicyRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setSslPolicyResource(SslPolicy.newBuilder().build())
           .build();
   Operation response = sslPoliciesClient.insertAsync(request).get();
 }
Parameter
Name Description
request InsertSslPolicyRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<Operation,Operation>

insertAsync(String project, SslPolicy sslPolicyResource)

public final OperationFuture<Operation,Operation> insertAsync(String project, SslPolicy sslPolicyResource)

Returns the specified SSL policy 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 (SslPoliciesClient sslPoliciesClient = SslPoliciesClient.create()) {
   String project = "project-309310695";
   SslPolicy sslPolicyResource = SslPolicy.newBuilder().build();
   Operation response = sslPoliciesClient.insertAsync(project, sslPolicyResource).get();
 }
Parameters
Name Description
project String

Project ID for this request.
sslPolicyResource SslPolicy

The body resource for this request
Returns
Type Description
OperationFuture<Operation,Operation>

insertCallable()

public final UnaryCallable<InsertSslPolicyRequest,Operation> insertCallable()

Returns the specified SSL policy 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 (SslPoliciesClient sslPoliciesClient = SslPoliciesClient.create()) {
   InsertSslPolicyRequest request =
       InsertSslPolicyRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setSslPolicyResource(SslPolicy.newBuilder().build())
           .build();
   ApiFuture<Operation> future = sslPoliciesClient.insertCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<InsertSslPolicyRequest,Operation>

insertOperationCallable()

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

Returns the specified SSL policy 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 (SslPoliciesClient sslPoliciesClient = SslPoliciesClient.create()) {
   InsertSslPolicyRequest request =
       InsertSslPolicyRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setSslPolicyResource(SslPolicy.newBuilder().build())
           .build();
   OperationFuture<Operation, Operation> future =
       sslPoliciesClient.insertOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
OperationCallable<InsertSslPolicyRequest,Operation,Operation>

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

list(ListSslPoliciesRequest request)

public final SslPoliciesClient.ListPagedResponse list(ListSslPoliciesRequest request)

Lists all the SSL policies that have been configured for 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 (SslPoliciesClient sslPoliciesClient = SslPoliciesClient.create()) {
   ListSslPoliciesRequest request =
       ListSslPoliciesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   for (SslPolicy element : sslPoliciesClient.list(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request ListSslPoliciesRequest

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

list(String project)

public final SslPoliciesClient.ListPagedResponse list(String project)

Lists all the SSL policies that have been configured for 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 (SslPoliciesClient sslPoliciesClient = SslPoliciesClient.create()) {
   String project = "project-309310695";
   for (SslPolicy element : sslPoliciesClient.list(project).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
project String

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

listAvailableFeatures(ListAvailableFeaturesSslPoliciesRequest request)

public final SslPoliciesListAvailableFeaturesResponse listAvailableFeatures(ListAvailableFeaturesSslPoliciesRequest request)

Lists all features that can be specified in the SSL policy when using custom profile.

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 (SslPoliciesClient sslPoliciesClient = SslPoliciesClient.create()) {
   ListAvailableFeaturesSslPoliciesRequest request =
       ListAvailableFeaturesSslPoliciesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   SslPoliciesListAvailableFeaturesResponse response =
       sslPoliciesClient.listAvailableFeatures(request);
 }
Parameter
Name Description
request ListAvailableFeaturesSslPoliciesRequest

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

listAvailableFeatures(String project)

public final SslPoliciesListAvailableFeaturesResponse listAvailableFeatures(String project)

Lists all features that can be specified in the SSL policy when using custom profile.

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 (SslPoliciesClient sslPoliciesClient = SslPoliciesClient.create()) {
   String project = "project-309310695";
   SslPoliciesListAvailableFeaturesResponse response =
       sslPoliciesClient.listAvailableFeatures(project);
 }
Parameter
Name Description
project String

Project ID for this request.
Returns
Type Description
SslPoliciesListAvailableFeaturesResponse

listAvailableFeaturesCallable()

public final UnaryCallable<ListAvailableFeaturesSslPoliciesRequest,SslPoliciesListAvailableFeaturesResponse> listAvailableFeaturesCallable()

Lists all features that can be specified in the SSL policy when using custom profile.

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 (SslPoliciesClient sslPoliciesClient = SslPoliciesClient.create()) {
   ListAvailableFeaturesSslPoliciesRequest request =
       ListAvailableFeaturesSslPoliciesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   ApiFuture<SslPoliciesListAvailableFeaturesResponse> future =
       sslPoliciesClient.listAvailableFeaturesCallable().futureCall(request);
   // Do something.
   SslPoliciesListAvailableFeaturesResponse response = future.get();
 }
Returns
Type Description
UnaryCallable<ListAvailableFeaturesSslPoliciesRequest,SslPoliciesListAvailableFeaturesResponse>

listCallable()

public final UnaryCallable<ListSslPoliciesRequest,SslPoliciesList> listCallable()

Lists all the SSL policies that have been configured for 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 (SslPoliciesClient sslPoliciesClient = SslPoliciesClient.create()) {
   ListSslPoliciesRequest request =
       ListSslPoliciesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   while (true) {
     SslPoliciesList response = sslPoliciesClient.listCallable().call(request);
     for (SslPolicy 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<ListSslPoliciesRequest,SslPoliciesList>

listPagedCallable()

public final UnaryCallable<ListSslPoliciesRequest,SslPoliciesClient.ListPagedResponse> listPagedCallable()

Lists all the SSL policies that have been configured for 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 (SslPoliciesClient sslPoliciesClient = SslPoliciesClient.create()) {
   ListSslPoliciesRequest request =
       ListSslPoliciesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   ApiFuture<SslPolicy> future = sslPoliciesClient.listPagedCallable().futureCall(request);
   // Do something.
   for (SslPolicy element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListSslPoliciesRequest,ListPagedResponse>

patchAsync(PatchSslPolicyRequest request)

public final OperationFuture<Operation,Operation> patchAsync(PatchSslPolicyRequest request)

Patches the specified SSL policy with 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 (SslPoliciesClient sslPoliciesClient = SslPoliciesClient.create()) {
   PatchSslPolicyRequest request =
       PatchSslPolicyRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setSslPolicy("sslPolicy618174046")
           .setSslPolicyResource(SslPolicy.newBuilder().build())
           .build();
   Operation response = sslPoliciesClient.patchAsync(request).get();
 }
Parameter
Name Description
request PatchSslPolicyRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<Operation,Operation>

patchAsync(String project, String sslPolicy, SslPolicy sslPolicyResource)

public final OperationFuture<Operation,Operation> patchAsync(String project, String sslPolicy, SslPolicy sslPolicyResource)

Patches the specified SSL policy with 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 (SslPoliciesClient sslPoliciesClient = SslPoliciesClient.create()) {
   String project = "project-309310695";
   String sslPolicy = "sslPolicy618174046";
   SslPolicy sslPolicyResource = SslPolicy.newBuilder().build();
   Operation response =
       sslPoliciesClient.patchAsync(project, sslPolicy, sslPolicyResource).get();
 }
Parameters
Name Description
project String

Project ID for this request.
sslPolicy String

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

The body resource for this request
Returns
Type Description
OperationFuture<Operation,Operation>

patchCallable()

public final UnaryCallable<PatchSslPolicyRequest,Operation> patchCallable()

Patches the specified SSL policy with 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 (SslPoliciesClient sslPoliciesClient = SslPoliciesClient.create()) {
   PatchSslPolicyRequest request =
       PatchSslPolicyRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setSslPolicy("sslPolicy618174046")
           .setSslPolicyResource(SslPolicy.newBuilder().build())
           .build();
   ApiFuture<Operation> future = sslPoliciesClient.patchCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<PatchSslPolicyRequest,Operation>

patchOperationCallable()

public final OperationCallable<PatchSslPolicyRequest,Operation,Operation> patchOperationCallable()

Patches the specified SSL policy with 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 (SslPoliciesClient sslPoliciesClient = SslPoliciesClient.create()) {
   PatchSslPolicyRequest request =
       PatchSslPolicyRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setSslPolicy("sslPolicy618174046")
           .setSslPolicyResource(SslPolicy.newBuilder().build())
           .build();
   OperationFuture<Operation, Operation> future =
       sslPoliciesClient.patchOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
OperationCallable<PatchSslPolicyRequest,Operation,Operation>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()