com.google.cloud.compute.v1

Class SnapshotClient

java.lang.Object

com.google.cloud.compute.v1.SnapshotClient

All Implemented Interfaces:

BackgroundResource, AutoCloseable

@Generated(value="by gapic-generator")
 @BetaApi
public class SnapshotClient
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 (SnapshotClient snapshotClient = SnapshotClient.create()) {
   ProjectGlobalSnapshotName snapshot = ProjectGlobalSnapshotName.of("[PROJECT]", "[SNAPSHOT]");
   Operation response = snapshotClient.deleteSnapshot(snapshot);
 }
 
 

Note: close() needs to be called on the snapshotClient 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 SnapshotSettings to create(). For example:

To customize credentials:

 
 SnapshotSettings snapshotSettings =
     SnapshotSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 SnapshotClient snapshotClient =
     SnapshotClient.create(snapshotSettings);
 
 

To customize the endpoint:

 
 SnapshotSettings snapshotSettings =
     SnapshotSettings.newBuilder().setEndpoint(myEndpoint).build();
 SnapshotClient snapshotClient =
     SnapshotClient.create(snapshotSettings);
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SnapshotClient.ListSnapshotsFixedSizeCollection
static class	SnapshotClient.ListSnapshotsPage
static class	SnapshotClient.ListSnapshotsPagedResponse

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SnapshotClient(SnapshotSettings settings) Constructs an instance of SnapshotClient, using the given settings.
protected	SnapshotClient(SnapshotStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static SnapshotClient	create() Constructs an instance of SnapshotClient with default settings.
static SnapshotClient	create(SnapshotSettings settings) Constructs an instance of SnapshotClient, using the given settings.
static SnapshotClient	create(SnapshotStub stub) Constructs an instance of SnapshotClient, using the given stub for making calls.
Operation	deleteSnapshot(DeleteSnapshotHttpRequest request) Deletes the specified Snapshot resource.
Operation	deleteSnapshot(ProjectGlobalSnapshotName snapshot) Deletes the specified Snapshot resource.
Operation	deleteSnapshot(String snapshot) Deletes the specified Snapshot resource.
UnaryCallable<DeleteSnapshotHttpRequest,Operation>	deleteSnapshotCallable() Deletes the specified Snapshot resource.
Policy	getIamPolicySnapshot(GetIamPolicySnapshotHttpRequest request) Gets the access control policy for a resource.
Policy	getIamPolicySnapshot(ProjectGlobalSnapshotResourceName resource) Gets the access control policy for a resource.
Policy	getIamPolicySnapshot(String resource) Gets the access control policy for a resource.
UnaryCallable<GetIamPolicySnapshotHttpRequest,Policy>	getIamPolicySnapshotCallable() Gets the access control policy for a resource.
SnapshotSettings	getSettings()
Snapshot	getSnapshot(GetSnapshotHttpRequest request) Returns the specified Snapshot resource.
Snapshot	getSnapshot(ProjectGlobalSnapshotName snapshot) Returns the specified Snapshot resource.
Snapshot	getSnapshot(String snapshot) Returns the specified Snapshot resource.
UnaryCallable<GetSnapshotHttpRequest,Snapshot>	getSnapshotCallable() Returns the specified Snapshot resource.
SnapshotStub	getStub()
boolean	isShutdown()
boolean	isTerminated()
SnapshotClient.ListSnapshotsPagedResponse	listSnapshots(ListSnapshotsHttpRequest request) Retrieves the list of Snapshot resources contained within the specified project.
SnapshotClient.ListSnapshotsPagedResponse	listSnapshots(ProjectName project) Retrieves the list of Snapshot resources contained within the specified project.
SnapshotClient.ListSnapshotsPagedResponse	listSnapshots(String project) Retrieves the list of Snapshot resources contained within the specified project.
UnaryCallable<ListSnapshotsHttpRequest,SnapshotList>	listSnapshotsCallable() Retrieves the list of Snapshot resources contained within the specified project.
UnaryCallable<ListSnapshotsHttpRequest,SnapshotClient.ListSnapshotsPagedResponse>	listSnapshotsPagedCallable() Retrieves the list of Snapshot resources contained within the specified project.
Policy	setIamPolicySnapshot(ProjectGlobalSnapshotResourceName resource, GlobalSetPolicyRequest globalSetPolicyRequestResource) Sets the access control policy on the specified resource.
Policy	setIamPolicySnapshot(SetIamPolicySnapshotHttpRequest request) Sets the access control policy on the specified resource.
Policy	setIamPolicySnapshot(String resource, GlobalSetPolicyRequest globalSetPolicyRequestResource) Sets the access control policy on the specified resource.
UnaryCallable<SetIamPolicySnapshotHttpRequest,Policy>	setIamPolicySnapshotCallable() Sets the access control policy on the specified resource.
Operation	setLabelsSnapshot(ProjectGlobalSnapshotResourceName resource, GlobalSetLabelsRequest globalSetLabelsRequestResource) Sets the labels on a snapshot.
Operation	setLabelsSnapshot(SetLabelsSnapshotHttpRequest request) Sets the labels on a snapshot.
Operation	setLabelsSnapshot(String resource, GlobalSetLabelsRequest globalSetLabelsRequestResource) Sets the labels on a snapshot.
UnaryCallable<SetLabelsSnapshotHttpRequest,Operation>	setLabelsSnapshotCallable() Sets the labels on a snapshot.
void	shutdown()
void	shutdownNow()
TestPermissionsResponse	testIamPermissionsSnapshot(ProjectGlobalSnapshotResourceName resource, TestPermissionsRequest testPermissionsRequestResource) Returns permissions that a caller has on the specified resource.
TestPermissionsResponse	testIamPermissionsSnapshot(String resource, TestPermissionsRequest testPermissionsRequestResource) Returns permissions that a caller has on the specified resource.
TestPermissionsResponse	testIamPermissionsSnapshot(TestIamPermissionsSnapshotHttpRequest request) Returns permissions that a caller has on the specified resource.
UnaryCallable<TestIamPermissionsSnapshotHttpRequest,TestPermissionsResponse>	testIamPermissionsSnapshotCallable() Returns permissions that a caller has on the specified resource.

Methods inherited from class java.lang.Object

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

Constructor Detail

SnapshotClient

protected SnapshotClient(SnapshotSettings settings)
                  throws IOException

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

SnapshotClient

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
protected SnapshotClient(SnapshotStub stub)

Method Detail

create

public static final SnapshotClient create()
                                   throws IOException

Constructs an instance of SnapshotClient with default settings.

Throws:

IOException

create

public static final SnapshotClient create(SnapshotSettings settings)
                                   throws IOException

Constructs an instance of SnapshotClient, 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 SnapshotClient create(SnapshotStub stub)

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

getSettings

public final SnapshotSettings getSettings()

getStub

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

deleteSnapshot

@BetaApi
public final Operation deleteSnapshot(ProjectGlobalSnapshotName snapshot)

Deletes the specified Snapshot resource. Keep in mind that deleting a single snapshot might not necessarily delete all the data on that snapshot. If any data on the snapshot that is marked for deletion is needed for subsequent snapshots, the data will be moved to the next corresponding snapshot.

For more information, see Deleting snapshots.

Sample code:

 try (SnapshotClient snapshotClient = SnapshotClient.create()) {
   ProjectGlobalSnapshotName snapshot = ProjectGlobalSnapshotName.of("[PROJECT]", "[SNAPSHOT]");
   Operation response = snapshotClient.deleteSnapshot(snapshot);
 }
 

Parameters:

snapshot - Name of the Snapshot resource to delete.

Throws:

ApiException - if the remote call fails

deleteSnapshot

@BetaApi
public final Operation deleteSnapshot(String snapshot)

Deletes the specified Snapshot resource. Keep in mind that deleting a single snapshot might not necessarily delete all the data on that snapshot. If any data on the snapshot that is marked for deletion is needed for subsequent snapshots, the data will be moved to the next corresponding snapshot.

For more information, see Deleting snapshots.

Sample code:

 try (SnapshotClient snapshotClient = SnapshotClient.create()) {
   ProjectGlobalSnapshotName snapshot = ProjectGlobalSnapshotName.of("[PROJECT]", "[SNAPSHOT]");
   Operation response = snapshotClient.deleteSnapshot(snapshot.toString());
 }
 

Parameters:

snapshot - Name of the Snapshot resource to delete.

Throws:

ApiException - if the remote call fails

deleteSnapshot

@BetaApi
public final Operation deleteSnapshot(DeleteSnapshotHttpRequest request)

Deletes the specified Snapshot resource. Keep in mind that deleting a single snapshot might not necessarily delete all the data on that snapshot. If any data on the snapshot that is marked for deletion is needed for subsequent snapshots, the data will be moved to the next corresponding snapshot.

For more information, see Deleting snapshots.

Sample code:

 try (SnapshotClient snapshotClient = SnapshotClient.create()) {
   String formattedSnapshot = ProjectGlobalSnapshotName.format("[PROJECT]", "[SNAPSHOT]");
   DeleteSnapshotHttpRequest request = DeleteSnapshotHttpRequest.newBuilder()
     .setSnapshot(formattedSnapshot)
     .build();
   Operation response = snapshotClient.deleteSnapshot(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

ApiException - if the remote call fails

deleteSnapshotCallable

@BetaApi
public final UnaryCallable<DeleteSnapshotHttpRequest,Operation> deleteSnapshotCallable()

Deletes the specified Snapshot resource. Keep in mind that deleting a single snapshot might not necessarily delete all the data on that snapshot. If any data on the snapshot that is marked for deletion is needed for subsequent snapshots, the data will be moved to the next corresponding snapshot.

For more information, see Deleting snapshots.

Sample code:

 try (SnapshotClient snapshotClient = SnapshotClient.create()) {
   String formattedSnapshot = ProjectGlobalSnapshotName.format("[PROJECT]", "[SNAPSHOT]");
   DeleteSnapshotHttpRequest request = DeleteSnapshotHttpRequest.newBuilder()
     .setSnapshot(formattedSnapshot)
     .build();
   ApiFuture<Operation> future = snapshotClient.deleteSnapshotCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

getSnapshot

@BetaApi
public final Snapshot getSnapshot(ProjectGlobalSnapshotName snapshot)

Returns the specified Snapshot resource. Gets a list of available snapshots by making a list() request.

Sample code:

 try (SnapshotClient snapshotClient = SnapshotClient.create()) {
   ProjectGlobalSnapshotName snapshot = ProjectGlobalSnapshotName.of("[PROJECT]", "[SNAPSHOT]");
   Snapshot response = snapshotClient.getSnapshot(snapshot);
 }
 

Parameters:

snapshot - Name of the Snapshot resource to return.

Throws:

ApiException - if the remote call fails

getSnapshot

@BetaApi
public final Snapshot getSnapshot(String snapshot)

Returns the specified Snapshot resource. Gets a list of available snapshots by making a list() request.

Sample code:

 try (SnapshotClient snapshotClient = SnapshotClient.create()) {
   ProjectGlobalSnapshotName snapshot = ProjectGlobalSnapshotName.of("[PROJECT]", "[SNAPSHOT]");
   Snapshot response = snapshotClient.getSnapshot(snapshot.toString());
 }
 

Parameters:

snapshot - Name of the Snapshot resource to return.

Throws:

ApiException - if the remote call fails

getSnapshot

@BetaApi
public final Snapshot getSnapshot(GetSnapshotHttpRequest request)

Returns the specified Snapshot resource. Gets a list of available snapshots by making a list() request.

Sample code:

 try (SnapshotClient snapshotClient = SnapshotClient.create()) {
   String formattedSnapshot = ProjectGlobalSnapshotName.format("[PROJECT]", "[SNAPSHOT]");
   GetSnapshotHttpRequest request = GetSnapshotHttpRequest.newBuilder()
     .setSnapshot(formattedSnapshot)
     .build();
   Snapshot response = snapshotClient.getSnapshot(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

ApiException - if the remote call fails

getSnapshotCallable

@BetaApi
public final UnaryCallable<GetSnapshotHttpRequest,Snapshot> getSnapshotCallable()

Returns the specified Snapshot resource. Gets a list of available snapshots by making a list() request.

Sample code:

 try (SnapshotClient snapshotClient = SnapshotClient.create()) {
   String formattedSnapshot = ProjectGlobalSnapshotName.format("[PROJECT]", "[SNAPSHOT]");
   GetSnapshotHttpRequest request = GetSnapshotHttpRequest.newBuilder()
     .setSnapshot(formattedSnapshot)
     .build();
   ApiFuture<Snapshot> future = snapshotClient.getSnapshotCallable().futureCall(request);
   // Do something
   Snapshot response = future.get();
 }
 

getIamPolicySnapshot

@BetaApi
public final Policy getIamPolicySnapshot(ProjectGlobalSnapshotResourceName resource)

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Sample code:

 try (SnapshotClient snapshotClient = SnapshotClient.create()) {
   ProjectGlobalSnapshotResourceName resource = ProjectGlobalSnapshotResourceName.of("[PROJECT]", "[RESOURCE]");
   Policy response = snapshotClient.getIamPolicySnapshot(resource);
 }
 

Parameters:

resource - Name or id of the resource for this request.

Throws:

ApiException - if the remote call fails

getIamPolicySnapshot

@BetaApi
public final Policy getIamPolicySnapshot(String resource)

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Sample code:

 try (SnapshotClient snapshotClient = SnapshotClient.create()) {
   ProjectGlobalSnapshotResourceName resource = ProjectGlobalSnapshotResourceName.of("[PROJECT]", "[RESOURCE]");
   Policy response = snapshotClient.getIamPolicySnapshot(resource.toString());
 }
 

Parameters:

resource - Name or id of the resource for this request.

Throws:

ApiException - if the remote call fails

getIamPolicySnapshot

@BetaApi
public final Policy getIamPolicySnapshot(GetIamPolicySnapshotHttpRequest request)

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Sample code:

 try (SnapshotClient snapshotClient = SnapshotClient.create()) {
   String formattedResource = ProjectGlobalSnapshotResourceName.format("[PROJECT]", "[RESOURCE]");
   GetIamPolicySnapshotHttpRequest request = GetIamPolicySnapshotHttpRequest.newBuilder()
     .setResource(formattedResource)
     .build();
   Policy response = snapshotClient.getIamPolicySnapshot(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

ApiException - if the remote call fails

getIamPolicySnapshotCallable

@BetaApi
public final UnaryCallable<GetIamPolicySnapshotHttpRequest,Policy> getIamPolicySnapshotCallable()

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Sample code:

 try (SnapshotClient snapshotClient = SnapshotClient.create()) {
   String formattedResource = ProjectGlobalSnapshotResourceName.format("[PROJECT]", "[RESOURCE]");
   GetIamPolicySnapshotHttpRequest request = GetIamPolicySnapshotHttpRequest.newBuilder()
     .setResource(formattedResource)
     .build();
   ApiFuture<Policy> future = snapshotClient.getIamPolicySnapshotCallable().futureCall(request);
   // Do something
   Policy response = future.get();
 }
 

listSnapshots

@BetaApi
public final SnapshotClient.ListSnapshotsPagedResponse listSnapshots(ProjectName project)

Retrieves the list of Snapshot resources contained within the specified project.

Sample code:

 try (SnapshotClient snapshotClient = SnapshotClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   for (Snapshot element : snapshotClient.listSnapshots(project).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

project - Project ID for this request.

Throws:

ApiException - if the remote call fails

listSnapshots

@BetaApi
public final SnapshotClient.ListSnapshotsPagedResponse listSnapshots(String project)

Retrieves the list of Snapshot resources contained within the specified project.

Sample code:

 try (SnapshotClient snapshotClient = SnapshotClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   for (Snapshot element : snapshotClient.listSnapshots(project.toString()).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

project - Project ID for this request.

Throws:

ApiException - if the remote call fails

listSnapshots

@BetaApi
public final SnapshotClient.ListSnapshotsPagedResponse listSnapshots(ListSnapshotsHttpRequest request)

Retrieves the list of Snapshot resources contained within the specified project.

Sample code:

 try (SnapshotClient snapshotClient = SnapshotClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   ListSnapshotsHttpRequest request = ListSnapshotsHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   for (Snapshot element : snapshotClient.listSnapshots(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

ApiException - if the remote call fails

listSnapshotsPagedCallable

@BetaApi
public final UnaryCallable<ListSnapshotsHttpRequest,SnapshotClient.ListSnapshotsPagedResponse> listSnapshotsPagedCallable()

Retrieves the list of Snapshot resources contained within the specified project.

Sample code:

 try (SnapshotClient snapshotClient = SnapshotClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   ListSnapshotsHttpRequest request = ListSnapshotsHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   ApiFuture<ListSnapshotsPagedResponse> future = snapshotClient.listSnapshotsPagedCallable().futureCall(request);
   // Do something
   for (Snapshot element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listSnapshotsCallable

@BetaApi
public final UnaryCallable<ListSnapshotsHttpRequest,SnapshotList> listSnapshotsCallable()

Retrieves the list of Snapshot resources contained within the specified project.

Sample code:

 try (SnapshotClient snapshotClient = SnapshotClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   ListSnapshotsHttpRequest request = ListSnapshotsHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   while (true) {
     SnapshotList response = snapshotClient.listSnapshotsCallable().call(request);
     for (Snapshot element : response.getItemsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

setIamPolicySnapshot

@BetaApi
public final Policy setIamPolicySnapshot(ProjectGlobalSnapshotResourceName resource,
                                                  GlobalSetPolicyRequest globalSetPolicyRequestResource)

Sets the access control policy on the specified resource. Replaces any existing policy.

Sample code:

 try (SnapshotClient snapshotClient = SnapshotClient.create()) {
   ProjectGlobalSnapshotResourceName resource = ProjectGlobalSnapshotResourceName.of("[PROJECT]", "[RESOURCE]");
   GlobalSetPolicyRequest globalSetPolicyRequestResource = GlobalSetPolicyRequest.newBuilder().build();
   Policy response = snapshotClient.setIamPolicySnapshot(resource, globalSetPolicyRequestResource);
 }
 

Parameters:

resource - Name or id of the resource for this request.

globalSetPolicyRequestResource -

Throws:

ApiException - if the remote call fails

setIamPolicySnapshot

@BetaApi
public final Policy setIamPolicySnapshot(String resource,
                                                  GlobalSetPolicyRequest globalSetPolicyRequestResource)

Sets the access control policy on the specified resource. Replaces any existing policy.

Sample code:

 try (SnapshotClient snapshotClient = SnapshotClient.create()) {
   ProjectGlobalSnapshotResourceName resource = ProjectGlobalSnapshotResourceName.of("[PROJECT]", "[RESOURCE]");
   GlobalSetPolicyRequest globalSetPolicyRequestResource = GlobalSetPolicyRequest.newBuilder().build();
   Policy response = snapshotClient.setIamPolicySnapshot(resource.toString(), globalSetPolicyRequestResource);
 }
 

Parameters:

resource - Name or id of the resource for this request.

globalSetPolicyRequestResource -

Throws:

ApiException - if the remote call fails

setIamPolicySnapshot

@BetaApi
public final Policy setIamPolicySnapshot(SetIamPolicySnapshotHttpRequest request)

Sets the access control policy on the specified resource. Replaces any existing policy.

Sample code:

 try (SnapshotClient snapshotClient = SnapshotClient.create()) {
   String formattedResource = ProjectGlobalSnapshotResourceName.format("[PROJECT]", "[RESOURCE]");
   GlobalSetPolicyRequest globalSetPolicyRequestResource = GlobalSetPolicyRequest.newBuilder().build();
   SetIamPolicySnapshotHttpRequest request = SetIamPolicySnapshotHttpRequest.newBuilder()
     .setResource(formattedResource)
     .setGlobalSetPolicyRequestResource(globalSetPolicyRequestResource)
     .build();
   Policy response = snapshotClient.setIamPolicySnapshot(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

ApiException - if the remote call fails

setIamPolicySnapshotCallable

@BetaApi
public final UnaryCallable<SetIamPolicySnapshotHttpRequest,Policy> setIamPolicySnapshotCallable()

Sets the access control policy on the specified resource. Replaces any existing policy.

Sample code:

 try (SnapshotClient snapshotClient = SnapshotClient.create()) {
   String formattedResource = ProjectGlobalSnapshotResourceName.format("[PROJECT]", "[RESOURCE]");
   GlobalSetPolicyRequest globalSetPolicyRequestResource = GlobalSetPolicyRequest.newBuilder().build();
   SetIamPolicySnapshotHttpRequest request = SetIamPolicySnapshotHttpRequest.newBuilder()
     .setResource(formattedResource)
     .setGlobalSetPolicyRequestResource(globalSetPolicyRequestResource)
     .build();
   ApiFuture<Policy> future = snapshotClient.setIamPolicySnapshotCallable().futureCall(request);
   // Do something
   Policy response = future.get();
 }
 

setLabelsSnapshot

@BetaApi
public final Operation setLabelsSnapshot(ProjectGlobalSnapshotResourceName resource,
                                                  GlobalSetLabelsRequest globalSetLabelsRequestResource)

Sets the labels on a snapshot. To learn more about labels, read the Labeling Resources documentation.

Sample code:

 try (SnapshotClient snapshotClient = SnapshotClient.create()) {
   ProjectGlobalSnapshotResourceName resource = ProjectGlobalSnapshotResourceName.of("[PROJECT]", "[RESOURCE]");
   GlobalSetLabelsRequest globalSetLabelsRequestResource = GlobalSetLabelsRequest.newBuilder().build();
   Operation response = snapshotClient.setLabelsSnapshot(resource, globalSetLabelsRequestResource);
 }
 

Parameters:

resource - Name or id of the resource for this request.

globalSetLabelsRequestResource -

Throws:

ApiException - if the remote call fails

setLabelsSnapshot

@BetaApi
public final Operation setLabelsSnapshot(String resource,
                                                  GlobalSetLabelsRequest globalSetLabelsRequestResource)

Sets the labels on a snapshot. To learn more about labels, read the Labeling Resources documentation.

Sample code:

 try (SnapshotClient snapshotClient = SnapshotClient.create()) {
   ProjectGlobalSnapshotResourceName resource = ProjectGlobalSnapshotResourceName.of("[PROJECT]", "[RESOURCE]");
   GlobalSetLabelsRequest globalSetLabelsRequestResource = GlobalSetLabelsRequest.newBuilder().build();
   Operation response = snapshotClient.setLabelsSnapshot(resource.toString(), globalSetLabelsRequestResource);
 }
 

Parameters:

resource - Name or id of the resource for this request.

globalSetLabelsRequestResource -

Throws:

ApiException - if the remote call fails

setLabelsSnapshot

@BetaApi
public final Operation setLabelsSnapshot(SetLabelsSnapshotHttpRequest request)

Sets the labels on a snapshot. To learn more about labels, read the Labeling Resources documentation.

Sample code:

 try (SnapshotClient snapshotClient = SnapshotClient.create()) {
   String formattedResource = ProjectGlobalSnapshotResourceName.format("[PROJECT]", "[RESOURCE]");
   GlobalSetLabelsRequest globalSetLabelsRequestResource = GlobalSetLabelsRequest.newBuilder().build();
   SetLabelsSnapshotHttpRequest request = SetLabelsSnapshotHttpRequest.newBuilder()
     .setResource(formattedResource)
     .setGlobalSetLabelsRequestResource(globalSetLabelsRequestResource)
     .build();
   Operation response = snapshotClient.setLabelsSnapshot(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

ApiException - if the remote call fails

setLabelsSnapshotCallable

@BetaApi
public final UnaryCallable<SetLabelsSnapshotHttpRequest,Operation> setLabelsSnapshotCallable()

Sets the labels on a snapshot. To learn more about labels, read the Labeling Resources documentation.

Sample code:

 try (SnapshotClient snapshotClient = SnapshotClient.create()) {
   String formattedResource = ProjectGlobalSnapshotResourceName.format("[PROJECT]", "[RESOURCE]");
   GlobalSetLabelsRequest globalSetLabelsRequestResource = GlobalSetLabelsRequest.newBuilder().build();
   SetLabelsSnapshotHttpRequest request = SetLabelsSnapshotHttpRequest.newBuilder()
     .setResource(formattedResource)
     .setGlobalSetLabelsRequestResource(globalSetLabelsRequestResource)
     .build();
   ApiFuture<Operation> future = snapshotClient.setLabelsSnapshotCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

testIamPermissionsSnapshot

@BetaApi
public final TestPermissionsResponse testIamPermissionsSnapshot(ProjectGlobalSnapshotResourceName resource,
                                                                         TestPermissionsRequest testPermissionsRequestResource)

Returns permissions that a caller has on the specified resource.

Sample code:

 try (SnapshotClient snapshotClient = SnapshotClient.create()) {
   ProjectGlobalSnapshotResourceName resource = ProjectGlobalSnapshotResourceName.of("[PROJECT]", "[RESOURCE]");
   TestPermissionsRequest testPermissionsRequestResource = TestPermissionsRequest.newBuilder().build();
   TestPermissionsResponse response = snapshotClient.testIamPermissionsSnapshot(resource, testPermissionsRequestResource);
 }
 

Parameters:

resource - Name or id of the resource for this request.

testPermissionsRequestResource -

Throws:

ApiException - if the remote call fails

testIamPermissionsSnapshot

@BetaApi
public final TestPermissionsResponse testIamPermissionsSnapshot(String resource,
                                                                         TestPermissionsRequest testPermissionsRequestResource)

Returns permissions that a caller has on the specified resource.

Sample code:

 try (SnapshotClient snapshotClient = SnapshotClient.create()) {
   ProjectGlobalSnapshotResourceName resource = ProjectGlobalSnapshotResourceName.of("[PROJECT]", "[RESOURCE]");
   TestPermissionsRequest testPermissionsRequestResource = TestPermissionsRequest.newBuilder().build();
   TestPermissionsResponse response = snapshotClient.testIamPermissionsSnapshot(resource.toString(), testPermissionsRequestResource);
 }
 

Parameters:

resource - Name or id of the resource for this request.

testPermissionsRequestResource -

Throws:

ApiException - if the remote call fails

testIamPermissionsSnapshot

@BetaApi
public final TestPermissionsResponse testIamPermissionsSnapshot(TestIamPermissionsSnapshotHttpRequest request)

Returns permissions that a caller has on the specified resource.

Sample code:

 try (SnapshotClient snapshotClient = SnapshotClient.create()) {
   String formattedResource = ProjectGlobalSnapshotResourceName.format("[PROJECT]", "[RESOURCE]");
   TestPermissionsRequest testPermissionsRequestResource = TestPermissionsRequest.newBuilder().build();
   TestIamPermissionsSnapshotHttpRequest request = TestIamPermissionsSnapshotHttpRequest.newBuilder()
     .setResource(formattedResource)
     .setTestPermissionsRequestResource(testPermissionsRequestResource)
     .build();
   TestPermissionsResponse response = snapshotClient.testIamPermissionsSnapshot(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

ApiException - if the remote call fails

testIamPermissionsSnapshotCallable

@BetaApi
public final UnaryCallable<TestIamPermissionsSnapshotHttpRequest,TestPermissionsResponse> testIamPermissionsSnapshotCallable()

Returns permissions that a caller has on the specified resource.

Sample code:

 try (SnapshotClient snapshotClient = SnapshotClient.create()) {
   String formattedResource = ProjectGlobalSnapshotResourceName.format("[PROJECT]", "[RESOURCE]");
   TestPermissionsRequest testPermissionsRequestResource = TestPermissionsRequest.newBuilder().build();
   TestIamPermissionsSnapshotHttpRequest request = TestIamPermissionsSnapshotHttpRequest.newBuilder()
     .setResource(formattedResource)
     .setTestPermissionsRequestResource(testPermissionsRequestResource)
     .build();
   ApiFuture<TestPermissionsResponse> future = snapshotClient.testIamPermissionsSnapshotCallable().futureCall(request);
   // Do something
   TestPermissionsResponse response = future.get();
 }
 

close

public final void close()

Specified by:

close in interface AutoCloseable

shutdown

public void shutdown()

Specified by:

shutdown in interface BackgroundResource

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface BackgroundResource

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface BackgroundResource

shutdownNow

public void shutdownNow()

Specified by:

shutdownNow in interface BackgroundResource

awaitTermination

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

Specified by:

awaitTermination in interface BackgroundResource

Throws:

InterruptedException