ToolsClient (Google Dialogflow CX 0.71.0 API)

java.lang.Object
- com.google.cloud.dialogflow.cx.v3beta1.ToolsClient

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

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

Service Description: Service for managing [Tools][google.cloud.dialogflow.cx.v3beta1.Tool].

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][google.cloud.dialogflow.cx.v3beta1.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][google.cloud.dialogflow.cx.v3beta1.Tool] 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][google.cloud.dialogflow.cx.v3beta1.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][google.cloud.dialogflow.cx.v3beta1.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][google.cloud.dialogflow.cx.v3beta1.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()
ListToolVersions	List versions of the specified [Tool][google.cloud.dialogflow.cx.v3beta1.Tool].	Request object method variants only take one parameter, a request object, which must be constructed before the call. listToolVersions(ListToolVersionsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listToolVersions(ToolName parent) listToolVersions(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. listToolVersionsPagedCallable() listToolVersionsCallable()
CreateToolVersion	Creates a version for the specified [Tool][google.cloud.dialogflow.cx.v3beta1.Tool].	Request object method variants only take one parameter, a request object, which must be constructed before the call. createToolVersion(CreateToolVersionRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. createToolVersion(ToolName parent, ToolVersion toolVersion) createToolVersion(String parent, ToolVersion toolVersion) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createToolVersionCallable()
GetToolVersion	Retrieves the specified version of the [Tool][google.cloud.dialogflow.cx.v3beta1.Tool].	Request object method variants only take one parameter, a request object, which must be constructed before the call. getToolVersion(GetToolVersionRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getToolVersion(ToolVersionName name) getToolVersion(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. getToolVersionCallable()
DeleteToolVersion	Deletes the specified version of the [Tool][google.cloud.dialogflow.cx.v3beta1.Tool].	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteToolVersion(DeleteToolVersionRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. deleteToolVersion(ToolVersionName name) deleteToolVersion(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. deleteToolVersionCallable()
RestoreToolVersion	Retrieves the specified version of the Tool and stores it as the current tool draft, returning the tool with resources updated.	Request object method variants only take one parameter, a request object, which must be constructed before the call. restoreToolVersion(RestoreToolVersionRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. restoreToolVersion(ToolVersionName name) restoreToolVersion(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. restoreToolVersionCallable()
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.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ToolsClient.ListLocationsFixedSizeCollection`
`static class`	`ToolsClient.ListLocationsPage`
`static class`	`ToolsClient.ListLocationsPagedResponse`
`static class`	`ToolsClient.ListToolsFixedSizeCollection`
`static class`	`ToolsClient.ListToolsPage`
`static class`	`ToolsClient.ListToolsPagedResponse`
`static class`	`ToolsClient.ListToolVersionsFixedSizeCollection`
`static class`	`ToolsClient.ListToolVersionsPage`
`static class`	`ToolsClient.ListToolVersionsPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`ToolsClient(ToolsSettings settings)` Constructs an instance of ToolsClient, using the given settings.
`protected`	`ToolsClient(ToolsStub 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 ToolsClient`	`create()` Constructs an instance of ToolsClient with default settings.
`static ToolsClient`	`create(ToolsSettings settings)` Constructs an instance of ToolsClient, using the given settings.
`static ToolsClient`	`create(ToolsStub stub)` Constructs an instance of ToolsClient, using the given stub for making calls.
`Tool`	`createTool(AgentName parent, Tool tool)` Creates a [Tool][google.cloud.dialogflow.cx.v3beta1.Tool] in the specified agent.
`Tool`	`createTool(CreateToolRequest request)` Creates a [Tool][google.cloud.dialogflow.cx.v3beta1.Tool] in the specified agent.
`Tool`	`createTool(String parent, Tool tool)` Creates a [Tool][google.cloud.dialogflow.cx.v3beta1.Tool] in the specified agent.
`com.google.api.gax.rpc.UnaryCallable<CreateToolRequest,Tool>`	`createToolCallable()` Creates a [Tool][google.cloud.dialogflow.cx.v3beta1.Tool] in the specified agent.
`ToolVersion`	`createToolVersion(CreateToolVersionRequest request)` Creates a version for the specified [Tool][google.cloud.dialogflow.cx.v3beta1.Tool].
`ToolVersion`	`createToolVersion(String parent, ToolVersion toolVersion)` Creates a version for the specified [Tool][google.cloud.dialogflow.cx.v3beta1.Tool].
`ToolVersion`	`createToolVersion(ToolName parent, ToolVersion toolVersion)` Creates a version for the specified [Tool][google.cloud.dialogflow.cx.v3beta1.Tool].
`com.google.api.gax.rpc.UnaryCallable<CreateToolVersionRequest,ToolVersion>`	`createToolVersionCallable()` Creates a version for the specified [Tool][google.cloud.dialogflow.cx.v3beta1.Tool].
`void`	`deleteTool(DeleteToolRequest request)` Deletes a specified [Tool][google.cloud.dialogflow.cx.v3beta1.Tool].
`void`	`deleteTool(String name)` Deletes a specified [Tool][google.cloud.dialogflow.cx.v3beta1.Tool].
`void`	`deleteTool(ToolName name)` Deletes a specified [Tool][google.cloud.dialogflow.cx.v3beta1.Tool].
`com.google.api.gax.rpc.UnaryCallable<DeleteToolRequest,com.google.protobuf.Empty>`	`deleteToolCallable()` Deletes a specified [Tool][google.cloud.dialogflow.cx.v3beta1.Tool].
`void`	`deleteToolVersion(DeleteToolVersionRequest request)` Deletes the specified version of the [Tool][google.cloud.dialogflow.cx.v3beta1.Tool].
`void`	`deleteToolVersion(String name)` Deletes the specified version of the [Tool][google.cloud.dialogflow.cx.v3beta1.Tool].
`void`	`deleteToolVersion(ToolVersionName name)` Deletes the specified version of the [Tool][google.cloud.dialogflow.cx.v3beta1.Tool].
`com.google.api.gax.rpc.UnaryCallable<DeleteToolVersionRequest,com.google.protobuf.Empty>`	`deleteToolVersionCallable()` Deletes the specified version of the [Tool][google.cloud.dialogflow.cx.v3beta1.Tool].
`com.google.api.gax.longrunning.OperationFuture<ExportToolsResponse,ExportToolsMetadata>`	`exportToolsAsync(ExportToolsRequest request)` Exports the selected tools.
`com.google.api.gax.rpc.UnaryCallable<ExportToolsRequest,com.google.longrunning.Operation>`	`exportToolsCallable()` Exports the selected tools.
`com.google.api.gax.rpc.OperationCallable<ExportToolsRequest,ExportToolsResponse,ExportToolsMetadata>`	`exportToolsOperationCallable()` Exports the selected tools.
`com.google.api.gax.httpjson.longrunning.OperationsClient`	`getHttpJsonOperationsClient()` Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
`com.google.cloud.location.Location`	`getLocation(com.google.cloud.location.GetLocationRequest request)` Gets information about a location.
`com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>`	`getLocationCallable()` Gets information about a location.
`com.google.longrunning.OperationsClient`	`getOperationsClient()` Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
`ToolsSettings`	`getSettings()`
`ToolsStub`	`getStub()`
`Tool`	`getTool(GetToolRequest request)` Retrieves the specified [Tool][google.cloud.dialogflow.cx.v3beta1.Tool].
`Tool`	`getTool(String name)` Retrieves the specified [Tool][google.cloud.dialogflow.cx.v3beta1.Tool].
`Tool`	`getTool(ToolName name)` Retrieves the specified [Tool][google.cloud.dialogflow.cx.v3beta1.Tool].
`com.google.api.gax.rpc.UnaryCallable<GetToolRequest,Tool>`	`getToolCallable()` Retrieves the specified [Tool][google.cloud.dialogflow.cx.v3beta1.Tool].
`ToolVersion`	`getToolVersion(GetToolVersionRequest request)` Retrieves the specified version of the [Tool][google.cloud.dialogflow.cx.v3beta1.Tool].
`ToolVersion`	`getToolVersion(String name)` Retrieves the specified version of the [Tool][google.cloud.dialogflow.cx.v3beta1.Tool].
`ToolVersion`	`getToolVersion(ToolVersionName name)` Retrieves the specified version of the [Tool][google.cloud.dialogflow.cx.v3beta1.Tool].
`com.google.api.gax.rpc.UnaryCallable<GetToolVersionRequest,ToolVersion>`	`getToolVersionCallable()` Retrieves the specified version of the [Tool][google.cloud.dialogflow.cx.v3beta1.Tool].
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`ToolsClient.ListLocationsPagedResponse`	`listLocations(com.google.cloud.location.ListLocationsRequest request)` Lists information about the supported locations for this service.
`com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse>`	`listLocationsCallable()` Lists information about the supported locations for this service.
`com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,ToolsClient.ListLocationsPagedResponse>`	`listLocationsPagedCallable()` Lists information about the supported locations for this service.
`ToolsClient.ListToolsPagedResponse`	`listTools(AgentName parent)` Returns a list of [Tools][google.cloud.dialogflow.cx.v3beta1.Tool] in the specified agent.
`ToolsClient.ListToolsPagedResponse`	`listTools(ListToolsRequest request)` Returns a list of [Tools][google.cloud.dialogflow.cx.v3beta1.Tool] in the specified agent.
`ToolsClient.ListToolsPagedResponse`	`listTools(String parent)` Returns a list of [Tools][google.cloud.dialogflow.cx.v3beta1.Tool] in the specified agent.
`com.google.api.gax.rpc.UnaryCallable<ListToolsRequest,ListToolsResponse>`	`listToolsCallable()` Returns a list of [Tools][google.cloud.dialogflow.cx.v3beta1.Tool] in the specified agent.
`com.google.api.gax.rpc.UnaryCallable<ListToolsRequest,ToolsClient.ListToolsPagedResponse>`	`listToolsPagedCallable()` Returns a list of [Tools][google.cloud.dialogflow.cx.v3beta1.Tool] in the specified agent.
`ToolsClient.ListToolVersionsPagedResponse`	`listToolVersions(ListToolVersionsRequest request)` List versions of the specified [Tool][google.cloud.dialogflow.cx.v3beta1.Tool].
`ToolsClient.ListToolVersionsPagedResponse`	`listToolVersions(String parent)` List versions of the specified [Tool][google.cloud.dialogflow.cx.v3beta1.Tool].
`ToolsClient.ListToolVersionsPagedResponse`	`listToolVersions(ToolName parent)` List versions of the specified [Tool][google.cloud.dialogflow.cx.v3beta1.Tool].
`com.google.api.gax.rpc.UnaryCallable<ListToolVersionsRequest,ListToolVersionsResponse>`	`listToolVersionsCallable()` List versions of the specified [Tool][google.cloud.dialogflow.cx.v3beta1.Tool].
`com.google.api.gax.rpc.UnaryCallable<ListToolVersionsRequest,ToolsClient.ListToolVersionsPagedResponse>`	`listToolVersionsPagedCallable()` List versions of the specified [Tool][google.cloud.dialogflow.cx.v3beta1.Tool].
`RestoreToolVersionResponse`	`restoreToolVersion(RestoreToolVersionRequest request)` Retrieves the specified version of the Tool and stores it as the current tool draft, returning the tool with resources updated.
`RestoreToolVersionResponse`	`restoreToolVersion(String name)` Retrieves the specified version of the Tool and stores it as the current tool draft, returning the tool with resources updated.
`RestoreToolVersionResponse`	`restoreToolVersion(ToolVersionName name)` Retrieves the specified version of the Tool and stores it as the current tool draft, returning the tool with resources updated.
`com.google.api.gax.rpc.UnaryCallable<RestoreToolVersionRequest,RestoreToolVersionResponse>`	`restoreToolVersionCallable()` Retrieves the specified version of the Tool and stores it as the current tool draft, returning the tool with resources updated.
`void`	`shutdown()`
`void`	`shutdownNow()`
`Tool`	`updateTool(Tool tool, com.google.protobuf.FieldMask updateMask)` Update the specified [Tool][google.cloud.dialogflow.cx.v3beta1.Tool].
`Tool`	`updateTool(UpdateToolRequest request)` Update the specified [Tool][google.cloud.dialogflow.cx.v3beta1.Tool].
`com.google.api.gax.rpc.UnaryCallable<UpdateToolRequest,Tool>`	`updateToolCallable()` Update the specified [Tool][google.cloud.dialogflow.cx.v3beta1.Tool].

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

Constructor Detail
- ToolsClient
```
protected ToolsClient(ToolsSettings settings)
               throws IOException
```
  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.
  
  Throws:
  
  IOException
- ToolsClient
```
protected ToolsClient(ToolsStub stub)
```

Method Detail

create

public static final ToolsClient create()
                                throws IOException

Constructs an instance of ToolsClient with default settings.

Throws:: IOException

create
```
public static final ToolsClient create(ToolsSettings settings)
                                throws IOException
```
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.

Throws:

IOException

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

getSettings

public final ToolsSettings getSettings()

getStub
```
public ToolsStub getStub()
```

getOperationsClient
```
public final com.google.longrunning.OperationsClient getOperationsClient()
```
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

getHttpJsonOperationsClient
```
@BetaApi
public final com.google.api.gax.httpjson.longrunning.OperationsClient getHttpJsonOperationsClient()
```
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

createTool

public final Tool createTool(AgentName parent,
                             Tool tool)

Creates a [Tool][google.cloud.dialogflow.cx.v3beta1.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:: parent - Required. The agent to create a Tool for. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.; tool - Required. The Tool to be created.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

createTool

public final Tool createTool(String parent,
                             Tool tool)

Creates a [Tool][google.cloud.dialogflow.cx.v3beta1.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:: parent - Required. The agent to create a Tool for. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.; tool - Required. The Tool to be created.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

createTool

public final Tool createTool(CreateToolRequest request)

Creates a [Tool][google.cloud.dialogflow.cx.v3beta1.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);
 }

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

createToolCallable

public final com.google.api.gax.rpc.UnaryCallable<CreateToolRequest,Tool> createToolCallable()

Creates a [Tool][google.cloud.dialogflow.cx.v3beta1.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();
 }

listTools

public final ToolsClient.ListToolsPagedResponse listTools(AgentName parent)

Returns a list of [Tools][google.cloud.dialogflow.cx.v3beta1.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]");
   for (Tool element : toolsClient.listTools(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: parent - Required. The agent to list the Tools from. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listTools

public final ToolsClient.ListToolsPagedResponse listTools(String parent)

Returns a list of [Tools][google.cloud.dialogflow.cx.v3beta1.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();
   for (Tool element : toolsClient.listTools(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: parent - Required. The agent to list the Tools from. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listTools

public final ToolsClient.ListToolsPagedResponse listTools(ListToolsRequest request)

Returns a list of [Tools][google.cloud.dialogflow.cx.v3beta1.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()) {
   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);
   }
 }

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

listToolsPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListToolsRequest,ToolsClient.ListToolsPagedResponse> listToolsPagedCallable()

Returns a list of [Tools][google.cloud.dialogflow.cx.v3beta1.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()) {
   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);
   }
 }

listToolsCallable

public final com.google.api.gax.rpc.UnaryCallable<ListToolsRequest,ListToolsResponse> listToolsCallable()

Returns a list of [Tools][google.cloud.dialogflow.cx.v3beta1.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()) {
   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;
     }
   }
 }

exportToolsAsync

public final com.google.api.gax.longrunning.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();
 }

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

exportToolsOperationCallable

public final com.google.api.gax.rpc.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();
 }

exportToolsCallable

public final com.google.api.gax.rpc.UnaryCallable<ExportToolsRequest,com.google.longrunning.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();
 }

getTool

public final Tool getTool(ToolName name)

Retrieves the specified [Tool][google.cloud.dialogflow.cx.v3beta1.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);
 }

Parameters:: name - Required. The name of the Tool. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>`.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getTool

public final Tool getTool(String name)

Retrieves the specified [Tool][google.cloud.dialogflow.cx.v3beta1.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);
 }

Parameters:: name - Required. The name of the Tool. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>`.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getTool

public final Tool getTool(GetToolRequest request)

Retrieves the specified [Tool][google.cloud.dialogflow.cx.v3beta1.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);
 }

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

getToolCallable

public final com.google.api.gax.rpc.UnaryCallable<GetToolRequest,Tool> getToolCallable()

Retrieves the specified [Tool][google.cloud.dialogflow.cx.v3beta1.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();
 }

updateTool

public final Tool updateTool(Tool tool,
                             com.google.protobuf.FieldMask updateMask)

Update the specified [Tool][google.cloud.dialogflow.cx.v3beta1.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:: tool - Required. The Tool to be updated.; updateMask - The mask to control which fields get updated. If the mask is not present, all fields will be updated.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

updateTool

public final Tool updateTool(UpdateToolRequest request)

Update the specified [Tool][google.cloud.dialogflow.cx.v3beta1.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);
 }

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

updateToolCallable

public final com.google.api.gax.rpc.UnaryCallable<UpdateToolRequest,Tool> updateToolCallable()

Update the specified [Tool][google.cloud.dialogflow.cx.v3beta1.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();
 }

deleteTool

public final void deleteTool(ToolName name)

Deletes a specified [Tool][google.cloud.dialogflow.cx.v3beta1.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);
 }

Parameters:: name - Required. The name of the Tool to be deleted. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>`.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

deleteTool

public final void deleteTool(String name)

Deletes a specified [Tool][google.cloud.dialogflow.cx.v3beta1.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);
 }

Parameters:: name - Required. The name of the Tool to be deleted. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>`.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

deleteTool

public final void deleteTool(DeleteToolRequest request)

Deletes a specified [Tool][google.cloud.dialogflow.cx.v3beta1.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);
 }

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

deleteToolCallable

public final com.google.api.gax.rpc.UnaryCallable<DeleteToolRequest,com.google.protobuf.Empty> deleteToolCallable()

Deletes a specified [Tool][google.cloud.dialogflow.cx.v3beta1.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();
 }