GlobalOrganizationOperationsClient (Google Compute Engine 1.59.0 API)

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

All Implemented Interfaces:: com.google.api.gax.core.BackgroundResource, AutoCloseable

@Generated(value="by gapic-generator-java")
public class GlobalOrganizationOperationsClient
extends Object
implements com.google.api.gax.core.BackgroundResource

Service Description: The GlobalOrganizationOperations 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 (GlobalOrganizationOperationsClient globalOrganizationOperationsClient =
     GlobalOrganizationOperationsClient.create()) {
   String operation = "operation1662702951";
   DeleteGlobalOrganizationOperationResponse response =
       globalOrganizationOperationsClient.delete(operation);
 }

Note: close() needs to be called on the GlobalOrganizationOperationsClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

Methods
Method	Description	Method Variants
Delete	Deletes the specified Operations resource.	Request object method variants only take one parameter, a request object, which must be constructed before the call. delete(DeleteGlobalOrganizationOperationRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. delete(String operation) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deleteCallable()
Get	Retrieves the specified Operations resource. Gets a list of operations by making a `list()` request.	Request object method variants only take one parameter, a request object, which must be constructed before the call. get(GetGlobalOrganizationOperationRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. get(String operation) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getCallable()
List	Retrieves a list of Operation resources contained within the specified organization.	Request object method variants only take one parameter, a request object, which must be constructed before the call. list(ListGlobalOrganizationOperationsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. list() Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listPagedCallable() listCallable()

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 GlobalOrganizationOperationsSettings 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
 GlobalOrganizationOperationsSettings globalOrganizationOperationsSettings =
     GlobalOrganizationOperationsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 GlobalOrganizationOperationsClient globalOrganizationOperationsClient =
     GlobalOrganizationOperationsClient.create(globalOrganizationOperationsSettings);

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
 GlobalOrganizationOperationsSettings globalOrganizationOperationsSettings =
     GlobalOrganizationOperationsSettings.newBuilder().setEndpoint(myEndpoint).build();
 GlobalOrganizationOperationsClient globalOrganizationOperationsClient =
     GlobalOrganizationOperationsClient.create(globalOrganizationOperationsSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`GlobalOrganizationOperationsClient.ListFixedSizeCollection`
`static class`	`GlobalOrganizationOperationsClient.ListPage`
`static class`	`GlobalOrganizationOperationsClient.ListPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`GlobalOrganizationOperationsClient(GlobalOrganizationOperationsSettings settings)` Constructs an instance of GlobalOrganizationOperationsClient, using the given settings.
`protected`	`GlobalOrganizationOperationsClient(GlobalOrganizationOperationsStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`void`	`close()`
`static GlobalOrganizationOperationsClient`	`create()` Constructs an instance of GlobalOrganizationOperationsClient with default settings.
`static GlobalOrganizationOperationsClient`	`create(GlobalOrganizationOperationsSettings settings)` Constructs an instance of GlobalOrganizationOperationsClient, using the given settings.
`static GlobalOrganizationOperationsClient`	`create(GlobalOrganizationOperationsStub stub)` Constructs an instance of GlobalOrganizationOperationsClient, using the given stub for making calls.
`DeleteGlobalOrganizationOperationResponse`	`delete(DeleteGlobalOrganizationOperationRequest request)` Deletes the specified Operations resource.
`DeleteGlobalOrganizationOperationResponse`	`delete(String operation)` Deletes the specified Operations resource.
`com.google.api.gax.rpc.UnaryCallable<DeleteGlobalOrganizationOperationRequest,DeleteGlobalOrganizationOperationResponse>`	`deleteCallable()` Deletes the specified Operations resource.
`Operation`	`get(GetGlobalOrganizationOperationRequest request)` Retrieves the specified Operations resource.
`Operation`	`get(String operation)` Retrieves the specified Operations resource.
`com.google.api.gax.rpc.UnaryCallable<GetGlobalOrganizationOperationRequest,Operation>`	`getCallable()` Retrieves the specified Operations resource.
`GlobalOrganizationOperationsSettings`	`getSettings()`
`GlobalOrganizationOperationsStub`	`getStub()`
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`GlobalOrganizationOperationsClient.ListPagedResponse`	`list()` Retrieves a list of Operation resources contained within the specified organization.
`GlobalOrganizationOperationsClient.ListPagedResponse`	`list(ListGlobalOrganizationOperationsRequest request)` Retrieves a list of Operation resources contained within the specified organization.
`com.google.api.gax.rpc.UnaryCallable<ListGlobalOrganizationOperationsRequest,OperationList>`	`listCallable()` Retrieves a list of Operation resources contained within the specified organization.
`com.google.api.gax.rpc.UnaryCallable<ListGlobalOrganizationOperationsRequest,GlobalOrganizationOperationsClient.ListPagedResponse>`	`listPagedCallable()` Retrieves a list of Operation resources contained within the specified organization.
`void`	`shutdown()`
`void`	`shutdownNow()`

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

Constructor Detail
- GlobalOrganizationOperationsClient
```
protected GlobalOrganizationOperationsClient(GlobalOrganizationOperationsSettings settings)
                                      throws IOException
```
  Constructs an instance of GlobalOrganizationOperationsClient, 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
- GlobalOrganizationOperationsClient
```
protected GlobalOrganizationOperationsClient(GlobalOrganizationOperationsStub stub)
```

Method Detail

create

public static final GlobalOrganizationOperationsClient create()
                                                       throws IOException

Constructs an instance of GlobalOrganizationOperationsClient with default settings.

Throws:: IOException

create
```
public static final GlobalOrganizationOperationsClient create(GlobalOrganizationOperationsSettings settings)
                                                       throws IOException
```
Constructs an instance of GlobalOrganizationOperationsClient, 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
```
public static final GlobalOrganizationOperationsClient create(GlobalOrganizationOperationsStub stub)
```
Constructs an instance of GlobalOrganizationOperationsClient, using the given stub for making calls. This is for advanced usage - prefer using create(GlobalOrganizationOperationsSettings).

getSettings

public final GlobalOrganizationOperationsSettings getSettings()

getStub

public GlobalOrganizationOperationsStub getStub()

delete

public final DeleteGlobalOrganizationOperationResponse delete(String operation)

Deletes the specified 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 (GlobalOrganizationOperationsClient globalOrganizationOperationsClient =
     GlobalOrganizationOperationsClient.create()) {
   String operation = "operation1662702951";
   DeleteGlobalOrganizationOperationResponse response =
       globalOrganizationOperationsClient.delete(operation);
 }

Parameters:: operation - Name of the Operations resource to delete.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

delete

public final DeleteGlobalOrganizationOperationResponse delete(DeleteGlobalOrganizationOperationRequest request)

Deletes the specified 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 (GlobalOrganizationOperationsClient globalOrganizationOperationsClient =
     GlobalOrganizationOperationsClient.create()) {
   DeleteGlobalOrganizationOperationRequest request =
       DeleteGlobalOrganizationOperationRequest.newBuilder()
           .setOperation("operation1662702951")
           .setParentId("parentId1175162725")
           .build();
   DeleteGlobalOrganizationOperationResponse response =
       globalOrganizationOperationsClient.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<DeleteGlobalOrganizationOperationRequest,DeleteGlobalOrganizationOperationResponse> deleteCallable()

Deletes the specified 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 (GlobalOrganizationOperationsClient globalOrganizationOperationsClient =
     GlobalOrganizationOperationsClient.create()) {
   DeleteGlobalOrganizationOperationRequest request =
       DeleteGlobalOrganizationOperationRequest.newBuilder()
           .setOperation("operation1662702951")
           .setParentId("parentId1175162725")
           .build();
   ApiFuture<DeleteGlobalOrganizationOperationResponse> future =
       globalOrganizationOperationsClient.deleteCallable().futureCall(request);
   // Do something.
   DeleteGlobalOrganizationOperationResponse response = future.get();
 }

get

public final Operation get(String operation)

Retrieves the specified Operations resource. Gets a list of operations by making a `list()` 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 (GlobalOrganizationOperationsClient globalOrganizationOperationsClient =
     GlobalOrganizationOperationsClient.create()) {
   String operation = "operation1662702951";
   Operation response = globalOrganizationOperationsClient.get(operation);
 }

Parameters:: 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(GetGlobalOrganizationOperationRequest request)

Retrieves the specified Operations resource. Gets a list of operations by making a `list()` 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 (GlobalOrganizationOperationsClient globalOrganizationOperationsClient =
     GlobalOrganizationOperationsClient.create()) {
   GetGlobalOrganizationOperationRequest request =
       GetGlobalOrganizationOperationRequest.newBuilder()
           .setOperation("operation1662702951")
           .setParentId("parentId1175162725")
           .build();
   Operation response = globalOrganizationOperationsClient.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<GetGlobalOrganizationOperationRequest,Operation> getCallable()

Retrieves the specified Operations resource. Gets a list of operations by making a `list()` 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 (GlobalOrganizationOperationsClient globalOrganizationOperationsClient =
     GlobalOrganizationOperationsClient.create()) {
   GetGlobalOrganizationOperationRequest request =
       GetGlobalOrganizationOperationRequest.newBuilder()
           .setOperation("operation1662702951")
           .setParentId("parentId1175162725")
           .build();
   ApiFuture<Operation> future =
       globalOrganizationOperationsClient.getCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

list

public final GlobalOrganizationOperationsClient.ListPagedResponse list()

Retrieves a list of Operation resources contained within the specified organization.

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 (GlobalOrganizationOperationsClient globalOrganizationOperationsClient =
     GlobalOrganizationOperationsClient.create()) {
   for (Operation element : globalOrganizationOperationsClient.list().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

list

public final GlobalOrganizationOperationsClient.ListPagedResponse list(ListGlobalOrganizationOperationsRequest request)

Retrieves a list of Operation resources contained within the specified organization.

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 (GlobalOrganizationOperationsClient globalOrganizationOperationsClient =
     GlobalOrganizationOperationsClient.create()) {
   ListGlobalOrganizationOperationsRequest request =
       ListGlobalOrganizationOperationsRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setParentId("parentId1175162725")
           .setReturnPartialSuccess(true)
           .build();
   for (Operation element : globalOrganizationOperationsClient.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<ListGlobalOrganizationOperationsRequest,GlobalOrganizationOperationsClient.ListPagedResponse> listPagedCallable()

Retrieves a list of Operation resources contained within the specified organization.

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 (GlobalOrganizationOperationsClient globalOrganizationOperationsClient =
     GlobalOrganizationOperationsClient.create()) {
   ListGlobalOrganizationOperationsRequest request =
       ListGlobalOrganizationOperationsRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setParentId("parentId1175162725")
           .setReturnPartialSuccess(true)
           .build();
   ApiFuture<Operation> future =
       globalOrganizationOperationsClient.listPagedCallable().futureCall(request);
   // Do something.
   for (Operation element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

listCallable

public final com.google.api.gax.rpc.UnaryCallable<ListGlobalOrganizationOperationsRequest,OperationList> listCallable()

Retrieves a list of Operation resources contained within the specified organization.

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 (GlobalOrganizationOperationsClient globalOrganizationOperationsClient =
     GlobalOrganizationOperationsClient.create()) {
   ListGlobalOrganizationOperationsRequest request =
       ListGlobalOrganizationOperationsRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setParentId("parentId1175162725")
           .setReturnPartialSuccess(true)
           .build();
   while (true) {
     OperationList response = globalOrganizationOperationsClient.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;
     }
   }
 }

close
```
public final void close()
```
Specified by:

close in interface AutoCloseable

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

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:: awaitTermination in interface com.google.api.gax.core.BackgroundResource
Throws:: InterruptedException

Class GlobalOrganizationOperationsClient

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GlobalOrganizationOperationsClient

GlobalOrganizationOperationsClient

Method Detail

create

create

create

getSettings

getStub

delete

delete

deleteCallable

get

get

getCallable

list

list

listPagedCallable

listCallable

close

shutdown

isShutdown

isTerminated

shutdownNow

awaitTermination