- 1.63.0 (latest)
- 1.62.0
- 1.61.0
- 1.59.0
- 1.58.0
- 1.57.0
- 1.56.0
- 1.55.0
- 1.54.0
- 1.53.0
- 1.52.0
- 1.51.0
- 1.50.0
- 1.49.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.0
- 1.37.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.26.0
- 1.25.0
- 1.24.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.1
- 1.11.0
- 1.9.1
- 1.8.1
- 1.7.2
- 1.6.0-beta
GitHub Repository | Product Reference |
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().
Method | Description | Method Variants |
---|---|---|
AggregatedList |
Retrieves an aggregated list of instantSnapshots. To prevent failure, Google recommends that you set the |
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
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
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
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.
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)
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()) {
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()
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();
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()
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();
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> |