@Generated(value="by gapic-generator-java") public class InstantSnapshotsClient extends Object implements com.google.api.gax.core.BackgroundResource
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().
| 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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
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.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return 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 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.
| Modifier and Type | Class and Description |
|---|---|
static class |
InstantSnapshotsClient.AggregatedListFixedSizeCollection |
static class |
InstantSnapshotsClient.AggregatedListPage |
static class |
InstantSnapshotsClient.AggregatedListPagedResponse |
static class |
InstantSnapshotsClient.ListFixedSizeCollection |
static class |
InstantSnapshotsClient.ListPage |
static class |
InstantSnapshotsClient.ListPagedResponse |
| Modifier | Constructor and Description |
|---|---|
protected |
InstantSnapshotsClient(InstantSnapshotsSettings settings)
Constructs an instance of InstantSnapshotsClient, using the given settings.
|
protected |
InstantSnapshotsClient(InstantSnapshotsStub stub) |
| Modifier and Type | Method and Description |
|---|---|
InstantSnapshotsClient.AggregatedListPagedResponse |
aggregatedList(AggregatedListInstantSnapshotsRequest request)
Retrieves an aggregated list of instantSnapshots.
|
InstantSnapshotsClient.AggregatedListPagedResponse |
aggregatedList(String project)
Retrieves an aggregated list of instantSnapshots.
|
com.google.api.gax.rpc.UnaryCallable<AggregatedListInstantSnapshotsRequest,InstantSnapshotAggregatedList> |
aggregatedListCallable()
Retrieves an aggregated list of instantSnapshots.
|
com.google.api.gax.rpc.UnaryCallable<AggregatedListInstantSnapshotsRequest,InstantSnapshotsClient.AggregatedListPagedResponse> |
aggregatedListPagedCallable()
Retrieves an aggregated list of instantSnapshots.
|
boolean |
awaitTermination(long duration,
TimeUnit unit) |
void |
close() |
static InstantSnapshotsClient |
create()
Constructs an instance of InstantSnapshotsClient with default settings.
|
static InstantSnapshotsClient |
create(InstantSnapshotsSettings settings)
Constructs an instance of InstantSnapshotsClient, using the given settings.
|
static InstantSnapshotsClient |
create(InstantSnapshotsStub stub)
Constructs an instance of InstantSnapshotsClient, using the given stub for making calls.
|
com.google.api.gax.longrunning.OperationFuture<Operation,Operation> |
deleteAsync(DeleteInstantSnapshotRequest request)
Deletes the specified InstantSnapshot resource.
|
com.google.api.gax.longrunning.OperationFuture<Operation,Operation> |
deleteAsync(String project,
String zone,
String instantSnapshot)
Deletes the specified InstantSnapshot resource.
|
com.google.api.gax.rpc.UnaryCallable<DeleteInstantSnapshotRequest,Operation> |
deleteCallable()
Deletes the specified InstantSnapshot resource.
|
com.google.api.gax.rpc.OperationCallable<DeleteInstantSnapshotRequest,Operation,Operation> |
deleteOperationCallable()
Deletes the specified InstantSnapshot resource.
|
InstantSnapshot |
get(GetInstantSnapshotRequest request)
Returns the specified InstantSnapshot resource in the specified zone.
|
InstantSnapshot |
get(String project,
String zone,
String instantSnapshot)
Returns the specified InstantSnapshot resource in the specified zone.
|
com.google.api.gax.rpc.UnaryCallable<GetInstantSnapshotRequest,InstantSnapshot> |
getCallable()
Returns the specified InstantSnapshot resource in the specified zone.
|
Policy |
getIamPolicy(GetIamPolicyInstantSnapshotRequest request)
Gets the access control policy for a resource.
|
Policy |
getIamPolicy(String project,
String zone,
String resource)
Gets the access control policy for a resource.
|
com.google.api.gax.rpc.UnaryCallable<GetIamPolicyInstantSnapshotRequest,Policy> |
getIamPolicyCallable()
Gets the access control policy for a resource.
|
InstantSnapshotsSettings |
getSettings() |
InstantSnapshotsStub |
getStub() |
com.google.api.gax.longrunning.OperationFuture<Operation,Operation> |
insertAsync(InsertInstantSnapshotRequest request)
Creates an instant snapshot in the specified zone.
|
com.google.api.gax.longrunning.OperationFuture<Operation,Operation> |
insertAsync(String project,
String zone,
InstantSnapshot instantSnapshotResource)
Creates an instant snapshot in the specified zone.
|
com.google.api.gax.rpc.UnaryCallable<InsertInstantSnapshotRequest,Operation> |
insertCallable()
Creates an instant snapshot in the specified zone.
|
com.google.api.gax.rpc.OperationCallable<InsertInstantSnapshotRequest,Operation,Operation> |
insertOperationCallable()
Creates an instant snapshot in the specified zone.
|
boolean |
isShutdown() |
boolean |
isTerminated() |
InstantSnapshotsClient.ListPagedResponse |
list(ListInstantSnapshotsRequest request)
Retrieves the list of InstantSnapshot resources contained within the specified zone.
|
InstantSnapshotsClient.ListPagedResponse |
list(String project,
String zone)
Retrieves the list of InstantSnapshot resources contained within the specified zone.
|
com.google.api.gax.rpc.UnaryCallable<ListInstantSnapshotsRequest,InstantSnapshotList> |
listCallable()
Retrieves the list of InstantSnapshot resources contained within the specified zone.
|
com.google.api.gax.rpc.UnaryCallable<ListInstantSnapshotsRequest,InstantSnapshotsClient.ListPagedResponse> |
listPagedCallable()
Retrieves the list of InstantSnapshot resources contained within the specified zone.
|
Policy |
setIamPolicy(SetIamPolicyInstantSnapshotRequest request)
Sets the access control policy on the specified resource.
|
Policy |
setIamPolicy(String project,
String zone,
String resource,
ZoneSetPolicyRequest zoneSetPolicyRequestResource)
Sets the access control policy on the specified resource.
|
com.google.api.gax.rpc.UnaryCallable<SetIamPolicyInstantSnapshotRequest,Policy> |
setIamPolicyCallable()
Sets the access control policy on the specified resource.
|
com.google.api.gax.longrunning.OperationFuture<Operation,Operation> |
setLabelsAsync(SetLabelsInstantSnapshotRequest request)
Sets the labels on a instantSnapshot in the given zone.
|
com.google.api.gax.longrunning.OperationFuture<Operation,Operation> |
setLabelsAsync(String project,
String zone,
String resource,
ZoneSetLabelsRequest zoneSetLabelsRequestResource)
Sets the labels on a instantSnapshot in the given zone.
|
com.google.api.gax.rpc.UnaryCallable<SetLabelsInstantSnapshotRequest,Operation> |
setLabelsCallable()
Sets the labels on a instantSnapshot in the given zone.
|
com.google.api.gax.rpc.OperationCallable<SetLabelsInstantSnapshotRequest,Operation,Operation> |
setLabelsOperationCallable()
Sets the labels on a instantSnapshot in the given zone.
|
void |
shutdown() |
void |
shutdownNow() |
TestPermissionsResponse |
testIamPermissions(String project,
String zone,
String resource,
TestPermissionsRequest testPermissionsRequestResource)
Returns permissions that a caller has on the specified resource.
|
TestPermissionsResponse |
testIamPermissions(TestIamPermissionsInstantSnapshotRequest request)
Returns permissions that a caller has on the specified resource.
|
com.google.api.gax.rpc.UnaryCallable<TestIamPermissionsInstantSnapshotRequest,TestPermissionsResponse> |
testIamPermissionsCallable()
Returns permissions that a caller has on the specified resource.
|
protected InstantSnapshotsClient(InstantSnapshotsSettings settings) throws IOException
IOExceptionprotected InstantSnapshotsClient(InstantSnapshotsStub stub)
public static final InstantSnapshotsClient create() throws IOException
IOExceptionpublic static final InstantSnapshotsClient create(InstantSnapshotsSettings settings) throws IOException
IOExceptionpublic static final InstantSnapshotsClient create(InstantSnapshotsStub stub)
public final InstantSnapshotsSettings getSettings()
public InstantSnapshotsStub getStub()
public final InstantSnapshotsClient.AggregatedListPagedResponse aggregatedList(String project)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (InstantSnapshotsClient instantSnapshotsClient = InstantSnapshotsClient.create()) {
String project = "project-309310695";
for (Map.Entry<String, InstantSnapshotsScopedList> element :
instantSnapshotsClient.aggregatedList(project).iterateAll()) {
// doThingsWith(element);
}
}
project - Project ID for this request.com.google.api.gax.rpc.ApiException - if the remote call failspublic final InstantSnapshotsClient.AggregatedListPagedResponse aggregatedList(AggregatedListInstantSnapshotsRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (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);
}
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<AggregatedListInstantSnapshotsRequest,InstantSnapshotsClient.AggregatedListPagedResponse> aggregatedListPagedCallable()
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);
}
}
public final com.google.api.gax.rpc.UnaryCallable<AggregatedListInstantSnapshotsRequest,InstantSnapshotAggregatedList> aggregatedListCallable()
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;
}
}
}
public final com.google.api.gax.longrunning.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();
}
project - Project ID for this request.zone - The name of the zone for this request.instantSnapshot - Name of the InstantSnapshot resource to delete.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> deleteAsync(DeleteInstantSnapshotRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (InstantSnapshotsClient instantSnapshotsClient = InstantSnapshotsClient.create()) {
DeleteInstantSnapshotRequest request =
DeleteInstantSnapshotRequest.newBuilder()
.setInstantSnapshot("instantSnapshot800321221")
.setProject("project-309310695")
.setRequestId("requestId693933066")
.setZone("zone3744684")
.build();
Operation response = instantSnapshotsClient.deleteAsync(request).get();
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.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();
}
public final com.google.api.gax.rpc.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();
}
public final InstantSnapshot get(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";
InstantSnapshot response = instantSnapshotsClient.get(project, zone, instantSnapshot);
}
project - Project ID for this request.zone - The name of the zone for this request.instantSnapshot - Name of the InstantSnapshot resource to return.com.google.api.gax.rpc.ApiException - if the remote call failspublic final InstantSnapshot get(GetInstantSnapshotRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (InstantSnapshotsClient instantSnapshotsClient = InstantSnapshotsClient.create()) {
GetInstantSnapshotRequest request =
GetInstantSnapshotRequest.newBuilder()
.setInstantSnapshot("instantSnapshot800321221")
.setProject("project-309310695")
.setZone("zone3744684")
.build();
InstantSnapshot response = instantSnapshotsClient.get(request);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<GetInstantSnapshotRequest,InstantSnapshot> getCallable()
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();
}
public final Policy getIamPolicy(String project, String zone, String 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";
Policy response = instantSnapshotsClient.getIamPolicy(project, zone, resource);
}
project - Project ID for this request.zone - The name of the zone for this request.resource - Name or id of the resource for this request.com.google.api.gax.rpc.ApiException - if the remote call failspublic final Policy getIamPolicy(GetIamPolicyInstantSnapshotRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (InstantSnapshotsClient instantSnapshotsClient = InstantSnapshotsClient.create()) {
GetIamPolicyInstantSnapshotRequest request =
GetIamPolicyInstantSnapshotRequest.newBuilder()
.setOptionsRequestedPolicyVersion(-574521795)
.setProject("project-309310695")
.setResource("resource-341064690")
.setZone("zone3744684")
.build();
Policy response = instantSnapshotsClient.getIamPolicy(request);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<GetIamPolicyInstantSnapshotRequest,Policy> getIamPolicyCallable()
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();
}
public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> insertAsync(String project, String zone, InstantSnapshot instantSnapshotResource)
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();
}
project - Project ID for this request.zone - Name of the zone for this request.instantSnapshotResource - The body resource for this requestcom.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> insertAsync(InsertInstantSnapshotRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (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();
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.OperationCallable<InsertInstantSnapshotRequest,Operation,Operation> insertOperationCallable()
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();
}
public final com.google.api.gax.rpc.UnaryCallable<InsertInstantSnapshotRequest,Operation> insertCallable()
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();
}
public final InstantSnapshotsClient.ListPagedResponse list(String project, String 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);
}
}
project - Project ID for this request.zone - The name of the zone for this request.com.google.api.gax.rpc.ApiException - if the remote call failspublic final InstantSnapshotsClient.ListPagedResponse list(ListInstantSnapshotsRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (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);
}
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<ListInstantSnapshotsRequest,InstantSnapshotsClient.ListPagedResponse> listPagedCallable()
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);
}
}
public final com.google.api.gax.rpc.UnaryCallable<ListInstantSnapshotsRequest,InstantSnapshotList> listCallable()
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;
}
}
}
public final Policy setIamPolicy(String project, String zone, String resource, ZoneSetPolicyRequest zoneSetPolicyRequestResource)
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);
}
project - Project ID for this request.zone - The name of the zone for this request.resource - Name or id of the resource for this request.zoneSetPolicyRequestResource - The body resource for this requestcom.google.api.gax.rpc.ApiException - if the remote call failspublic final Policy setIamPolicy(SetIamPolicyInstantSnapshotRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (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);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<SetIamPolicyInstantSnapshotRequest,Policy> setIamPolicyCallable()
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();
}
public final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> setLabelsAsync(String project, String zone, String resource, ZoneSetLabelsRequest zoneSetLabelsRequestResource)
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();
}
project - Project ID for this request.zone - The name of the zone for this request.resource - Name or id of the resource for this request.zoneSetLabelsRequestResource - The body resource for this requestcom.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.longrunning.OperationFuture<Operation,Operation> setLabelsAsync(SetLabelsInstantSnapshotRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (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();
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.OperationCallable<SetLabelsInstantSnapshotRequest,Operation,Operation> setLabelsOperationCallable()
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();
}
public final com.google.api.gax.rpc.UnaryCallable<SetLabelsInstantSnapshotRequest,Operation> setLabelsCallable()
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();
}
public final TestPermissionsResponse testIamPermissions(String project, String zone, String resource, TestPermissionsRequest testPermissionsRequestResource)
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);
}
project - Project ID for this request.zone - The name of the zone for this request.resource - Name or id of the resource for this request.testPermissionsRequestResource - The body resource for this requestcom.google.api.gax.rpc.ApiException - if the remote call failspublic final TestPermissionsResponse testIamPermissions(TestIamPermissionsInstantSnapshotRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (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);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<TestIamPermissionsInstantSnapshotRequest,TestPermissionsResponse> testIamPermissionsCallable()
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();
}
public final void close()
close in interface AutoCloseablepublic void shutdown()
shutdown in interface com.google.api.gax.core.BackgroundResourcepublic boolean isShutdown()
isShutdown in interface com.google.api.gax.core.BackgroundResourcepublic boolean isTerminated()
isTerminated in interface com.google.api.gax.core.BackgroundResourcepublic void shutdownNow()
shutdownNow in interface com.google.api.gax.core.BackgroundResourcepublic boolean awaitTermination(long duration,
TimeUnit unit)
throws InterruptedException
awaitTermination in interface com.google.api.gax.core.BackgroundResourceInterruptedExceptionCopyright © 2024 Google LLC. All rights reserved.