Class GlobalOrganizationOperationsClient (1.54.0)

GitHub RepositoryProduct Reference

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.

Inheritance

java.lang.Object > GlobalOrganizationOperationsClient

Static Methods

create()

public static final GlobalOrganizationOperationsClient create()

Constructs an instance of GlobalOrganizationOperationsClient with default settings.

Returns
Type Description
GlobalOrganizationOperationsClient
Exceptions
Type Description
IOException

create(GlobalOrganizationOperationsSettings settings)

public static final GlobalOrganizationOperationsClient create(GlobalOrganizationOperationsSettings settings)

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.

Parameter
Name Description
settings GlobalOrganizationOperationsSettings
Returns
Type Description
GlobalOrganizationOperationsClient
Exceptions
Type Description
IOException

create(GlobalOrganizationOperationsStub stub)

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).

Parameter
Name Description
stub GlobalOrganizationOperationsStub
Returns
Type Description
GlobalOrganizationOperationsClient

Constructors

GlobalOrganizationOperationsClient(GlobalOrganizationOperationsSettings settings)

protected GlobalOrganizationOperationsClient(GlobalOrganizationOperationsSettings settings)

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.

Parameter
Name Description
settings GlobalOrganizationOperationsSettings

GlobalOrganizationOperationsClient(GlobalOrganizationOperationsStub stub)

protected GlobalOrganizationOperationsClient(GlobalOrganizationOperationsStub stub)
Parameter
Name Description
stub GlobalOrganizationOperationsStub

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

delete(DeleteGlobalOrganizationOperationRequest request)

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);
 }
Parameter
Name Description
request DeleteGlobalOrganizationOperationRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
DeleteGlobalOrganizationOperationResponse

delete(String operation)

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);
 }
Parameter
Name Description
operation String

Name of the Operations resource to delete.
Returns
Type Description
DeleteGlobalOrganizationOperationResponse

deleteCallable()

public final 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();
 }
Returns
Type Description
UnaryCallable<DeleteGlobalOrganizationOperationRequest,DeleteGlobalOrganizationOperationResponse>

get(GetGlobalOrganizationOperationRequest request)

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);
 }
Parameter
Name Description
request GetGlobalOrganizationOperationRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
Operation

get(String operation)

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);
 }
Parameter
Name Description
operation String

Name of the Operations resource to return.
Returns
Type Description
Operation

getCallable()

public final 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();
 }
Returns
Type Description
UnaryCallable<GetGlobalOrganizationOperationRequest,Operation>

getSettings()

public final GlobalOrganizationOperationsSettings getSettings()
Returns
Type Description
GlobalOrganizationOperationsSettings

getStub()

public GlobalOrganizationOperationsStub getStub()
Returns
Type Description
GlobalOrganizationOperationsStub

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

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);
   }
 }
Returns
Type Description
GlobalOrganizationOperationsClient.ListPagedResponse

list(ListGlobalOrganizationOperationsRequest request)

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);
   }
 }
Parameter
Name Description
request ListGlobalOrganizationOperationsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
GlobalOrganizationOperationsClient.ListPagedResponse

listCallable()

public final 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;
     }
   }
 }
Returns
Type Description
UnaryCallable<ListGlobalOrganizationOperationsRequest,OperationList>

listPagedCallable()

public final 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);
   }
 }
Returns
Type Description
UnaryCallable<ListGlobalOrganizationOperationsRequest,ListPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()