Class ToolsClient (0.55.0)

GitHub RepositoryProduct ReferenceREST DocumentationRPC Documentation

Service Description: Service for managing Tools.

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 (ToolsClient toolsClient = ToolsClient.create()) {
   AgentName parent = AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]");
   Tool tool = Tool.newBuilder().build();
   Tool response = toolsClient.createTool(parent, tool);
 }

Note: close() needs to be called on the ToolsClient 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

CreateTool

Creates a Tool in the specified agent.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createTool(CreateToolRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • createTool(AgentName parent, Tool tool)

  • createTool(String parent, Tool tool)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createToolCallable()

ListTools

Returns a list of Tools in the specified agent.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listTools(ListToolsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listTools(AgentName parent)

  • listTools(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listToolsPagedCallable()

  • listToolsCallable()

ExportTools

Exports the selected tools.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • exportToolsAsync(ExportToolsRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • exportToolsOperationCallable()

  • exportToolsCallable()

GetTool

Retrieves the specified Tool.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getTool(GetToolRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getTool(ToolName name)

  • getTool(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getToolCallable()

UpdateTool

Update the specified Tool.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateTool(UpdateToolRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • updateTool(Tool tool, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateToolCallable()

DeleteTool

Deletes a specified Tool.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteTool(DeleteToolRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • deleteTool(ToolName name)

  • deleteTool(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteToolCallable()

ListLocations

Lists information about the supported locations for this service.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listLocations(ListLocationsRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listLocationsPagedCallable()

  • listLocationsCallable()

GetLocation

Gets information about a location.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getLocation(GetLocationRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getLocationCallable()

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 ToolsSettings 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
 ToolsSettings toolsSettings =
     ToolsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ToolsClient toolsClient = ToolsClient.create(toolsSettings);

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
 ToolsSettings toolsSettings = ToolsSettings.newBuilder().setEndpoint(myEndpoint).build();
 ToolsClient toolsClient = ToolsClient.create(toolsSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // 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
 ToolsSettings toolsSettings = ToolsSettings.newHttpJsonBuilder().build();
 ToolsClient toolsClient = ToolsClient.create(toolsSettings);

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

Inheritance

java.lang.Object > ToolsClient

Static Methods

create()

public static final ToolsClient create()

Constructs an instance of ToolsClient with default settings.

Returns
Type Description
ToolsClient
Exceptions
Type Description
IOException

create(ToolsSettings settings)

public static final ToolsClient create(ToolsSettings settings)

Constructs an instance of ToolsClient, 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 ToolsSettings
Returns
Type Description
ToolsClient
Exceptions
Type Description
IOException

create(ToolsStub stub)

public static final ToolsClient create(ToolsStub stub)

Constructs an instance of ToolsClient, using the given stub for making calls. This is for advanced usage - prefer using create(ToolsSettings).

Parameter
Name Description
stub ToolsStub
Returns
Type Description
ToolsClient

Constructors

ToolsClient(ToolsSettings settings)

protected ToolsClient(ToolsSettings settings)

Constructs an instance of ToolsClient, 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 ToolsSettings

ToolsClient(ToolsStub stub)

protected ToolsClient(ToolsStub stub)
Parameter
Name Description
stub ToolsStub

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

createTool(AgentName parent, Tool tool)

public final Tool createTool(AgentName parent, Tool tool)

Creates a Tool in the specified agent.

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 (ToolsClient toolsClient = ToolsClient.create()) {
   AgentName parent = AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]");
   Tool tool = Tool.newBuilder().build();
   Tool response = toolsClient.createTool(parent, tool);
 }
Parameters
Name Description
parent AgentName

Required. The agent to create a Tool for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.
tool Tool

Required. The Tool to be created.
Returns
Type Description
Tool

createTool(CreateToolRequest request)

public final Tool createTool(CreateToolRequest request)

Creates a Tool in the specified agent.

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 (ToolsClient toolsClient = ToolsClient.create()) {
   CreateToolRequest request =
       CreateToolRequest.newBuilder()
           .setParent(AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]").toString())
           .setTool(Tool.newBuilder().build())
           .build();
   Tool response = toolsClient.createTool(request);
 }
Parameter
Name Description
request CreateToolRequest

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

createTool(String parent, Tool tool)

public final Tool createTool(String parent, Tool tool)

Creates a Tool in the specified agent.

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 (ToolsClient toolsClient = ToolsClient.create()) {
   String parent = AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]").toString();
   Tool tool = Tool.newBuilder().build();
   Tool response = toolsClient.createTool(parent, tool);
 }
Parameters
Name Description
parent String

Required. The agent to create a Tool for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.
tool Tool

Required. The Tool to be created.
Returns
Type Description
Tool

createToolCallable()

public final UnaryCallable<CreateToolRequest,Tool> createToolCallable()

Creates a Tool in the specified agent.

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 (ToolsClient toolsClient = ToolsClient.create()) {
   CreateToolRequest request =
       CreateToolRequest.newBuilder()
           .setParent(AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]").toString())
           .setTool(Tool.newBuilder().build())
           .build();
   ApiFuture<Tool> future = toolsClient.createToolCallable().futureCall(request);
   // Do something.
   Tool response = future.get();
 }
Returns
Type Description
UnaryCallable<CreateToolRequest,Tool>

deleteTool(DeleteToolRequest request)

public final void deleteTool(DeleteToolRequest request)

Deletes a specified Tool.

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 (ToolsClient toolsClient = ToolsClient.create()) {
   DeleteToolRequest request =
       DeleteToolRequest.newBuilder()
           .setName(ToolName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[TOOL]").toString())
           .setForce(true)
           .build();
   toolsClient.deleteTool(request);
 }
Parameter
Name Description
request DeleteToolRequest

The request object containing all of the parameters for the API call.

deleteTool(ToolName name)

public final void deleteTool(ToolName name)

Deletes a specified Tool.

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 (ToolsClient toolsClient = ToolsClient.create()) {
   ToolName name = ToolName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[TOOL]");
   toolsClient.deleteTool(name);
 }
Parameter
Name Description
name ToolName

Required. The name of the Tool to be deleted. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/tools/<Tool ID>.

deleteTool(String name)

public final void deleteTool(String name)

Deletes a specified Tool.

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 (ToolsClient toolsClient = ToolsClient.create()) {
   String name = ToolName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[TOOL]").toString();
   toolsClient.deleteTool(name);
 }
Parameter
Name Description
name String

Required. The name of the Tool to be deleted. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/tools/<Tool ID>.

deleteToolCallable()

public final UnaryCallable<DeleteToolRequest,Empty> deleteToolCallable()

Deletes a specified Tool.

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 (ToolsClient toolsClient = ToolsClient.create()) {
   DeleteToolRequest request =
       DeleteToolRequest.newBuilder()
           .setName(ToolName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[TOOL]").toString())
           .setForce(true)
           .build();
   ApiFuture<Empty> future = toolsClient.deleteToolCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
UnaryCallable<DeleteToolRequest,Empty>

exportToolsAsync(ExportToolsRequest request)

public final OperationFuture<ExportToolsResponse,ExportToolsMetadata> exportToolsAsync(ExportToolsRequest request)

Exports the selected tools.

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 (ToolsClient toolsClient = ToolsClient.create()) {
   ExportToolsRequest request =
       ExportToolsRequest.newBuilder()
           .setParent(AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]").toString())
           .addAllTools(new ArrayList<String>())
           .build();
   ExportToolsResponse response = toolsClient.exportToolsAsync(request).get();
 }
Parameter
Name Description
request ExportToolsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<ExportToolsResponse,ExportToolsMetadata>

exportToolsCallable()

public final UnaryCallable<ExportToolsRequest,Operation> exportToolsCallable()

Exports the selected tools.

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 (ToolsClient toolsClient = ToolsClient.create()) {
   ExportToolsRequest request =
       ExportToolsRequest.newBuilder()
           .setParent(AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]").toString())
           .addAllTools(new ArrayList<String>())
           .build();
   ApiFuture<Operation> future = toolsClient.exportToolsCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<ExportToolsRequest,Operation>

exportToolsOperationCallable()

public final OperationCallable<ExportToolsRequest,ExportToolsResponse,ExportToolsMetadata> exportToolsOperationCallable()

Exports the selected tools.

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 (ToolsClient toolsClient = ToolsClient.create()) {
   ExportToolsRequest request =
       ExportToolsRequest.newBuilder()
           .setParent(AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]").toString())
           .addAllTools(new ArrayList<String>())
           .build();
   OperationFuture<ExportToolsResponse, ExportToolsMetadata> future =
       toolsClient.exportToolsOperationCallable().futureCall(request);
   // Do something.
   ExportToolsResponse response = future.get();
 }
Returns
Type Description
OperationCallable<ExportToolsRequest,ExportToolsResponse,ExportToolsMetadata>

getHttpJsonOperationsClient()

public final OperationsClient getHttpJsonOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

Returns
Type Description
OperationsClient

getLocation(GetLocationRequest request)

public final Location getLocation(GetLocationRequest request)

Gets information about a location.

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 (ToolsClient toolsClient = ToolsClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   Location response = toolsClient.getLocation(request);
 }
Parameter
Name Description
request com.google.cloud.location.GetLocationRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
com.google.cloud.location.Location

getLocationCallable()

public final UnaryCallable<GetLocationRequest,Location> getLocationCallable()

Gets information about a location.

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 (ToolsClient toolsClient = ToolsClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   ApiFuture<Location> future = toolsClient.getLocationCallable().futureCall(request);
   // Do something.
   Location response = future.get();
 }
Returns
Type Description
UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>

getOperationsClient()

public final OperationsClient getOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

Returns
Type Description
OperationsClient

getSettings()

public final ToolsSettings getSettings()
Returns
Type Description
ToolsSettings

getStub()

public ToolsStub getStub()
Returns
Type Description
ToolsStub

getTool(GetToolRequest request)

public final Tool getTool(GetToolRequest request)

Retrieves the specified Tool.

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 (ToolsClient toolsClient = ToolsClient.create()) {
   GetToolRequest request =
       GetToolRequest.newBuilder()
           .setName(ToolName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[TOOL]").toString())
           .build();
   Tool response = toolsClient.getTool(request);
 }
Parameter
Name Description
request GetToolRequest

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

getTool(ToolName name)

public final Tool getTool(ToolName name)

Retrieves the specified Tool.

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 (ToolsClient toolsClient = ToolsClient.create()) {
   ToolName name = ToolName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[TOOL]");
   Tool response = toolsClient.getTool(name);
 }
Parameter
Name Description
name ToolName

Required. The name of the Tool. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/tools/<Tool ID>.
Returns
Type Description
Tool

getTool(String name)

public final Tool getTool(String name)

Retrieves the specified Tool.

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 (ToolsClient toolsClient = ToolsClient.create()) {
   String name = ToolName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[TOOL]").toString();
   Tool response = toolsClient.getTool(name);
 }
Parameter
Name Description
name String

Required. The name of the Tool. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/tools/<Tool ID>.
Returns
Type Description
Tool

getToolCallable()

public final UnaryCallable<GetToolRequest,Tool> getToolCallable()

Retrieves the specified Tool.

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 (ToolsClient toolsClient = ToolsClient.create()) {
   GetToolRequest request =
       GetToolRequest.newBuilder()
           .setName(ToolName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[TOOL]").toString())
           .build();
   ApiFuture<Tool> future = toolsClient.getToolCallable().futureCall(request);
   // Do something.
   Tool response = future.get();
 }
Returns
Type Description
UnaryCallable<GetToolRequest,Tool>

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

listLocations(ListLocationsRequest request)

public final ToolsClient.ListLocationsPagedResponse listLocations(ListLocationsRequest request)

Lists information about the supported locations for this service.

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 (ToolsClient toolsClient = ToolsClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Location element : toolsClient.listLocations(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request com.google.cloud.location.ListLocationsRequest

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

listLocationsCallable()

public final UnaryCallable<ListLocationsRequest,ListLocationsResponse> listLocationsCallable()

Lists information about the supported locations for this service.

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 (ToolsClient toolsClient = ToolsClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListLocationsResponse response = toolsClient.listLocationsCallable().call(request);
     for (Location element : response.getLocationsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse>

listLocationsPagedCallable()

public final UnaryCallable<ListLocationsRequest,ToolsClient.ListLocationsPagedResponse> listLocationsPagedCallable()

Lists information about the supported locations for this service.

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 (ToolsClient toolsClient = ToolsClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Location> future = toolsClient.listLocationsPagedCallable().futureCall(request);
   // Do something.
   for (Location element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<com.google.cloud.location.ListLocationsRequest,ListLocationsPagedResponse>

listTools(AgentName parent)

public final ToolsClient.ListToolsPagedResponse listTools(AgentName parent)

Returns a list of Tools in the specified agent.

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 (ToolsClient toolsClient = ToolsClient.create()) {
   AgentName parent = AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]");
   for (Tool element : toolsClient.listTools(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent AgentName

Required. The agent to list the Tools from. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.
Returns
Type Description
ToolsClient.ListToolsPagedResponse

listTools(ListToolsRequest request)

public final ToolsClient.ListToolsPagedResponse listTools(ListToolsRequest request)

Returns a list of Tools in the specified agent.

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 (ToolsClient toolsClient = ToolsClient.create()) {
   ListToolsRequest request =
       ListToolsRequest.newBuilder()
           .setParent(AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Tool element : toolsClient.listTools(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request ListToolsRequest

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

listTools(String parent)

public final ToolsClient.ListToolsPagedResponse listTools(String parent)

Returns a list of Tools in the specified agent.

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 (ToolsClient toolsClient = ToolsClient.create()) {
   String parent = AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]").toString();
   for (Tool element : toolsClient.listTools(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent String

Required. The agent to list the Tools from. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.
Returns
Type Description
ToolsClient.ListToolsPagedResponse

listToolsCallable()

public final UnaryCallable<ListToolsRequest,ListToolsResponse> listToolsCallable()

Returns a list of Tools in the specified agent.

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 (ToolsClient toolsClient = ToolsClient.create()) {
   ListToolsRequest request =
       ListToolsRequest.newBuilder()
           .setParent(AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListToolsResponse response = toolsClient.listToolsCallable().call(request);
     for (Tool element : response.getToolsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<ListToolsRequest,ListToolsResponse>

listToolsPagedCallable()

public final UnaryCallable<ListToolsRequest,ToolsClient.ListToolsPagedResponse> listToolsPagedCallable()

Returns a list of Tools in the specified agent.

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 (ToolsClient toolsClient = ToolsClient.create()) {
   ListToolsRequest request =
       ListToolsRequest.newBuilder()
           .setParent(AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Tool> future = toolsClient.listToolsPagedCallable().futureCall(request);
   // Do something.
   for (Tool element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListToolsRequest,ListToolsPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateTool(Tool tool, FieldMask updateMask)

public final Tool updateTool(Tool tool, FieldMask updateMask)

Update the specified Tool.

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 (ToolsClient toolsClient = ToolsClient.create()) {
   Tool tool = Tool.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Tool response = toolsClient.updateTool(tool, updateMask);
 }
Parameters
Name Description
tool Tool

Required. The Tool to be updated.
updateMask FieldMask

The mask to control which fields get updated. If the mask is not present, all fields will be updated.
Returns
Type Description
Tool

updateTool(UpdateToolRequest request)

public final Tool updateTool(UpdateToolRequest request)

Update the specified Tool.

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 (ToolsClient toolsClient = ToolsClient.create()) {
   UpdateToolRequest request =
       UpdateToolRequest.newBuilder()
           .setTool(Tool.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Tool response = toolsClient.updateTool(request);
 }
Parameter
Name Description
request UpdateToolRequest

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

updateToolCallable()

public final UnaryCallable<UpdateToolRequest,Tool> updateToolCallable()

Update the specified Tool.

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 (ToolsClient toolsClient = ToolsClient.create()) {
   UpdateToolRequest request =
       UpdateToolRequest.newBuilder()
           .setTool(Tool.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Tool> future = toolsClient.updateToolCallable().futureCall(request);
   // Do something.
   Tool response = future.get();
 }
Returns
Type Description
UnaryCallable<UpdateToolRequest,Tool>