ConversationsClient (Google Cloud Dialog Flow API Parent 4.9.1 API)

java.lang.Object
- com.google.cloud.dialogflow.v2.ConversationsClient

All Implemented Interfaces:: BackgroundResource, AutoCloseable

@Generated(value="by gapic-generator-java")
public class ConversationsClient
extends Object
implements BackgroundResource

Service Description: Service for managing [Conversations][google.cloud.dialogflow.v2.Conversation].

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 (ConversationsClient conversationsClient = ConversationsClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   Conversation conversation = Conversation.newBuilder().build();
   Conversation response = conversationsClient.createConversation(parent, conversation);
 }

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

The surface of this class includes several types of Java methods for each of the API's methods:

A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of ConversationsSettings 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
 ConversationsSettings conversationsSettings =
     ConversationsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ConversationsClient conversationsClient = ConversationsClient.create(conversationsSettings);

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
 ConversationsSettings conversationsSettings =
     ConversationsSettings.newBuilder().setEndpoint(myEndpoint).build();
 ConversationsClient conversationsClient = ConversationsClient.create(conversationsSettings);

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
 ConversationsSettings conversationsSettings =
     ConversationsSettings.newBuilder()
         .setTransportChannelProvider(
             ConversationsSettings.defaultHttpJsonTransportProviderBuilder().build())
         .build();
 ConversationsClient conversationsClient = ConversationsClient.create(conversationsSettings);

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`	`ConversationsClient.ListConversationsFixedSizeCollection`
`static class`	`ConversationsClient.ListConversationsPage`
`static class`	`ConversationsClient.ListConversationsPagedResponse`
`static class`	`ConversationsClient.ListLocationsFixedSizeCollection`
`static class`	`ConversationsClient.ListLocationsPage`
`static class`	`ConversationsClient.ListLocationsPagedResponse`
`static class`	`ConversationsClient.ListMessagesFixedSizeCollection`
`static class`	`ConversationsClient.ListMessagesPage`
`static class`	`ConversationsClient.ListMessagesPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`ConversationsClient(ConversationsSettings settings)` Constructs an instance of ConversationsClient, using the given settings.
`protected`	`ConversationsClient(ConversationsStub 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()`
`Conversation`	`completeConversation(CompleteConversationRequest request)` Completes the specified conversation.
`Conversation`	`completeConversation(ConversationName name)` Completes the specified conversation.
`Conversation`	`completeConversation(String name)` Completes the specified conversation.
`UnaryCallable<CompleteConversationRequest,Conversation>`	`completeConversationCallable()` Completes the specified conversation.
`static ConversationsClient`	`create()` Constructs an instance of ConversationsClient with default settings.
`static ConversationsClient`	`create(ConversationsSettings settings)` Constructs an instance of ConversationsClient, using the given settings.
`static ConversationsClient`	`create(ConversationsStub stub)` Constructs an instance of ConversationsClient, using the given stub for making calls.
`Conversation`	`createConversation(CreateConversationRequest request)` Creates a new conversation.
`Conversation`	`createConversation(LocationName parent, Conversation conversation)` Creates a new conversation.
`Conversation`	`createConversation(ProjectName parent, Conversation conversation)` Creates a new conversation.
`Conversation`	`createConversation(String parent, Conversation conversation)` Creates a new conversation.
`UnaryCallable<CreateConversationRequest,Conversation>`	`createConversationCallable()` Creates a new conversation.
`Conversation`	`getConversation(ConversationName name)` Retrieves the specific conversation.
`Conversation`	`getConversation(GetConversationRequest request)` Retrieves the specific conversation.
`Conversation`	`getConversation(String name)` Retrieves the specific conversation.
`UnaryCallable<GetConversationRequest,Conversation>`	`getConversationCallable()` Retrieves the specific conversation.
`com.google.cloud.location.Location`	`getLocation(com.google.cloud.location.GetLocationRequest request)` Gets information about a location.
`UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>`	`getLocationCallable()` Gets information about a location.
`ConversationsSettings`	`getSettings()`
`ConversationsStub`	`getStub()`
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`ConversationsClient.ListConversationsPagedResponse`	`listConversations(ListConversationsRequest request)` Returns the list of all conversations in the specified project.
`ConversationsClient.ListConversationsPagedResponse`	`listConversations(LocationName parent)` Returns the list of all conversations in the specified project.
`ConversationsClient.ListConversationsPagedResponse`	`listConversations(ProjectName parent)` Returns the list of all conversations in the specified project.
`ConversationsClient.ListConversationsPagedResponse`	`listConversations(String parent)` Returns the list of all conversations in the specified project.
`UnaryCallable<ListConversationsRequest,ListConversationsResponse>`	`listConversationsCallable()` Returns the list of all conversations in the specified project.
`UnaryCallable<ListConversationsRequest,ConversationsClient.ListConversationsPagedResponse>`	`listConversationsPagedCallable()` Returns the list of all conversations in the specified project.
`ConversationsClient.ListLocationsPagedResponse`	`listLocations(com.google.cloud.location.ListLocationsRequest request)` Lists information about the supported locations for this service.
`UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse>`	`listLocationsCallable()` Lists information about the supported locations for this service.
`UnaryCallable<com.google.cloud.location.ListLocationsRequest,ConversationsClient.ListLocationsPagedResponse>`	`listLocationsPagedCallable()` Lists information about the supported locations for this service.
`ConversationsClient.ListMessagesPagedResponse`	`listMessages(ConversationName parent)` Lists messages that belong to a given conversation.
`ConversationsClient.ListMessagesPagedResponse`	`listMessages(ListMessagesRequest request)` Lists messages that belong to a given conversation.
`ConversationsClient.ListMessagesPagedResponse`	`listMessages(String parent)` Lists messages that belong to a given conversation.
`UnaryCallable<ListMessagesRequest,ListMessagesResponse>`	`listMessagesCallable()` Lists messages that belong to a given conversation.
`UnaryCallable<ListMessagesRequest,ConversationsClient.ListMessagesPagedResponse>`	`listMessagesPagedCallable()` Lists messages that belong to a given conversation.
`void`	`shutdown()`
`void`	`shutdownNow()`

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

Constructor Detail
- ConversationsClient
```
protected ConversationsClient(ConversationsSettings settings)
                       throws IOException
```
  Constructs an instance of ConversationsClient, 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
- ConversationsClient
```
protected ConversationsClient(ConversationsStub stub)
```

Method Detail

create

public static final ConversationsClient create()
                                        throws IOException

Constructs an instance of ConversationsClient with default settings.

Throws:: IOException

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

getSettings

public final ConversationsSettings getSettings()

getStub
```
public ConversationsStub getStub()
```

createConversation
```
public final Conversation createConversation(LocationName parent,
                                             Conversation conversation)
```
Creates a new conversation. Conversations are auto-completed after 24 hours.
Conversation Lifecycle: There are two stages during a conversation: Automated Agent Stage and Assist Stage.
For Automated Agent Stage, there will be a dialogflow agent responding to user queries.
For Assist Stage, there's no dialogflow agent responding to user queries. But we will provide suggestions which are generated from conversation.
If [Conversation.conversation_profile][google.cloud.dialogflow.v2.Conversation.conversation_profile] is configured for a dialogflow agent, conversation will start from `Automated Agent Stage`, otherwise, it will start from `Assist Stage`. And during `Automated Agent Stage`, once an [Intent][google.cloud.dialogflow.v2.Intent] with [Intent.live_agent_handoff][google.cloud.dialogflow.v2.Intent.live_agent_handoff] is triggered, conversation will transfer to Assist Stage.
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 (ConversationsClient conversationsClient = ConversationsClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   Conversation conversation = Conversation.newBuilder().build();
   Conversation response = conversationsClient.createConversation(parent, conversation);
 }
 
```
Parameters:

parent - Required. Resource identifier of the project creating the conversation. Format: `projects/<Project ID>/locations/<Location ID>`.

conversation - Required. The conversation to create.

Throws:

ApiException - if the remote call fails

createConversation
```
public final Conversation createConversation(ProjectName parent,
                                             Conversation conversation)
```
Creates a new conversation. Conversations are auto-completed after 24 hours.
Conversation Lifecycle: There are two stages during a conversation: Automated Agent Stage and Assist Stage.
For Automated Agent Stage, there will be a dialogflow agent responding to user queries.
For Assist Stage, there's no dialogflow agent responding to user queries. But we will provide suggestions which are generated from conversation.
If [Conversation.conversation_profile][google.cloud.dialogflow.v2.Conversation.conversation_profile] is configured for a dialogflow agent, conversation will start from `Automated Agent Stage`, otherwise, it will start from `Assist Stage`. And during `Automated Agent Stage`, once an [Intent][google.cloud.dialogflow.v2.Intent] with [Intent.live_agent_handoff][google.cloud.dialogflow.v2.Intent.live_agent_handoff] is triggered, conversation will transfer to Assist Stage.
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 (ConversationsClient conversationsClient = ConversationsClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   Conversation conversation = Conversation.newBuilder().build();
   Conversation response = conversationsClient.createConversation(parent, conversation);
 }
 
```
Parameters:

parent - Required. Resource identifier of the project creating the conversation. Format: `projects/<Project ID>/locations/<Location ID>`.

conversation - Required. The conversation to create.

Throws:

ApiException - if the remote call fails

createConversation
```
public final Conversation createConversation(String parent,
                                             Conversation conversation)
```
Creates a new conversation. Conversations are auto-completed after 24 hours.
Conversation Lifecycle: There are two stages during a conversation: Automated Agent Stage and Assist Stage.
For Automated Agent Stage, there will be a dialogflow agent responding to user queries.
For Assist Stage, there's no dialogflow agent responding to user queries. But we will provide suggestions which are generated from conversation.
If [Conversation.conversation_profile][google.cloud.dialogflow.v2.Conversation.conversation_profile] is configured for a dialogflow agent, conversation will start from `Automated Agent Stage`, otherwise, it will start from `Assist Stage`. And during `Automated Agent Stage`, once an [Intent][google.cloud.dialogflow.v2.Intent] with [Intent.live_agent_handoff][google.cloud.dialogflow.v2.Intent.live_agent_handoff] is triggered, conversation will transfer to Assist Stage.
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 (ConversationsClient conversationsClient = ConversationsClient.create()) {
   String parent = ProjectName.of("[PROJECT]").toString();
   Conversation conversation = Conversation.newBuilder().build();
   Conversation response = conversationsClient.createConversation(parent, conversation);
 }
 
```
Parameters:

parent - Required. Resource identifier of the project creating the conversation. Format: `projects/<Project ID>/locations/<Location ID>`.

conversation - Required. The conversation to create.

Throws:

ApiException - if the remote call fails

createConversation
```
public final Conversation createConversation(CreateConversationRequest request)
```
Creates a new conversation. Conversations are auto-completed after 24 hours.
Conversation Lifecycle: There are two stages during a conversation: Automated Agent Stage and Assist Stage.
For Automated Agent Stage, there will be a dialogflow agent responding to user queries.
For Assist Stage, there's no dialogflow agent responding to user queries. But we will provide suggestions which are generated from conversation.
If [Conversation.conversation_profile][google.cloud.dialogflow.v2.Conversation.conversation_profile] is configured for a dialogflow agent, conversation will start from `Automated Agent Stage`, otherwise, it will start from `Assist Stage`. And during `Automated Agent Stage`, once an [Intent][google.cloud.dialogflow.v2.Intent] with [Intent.live_agent_handoff][google.cloud.dialogflow.v2.Intent.live_agent_handoff] is triggered, conversation will transfer to Assist Stage.
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 (ConversationsClient conversationsClient = ConversationsClient.create()) {
   CreateConversationRequest request =
       CreateConversationRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setConversation(Conversation.newBuilder().build())
           .setConversationId("conversationId-1676095234")
           .build();
   Conversation response = conversationsClient.createConversation(request);
 }
 
```
Parameters:

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

Throws:

ApiException - if the remote call fails

createConversationCallable

public final UnaryCallable<CreateConversationRequest,Conversation> createConversationCallable()

Creates a new conversation. Conversations are auto-completed after 24 hours.

Conversation Lifecycle: There are two stages during a conversation: Automated Agent Stage and Assist Stage.

For Automated Agent Stage, there will be a dialogflow agent responding to user queries.

For Assist Stage, there's no dialogflow agent responding to user queries. But we will provide suggestions which are generated from conversation.

If [Conversation.conversation_profile][google.cloud.dialogflow.v2.Conversation.conversation_profile] is configured for a dialogflow agent, conversation will start from `Automated Agent Stage`, otherwise, it will start from `Assist Stage`. And during `Automated Agent Stage`, once an [Intent][google.cloud.dialogflow.v2.Intent] with [Intent.live_agent_handoff][google.cloud.dialogflow.v2.Intent.live_agent_handoff] is triggered, conversation will transfer to Assist Stage.

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 (ConversationsClient conversationsClient = ConversationsClient.create()) {
   CreateConversationRequest request =
       CreateConversationRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setConversation(Conversation.newBuilder().build())
           .setConversationId("conversationId-1676095234")
           .build();
   ApiFuture<Conversation> future =
       conversationsClient.createConversationCallable().futureCall(request);
   // Do something.
   Conversation response = future.get();
 }