@Generated(value="by gapic-generator-java") public class ZoneOperationsClient extends Object implements com.google.api.gax.core.BackgroundResource
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ZoneOperationsClient zoneOperationsClient = ZoneOperationsClient.create()) {
String project = "project-309310695";
String zone = "zone3744684";
String operation = "operation1662702951";
DeleteZoneOperationResponse response = zoneOperationsClient.delete(project, zone, operation);
}
Note: close() needs to be called on the ZoneOperationsClient 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 zone-specific Operations 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.
|
Get |
Retrieves the specified zone-specific Operations 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.
|
List |
Retrieves a list of Operation 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.
|
Wait |
Waits for the specified Operation resource to return as `DONE` or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method waits for no more than the 2 minutes and then returns the current state of the operation, which might be `DONE` or still in progress. This method is called on a best-effort basis. Specifically: - In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. - If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is not `DONE`. |
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 ZoneOperationsSettings 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
ZoneOperationsSettings zoneOperationsSettings =
ZoneOperationsSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
ZoneOperationsClient zoneOperationsClient = ZoneOperationsClient.create(zoneOperationsSettings);
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
ZoneOperationsSettings zoneOperationsSettings =
ZoneOperationsSettings.newBuilder().setEndpoint(myEndpoint).build();
ZoneOperationsClient zoneOperationsClient = ZoneOperationsClient.create(zoneOperationsSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
| Modifier and Type | Class and Description |
|---|---|
static class |
ZoneOperationsClient.ListFixedSizeCollection |
static class |
ZoneOperationsClient.ListPage |
static class |
ZoneOperationsClient.ListPagedResponse |
| Modifier | Constructor and Description |
|---|---|
protected |
ZoneOperationsClient(ZoneOperationsSettings settings)
Constructs an instance of ZoneOperationsClient, using the given settings.
|
protected |
ZoneOperationsClient(ZoneOperationsStub stub) |
| Modifier and Type | Method and Description |
|---|---|
boolean |
awaitTermination(long duration,
TimeUnit unit) |
void |
close() |
static ZoneOperationsClient |
create()
Constructs an instance of ZoneOperationsClient with default settings.
|
static ZoneOperationsClient |
create(ZoneOperationsSettings settings)
Constructs an instance of ZoneOperationsClient, using the given settings.
|
static ZoneOperationsClient |
create(ZoneOperationsStub stub)
Constructs an instance of ZoneOperationsClient, using the given stub for making calls.
|
DeleteZoneOperationResponse |
delete(DeleteZoneOperationRequest request)
Deletes the specified zone-specific Operations resource.
|
DeleteZoneOperationResponse |
delete(String project,
String zone,
String operation)
Deletes the specified zone-specific Operations resource.
|
com.google.api.gax.rpc.UnaryCallable<DeleteZoneOperationRequest,DeleteZoneOperationResponse> |
deleteCallable()
Deletes the specified zone-specific Operations resource.
|
Operation |
get(GetZoneOperationRequest request)
Retrieves the specified zone-specific Operations resource.
|
Operation |
get(String project,
String zone,
String operation)
Retrieves the specified zone-specific Operations resource.
|
com.google.api.gax.rpc.UnaryCallable<GetZoneOperationRequest,Operation> |
getCallable()
Retrieves the specified zone-specific Operations resource.
|
ZoneOperationsSettings |
getSettings() |
ZoneOperationsStub |
getStub() |
boolean |
isShutdown() |
boolean |
isTerminated() |
ZoneOperationsClient.ListPagedResponse |
list(ListZoneOperationsRequest request)
Retrieves a list of Operation resources contained within the specified zone.
|
ZoneOperationsClient.ListPagedResponse |
list(String project,
String zone)
Retrieves a list of Operation resources contained within the specified zone.
|
com.google.api.gax.rpc.UnaryCallable<ListZoneOperationsRequest,OperationList> |
listCallable()
Retrieves a list of Operation resources contained within the specified zone.
|
com.google.api.gax.rpc.UnaryCallable<ListZoneOperationsRequest,ZoneOperationsClient.ListPagedResponse> |
listPagedCallable()
Retrieves a list of Operation resources contained within the specified zone.
|
void |
shutdown() |
void |
shutdownNow() |
Operation |
wait(String project,
String zone,
String operation)
Waits for the specified Operation resource to return as `DONE` or for the request to approach
the 2 minute deadline, and retrieves the specified Operation resource.
|
Operation |
wait(WaitZoneOperationRequest request)
Waits for the specified Operation resource to return as `DONE` or for the request to approach
the 2 minute deadline, and retrieves the specified Operation resource.
|
com.google.api.gax.rpc.UnaryCallable<WaitZoneOperationRequest,Operation> |
waitCallable()
Waits for the specified Operation resource to return as `DONE` or for the request to approach
the 2 minute deadline, and retrieves the specified Operation resource.
|
protected ZoneOperationsClient(ZoneOperationsSettings settings) throws IOException
IOExceptionprotected ZoneOperationsClient(ZoneOperationsStub stub)
public static final ZoneOperationsClient create() throws IOException
IOExceptionpublic static final ZoneOperationsClient create(ZoneOperationsSettings settings) throws IOException
IOExceptionpublic static final ZoneOperationsClient create(ZoneOperationsStub stub)
public final ZoneOperationsSettings getSettings()
public ZoneOperationsStub getStub()
public final DeleteZoneOperationResponse delete(String project, String zone, String operation)
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 (ZoneOperationsClient zoneOperationsClient = ZoneOperationsClient.create()) {
String project = "project-309310695";
String zone = "zone3744684";
String operation = "operation1662702951";
DeleteZoneOperationResponse response = zoneOperationsClient.delete(project, zone, operation);
}
project - Project ID for this request.zone - Name of the zone for this request.operation - Name of the Operations resource to delete.com.google.api.gax.rpc.ApiException - if the remote call failspublic final DeleteZoneOperationResponse delete(DeleteZoneOperationRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ZoneOperationsClient zoneOperationsClient = ZoneOperationsClient.create()) {
DeleteZoneOperationRequest request =
DeleteZoneOperationRequest.newBuilder()
.setOperation("operation1662702951")
.setProject("project-309310695")
.setZone("zone3744684")
.build();
DeleteZoneOperationResponse response = zoneOperationsClient.delete(request);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<DeleteZoneOperationRequest,DeleteZoneOperationResponse> deleteCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ZoneOperationsClient zoneOperationsClient = ZoneOperationsClient.create()) {
DeleteZoneOperationRequest request =
DeleteZoneOperationRequest.newBuilder()
.setOperation("operation1662702951")
.setProject("project-309310695")
.setZone("zone3744684")
.build();
ApiFuture<DeleteZoneOperationResponse> future =
zoneOperationsClient.deleteCallable().futureCall(request);
// Do something.
DeleteZoneOperationResponse response = future.get();
}
public final Operation get(String project, String zone, String operation)
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 (ZoneOperationsClient zoneOperationsClient = ZoneOperationsClient.create()) {
String project = "project-309310695";
String zone = "zone3744684";
String operation = "operation1662702951";
Operation response = zoneOperationsClient.get(project, zone, operation);
}
project - Project ID for this request.zone - Name of the zone for this request.operation - Name of the Operations resource to return.com.google.api.gax.rpc.ApiException - if the remote call failspublic final Operation get(GetZoneOperationRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ZoneOperationsClient zoneOperationsClient = ZoneOperationsClient.create()) {
GetZoneOperationRequest request =
GetZoneOperationRequest.newBuilder()
.setOperation("operation1662702951")
.setProject("project-309310695")
.setZone("zone3744684")
.build();
Operation response = zoneOperationsClient.get(request);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<GetZoneOperationRequest,Operation> getCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ZoneOperationsClient zoneOperationsClient = ZoneOperationsClient.create()) {
GetZoneOperationRequest request =
GetZoneOperationRequest.newBuilder()
.setOperation("operation1662702951")
.setProject("project-309310695")
.setZone("zone3744684")
.build();
ApiFuture<Operation> future = zoneOperationsClient.getCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
public final ZoneOperationsClient.ListPagedResponse list(String project, String zone)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ZoneOperationsClient zoneOperationsClient = ZoneOperationsClient.create()) {
String project = "project-309310695";
String zone = "zone3744684";
for (Operation element : zoneOperationsClient.list(project, zone).iterateAll()) {
// doThingsWith(element);
}
}
project - Project ID for this request.zone - Name of the zone for request.com.google.api.gax.rpc.ApiException - if the remote call failspublic final ZoneOperationsClient.ListPagedResponse list(ListZoneOperationsRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ZoneOperationsClient zoneOperationsClient = ZoneOperationsClient.create()) {
ListZoneOperationsRequest request =
ListZoneOperationsRequest.newBuilder()
.setFilter("filter-1274492040")
.setMaxResults(1128457243)
.setOrderBy("orderBy-1207110587")
.setPageToken("pageToken873572522")
.setProject("project-309310695")
.setReturnPartialSuccess(true)
.setZone("zone3744684")
.build();
for (Operation element : zoneOperationsClient.list(request).iterateAll()) {
// doThingsWith(element);
}
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<ListZoneOperationsRequest,ZoneOperationsClient.ListPagedResponse> listPagedCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ZoneOperationsClient zoneOperationsClient = ZoneOperationsClient.create()) {
ListZoneOperationsRequest request =
ListZoneOperationsRequest.newBuilder()
.setFilter("filter-1274492040")
.setMaxResults(1128457243)
.setOrderBy("orderBy-1207110587")
.setPageToken("pageToken873572522")
.setProject("project-309310695")
.setReturnPartialSuccess(true)
.setZone("zone3744684")
.build();
ApiFuture<Operation> future = zoneOperationsClient.listPagedCallable().futureCall(request);
// Do something.
for (Operation element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
public final com.google.api.gax.rpc.UnaryCallable<ListZoneOperationsRequest,OperationList> listCallable()
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ZoneOperationsClient zoneOperationsClient = ZoneOperationsClient.create()) {
ListZoneOperationsRequest request =
ListZoneOperationsRequest.newBuilder()
.setFilter("filter-1274492040")
.setMaxResults(1128457243)
.setOrderBy("orderBy-1207110587")
.setPageToken("pageToken873572522")
.setProject("project-309310695")
.setReturnPartialSuccess(true)
.setZone("zone3744684")
.build();
while (true) {
OperationList response = zoneOperationsClient.listCallable().call(request);
for (Operation element : response.getItemsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
public final Operation wait(String project, String zone, String operation)
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 (ZoneOperationsClient zoneOperationsClient = ZoneOperationsClient.create()) {
String project = "project-309310695";
String zone = "zone3744684";
String operation = "operation1662702951";
Operation response = zoneOperationsClient.wait(project, zone, operation);
}
project - Project ID for this request.zone - Name of the zone for this request.operation - Name of the Operations resource to return.com.google.api.gax.rpc.ApiException - if the remote call failspublic final Operation wait(WaitZoneOperationRequest request)
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ZoneOperationsClient zoneOperationsClient = ZoneOperationsClient.create()) {
WaitZoneOperationRequest request =
WaitZoneOperationRequest.newBuilder()
.setOperation("operation1662702951")
.setProject("project-309310695")
.setZone("zone3744684")
.build();
Operation response = zoneOperationsClient.wait(request);
}
request - The request object containing all of the parameters for the API call.com.google.api.gax.rpc.ApiException - if the remote call failspublic final com.google.api.gax.rpc.UnaryCallable<WaitZoneOperationRequest,Operation> waitCallable()
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 (ZoneOperationsClient zoneOperationsClient = ZoneOperationsClient.create()) {
WaitZoneOperationRequest request =
WaitZoneOperationRequest.newBuilder()
.setOperation("operation1662702951")
.setProject("project-309310695")
.setZone("zone3744684")
.build();
ApiFuture<Operation> future = zoneOperationsClient.waitCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
public final void close()
close in interface AutoCloseablepublic void shutdown()
shutdown in interface com.google.api.gax.core.BackgroundResourcepublic boolean isShutdown()
isShutdown in interface com.google.api.gax.core.BackgroundResourcepublic boolean isTerminated()
isTerminated in interface com.google.api.gax.core.BackgroundResourcepublic void shutdownNow()
shutdownNow in interface com.google.api.gax.core.BackgroundResourcepublic boolean awaitTermination(long duration,
TimeUnit unit)
throws InterruptedException
awaitTermination in interface com.google.api.gax.core.BackgroundResourceInterruptedExceptionCopyright © 2024 Google LLC. All rights reserved.