Class SnapshotSettingsServiceClient (1.56.0)

GitHub RepositoryProduct Reference

Service Description: The SnapshotSettings 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 (SnapshotSettingsServiceClient snapshotSettingsServiceClient =
     SnapshotSettingsServiceClient.create()) {
   String project = "project-309310695";
   SnapshotSettings response = snapshotSettingsServiceClient.get(project);
 }

Note: close() needs to be called on the SnapshotSettingsServiceClient 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

Get

Get snapshot settings.

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

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

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

  • getCallable()

Patch

Patch snapshot settings.

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

  • patchAsync(PatchSnapshotSettingRequest 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, SnapshotSettings snapshotSettingsResource)

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 SnapshotSettingsServiceSettings 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
 SnapshotSettingsServiceSettings snapshotSettingsServiceSettings =
     SnapshotSettingsServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 SnapshotSettingsServiceClient snapshotSettingsServiceClient =
     SnapshotSettingsServiceClient.create(snapshotSettingsServiceSettings);

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
 SnapshotSettingsServiceSettings snapshotSettingsServiceSettings =
     SnapshotSettingsServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 SnapshotSettingsServiceClient snapshotSettingsServiceClient =
     SnapshotSettingsServiceClient.create(snapshotSettingsServiceSettings);

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

Inheritance

java.lang.Object > SnapshotSettingsServiceClient

Static Methods

create()

public static final SnapshotSettingsServiceClient create()

Constructs an instance of SnapshotSettingsServiceClient with default settings.

Returns
Type Description
SnapshotSettingsServiceClient
Exceptions
Type Description
IOException

create(SnapshotSettingsServiceSettings settings)

public static final SnapshotSettingsServiceClient create(SnapshotSettingsServiceSettings settings)

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

create(SnapshotSettingsServiceStub stub)

public static final SnapshotSettingsServiceClient create(SnapshotSettingsServiceStub stub)

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

Parameter
Name Description
stub SnapshotSettingsServiceStub
Returns
Type Description
SnapshotSettingsServiceClient

Constructors

SnapshotSettingsServiceClient(SnapshotSettingsServiceSettings settings)

protected SnapshotSettingsServiceClient(SnapshotSettingsServiceSettings settings)

Constructs an instance of SnapshotSettingsServiceClient, 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 SnapshotSettingsServiceSettings

SnapshotSettingsServiceClient(SnapshotSettingsServiceStub stub)

protected SnapshotSettingsServiceClient(SnapshotSettingsServiceStub stub)
Parameter
Name Description
stub SnapshotSettingsServiceStub

Methods

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

get(GetSnapshotSettingRequest request)

public final SnapshotSettings get(GetSnapshotSettingRequest request)

Get snapshot settings.

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 (SnapshotSettingsServiceClient snapshotSettingsServiceClient =
     SnapshotSettingsServiceClient.create()) {
   GetSnapshotSettingRequest request =
       GetSnapshotSettingRequest.newBuilder().setProject("project-309310695").build();
   SnapshotSettings response = snapshotSettingsServiceClient.get(request);
 }
Parameter
Name Description
request GetSnapshotSettingRequest

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

get(String project)

public final SnapshotSettings get(String project)

Get snapshot settings.

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 (SnapshotSettingsServiceClient snapshotSettingsServiceClient =
     SnapshotSettingsServiceClient.create()) {
   String project = "project-309310695";
   SnapshotSettings response = snapshotSettingsServiceClient.get(project);
 }
Parameter
Name Description
project String

Project ID for this request.
Returns
Type Description
SnapshotSettings

getCallable()

public final UnaryCallable<GetSnapshotSettingRequest,SnapshotSettings> getCallable()

Get snapshot settings.

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 (SnapshotSettingsServiceClient snapshotSettingsServiceClient =
     SnapshotSettingsServiceClient.create()) {
   GetSnapshotSettingRequest request =
       GetSnapshotSettingRequest.newBuilder().setProject("project-309310695").build();
   ApiFuture<SnapshotSettings> future =
       snapshotSettingsServiceClient.getCallable().futureCall(request);
   // Do something.
   SnapshotSettings response = future.get();
 }
Returns
Type Description
UnaryCallable<GetSnapshotSettingRequest,SnapshotSettings>

getSettings()

public final SnapshotSettingsServiceSettings getSettings()
Returns
Type Description
SnapshotSettingsServiceSettings

getStub()

public SnapshotSettingsServiceStub getStub()
Returns
Type Description
SnapshotSettingsServiceStub

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

patchAsync(PatchSnapshotSettingRequest request)

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

Patch snapshot settings.

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 (SnapshotSettingsServiceClient snapshotSettingsServiceClient =
     SnapshotSettingsServiceClient.create()) {
   PatchSnapshotSettingRequest request =
       PatchSnapshotSettingRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setSnapshotSettingsResource(SnapshotSettings.newBuilder().build())
           .setUpdateMask("updateMask-296147115")
           .build();
   Operation response = snapshotSettingsServiceClient.patchAsync(request).get();
 }
Parameter
Name Description
request PatchSnapshotSettingRequest

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

patchAsync(String project, SnapshotSettings snapshotSettingsResource)

public final OperationFuture<Operation,Operation> patchAsync(String project, SnapshotSettings snapshotSettingsResource)

Patch snapshot settings.

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 (SnapshotSettingsServiceClient snapshotSettingsServiceClient =
     SnapshotSettingsServiceClient.create()) {
   String project = "project-309310695";
   SnapshotSettings snapshotSettingsResource = SnapshotSettings.newBuilder().build();
   Operation response =
       snapshotSettingsServiceClient.patchAsync(project, snapshotSettingsResource).get();
 }
Parameters
Name Description
project String

Project ID for this request.
snapshotSettingsResource SnapshotSettings

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

patchCallable()

public final UnaryCallable<PatchSnapshotSettingRequest,Operation> patchCallable()

Patch snapshot settings.

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 (SnapshotSettingsServiceClient snapshotSettingsServiceClient =
     SnapshotSettingsServiceClient.create()) {
   PatchSnapshotSettingRequest request =
       PatchSnapshotSettingRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setSnapshotSettingsResource(SnapshotSettings.newBuilder().build())
           .setUpdateMask("updateMask-296147115")
           .build();
   ApiFuture<Operation> future =
       snapshotSettingsServiceClient.patchCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<PatchSnapshotSettingRequest,Operation>

patchOperationCallable()

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

Patch snapshot settings.

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 (SnapshotSettingsServiceClient snapshotSettingsServiceClient =
     SnapshotSettingsServiceClient.create()) {
   PatchSnapshotSettingRequest request =
       PatchSnapshotSettingRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setSnapshotSettingsResource(SnapshotSettings.newBuilder().build())
           .setUpdateMask("updateMask-296147115")
           .build();
   OperationFuture<Operation, Operation> future =
       snapshotSettingsServiceClient.patchOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
OperationCallable<PatchSnapshotSettingRequest,Operation,Operation>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()