- 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 RegionInstantSnapshots 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 (RegionInstantSnapshotsClient regionInstantSnapshotsClient =
RegionInstantSnapshotsClient.create()) {
String project = "project-309310695";
String region = "region-934795532";
String instantSnapshot = "instantSnapshot800321221";
InstantSnapshot response = regionInstantSnapshotsClient.get(project, region, instantSnapshot);
}
Note: close() needs to be called on the RegionInstantSnapshotsClient 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 |
---|---|---|
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 region. |
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 region. |
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 region. |
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 region. 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 RegionInstantSnapshotsSettings 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
RegionInstantSnapshotsSettings regionInstantSnapshotsSettings =
RegionInstantSnapshotsSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
RegionInstantSnapshotsClient regionInstantSnapshotsClient =
RegionInstantSnapshotsClient.create(regionInstantSnapshotsSettings);
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
RegionInstantSnapshotsSettings regionInstantSnapshotsSettings =
RegionInstantSnapshotsSettings.newBuilder().setEndpoint(myEndpoint).build();
RegionInstantSnapshotsClient regionInstantSnapshotsClient =
RegionInstantSnapshotsClient.create(regionInstantSnapshotsSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Static Methods
create()
public static final RegionInstantSnapshotsClient create()
Constructs an instance of RegionInstantSnapshotsClient with default settings.
Returns | |
---|---|
Type | Description |
RegionInstantSnapshotsClient |
Exceptions | |
---|---|
Type | Description |
IOException |
create(RegionInstantSnapshotsSettings settings)
public static final RegionInstantSnapshotsClient create(RegionInstantSnapshotsSettings settings)
Constructs an instance of RegionInstantSnapshotsClient, 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 | RegionInstantSnapshotsSettings |
Returns | |
---|---|
Type | Description |
RegionInstantSnapshotsClient |
Exceptions | |
---|---|
Type | Description |
IOException |
create(RegionInstantSnapshotsStub stub)
public static final RegionInstantSnapshotsClient create(RegionInstantSnapshotsStub stub)
Constructs an instance of RegionInstantSnapshotsClient, using the given stub for making calls. This is for advanced usage - prefer using create(RegionInstantSnapshotsSettings).
Parameter | |
---|---|
Name | Description |
stub | RegionInstantSnapshotsStub |
Returns | |
---|---|
Type | Description |
RegionInstantSnapshotsClient |
Constructors
RegionInstantSnapshotsClient(RegionInstantSnapshotsSettings settings)
protected RegionInstantSnapshotsClient(RegionInstantSnapshotsSettings settings)
Constructs an instance of RegionInstantSnapshotsClient, 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 | RegionInstantSnapshotsSettings |
RegionInstantSnapshotsClient(RegionInstantSnapshotsStub stub)
protected RegionInstantSnapshotsClient(RegionInstantSnapshotsStub stub)
Parameter | |
---|---|
Name | Description |
stub | RegionInstantSnapshotsStub |
Methods
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(DeleteRegionInstantSnapshotRequest request)
public final OperationFuture<Operation,Operation> deleteAsync(DeleteRegionInstantSnapshotRequest 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 (RegionInstantSnapshotsClient regionInstantSnapshotsClient =
RegionInstantSnapshotsClient.create()) {
DeleteRegionInstantSnapshotRequest request =
DeleteRegionInstantSnapshotRequest.newBuilder()
.setInstantSnapshot("instantSnapshot800321221")
.setProject("project-309310695")
.setRegion("region-934795532")
.setRequestId("requestId693933066")
.build();
Operation response = regionInstantSnapshotsClient.deleteAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request | DeleteRegionInstantSnapshotRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Operation,Operation> |
deleteAsync(String project, String region, String instantSnapshot)
public final OperationFuture<Operation,Operation> deleteAsync(String project, String region, 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 (RegionInstantSnapshotsClient regionInstantSnapshotsClient =
RegionInstantSnapshotsClient.create()) {
String project = "project-309310695";
String region = "region-934795532";
String instantSnapshot = "instantSnapshot800321221";
Operation response =
regionInstantSnapshotsClient.deleteAsync(project, region, instantSnapshot).get();
}
Parameters | |
---|---|
Name | Description |
project | String Project ID for this request. |
region | String The name of the region for this request. |
instantSnapshot | String Name of the InstantSnapshot resource to delete. |
Returns | |
---|---|
Type | Description |
OperationFuture<Operation,Operation> |
deleteCallable()
public final UnaryCallable<DeleteRegionInstantSnapshotRequest,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 (RegionInstantSnapshotsClient regionInstantSnapshotsClient =
RegionInstantSnapshotsClient.create()) {
DeleteRegionInstantSnapshotRequest request =
DeleteRegionInstantSnapshotRequest.newBuilder()
.setInstantSnapshot("instantSnapshot800321221")
.setProject("project-309310695")
.setRegion("region-934795532")
.setRequestId("requestId693933066")
.build();
ApiFuture<Operation> future =
regionInstantSnapshotsClient.deleteCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<DeleteRegionInstantSnapshotRequest,Operation> |
deleteOperationCallable()
public final OperationCallable<DeleteRegionInstantSnapshotRequest,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 (RegionInstantSnapshotsClient regionInstantSnapshotsClient =
RegionInstantSnapshotsClient.create()) {
DeleteRegionInstantSnapshotRequest request =
DeleteRegionInstantSnapshotRequest.newBuilder()
.setInstantSnapshot("instantSnapshot800321221")
.setProject("project-309310695")
.setRegion("region-934795532")
.setRequestId("requestId693933066")
.build();
OperationFuture<Operation, Operation> future =
regionInstantSnapshotsClient.deleteOperationCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<DeleteRegionInstantSnapshotRequest,Operation,Operation> |
get(GetRegionInstantSnapshotRequest request)
public final InstantSnapshot get(GetRegionInstantSnapshotRequest request)
Returns the specified InstantSnapshot resource in the specified region.
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 (RegionInstantSnapshotsClient regionInstantSnapshotsClient =
RegionInstantSnapshotsClient.create()) {
GetRegionInstantSnapshotRequest request =
GetRegionInstantSnapshotRequest.newBuilder()
.setInstantSnapshot("instantSnapshot800321221")
.setProject("project-309310695")
.setRegion("region-934795532")
.build();
InstantSnapshot response = regionInstantSnapshotsClient.get(request);
}
Parameter | |
---|---|
Name | Description |
request | GetRegionInstantSnapshotRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
InstantSnapshot |
get(String project, String region, String instantSnapshot)
public final InstantSnapshot get(String project, String region, String instantSnapshot)
Returns the specified InstantSnapshot resource in the specified region.
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 (RegionInstantSnapshotsClient regionInstantSnapshotsClient =
RegionInstantSnapshotsClient.create()) {
String project = "project-309310695";
String region = "region-934795532";
String instantSnapshot = "instantSnapshot800321221";
InstantSnapshot response = regionInstantSnapshotsClient.get(project, region, instantSnapshot);
}
Parameters | |
---|---|
Name | Description |
project | String Project ID for this request. |
region | String The name of the region for this request. |
instantSnapshot | String Name of the InstantSnapshot resource to return. |
Returns | |
---|---|
Type | Description |
InstantSnapshot |
getCallable()
public final UnaryCallable<GetRegionInstantSnapshotRequest,InstantSnapshot> getCallable()
Returns the specified InstantSnapshot resource in the specified region.
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 (RegionInstantSnapshotsClient regionInstantSnapshotsClient =
RegionInstantSnapshotsClient.create()) {
GetRegionInstantSnapshotRequest request =
GetRegionInstantSnapshotRequest.newBuilder()
.setInstantSnapshot("instantSnapshot800321221")
.setProject("project-309310695")
.setRegion("region-934795532")
.build();
ApiFuture<InstantSnapshot> future =
regionInstantSnapshotsClient.getCallable().futureCall(request);
// Do something.
InstantSnapshot response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<GetRegionInstantSnapshotRequest,InstantSnapshot> |
getIamPolicy(GetIamPolicyRegionInstantSnapshotRequest request)
public final Policy getIamPolicy(GetIamPolicyRegionInstantSnapshotRequest 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 (RegionInstantSnapshotsClient regionInstantSnapshotsClient =
RegionInstantSnapshotsClient.create()) {
GetIamPolicyRegionInstantSnapshotRequest request =
GetIamPolicyRegionInstantSnapshotRequest.newBuilder()
.setOptionsRequestedPolicyVersion(-574521795)
.setProject("project-309310695")
.setRegion("region-934795532")
.setResource("resource-341064690")
.build();
Policy response = regionInstantSnapshotsClient.getIamPolicy(request);
}
Parameter | |
---|---|
Name | Description |
request | GetIamPolicyRegionInstantSnapshotRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
Policy |
getIamPolicy(String project, String region, String resource)
public final Policy getIamPolicy(String project, String region, 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 (RegionInstantSnapshotsClient regionInstantSnapshotsClient =
RegionInstantSnapshotsClient.create()) {
String project = "project-309310695";
String region = "region-934795532";
String resource = "resource-341064690";
Policy response = regionInstantSnapshotsClient.getIamPolicy(project, region, resource);
}
Parameters | |
---|---|
Name | Description |
project | String Project ID for this request. |
region | String The name of the region for this request. |
resource | String Name or id of the resource for this request. |
Returns | |
---|---|
Type | Description |
Policy |
getIamPolicyCallable()
public final UnaryCallable<GetIamPolicyRegionInstantSnapshotRequest,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 (RegionInstantSnapshotsClient regionInstantSnapshotsClient =
RegionInstantSnapshotsClient.create()) {
GetIamPolicyRegionInstantSnapshotRequest request =
GetIamPolicyRegionInstantSnapshotRequest.newBuilder()
.setOptionsRequestedPolicyVersion(-574521795)
.setProject("project-309310695")
.setRegion("region-934795532")
.setResource("resource-341064690")
.build();
ApiFuture<Policy> future =
regionInstantSnapshotsClient.getIamPolicyCallable().futureCall(request);
// Do something.
Policy response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<GetIamPolicyRegionInstantSnapshotRequest,Policy> |
getSettings()
public final RegionInstantSnapshotsSettings getSettings()
Returns | |
---|---|
Type | Description |
RegionInstantSnapshotsSettings |
getStub()
public RegionInstantSnapshotsStub getStub()
Returns | |
---|---|
Type | Description |
RegionInstantSnapshotsStub |
insertAsync(InsertRegionInstantSnapshotRequest request)
public final OperationFuture<Operation,Operation> insertAsync(InsertRegionInstantSnapshotRequest request)
Creates an instant snapshot in the specified region.
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 (RegionInstantSnapshotsClient regionInstantSnapshotsClient =
RegionInstantSnapshotsClient.create()) {
InsertRegionInstantSnapshotRequest request =
InsertRegionInstantSnapshotRequest.newBuilder()
.setInstantSnapshotResource(InstantSnapshot.newBuilder().build())
.setProject("project-309310695")
.setRegion("region-934795532")
.setRequestId("requestId693933066")
.build();
Operation response = regionInstantSnapshotsClient.insertAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request | InsertRegionInstantSnapshotRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Operation,Operation> |
insertAsync(String project, String region, InstantSnapshot instantSnapshotResource)
public final OperationFuture<Operation,Operation> insertAsync(String project, String region, InstantSnapshot instantSnapshotResource)
Creates an instant snapshot in the specified region.
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 (RegionInstantSnapshotsClient regionInstantSnapshotsClient =
RegionInstantSnapshotsClient.create()) {
String project = "project-309310695";
String region = "region-934795532";
InstantSnapshot instantSnapshotResource = InstantSnapshot.newBuilder().build();
Operation response =
regionInstantSnapshotsClient.insertAsync(project, region, instantSnapshotResource).get();
}
Parameters | |
---|---|
Name | Description |
project | String Project ID for this request. |
region | String Name of the region for this request. |
instantSnapshotResource | InstantSnapshot The body resource for this request |
Returns | |
---|---|
Type | Description |
OperationFuture<Operation,Operation> |
insertCallable()
public final UnaryCallable<InsertRegionInstantSnapshotRequest,Operation> insertCallable()
Creates an instant snapshot in the specified region.
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 (RegionInstantSnapshotsClient regionInstantSnapshotsClient =
RegionInstantSnapshotsClient.create()) {
InsertRegionInstantSnapshotRequest request =
InsertRegionInstantSnapshotRequest.newBuilder()
.setInstantSnapshotResource(InstantSnapshot.newBuilder().build())
.setProject("project-309310695")
.setRegion("region-934795532")
.setRequestId("requestId693933066")
.build();
ApiFuture<Operation> future =
regionInstantSnapshotsClient.insertCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<InsertRegionInstantSnapshotRequest,Operation> |
insertOperationCallable()
public final OperationCallable<InsertRegionInstantSnapshotRequest,Operation,Operation> insertOperationCallable()
Creates an instant snapshot in the specified region.
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 (RegionInstantSnapshotsClient regionInstantSnapshotsClient =
RegionInstantSnapshotsClient.create()) {
InsertRegionInstantSnapshotRequest request =
InsertRegionInstantSnapshotRequest.newBuilder()
.setInstantSnapshotResource(InstantSnapshot.newBuilder().build())
.setProject("project-309310695")
.setRegion("region-934795532")
.setRequestId("requestId693933066")
.build();
OperationFuture<Operation, Operation> future =
regionInstantSnapshotsClient.insertOperationCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<InsertRegionInstantSnapshotRequest,Operation,Operation> |
isShutdown()
public boolean isShutdown()
Returns | |
---|---|
Type | Description |
boolean |
isTerminated()
public boolean isTerminated()
Returns | |
---|---|
Type | Description |
boolean |
list(ListRegionInstantSnapshotsRequest request)
public final RegionInstantSnapshotsClient.ListPagedResponse list(ListRegionInstantSnapshotsRequest request)
Retrieves the list of InstantSnapshot resources contained within the specified region.
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 (RegionInstantSnapshotsClient regionInstantSnapshotsClient =
RegionInstantSnapshotsClient.create()) {
ListRegionInstantSnapshotsRequest request =
ListRegionInstantSnapshotsRequest.newBuilder()
.setFilter("filter-1274492040")
.setMaxResults(1128457243)
.setOrderBy("orderBy-1207110587")
.setPageToken("pageToken873572522")
.setProject("project-309310695")
.setRegion("region-934795532")
.setReturnPartialSuccess(true)
.build();
for (InstantSnapshot element : regionInstantSnapshotsClient.list(request).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
request | ListRegionInstantSnapshotsRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
RegionInstantSnapshotsClient.ListPagedResponse |
list(String project, String region)
public final RegionInstantSnapshotsClient.ListPagedResponse list(String project, String region)
Retrieves the list of InstantSnapshot resources contained within the specified region.
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 (RegionInstantSnapshotsClient regionInstantSnapshotsClient =
RegionInstantSnapshotsClient.create()) {
String project = "project-309310695";
String region = "region-934795532";
for (InstantSnapshot element :
regionInstantSnapshotsClient.list(project, region).iterateAll()) {
// doThingsWith(element);
}
}
Parameters | |
---|---|
Name | Description |
project | String Project ID for this request. |
region | String The name of the region for this request. |
Returns | |
---|---|
Type | Description |
RegionInstantSnapshotsClient.ListPagedResponse |
listCallable()
public final UnaryCallable<ListRegionInstantSnapshotsRequest,InstantSnapshotList> listCallable()
Retrieves the list of InstantSnapshot resources contained within the specified region.
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 (RegionInstantSnapshotsClient regionInstantSnapshotsClient =
RegionInstantSnapshotsClient.create()) {
ListRegionInstantSnapshotsRequest request =
ListRegionInstantSnapshotsRequest.newBuilder()
.setFilter("filter-1274492040")
.setMaxResults(1128457243)
.setOrderBy("orderBy-1207110587")
.setPageToken("pageToken873572522")
.setProject("project-309310695")
.setRegion("region-934795532")
.setReturnPartialSuccess(true)
.build();
while (true) {
InstantSnapshotList response = regionInstantSnapshotsClient.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<ListRegionInstantSnapshotsRequest,InstantSnapshotList> |
listPagedCallable()
public final UnaryCallable<ListRegionInstantSnapshotsRequest,RegionInstantSnapshotsClient.ListPagedResponse> listPagedCallable()
Retrieves the list of InstantSnapshot resources contained within the specified region.
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 (RegionInstantSnapshotsClient regionInstantSnapshotsClient =
RegionInstantSnapshotsClient.create()) {
ListRegionInstantSnapshotsRequest request =
ListRegionInstantSnapshotsRequest.newBuilder()
.setFilter("filter-1274492040")
.setMaxResults(1128457243)
.setOrderBy("orderBy-1207110587")
.setPageToken("pageToken873572522")
.setProject("project-309310695")
.setRegion("region-934795532")
.setReturnPartialSuccess(true)
.build();
ApiFuture<InstantSnapshot> future =
regionInstantSnapshotsClient.listPagedCallable().futureCall(request);
// Do something.
for (InstantSnapshot element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListRegionInstantSnapshotsRequest,ListPagedResponse> |
setIamPolicy(SetIamPolicyRegionInstantSnapshotRequest request)
public final Policy setIamPolicy(SetIamPolicyRegionInstantSnapshotRequest 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 (RegionInstantSnapshotsClient regionInstantSnapshotsClient =
RegionInstantSnapshotsClient.create()) {
SetIamPolicyRegionInstantSnapshotRequest request =
SetIamPolicyRegionInstantSnapshotRequest.newBuilder()
.setProject("project-309310695")
.setRegion("region-934795532")
.setRegionSetPolicyRequestResource(RegionSetPolicyRequest.newBuilder().build())
.setResource("resource-341064690")
.build();
Policy response = regionInstantSnapshotsClient.setIamPolicy(request);
}
Parameter | |
---|---|
Name | Description |
request | SetIamPolicyRegionInstantSnapshotRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
Policy |
setIamPolicy(String project, String region, String resource, RegionSetPolicyRequest regionSetPolicyRequestResource)
public final Policy setIamPolicy(String project, String region, String resource, RegionSetPolicyRequest regionSetPolicyRequestResource)
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 (RegionInstantSnapshotsClient regionInstantSnapshotsClient =
RegionInstantSnapshotsClient.create()) {
String project = "project-309310695";
String region = "region-934795532";
String resource = "resource-341064690";
RegionSetPolicyRequest regionSetPolicyRequestResource =
RegionSetPolicyRequest.newBuilder().build();
Policy response =
regionInstantSnapshotsClient.setIamPolicy(
project, region, resource, regionSetPolicyRequestResource);
}
Parameters | |
---|---|
Name | Description |
project | String Project ID for this request. |
region | String The name of the region for this request. |
resource | String Name or id of the resource for this request. |
regionSetPolicyRequestResource | RegionSetPolicyRequest The body resource for this request |
Returns | |
---|---|
Type | Description |
Policy |
setIamPolicyCallable()
public final UnaryCallable<SetIamPolicyRegionInstantSnapshotRequest,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 (RegionInstantSnapshotsClient regionInstantSnapshotsClient =
RegionInstantSnapshotsClient.create()) {
SetIamPolicyRegionInstantSnapshotRequest request =
SetIamPolicyRegionInstantSnapshotRequest.newBuilder()
.setProject("project-309310695")
.setRegion("region-934795532")
.setRegionSetPolicyRequestResource(RegionSetPolicyRequest.newBuilder().build())
.setResource("resource-341064690")
.build();
ApiFuture<Policy> future =
regionInstantSnapshotsClient.setIamPolicyCallable().futureCall(request);
// Do something.
Policy response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<SetIamPolicyRegionInstantSnapshotRequest,Policy> |
setLabelsAsync(SetLabelsRegionInstantSnapshotRequest request)
public final OperationFuture<Operation,Operation> setLabelsAsync(SetLabelsRegionInstantSnapshotRequest request)
Sets the labels on a instantSnapshot in the given region. 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 (RegionInstantSnapshotsClient regionInstantSnapshotsClient =
RegionInstantSnapshotsClient.create()) {
SetLabelsRegionInstantSnapshotRequest request =
SetLabelsRegionInstantSnapshotRequest.newBuilder()
.setProject("project-309310695")
.setRegion("region-934795532")
.setRegionSetLabelsRequestResource(RegionSetLabelsRequest.newBuilder().build())
.setRequestId("requestId693933066")
.setResource("resource-341064690")
.build();
Operation response = regionInstantSnapshotsClient.setLabelsAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request | SetLabelsRegionInstantSnapshotRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Operation,Operation> |
setLabelsAsync(String project, String region, String resource, RegionSetLabelsRequest regionSetLabelsRequestResource)
public final OperationFuture<Operation,Operation> setLabelsAsync(String project, String region, String resource, RegionSetLabelsRequest regionSetLabelsRequestResource)
Sets the labels on a instantSnapshot in the given region. 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 (RegionInstantSnapshotsClient regionInstantSnapshotsClient =
RegionInstantSnapshotsClient.create()) {
String project = "project-309310695";
String region = "region-934795532";
String resource = "resource-341064690";
RegionSetLabelsRequest regionSetLabelsRequestResource =
RegionSetLabelsRequest.newBuilder().build();
Operation response =
regionInstantSnapshotsClient
.setLabelsAsync(project, region, resource, regionSetLabelsRequestResource)
.get();
}
Parameters | |
---|---|
Name | Description |
project | String Project ID for this request. |
region | String The region for this request. |
resource | String Name or id of the resource for this request. |
regionSetLabelsRequestResource | RegionSetLabelsRequest The body resource for this request |
Returns | |
---|---|
Type | Description |
OperationFuture<Operation,Operation> |
setLabelsCallable()
public final UnaryCallable<SetLabelsRegionInstantSnapshotRequest,Operation> setLabelsCallable()
Sets the labels on a instantSnapshot in the given region. 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 (RegionInstantSnapshotsClient regionInstantSnapshotsClient =
RegionInstantSnapshotsClient.create()) {
SetLabelsRegionInstantSnapshotRequest request =
SetLabelsRegionInstantSnapshotRequest.newBuilder()
.setProject("project-309310695")
.setRegion("region-934795532")
.setRegionSetLabelsRequestResource(RegionSetLabelsRequest.newBuilder().build())
.setRequestId("requestId693933066")
.setResource("resource-341064690")
.build();
ApiFuture<Operation> future =
regionInstantSnapshotsClient.setLabelsCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<SetLabelsRegionInstantSnapshotRequest,Operation> |
setLabelsOperationCallable()
public final OperationCallable<SetLabelsRegionInstantSnapshotRequest,Operation,Operation> setLabelsOperationCallable()
Sets the labels on a instantSnapshot in the given region. 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 (RegionInstantSnapshotsClient regionInstantSnapshotsClient =
RegionInstantSnapshotsClient.create()) {
SetLabelsRegionInstantSnapshotRequest request =
SetLabelsRegionInstantSnapshotRequest.newBuilder()
.setProject("project-309310695")
.setRegion("region-934795532")
.setRegionSetLabelsRequestResource(RegionSetLabelsRequest.newBuilder().build())
.setRequestId("requestId693933066")
.setResource("resource-341064690")
.build();
OperationFuture<Operation, Operation> future =
regionInstantSnapshotsClient.setLabelsOperationCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<SetLabelsRegionInstantSnapshotRequest,Operation,Operation> |
shutdown()
public void shutdown()
shutdownNow()
public void shutdownNow()
testIamPermissions(TestIamPermissionsRegionInstantSnapshotRequest request)
public final TestPermissionsResponse testIamPermissions(TestIamPermissionsRegionInstantSnapshotRequest 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 (RegionInstantSnapshotsClient regionInstantSnapshotsClient =
RegionInstantSnapshotsClient.create()) {
TestIamPermissionsRegionInstantSnapshotRequest request =
TestIamPermissionsRegionInstantSnapshotRequest.newBuilder()
.setProject("project-309310695")
.setRegion("region-934795532")
.setResource("resource-341064690")
.setTestPermissionsRequestResource(TestPermissionsRequest.newBuilder().build())
.build();
TestPermissionsResponse response = regionInstantSnapshotsClient.testIamPermissions(request);
}
Parameter | |
---|---|
Name | Description |
request | TestIamPermissionsRegionInstantSnapshotRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
TestPermissionsResponse |
testIamPermissions(String project, String region, String resource, TestPermissionsRequest testPermissionsRequestResource)
public final TestPermissionsResponse testIamPermissions(String project, String region, 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 (RegionInstantSnapshotsClient regionInstantSnapshotsClient =
RegionInstantSnapshotsClient.create()) {
String project = "project-309310695";
String region = "region-934795532";
String resource = "resource-341064690";
TestPermissionsRequest testPermissionsRequestResource =
TestPermissionsRequest.newBuilder().build();
TestPermissionsResponse response =
regionInstantSnapshotsClient.testIamPermissions(
project, region, resource, testPermissionsRequestResource);
}
Parameters | |
---|---|
Name | Description |
project | String Project ID for this request. |
region | String The name of the region 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<TestIamPermissionsRegionInstantSnapshotRequest,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 (RegionInstantSnapshotsClient regionInstantSnapshotsClient =
RegionInstantSnapshotsClient.create()) {
TestIamPermissionsRegionInstantSnapshotRequest request =
TestIamPermissionsRegionInstantSnapshotRequest.newBuilder()
.setProject("project-309310695")
.setRegion("region-934795532")
.setResource("resource-341064690")
.setTestPermissionsRequestResource(TestPermissionsRequest.newBuilder().build())
.build();
ApiFuture<TestPermissionsResponse> future =
regionInstantSnapshotsClient.testIamPermissionsCallable().futureCall(request);
// Do something.
TestPermissionsResponse response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<TestIamPermissionsRegionInstantSnapshotRequest,TestPermissionsResponse> |