Class InstantSnapshotsClient (1.51.0)

Service Description: The InstantSnapshots 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 (InstantSnapshotsClient instantSnapshotsClient = InstantSnapshotsClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   String instantSnapshot = "instantSnapshot800321221";
   InstantSnapshot response = instantSnapshotsClient.get(project, zone, instantSnapshot);
 }

Note: close() needs to be called on the InstantSnapshotsClient 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 an aggregated list of instantSnapshots. 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(AggregatedListInstantSnapshotsRequest 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 InstantSnapshot resource. Keep in mind that deleting a single instantSnapshot might not necessarily delete all the data on that instantSnapshot. If any data on the instantSnapshot that is marked for deletion is needed for subsequent instantSnapshots, the data will be moved to the next corresponding instantSnapshot. For more information, see Deleting instantSnapshots.	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteAsync(DeleteInstantSnapshotRequest 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 zone, String instantSnapshot) 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	Returns the specified InstantSnapshot resource in the specified zone.	Request object method variants only take one parameter, a request object, which must be constructed before the call. get(GetInstantSnapshotRequest 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 zone, String instantSnapshot) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getCallable()
GetIamPolicy	Gets the access control policy for a resource. May be empty if no such policy or resource exists.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getIamPolicy(GetIamPolicyInstantSnapshotRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getIamPolicy(String project, String zone, String resource) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getIamPolicyCallable()
Insert	Creates an instant snapshot in the specified zone.	Request object method variants only take one parameter, a request object, which must be constructed before the call. insertAsync(InsertInstantSnapshotRequest 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, String zone, InstantSnapshot instantSnapshotResource) 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	Retrieves the list of InstantSnapshot resources contained within the specified zone.	Request object method variants only take one parameter, a request object, which must be constructed before the call. list(ListInstantSnapshotsRequest 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, String zone) 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()
SetIamPolicy	Sets the access control policy on the specified resource. Replaces any existing policy.	Request object method variants only take one parameter, a request object, which must be constructed before the call. setIamPolicy(SetIamPolicyInstantSnapshotRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. setIamPolicy(String project, String zone, String resource, ZoneSetPolicyRequest zoneSetPolicyRequestResource) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. setIamPolicyCallable()
SetLabels	Sets the labels on a instantSnapshot in the given zone. To learn more about labels, read the Labeling Resources documentation.	Request object method variants only take one parameter, a request object, which must be constructed before the call. setLabelsAsync(SetLabelsInstantSnapshotRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. setLabelsAsync(String project, String zone, String resource, ZoneSetLabelsRequest zoneSetLabelsRequestResource) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. setLabelsOperationCallable() setLabelsCallable()
TestIamPermissions	Returns permissions that a caller has on the specified resource.	Request object method variants only take one parameter, a request object, which must be constructed before the call. testIamPermissions(TestIamPermissionsInstantSnapshotRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. testIamPermissions(String project, String zone, String resource, TestPermissionsRequest testPermissionsRequestResource) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. testIamPermissionsCallable()

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 InstantSnapshotsSettings 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
 InstantSnapshotsSettings instantSnapshotsSettings =
     InstantSnapshotsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 InstantSnapshotsClient instantSnapshotsClient =
     InstantSnapshotsClient.create(instantSnapshotsSettings);

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
 InstantSnapshotsSettings instantSnapshotsSettings =
     InstantSnapshotsSettings.newBuilder().setEndpoint(myEndpoint).build();
 InstantSnapshotsClient instantSnapshotsClient =
     InstantSnapshotsClient.create(instantSnapshotsSettings);

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

Inheritance

java.lang.Object > InstantSnapshotsClient

Static Methods

create()

public static final InstantSnapshotsClient create()

Constructs an instance of InstantSnapshotsClient with default settings.

Returns
Type	Description
`InstantSnapshotsClient`

Exceptions
Type	Description
`IOException`

create(InstantSnapshotsSettings settings)

public static final InstantSnapshotsClient create(InstantSnapshotsSettings settings)

Constructs an instance of InstantSnapshotsClient, 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`	`InstantSnapshotsSettings`

Returns
Type	Description
`InstantSnapshotsClient`

Exceptions
Type	Description
`IOException`

create(InstantSnapshotsStub stub)

public static final InstantSnapshotsClient create(InstantSnapshotsStub stub)

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

Parameter
Name	Description
`stub`	`InstantSnapshotsStub`

Returns
Type	Description
`InstantSnapshotsClient`

Constructors

InstantSnapshotsClient(InstantSnapshotsSettings settings)

protected InstantSnapshotsClient(InstantSnapshotsSettings settings)

Constructs an instance of InstantSnapshotsClient, 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`	`InstantSnapshotsSettings`

InstantSnapshotsClient(InstantSnapshotsStub stub)

protected InstantSnapshotsClient(InstantSnapshotsStub stub)

Parameter
Name	Description
`stub`	`InstantSnapshotsStub`

Methods

aggregatedList(AggregatedListInstantSnapshotsRequest request)

public final InstantSnapshotsClient.AggregatedListPagedResponse aggregatedList(AggregatedListInstantSnapshotsRequest request)

Retrieves an aggregated list of instantSnapshots. 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 (InstantSnapshotsClient instantSnapshotsClient = InstantSnapshotsClient.create()) {
   AggregatedListInstantSnapshotsRequest request =
       AggregatedListInstantSnapshotsRequest.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, InstantSnapshotsScopedList> element :
       instantSnapshotsClient.aggregatedList(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`AggregatedListInstantSnapshotsRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`InstantSnapshotsClient.AggregatedListPagedResponse`

aggregatedList(String project)

public final InstantSnapshotsClient.AggregatedListPagedResponse aggregatedList(String project)

Retrieves an aggregated list of instantSnapshots. 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 (InstantSnapshotsClient instantSnapshotsClient = InstantSnapshotsClient.create()) {
   String project = "project-309310695";
   for (Map.Entry<String, InstantSnapshotsScopedList> element :
       instantSnapshotsClient.aggregatedList(project).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`project`	`String` Project ID for this request.

Returns
Type	Description
`InstantSnapshotsClient.AggregatedListPagedResponse`

aggregatedListCallable()

public final UnaryCallable<AggregatedListInstantSnapshotsRequest,InstantSnapshotAggregatedList> aggregatedListCallable()

Retrieves an aggregated list of instantSnapshots. 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 (InstantSnapshotsClient instantSnapshotsClient = InstantSnapshotsClient.create()) {
   AggregatedListInstantSnapshotsRequest request =
       AggregatedListInstantSnapshotsRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setIncludeAllScopes(true)
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .setServiceProjectNumber(-1293855239)
           .build();
   while (true) {
     InstantSnapshotAggregatedList response =
         instantSnapshotsClient.aggregatedListCallable().call(request);
     for (Map.Entry<String, InstantSnapshotsScopedList> 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<AggregatedListInstantSnapshotsRequest,InstantSnapshotAggregatedList>`

aggregatedListPagedCallable()

public final UnaryCallable<AggregatedListInstantSnapshotsRequest,InstantSnapshotsClient.AggregatedListPagedResponse> aggregatedListPagedCallable()

Retrieves an aggregated list of instantSnapshots. 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 (InstantSnapshotsClient instantSnapshotsClient = InstantSnapshotsClient.create()) {
   AggregatedListInstantSnapshotsRequest request =
       AggregatedListInstantSnapshotsRequest.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, InstantSnapshotsScopedList>> future =
       instantSnapshotsClient.aggregatedListPagedCallable().futureCall(request);
   // Do something.
   for (Map.Entry<String, InstantSnapshotsScopedList> element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<AggregatedListInstantSnapshotsRequest,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(DeleteInstantSnapshotRequest request)

public final OperationFuture<Operation,Operation> deleteAsync(DeleteInstantSnapshotRequest request)

Deletes the specified InstantSnapshot resource. Keep in mind that deleting a single instantSnapshot might not necessarily delete all the data on that instantSnapshot. If any data on the instantSnapshot that is marked for deletion is needed for subsequent instantSnapshots, the data will be moved to the next corresponding instantSnapshot. For more information, see Deleting instantSnapshots.

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 (InstantSnapshotsClient instantSnapshotsClient = InstantSnapshotsClient.create()) {
   DeleteInstantSnapshotRequest request =
       DeleteInstantSnapshotRequest.newBuilder()
           .setInstantSnapshot("instantSnapshot800321221")
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setZone("zone3744684")
           .build();
   Operation response = instantSnapshotsClient.deleteAsync(request).get();
 }

Parameter
Name	Description
`request`	`DeleteInstantSnapshotRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`OperationFuture<Operation,Operation>`

deleteAsync(String project, String zone, String instantSnapshot)

public final OperationFuture<Operation,Operation> deleteAsync(String project, String zone, String instantSnapshot)

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 (InstantSnapshotsClient instantSnapshotsClient = InstantSnapshotsClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   String instantSnapshot = "instantSnapshot800321221";
   Operation response = instantSnapshotsClient.deleteAsync(project, zone, instantSnapshot).get();
 }

Parameters
Name	Description
`project`	`String` Project ID for this request.
`zone`	`String` The name of the zone for this request.
`instantSnapshot`	`String` Name of the InstantSnapshot resource to delete.

Returns
Type	Description
`OperationFuture<Operation,Operation>`

deleteCallable()

public final UnaryCallable<DeleteInstantSnapshotRequest,Operation> deleteCallable()

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 (InstantSnapshotsClient instantSnapshotsClient = InstantSnapshotsClient.create()) {
   DeleteInstantSnapshotRequest request =
       DeleteInstantSnapshotRequest.newBuilder()
           .setInstantSnapshot("instantSnapshot800321221")
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setZone("zone3744684")
           .build();
   ApiFuture<Operation> future = instantSnapshotsClient.deleteCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

Returns
Type	Description
`UnaryCallable<DeleteInstantSnapshotRequest,Operation>`

deleteOperationCallable()

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

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 (InstantSnapshotsClient instantSnapshotsClient = InstantSnapshotsClient.create()) {
   DeleteInstantSnapshotRequest request =
       DeleteInstantSnapshotRequest.newBuilder()
           .setInstantSnapshot("instantSnapshot800321221")
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setZone("zone3744684")
           .build();
   OperationFuture<Operation, Operation> future =
       instantSnapshotsClient.deleteOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

Returns
Type	Description
`OperationCallable<DeleteInstantSnapshotRequest,Operation,Operation>`

get(GetInstantSnapshotRequest request)

public final InstantSnapshot get(GetInstantSnapshotRequest request)

Returns the specified InstantSnapshot resource in the specified zone.

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 (InstantSnapshotsClient instantSnapshotsClient = InstantSnapshotsClient.create()) {
   GetInstantSnapshotRequest request =
       GetInstantSnapshotRequest.newBuilder()
           .setInstantSnapshot("instantSnapshot800321221")
           .setProject("project-309310695")
           .setZone("zone3744684")
           .build();
   InstantSnapshot response = instantSnapshotsClient.get(request);
 }

Parameter
Name	Description
`request`	`GetInstantSnapshotRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`InstantSnapshot`

get(String project, String zone, String instantSnapshot)

public final InstantSnapshot get(String project, String zone, String instantSnapshot)

Returns the specified InstantSnapshot resource in the specified zone.

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 (InstantSnapshotsClient instantSnapshotsClient = InstantSnapshotsClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   String instantSnapshot = "instantSnapshot800321221";
   InstantSnapshot response = instantSnapshotsClient.get(project, zone, instantSnapshot);
 }

Parameters
Name	Description
`project`	`String` Project ID for this request.
`zone`	`String` The name of the zone for this request.
`instantSnapshot`	`String` Name of the InstantSnapshot resource to return.

Returns
Type	Description
`InstantSnapshot`

getCallable()

public final UnaryCallable<GetInstantSnapshotRequest,InstantSnapshot> getCallable()

Returns the specified InstantSnapshot resource in the specified zone.

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 (InstantSnapshotsClient instantSnapshotsClient = InstantSnapshotsClient.create()) {
   GetInstantSnapshotRequest request =
       GetInstantSnapshotRequest.newBuilder()
           .setInstantSnapshot("instantSnapshot800321221")
           .setProject("project-309310695")
           .setZone("zone3744684")
           .build();
   ApiFuture<InstantSnapshot> future = instantSnapshotsClient.getCallable().futureCall(request);
   // Do something.
   InstantSnapshot response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetInstantSnapshotRequest,InstantSnapshot>`

getIamPolicy(GetIamPolicyInstantSnapshotRequest request)

public final Policy getIamPolicy(GetIamPolicyInstantSnapshotRequest request)

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

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 (InstantSnapshotsClient instantSnapshotsClient = InstantSnapshotsClient.create()) {
   GetIamPolicyInstantSnapshotRequest request =
       GetIamPolicyInstantSnapshotRequest.newBuilder()
           .setOptionsRequestedPolicyVersion(-574521795)
           .setProject("project-309310695")
           .setResource("resource-341064690")
           .setZone("zone3744684")
           .build();
   Policy response = instantSnapshotsClient.getIamPolicy(request);
 }

Parameter
Name	Description
`request`	`GetIamPolicyInstantSnapshotRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`Policy`

getIamPolicy(String project, String zone, String resource)

public final Policy getIamPolicy(String project, String zone, String resource)

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

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 (InstantSnapshotsClient instantSnapshotsClient = InstantSnapshotsClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   String resource = "resource-341064690";
   Policy response = instantSnapshotsClient.getIamPolicy(project, zone, resource);
 }

Parameters
Name	Description
`project`	`String` Project ID for this request.
`zone`	`String` The name of the zone for this request.
`resource`	`String` Name or id of the resource for this request.

Returns
Type	Description
`Policy`

getIamPolicyCallable()

public final UnaryCallable<GetIamPolicyInstantSnapshotRequest,Policy> getIamPolicyCallable()

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

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 (InstantSnapshotsClient instantSnapshotsClient = InstantSnapshotsClient.create()) {
   GetIamPolicyInstantSnapshotRequest request =
       GetIamPolicyInstantSnapshotRequest.newBuilder()
           .setOptionsRequestedPolicyVersion(-574521795)
           .setProject("project-309310695")
           .setResource("resource-341064690")
           .setZone("zone3744684")
           .build();
   ApiFuture<Policy> future = instantSnapshotsClient.getIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetIamPolicyInstantSnapshotRequest,Policy>`

getSettings()

public final InstantSnapshotsSettings getSettings()

Returns
Type	Description
`InstantSnapshotsSettings`

getStub()

public InstantSnapshotsStub getStub()

Returns
Type	Description
`InstantSnapshotsStub`

insertAsync(InsertInstantSnapshotRequest request)

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

Creates an instant snapshot in the specified zone.

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 (InstantSnapshotsClient instantSnapshotsClient = InstantSnapshotsClient.create()) {
   InsertInstantSnapshotRequest request =
       InsertInstantSnapshotRequest.newBuilder()
           .setInstantSnapshotResource(InstantSnapshot.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setZone("zone3744684")
           .build();
   Operation response = instantSnapshotsClient.insertAsync(request).get();
 }

Parameter
Name	Description
`request`	`InsertInstantSnapshotRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`OperationFuture<Operation,Operation>`

insertAsync(String project, String zone, InstantSnapshot instantSnapshotResource)

public final OperationFuture<Operation,Operation> insertAsync(String project, String zone, InstantSnapshot instantSnapshotResource)

Creates an instant snapshot in the specified zone.

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 (InstantSnapshotsClient instantSnapshotsClient = InstantSnapshotsClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   InstantSnapshot instantSnapshotResource = InstantSnapshot.newBuilder().build();
   Operation response =
       instantSnapshotsClient.insertAsync(project, zone, instantSnapshotResource).get();
 }

Parameters
Name	Description
`project`	`String` Project ID for this request.
`zone`	`String` Name of the zone for this request.
`instantSnapshotResource`	`InstantSnapshot` The body resource for this request

Returns
Type	Description
`OperationFuture<Operation,Operation>`

insertCallable()

public final UnaryCallable<InsertInstantSnapshotRequest,Operation> insertCallable()

Creates an instant snapshot in the specified zone.

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 (InstantSnapshotsClient instantSnapshotsClient = InstantSnapshotsClient.create()) {
   InsertInstantSnapshotRequest request =
       InsertInstantSnapshotRequest.newBuilder()
           .setInstantSnapshotResource(InstantSnapshot.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setZone("zone3744684")
           .build();
   ApiFuture<Operation> future = instantSnapshotsClient.insertCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

Returns
Type	Description
`UnaryCallable<InsertInstantSnapshotRequest,Operation>`

insertOperationCallable()

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

Creates an instant snapshot in the specified zone.

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 (InstantSnapshotsClient instantSnapshotsClient = InstantSnapshotsClient.create()) {
   InsertInstantSnapshotRequest request =
       InsertInstantSnapshotRequest.newBuilder()
           .setInstantSnapshotResource(InstantSnapshot.newBuilder().build())
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setZone("zone3744684")
           .build();
   OperationFuture<Operation, Operation> future =
       instantSnapshotsClient.insertOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

Returns
Type	Description
`OperationCallable<InsertInstantSnapshotRequest,Operation,Operation>`

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
Type	Description
`boolean`

list(ListInstantSnapshotsRequest request)

public final InstantSnapshotsClient.ListPagedResponse list(ListInstantSnapshotsRequest request)

Retrieves the list of InstantSnapshot resources contained within the specified zone.

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 (InstantSnapshotsClient instantSnapshotsClient = InstantSnapshotsClient.create()) {
   ListInstantSnapshotsRequest request =
       ListInstantSnapshotsRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .setZone("zone3744684")
           .build();
   for (InstantSnapshot element : instantSnapshotsClient.list(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`ListInstantSnapshotsRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`InstantSnapshotsClient.ListPagedResponse`

list(String project, String zone)

public final InstantSnapshotsClient.ListPagedResponse list(String project, String zone)

Retrieves the list of InstantSnapshot resources contained within the specified zone.

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 (InstantSnapshotsClient instantSnapshotsClient = InstantSnapshotsClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   for (InstantSnapshot element : instantSnapshotsClient.list(project, zone).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters
Name	Description
`project`	`String` Project ID for this request.
`zone`	`String` The name of the zone for this request.

Returns
Type	Description
`InstantSnapshotsClient.ListPagedResponse`

listCallable()

public final UnaryCallable<ListInstantSnapshotsRequest,InstantSnapshotList> listCallable()

Retrieves the list of InstantSnapshot resources contained within the specified zone.

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 (InstantSnapshotsClient instantSnapshotsClient = InstantSnapshotsClient.create()) {
   ListInstantSnapshotsRequest request =
       ListInstantSnapshotsRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .setZone("zone3744684")
           .build();
   while (true) {
     InstantSnapshotList response = instantSnapshotsClient.listCallable().call(request);
     for (InstantSnapshot 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<ListInstantSnapshotsRequest,InstantSnapshotList>`

listPagedCallable()

public final UnaryCallable<ListInstantSnapshotsRequest,InstantSnapshotsClient.ListPagedResponse> listPagedCallable()

Retrieves the list of InstantSnapshot resources contained within the specified zone.

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 (InstantSnapshotsClient instantSnapshotsClient = InstantSnapshotsClient.create()) {
   ListInstantSnapshotsRequest request =
       ListInstantSnapshotsRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .setZone("zone3744684")
           .build();
   ApiFuture<InstantSnapshot> future =
       instantSnapshotsClient.listPagedCallable().futureCall(request);
   // Do something.
   for (InstantSnapshot element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<ListInstantSnapshotsRequest,ListPagedResponse>`

setIamPolicy(SetIamPolicyInstantSnapshotRequest request)

public final Policy setIamPolicy(SetIamPolicyInstantSnapshotRequest request)

Sets the access control policy on the specified resource. Replaces any existing 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 (InstantSnapshotsClient instantSnapshotsClient = InstantSnapshotsClient.create()) {
   SetIamPolicyInstantSnapshotRequest request =
       SetIamPolicyInstantSnapshotRequest.newBuilder()
           .setProject("project-309310695")
           .setResource("resource-341064690")
           .setZone("zone3744684")
           .setZoneSetPolicyRequestResource(ZoneSetPolicyRequest.newBuilder().build())
           .build();
   Policy response = instantSnapshotsClient.setIamPolicy(request);
 }

Parameter
Name	Description
`request`	`SetIamPolicyInstantSnapshotRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`Policy`

setIamPolicy(String project, String zone, String resource, ZoneSetPolicyRequest zoneSetPolicyRequestResource)

public final Policy setIamPolicy(String project, String zone, String resource, ZoneSetPolicyRequest zoneSetPolicyRequestResource)

Sets the access control policy on the specified resource. Replaces any existing 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 (InstantSnapshotsClient instantSnapshotsClient = InstantSnapshotsClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   String resource = "resource-341064690";
   ZoneSetPolicyRequest zoneSetPolicyRequestResource = ZoneSetPolicyRequest.newBuilder().build();
   Policy response =
       instantSnapshotsClient.setIamPolicy(
           project, zone, resource, zoneSetPolicyRequestResource);
 }

Parameters
Name	Description
`project`	`String` Project ID for this request.
`zone`	`String` The name of the zone for this request.
`resource`	`String` Name or id of the resource for this request.
`zoneSetPolicyRequestResource`	`ZoneSetPolicyRequest` The body resource for this request

Returns
Type	Description
`Policy`

setIamPolicyCallable()

public final UnaryCallable<SetIamPolicyInstantSnapshotRequest,Policy> setIamPolicyCallable()

Sets the access control policy on the specified resource. Replaces any existing 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 (InstantSnapshotsClient instantSnapshotsClient = InstantSnapshotsClient.create()) {
   SetIamPolicyInstantSnapshotRequest request =
       SetIamPolicyInstantSnapshotRequest.newBuilder()
           .setProject("project-309310695")
           .setResource("resource-341064690")
           .setZone("zone3744684")
           .setZoneSetPolicyRequestResource(ZoneSetPolicyRequest.newBuilder().build())
           .build();
   ApiFuture<Policy> future = instantSnapshotsClient.setIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }

Returns
Type	Description
`UnaryCallable<SetIamPolicyInstantSnapshotRequest,Policy>`

setLabelsAsync(SetLabelsInstantSnapshotRequest request)

public final OperationFuture<Operation,Operation> setLabelsAsync(SetLabelsInstantSnapshotRequest request)

Sets the labels on a instantSnapshot in the given zone. To learn more about labels, read the Labeling Resources documentation.

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 (InstantSnapshotsClient instantSnapshotsClient = InstantSnapshotsClient.create()) {
   SetLabelsInstantSnapshotRequest request =
       SetLabelsInstantSnapshotRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setResource("resource-341064690")
           .setZone("zone3744684")
           .setZoneSetLabelsRequestResource(ZoneSetLabelsRequest.newBuilder().build())
           .build();
   Operation response = instantSnapshotsClient.setLabelsAsync(request).get();
 }

Parameter
Name	Description
`request`	`SetLabelsInstantSnapshotRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`OperationFuture<Operation,Operation>`

setLabelsAsync(String project, String zone, String resource, ZoneSetLabelsRequest zoneSetLabelsRequestResource)

public final OperationFuture<Operation,Operation> setLabelsAsync(String project, String zone, String resource, ZoneSetLabelsRequest zoneSetLabelsRequestResource)

Sets the labels on a instantSnapshot in the given zone. To learn more about labels, read the Labeling Resources documentation.

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 (InstantSnapshotsClient instantSnapshotsClient = InstantSnapshotsClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   String resource = "resource-341064690";
   ZoneSetLabelsRequest zoneSetLabelsRequestResource = ZoneSetLabelsRequest.newBuilder().build();
   Operation response =
       instantSnapshotsClient
           .setLabelsAsync(project, zone, resource, zoneSetLabelsRequestResource)
           .get();
 }

Parameters
Name	Description
`project`	`String` Project ID for this request.
`zone`	`String` The name of the zone for this request.
`resource`	`String` Name or id of the resource for this request.
`zoneSetLabelsRequestResource`	`ZoneSetLabelsRequest` The body resource for this request

Returns
Type	Description
`OperationFuture<Operation,Operation>`

setLabelsCallable()

public final UnaryCallable<SetLabelsInstantSnapshotRequest,Operation> setLabelsCallable()

Sets the labels on a instantSnapshot in the given zone. To learn more about labels, read the Labeling Resources documentation.

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 (InstantSnapshotsClient instantSnapshotsClient = InstantSnapshotsClient.create()) {
   SetLabelsInstantSnapshotRequest request =
       SetLabelsInstantSnapshotRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setResource("resource-341064690")
           .setZone("zone3744684")
           .setZoneSetLabelsRequestResource(ZoneSetLabelsRequest.newBuilder().build())
           .build();
   ApiFuture<Operation> future = instantSnapshotsClient.setLabelsCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

Returns
Type	Description
`UnaryCallable<SetLabelsInstantSnapshotRequest,Operation>`

setLabelsOperationCallable()

public final OperationCallable<SetLabelsInstantSnapshotRequest,Operation,Operation> setLabelsOperationCallable()

Sets the labels on a instantSnapshot in the given zone. To learn more about labels, read the Labeling Resources documentation.

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 (InstantSnapshotsClient instantSnapshotsClient = InstantSnapshotsClient.create()) {
   SetLabelsInstantSnapshotRequest request =
       SetLabelsInstantSnapshotRequest.newBuilder()
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .setResource("resource-341064690")
           .setZone("zone3744684")
           .setZoneSetLabelsRequestResource(ZoneSetLabelsRequest.newBuilder().build())
           .build();
   OperationFuture<Operation, Operation> future =
       instantSnapshotsClient.setLabelsOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

Returns
Type	Description
`OperationCallable<SetLabelsInstantSnapshotRequest,Operation,Operation>`

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

testIamPermissions(TestIamPermissionsInstantSnapshotRequest request)

public final TestPermissionsResponse testIamPermissions(TestIamPermissionsInstantSnapshotRequest request)

Returns permissions that a caller has on the specified 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 (InstantSnapshotsClient instantSnapshotsClient = InstantSnapshotsClient.create()) {
   TestIamPermissionsInstantSnapshotRequest request =
       TestIamPermissionsInstantSnapshotRequest.newBuilder()
           .setProject("project-309310695")
           .setResource("resource-341064690")
           .setTestPermissionsRequestResource(TestPermissionsRequest.newBuilder().build())
           .setZone("zone3744684")
           .build();
   TestPermissionsResponse response = instantSnapshotsClient.testIamPermissions(request);
 }

Parameter
Name	Description
`request`	`TestIamPermissionsInstantSnapshotRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`TestPermissionsResponse`

testIamPermissions(String project, String zone, String resource, TestPermissionsRequest testPermissionsRequestResource)

public final TestPermissionsResponse testIamPermissions(String project, String zone, String resource, TestPermissionsRequest testPermissionsRequestResource)

Returns permissions that a caller has on the specified 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 (InstantSnapshotsClient instantSnapshotsClient = InstantSnapshotsClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   String resource = "resource-341064690";
   TestPermissionsRequest testPermissionsRequestResource =
       TestPermissionsRequest.newBuilder().build();
   TestPermissionsResponse response =
       instantSnapshotsClient.testIamPermissions(
           project, zone, resource, testPermissionsRequestResource);
 }

Parameters
Name	Description
`project`	`String` Project ID for this request.
`zone`	`String` The name of the zone for this request.
`resource`	`String` Name or id of the resource for this request.
`testPermissionsRequestResource`	`TestPermissionsRequest` The body resource for this request

Returns
Type	Description
`TestPermissionsResponse`

testIamPermissionsCallable()

public final UnaryCallable<TestIamPermissionsInstantSnapshotRequest,TestPermissionsResponse> testIamPermissionsCallable()

Returns permissions that a caller has on the specified 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 (InstantSnapshotsClient instantSnapshotsClient = InstantSnapshotsClient.create()) {
   TestIamPermissionsInstantSnapshotRequest request =
       TestIamPermissionsInstantSnapshotRequest.newBuilder()
           .setProject("project-309310695")
           .setResource("resource-341064690")
           .setTestPermissionsRequestResource(TestPermissionsRequest.newBuilder().build())
           .setZone("zone3744684")
           .build();
   ApiFuture<TestPermissionsResponse> future =
       instantSnapshotsClient.testIamPermissionsCallable().futureCall(request);
   // Do something.
   TestPermissionsResponse response = future.get();
 }

Returns
Type	Description
`UnaryCallable<TestIamPermissionsInstantSnapshotRequest,TestPermissionsResponse>`