ConversationHistoryClient (Google Dialogflow CX 0.71.0 API)

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

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

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

Service Description: Service for managing conversation history.

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 (ConversationHistoryClient conversationHistoryClient = ConversationHistoryClient.create()) {
   ConversationName name =
       ConversationName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[CONVERSATION]");
   Conversation response = conversationHistoryClient.getConversation(name);
 }

Note: close() needs to be called on the ConversationHistoryClient 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
ListConversations	Returns the list of all conversations.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listConversations(ListConversationsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listConversations(AgentName parent) listConversations(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. listConversationsPagedCallable() listConversationsCallable()
GetConversation	Retrieves the specified conversation.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getConversation(GetConversationRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getConversation(ConversationName name) getConversation(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. getConversationCallable()
DeleteConversation	Deletes the specified conversation.	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteConversation(DeleteConversationRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. deleteConversation(ConversationName name) deleteConversation(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. deleteConversationCallable()
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 ConversationHistorySettings 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
 ConversationHistorySettings conversationHistorySettings =
     ConversationHistorySettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ConversationHistoryClient conversationHistoryClient =
     ConversationHistoryClient.create(conversationHistorySettings);

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
 ConversationHistorySettings conversationHistorySettings =
     ConversationHistorySettings.newBuilder().setEndpoint(myEndpoint).build();
 ConversationHistoryClient conversationHistoryClient =
     ConversationHistoryClient.create(conversationHistorySettings);

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
 ConversationHistorySettings conversationHistorySettings =
     ConversationHistorySettings.newHttpJsonBuilder().build();
 ConversationHistoryClient conversationHistoryClient =
     ConversationHistoryClient.create(conversationHistorySettings);

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`	`ConversationHistoryClient.ListConversationsFixedSizeCollection`
`static class`	`ConversationHistoryClient.ListConversationsPage`
`static class`	`ConversationHistoryClient.ListConversationsPagedResponse`
`static class`	`ConversationHistoryClient.ListLocationsFixedSizeCollection`
`static class`	`ConversationHistoryClient.ListLocationsPage`
`static class`	`ConversationHistoryClient.ListLocationsPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`ConversationHistoryClient(ConversationHistorySettings settings)` Constructs an instance of ConversationHistoryClient, using the given settings.
`protected`	`ConversationHistoryClient(ConversationHistoryStub 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 ConversationHistoryClient`	`create()` Constructs an instance of ConversationHistoryClient with default settings.
`static ConversationHistoryClient`	`create(ConversationHistorySettings settings)` Constructs an instance of ConversationHistoryClient, using the given settings.
`static ConversationHistoryClient`	`create(ConversationHistoryStub stub)` Constructs an instance of ConversationHistoryClient, using the given stub for making calls.
`void`	`deleteConversation(ConversationName name)` Deletes the specified conversation.
`void`	`deleteConversation(DeleteConversationRequest request)` Deletes the specified conversation.
`void`	`deleteConversation(String name)` Deletes the specified conversation.
`com.google.api.gax.rpc.UnaryCallable<DeleteConversationRequest,com.google.protobuf.Empty>`	`deleteConversationCallable()` Deletes the specified conversation.
`Conversation`	`getConversation(ConversationName name)` Retrieves the specified conversation.
`Conversation`	`getConversation(GetConversationRequest request)` Retrieves the specified conversation.
`Conversation`	`getConversation(String name)` Retrieves the specified conversation.
`com.google.api.gax.rpc.UnaryCallable<GetConversationRequest,Conversation>`	`getConversationCallable()` Retrieves the specified conversation.
`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.
`ConversationHistorySettings`	`getSettings()`
`ConversationHistoryStub`	`getStub()`
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`ConversationHistoryClient.ListConversationsPagedResponse`	`listConversations(AgentName parent)` Returns the list of all conversations.
`ConversationHistoryClient.ListConversationsPagedResponse`	`listConversations(ListConversationsRequest request)` Returns the list of all conversations.
`ConversationHistoryClient.ListConversationsPagedResponse`	`listConversations(String parent)` Returns the list of all conversations.
`com.google.api.gax.rpc.UnaryCallable<ListConversationsRequest,ListConversationsResponse>`	`listConversationsCallable()` Returns the list of all conversations.
`com.google.api.gax.rpc.UnaryCallable<ListConversationsRequest,ConversationHistoryClient.ListConversationsPagedResponse>`	`listConversationsPagedCallable()` Returns the list of all conversations.
`ConversationHistoryClient.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,ConversationHistoryClient.ListLocationsPagedResponse>`	`listLocationsPagedCallable()` Lists information about the supported locations for this service.
`void`	`shutdown()`
`void`	`shutdownNow()`

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

Constructor Detail
- ConversationHistoryClient
```
protected ConversationHistoryClient(ConversationHistorySettings settings)
                             throws IOException
```
  Constructs an instance of ConversationHistoryClient, 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
- ConversationHistoryClient
```
protected ConversationHistoryClient(ConversationHistoryStub stub)
```

Method Detail

create

public static final ConversationHistoryClient create()
                                              throws IOException

Constructs an instance of ConversationHistoryClient with default settings.

Throws:: IOException

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

getSettings

public final ConversationHistorySettings getSettings()