Package com.google.cloud.compute.v1

Class ZoneOperationsClient

  • All Implemented Interfaces:
    com.google.api.gax.core.BackgroundResource, AutoCloseable
    @Generated("by gapic-generator-java")
public class ZoneOperationsClient
extends Object
implements com.google.api.gax.core.BackgroundResource
    Service Description: The ZoneOperations 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 (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().

    The surface of this class includes several types of Java methods for each of the API's methods:

    1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
    2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
    3. A "callable" method. This type of method takes no parameters and returns 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.

    • Constructor Detail

      • ZoneOperationsClient

        protected ZoneOperationsClient​(ZoneOperationsSettings settings)
                        throws IOException
        Constructs an instance of ZoneOperationsClient, 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.
        Throws:
        IOException

    • Method Detail

      • create

        public static final ZoneOperationsClient create​(ZoneOperationsStub stub)
        Constructs an instance of ZoneOperationsClient, using the given stub for making calls. This is for advanced usage - prefer using create(ZoneOperationsSettings).

      • delete

        public final DeleteZoneOperationResponse delete​(String project,
                                                String zone,
                                                String operation)
        Deletes the specified zone-specific Operations 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 (ZoneOperationsClient zoneOperationsClient = ZoneOperationsClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   String operation = "operation1662702951";
   DeleteZoneOperationResponse response = zoneOperationsClient.delete(project, zone, operation);
 }
        Parameters:
        project - Project ID for this request.
        zone - Name of the zone for this request.
        operation - Name of the Operations resource to delete.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • delete

        public final DeleteZoneOperationResponse delete​(DeleteZoneOperationRequest request)
        Deletes the specified zone-specific Operations 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 (ZoneOperationsClient zoneOperationsClient = ZoneOperationsClient.create()) {
   DeleteZoneOperationRequest request =
       DeleteZoneOperationRequest.newBuilder()
           .setOperation("operation1662702951")
           .setProject("project-309310695")
           .setZone("zone3744684")
           .build();
   DeleteZoneOperationResponse response = zoneOperationsClient.delete(request);
 }
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • deleteCallable

        public final com.google.api.gax.rpc.UnaryCallable<DeleteZoneOperationRequest,​DeleteZoneOperationResponse> deleteCallable()
        Deletes the specified zone-specific Operations 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 (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();
 }

      • get

        public final Operation get​(String project,
                           String zone,
                           String operation)
        Retrieves the specified zone-specific Operations 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 (ZoneOperationsClient zoneOperationsClient = ZoneOperationsClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   String operation = "operation1662702951";
   Operation response = zoneOperationsClient.get(project, zone, operation);
 }
        Parameters:
        project - Project ID for this request.
        zone - Name of the zone for this request.
        operation - Name of the Operations resource to return.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • get

        public final Operation get​(GetZoneOperationRequest request)
        Retrieves the specified zone-specific Operations 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 (ZoneOperationsClient zoneOperationsClient = ZoneOperationsClient.create()) {
   GetZoneOperationRequest request =
       GetZoneOperationRequest.newBuilder()
           .setOperation("operation1662702951")
           .setProject("project-309310695")
           .setZone("zone3744684")
           .build();
   Operation response = zoneOperationsClient.get(request);
 }
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • getCallable

        public final com.google.api.gax.rpc.UnaryCallable<GetZoneOperationRequest,​Operation> getCallable()
        Retrieves the specified zone-specific Operations 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 (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();
 }

      • list

        public final ZoneOperationsClient.ListPagedResponse list​(String project,
                                                         String zone)
        Retrieves a list of Operation 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 (ZoneOperationsClient zoneOperationsClient = ZoneOperationsClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   for (Operation element : zoneOperationsClient.list(project, zone).iterateAll()) {
     // doThingsWith(element);
   }
 }
        Parameters:
        project - Project ID for this request.
        zone - Name of the zone for request.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • list

        public final ZoneOperationsClient.ListPagedResponse list​(ListZoneOperationsRequest request)
        Retrieves a list of Operation 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 (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);
   }
 }
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • listPagedCallable

        public final com.google.api.gax.rpc.UnaryCallable<ListZoneOperationsRequest,​ZoneOperationsClient.ListPagedResponse> listPagedCallable()
        Retrieves a list of Operation 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 (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);
   }
 }

      • listCallable

        public final com.google.api.gax.rpc.UnaryCallable<ListZoneOperationsRequest,​OperationList> listCallable()
        Retrieves a list of Operation 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 (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;
     }
   }
 }

      • wait

        public final 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. 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`.

        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);
 }
        Parameters:
        project - Project ID for this request.
        zone - Name of the zone for this request.
        operation - Name of the Operations resource to return.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • wait

        public final 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. 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`.

        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);
 }
        Parameters:
        request - The request object containing all of the parameters for the API call.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • waitCallable

        public final 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. 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`.

        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();
 }

      • shutdown

        public void shutdown()
        Specified by:
        shutdown in interface com.google.api.gax.core.BackgroundResource

      • isShutdown

        public boolean isShutdown()
        Specified by:
        isShutdown in interface com.google.api.gax.core.BackgroundResource

      • isTerminated

        public boolean isTerminated()
        Specified by:
        isTerminated in interface com.google.api.gax.core.BackgroundResource

      • shutdownNow

        public void shutdownNow()
        Specified by:
        shutdownNow in interface com.google.api.gax.core.BackgroundResource