com.google.cloud.compute.v1

Class SnapshotSettingsServiceClient

java.lang.Object

com.google.cloud.compute.v1.SnapshotSettingsServiceClient

All Implemented Interfaces:

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

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

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.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SnapshotSettingsServiceClient(SnapshotSettingsServiceSettings settings) Constructs an instance of SnapshotSettingsServiceClient, using the given settings.
protected	SnapshotSettingsServiceClient(SnapshotSettingsServiceStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static SnapshotSettingsServiceClient	create() Constructs an instance of SnapshotSettingsServiceClient with default settings.
static SnapshotSettingsServiceClient	create(SnapshotSettingsServiceSettings settings) Constructs an instance of SnapshotSettingsServiceClient, using the given settings.
static SnapshotSettingsServiceClient	create(SnapshotSettingsServiceStub stub) Constructs an instance of SnapshotSettingsServiceClient, using the given stub for making calls.
SnapshotSettings	get(GetSnapshotSettingRequest request) Get snapshot settings.
SnapshotSettings	get(String project) Get snapshot settings.
com.google.api.gax.rpc.UnaryCallable<GetSnapshotSettingRequest,SnapshotSettings>	getCallable() Get snapshot settings.
SnapshotSettingsServiceSettings	getSettings()
SnapshotSettingsServiceStub	getStub()
boolean	isShutdown()
boolean	isTerminated()
com.google.api.gax.longrunning.OperationFuture<Operation,Operation>	patchAsync(PatchSnapshotSettingRequest request) Patch snapshot settings.
com.google.api.gax.longrunning.OperationFuture<Operation,Operation>	patchAsync(String project, SnapshotSettings snapshotSettingsResource) Patch snapshot settings.
com.google.api.gax.rpc.UnaryCallable<PatchSnapshotSettingRequest,Operation>	patchCallable() Patch snapshot settings.
com.google.api.gax.rpc.OperationCallable<PatchSnapshotSettingRequest,Operation,Operation>	patchOperationCallable() Patch snapshot settings.
void	shutdown()
void	shutdownNow()

Methods inherited from class java.lang.Object

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

Constructor Detail

SnapshotSettingsServiceClient

protected SnapshotSettingsServiceClient(SnapshotSettingsServiceSettings settings)
                                 throws IOException

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.

Throws:

IOException

SnapshotSettingsServiceClient

protected SnapshotSettingsServiceClient(SnapshotSettingsServiceStub stub)

Method Detail

create

public static final SnapshotSettingsServiceClient create()
                                                  throws IOException

Constructs an instance of SnapshotSettingsServiceClient with default settings.

Throws:

IOException

create

public static final SnapshotSettingsServiceClient create(SnapshotSettingsServiceSettings settings)
                                                  throws IOException

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.

Throws:

IOException

create

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

getSettings

public final SnapshotSettingsServiceSettings getSettings()

getStub

public SnapshotSettingsServiceStub getStub()

get

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);
 }
 

Parameters:

project - Project ID for this request.

Throws:

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

get

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);
 }
 

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

getCallable

public final com.google.api.gax.rpc.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();
 }
 

patchAsync

public final com.google.api.gax.longrunning.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:

project - Project ID for this request.

snapshotSettingsResource - The body resource for this request

Throws:

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

patchAsync

public final com.google.api.gax.longrunning.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();
 }
 

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

patchOperationCallable

public final com.google.api.gax.rpc.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();
 }
 

patchCallable

public final com.google.api.gax.rpc.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();
 }
 

close

public final void close()

Specified by:

close in interface AutoCloseable

shutdown

public void shutdown()

Specified by:

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

isShutdown

public boolean isShutdown()

Specified by:

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

isTerminated

public boolean isTerminated()

Specified by:

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

shutdownNow

public void shutdownNow()

Specified by:

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

awaitTermination

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

Specified by:

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

Throws:

InterruptedException