GlobalOperationClient (Google Cloud 0.90.0-alpha API)

java.lang.Object
- com.google.cloud.compute.v1.GlobalOperationClient

All Implemented Interfaces:

BackgroundResource, AutoCloseable
```
@Generated(value="by gapic-generator")
 @BetaApi
public class GlobalOperationClient
extends Object
implements BackgroundResource
```
Service Description: Creates and runs virtual machines on Google Cloud Platform.
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:
```
 
 try (GlobalOperationClient globalOperationClient = GlobalOperationClient.create()) {
   ProjectGlobalOperationName operation = ProjectGlobalOperationName.of("[PROJECT]", "[OPERATION]");
   globalOperationClient.deleteGlobalOperation(operation);
 }
 
 
```
Note: close() needs to be called on the globalOperationClient 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 GlobalOperationSettings to create(). For example:
To customize credentials:
```
 
 GlobalOperationSettings globalOperationSettings =
     GlobalOperationSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 GlobalOperationClient globalOperationClient =
     GlobalOperationClient.create(globalOperationSettings);
 
 
```
To customize the endpoint:
```
 
 GlobalOperationSettings globalOperationSettings =
     GlobalOperationSettings.newBuilder().setEndpoint(myEndpoint).build();
 GlobalOperationClient globalOperationClient =
     GlobalOperationClient.create(globalOperationSettings);
 
 
```

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`GlobalOperationClient.AggregatedListGlobalOperationsFixedSizeCollection`
`static class`	`GlobalOperationClient.AggregatedListGlobalOperationsPage`
`static class`	`GlobalOperationClient.AggregatedListGlobalOperationsPagedResponse`
`static class`	`GlobalOperationClient.ListGlobalOperationsFixedSizeCollection`
`static class`	`GlobalOperationClient.ListGlobalOperationsPage`
`static class`	`GlobalOperationClient.ListGlobalOperationsPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`GlobalOperationClient(GlobalOperationSettings settings)` Constructs an instance of GlobalOperationClient, using the given settings.
`protected`	`GlobalOperationClient(GlobalOperationStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GlobalOperationClient.AggregatedListGlobalOperationsPagedResponse`	`aggregatedListGlobalOperations(AggregatedListGlobalOperationsHttpRequest request)` Retrieves an aggregated list of all operations.
`GlobalOperationClient.AggregatedListGlobalOperationsPagedResponse`	`aggregatedListGlobalOperations(ProjectName project)` Retrieves an aggregated list of all operations.
`GlobalOperationClient.AggregatedListGlobalOperationsPagedResponse`	`aggregatedListGlobalOperations(String project)` Retrieves an aggregated list of all operations.
`UnaryCallable<AggregatedListGlobalOperationsHttpRequest,OperationAggregatedList>`	`aggregatedListGlobalOperationsCallable()` Retrieves an aggregated list of all operations.
`UnaryCallable<AggregatedListGlobalOperationsHttpRequest,GlobalOperationClient.AggregatedListGlobalOperationsPagedResponse>`	`aggregatedListGlobalOperationsPagedCallable()` Retrieves an aggregated list of all operations.
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`void`	`close()`
`static GlobalOperationClient`	`create()` Constructs an instance of GlobalOperationClient with default settings.
`static GlobalOperationClient`	`create(GlobalOperationSettings settings)` Constructs an instance of GlobalOperationClient, using the given settings.
`static GlobalOperationClient`	`create(GlobalOperationStub stub)` Constructs an instance of GlobalOperationClient, using the given stub for making calls.
`void`	`deleteGlobalOperation(DeleteGlobalOperationHttpRequest request)` Deletes the specified Operations resource.
`void`	`deleteGlobalOperation(ProjectGlobalOperationName operation)` Deletes the specified Operations resource.
`void`	`deleteGlobalOperation(String operation)` Deletes the specified Operations resource.
`UnaryCallable<DeleteGlobalOperationHttpRequest,Void>`	`deleteGlobalOperationCallable()` Deletes the specified Operations resource.
`Operation`	`getGlobalOperation(GetGlobalOperationHttpRequest request)` Retrieves the specified Operations resource.
`Operation`	`getGlobalOperation(ProjectGlobalOperationName operation)` Retrieves the specified Operations resource.
`Operation`	`getGlobalOperation(String operation)` Retrieves the specified Operations resource.
`UnaryCallable<GetGlobalOperationHttpRequest,Operation>`	`getGlobalOperationCallable()` Retrieves the specified Operations resource.
`GlobalOperationSettings`	`getSettings()`
`GlobalOperationStub`	`getStub()`
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`GlobalOperationClient.ListGlobalOperationsPagedResponse`	`listGlobalOperations(ListGlobalOperationsHttpRequest request)` Retrieves a list of Operation resources contained within the specified project.
`GlobalOperationClient.ListGlobalOperationsPagedResponse`	`listGlobalOperations(ProjectName project)` Retrieves a list of Operation resources contained within the specified project.
`GlobalOperationClient.ListGlobalOperationsPagedResponse`	`listGlobalOperations(String project)` Retrieves a list of Operation resources contained within the specified project.
`UnaryCallable<ListGlobalOperationsHttpRequest,OperationList>`	`listGlobalOperationsCallable()` Retrieves a list of Operation resources contained within the specified project.
`UnaryCallable<ListGlobalOperationsHttpRequest,GlobalOperationClient.ListGlobalOperationsPagedResponse>`	`listGlobalOperationsPagedCallable()` Retrieves a list of Operation resources contained within the specified project.
`void`	`shutdown()`
`void`	`shutdownNow()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- GlobalOperationClient
```
protected GlobalOperationClient(GlobalOperationSettings settings)
                         throws IOException
```
  Constructs an instance of GlobalOperationClient, 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
- GlobalOperationClient
```
@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
protected GlobalOperationClient(GlobalOperationStub stub)
```

Method Detail

create

public static final GlobalOperationClient create()
                                          throws IOException

Constructs an instance of GlobalOperationClient with default settings.

Throws:: IOException

create
```
public static final GlobalOperationClient create(GlobalOperationSettings settings)
                                          throws IOException
```
Constructs an instance of GlobalOperationClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Throws:

IOException

create

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public static final GlobalOperationClient create(GlobalOperationStub stub)

Constructs an instance of GlobalOperationClient, using the given stub for making calls. This is for advanced usage - prefer to use GlobalOperationSettings}.

getSettings

public final GlobalOperationSettings getSettings()

getStub

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public GlobalOperationStub getStub()

aggregatedListGlobalOperations

@BetaApi
public final GlobalOperationClient.AggregatedListGlobalOperationsPagedResponse aggregatedListGlobalOperations(ProjectName project)

Retrieves an aggregated list of all operations.

Sample code:


 try (GlobalOperationClient globalOperationClient = GlobalOperationClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   for (OperationsScopedList element : globalOperationClient.aggregatedListGlobalOperations(project).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: project - Project ID for this request.
Throws:: ApiException - if the remote call fails

aggregatedListGlobalOperations

@BetaApi
public final GlobalOperationClient.AggregatedListGlobalOperationsPagedResponse aggregatedListGlobalOperations(String project)

Retrieves an aggregated list of all operations.

Sample code:


 try (GlobalOperationClient globalOperationClient = GlobalOperationClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   for (OperationsScopedList element : globalOperationClient.aggregatedListGlobalOperations(project.toString()).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: project - Project ID for this request.
Throws:: ApiException - if the remote call fails

aggregatedListGlobalOperations

@BetaApi
public final GlobalOperationClient.AggregatedListGlobalOperationsPagedResponse aggregatedListGlobalOperations(AggregatedListGlobalOperationsHttpRequest request)

Retrieves an aggregated list of all operations.

Sample code:


 try (GlobalOperationClient globalOperationClient = GlobalOperationClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   AggregatedListGlobalOperationsHttpRequest request = AggregatedListGlobalOperationsHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   for (OperationsScopedList element : globalOperationClient.aggregatedListGlobalOperations(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: ApiException - if the remote call fails

aggregatedListGlobalOperationsPagedCallable

@BetaApi
public final UnaryCallable<AggregatedListGlobalOperationsHttpRequest,GlobalOperationClient.AggregatedListGlobalOperationsPagedResponse> aggregatedListGlobalOperationsPagedCallable()

Retrieves an aggregated list of all operations.

Sample code:


 try (GlobalOperationClient globalOperationClient = GlobalOperationClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   AggregatedListGlobalOperationsHttpRequest request = AggregatedListGlobalOperationsHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   ApiFuture<AggregatedListGlobalOperationsPagedResponse> future = globalOperationClient.aggregatedListGlobalOperationsPagedCallable().futureCall(request);
   // Do something
   for (OperationsScopedList element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

aggregatedListGlobalOperationsCallable

@BetaApi
public final UnaryCallable<AggregatedListGlobalOperationsHttpRequest,OperationAggregatedList> aggregatedListGlobalOperationsCallable()

Retrieves an aggregated list of all operations.

Sample code:


 try (GlobalOperationClient globalOperationClient = GlobalOperationClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   AggregatedListGlobalOperationsHttpRequest request = AggregatedListGlobalOperationsHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   while (true) {
     OperationAggregatedList response = globalOperationClient.aggregatedListGlobalOperationsCallable().call(request);
     for (OperationsScopedList element : response.getItemsMap()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

deleteGlobalOperation

@BetaApi
public final void deleteGlobalOperation(ProjectGlobalOperationName operation)

Deletes the specified Operations resource.

Sample code:


 try (GlobalOperationClient globalOperationClient = GlobalOperationClient.create()) {
   ProjectGlobalOperationName operation = ProjectGlobalOperationName.of("[PROJECT]", "[OPERATION]");
   globalOperationClient.deleteGlobalOperation(operation);
 }

Parameters:: operation - Name of the Operations resource to delete.
Throws:: ApiException - if the remote call fails

deleteGlobalOperation

@BetaApi
public final void deleteGlobalOperation(String operation)

Deletes the specified Operations resource.

Sample code:


 try (GlobalOperationClient globalOperationClient = GlobalOperationClient.create()) {
   ProjectGlobalOperationName operation = ProjectGlobalOperationName.of("[PROJECT]", "[OPERATION]");
   globalOperationClient.deleteGlobalOperation(operation.toString());
 }

Parameters:: operation - Name of the Operations resource to delete.
Throws:: ApiException - if the remote call fails

deleteGlobalOperation

@BetaApi
public final void deleteGlobalOperation(DeleteGlobalOperationHttpRequest request)

Deletes the specified Operations resource.

Sample code:


 try (GlobalOperationClient globalOperationClient = GlobalOperationClient.create()) {
   String formattedOperation = ProjectGlobalOperationName.format("[PROJECT]", "[OPERATION]");
   DeleteGlobalOperationHttpRequest request = DeleteGlobalOperationHttpRequest.newBuilder()
     .setOperation(formattedOperation)
     .build();
   globalOperationClient.deleteGlobalOperation(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: ApiException - if the remote call fails

deleteGlobalOperationCallable

@BetaApi
public final UnaryCallable<DeleteGlobalOperationHttpRequest,Void> deleteGlobalOperationCallable()

Deletes the specified Operations resource.

Sample code:


 try (GlobalOperationClient globalOperationClient = GlobalOperationClient.create()) {
   String formattedOperation = ProjectGlobalOperationName.format("[PROJECT]", "[OPERATION]");
   DeleteGlobalOperationHttpRequest request = DeleteGlobalOperationHttpRequest.newBuilder()
     .setOperation(formattedOperation)
     .build();
   ApiFuture<Void> future = globalOperationClient.deleteGlobalOperationCallable().futureCall(request);
   // Do something
   future.get();
 }

getGlobalOperation

@BetaApi
public final Operation getGlobalOperation(ProjectGlobalOperationName operation)

Retrieves the specified Operations resource. Gets a list of operations by making a list() request.

Sample code:


 try (GlobalOperationClient globalOperationClient = GlobalOperationClient.create()) {
   ProjectGlobalOperationName operation = ProjectGlobalOperationName.of("[PROJECT]", "[OPERATION]");
   Operation response = globalOperationClient.getGlobalOperation(operation);
 }

Parameters:: operation - Name of the Operations resource to return.
Throws:: ApiException - if the remote call fails

getGlobalOperation

@BetaApi
public final Operation getGlobalOperation(String operation)

Retrieves the specified Operations resource. Gets a list of operations by making a list() request.

Sample code:


 try (GlobalOperationClient globalOperationClient = GlobalOperationClient.create()) {
   ProjectGlobalOperationName operation = ProjectGlobalOperationName.of("[PROJECT]", "[OPERATION]");
   Operation response = globalOperationClient.getGlobalOperation(operation.toString());
 }

Parameters:: operation - Name of the Operations resource to return.
Throws:: ApiException - if the remote call fails

getGlobalOperation

@BetaApi
public final Operation getGlobalOperation(GetGlobalOperationHttpRequest request)

Retrieves the specified Operations resource. Gets a list of operations by making a list() request.

Sample code:


 try (GlobalOperationClient globalOperationClient = GlobalOperationClient.create()) {
   String formattedOperation = ProjectGlobalOperationName.format("[PROJECT]", "[OPERATION]");
   GetGlobalOperationHttpRequest request = GetGlobalOperationHttpRequest.newBuilder()
     .setOperation(formattedOperation)
     .build();
   Operation response = globalOperationClient.getGlobalOperation(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: ApiException - if the remote call fails

getGlobalOperationCallable

@BetaApi
public final UnaryCallable<GetGlobalOperationHttpRequest,Operation> getGlobalOperationCallable()

Retrieves the specified Operations resource. Gets a list of operations by making a list() request.

Sample code:


 try (GlobalOperationClient globalOperationClient = GlobalOperationClient.create()) {
   String formattedOperation = ProjectGlobalOperationName.format("[PROJECT]", "[OPERATION]");
   GetGlobalOperationHttpRequest request = GetGlobalOperationHttpRequest.newBuilder()
     .setOperation(formattedOperation)
     .build();
   ApiFuture<Operation> future = globalOperationClient.getGlobalOperationCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }