com.google.api.services.discoveryengine.v1

Class DiscoveryEngine.Projects.Locations.Collections.DataStores.Conversations

java.lang.Object

com.google.api.services.discoveryengine.v1.DiscoveryEngine.Projects.Locations.Collections.DataStores.Conversations

Enclosing class:

DiscoveryEngine.Projects.Locations.Collections.DataStores

public class DiscoveryEngine.Projects.Locations.Collections.DataStores.Conversations
extends Object

The "conversations" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	DiscoveryEngine.Projects.Locations.Collections.DataStores.Conversations.Converse
class	DiscoveryEngine.Projects.Locations.Collections.DataStores.Conversations.Create
class	DiscoveryEngine.Projects.Locations.Collections.DataStores.Conversations.Delete
class	DiscoveryEngine.Projects.Locations.Collections.DataStores.Conversations.Get
class	DiscoveryEngine.Projects.Locations.Collections.DataStores.Conversations.List
class	DiscoveryEngine.Projects.Locations.Collections.DataStores.Conversations.Patch

Constructor Summary

Constructors

Constructor and Description
Conversations()

Method Summary

Modifier and Type	Method and Description
DiscoveryEngine.Projects.Locations.Collections.DataStores.Conversations.Converse	converse(String name, GoogleCloudDiscoveryengineV1ConverseConversationRequest content) Converses a conversation.
DiscoveryEngine.Projects.Locations.Collections.DataStores.Conversations.Create	create(String parent, GoogleCloudDiscoveryengineV1Conversation content) Creates a Conversation.
DiscoveryEngine.Projects.Locations.Collections.DataStores.Conversations.Delete	delete(String name) Deletes a Conversation.
DiscoveryEngine.Projects.Locations.Collections.DataStores.Conversations.Get	get(String name) Gets a Conversation.
DiscoveryEngine.Projects.Locations.Collections.DataStores.Conversations.List	list(String parent) Lists all Conversations by their parent DataStore.
DiscoveryEngine.Projects.Locations.Collections.DataStores.Conversations.Patch	patch(String name, GoogleCloudDiscoveryengineV1Conversation content) Updates a Conversation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Conversations

public Conversations()

Method Detail

converse

public DiscoveryEngine.Projects.Locations.Collections.DataStores.Conversations.Converse converse(String name,
                                                                                                 GoogleCloudDiscoveryengineV1ConverseConversationRequest content)
                                                                                          throws IOException

Converses a conversation. Create a request for the method "conversations.converse". This request holds the parameters needed by the discoveryengine server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. The resource name of the Conversation to get. Format: `projects/{project}/locations/{locat ion}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. Use `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_sto re_id}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session.

content - the GoogleCloudDiscoveryengineV1ConverseConversationRequest

Returns:

the request

Throws:

IOException

create

public DiscoveryEngine.Projects.Locations.Collections.DataStores.Conversations.Create create(String parent,
                                                                                             GoogleCloudDiscoveryengineV1Conversation content)
                                                                                      throws IOException

Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned. Create a request for the method "conversations.create". This request holds the parameters needed by the discoveryengine server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_i d}`

content - the GoogleCloudDiscoveryengineV1Conversation

Returns:

the request

Throws:

IOException

delete

public DiscoveryEngine.Projects.Locations.Collections.DataStores.Conversations.Delete delete(String name)
                                                                                      throws IOException

Deletes a Conversation. If the Conversation to delete does not exist, a NOT_FOUND error is returned. Create a request for the method "conversations.delete". This request holds the parameters needed by the discoveryengine server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. The resource name of the Conversation to delete. Format: `projects/{project}/locations/{lo cation}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id }`

Returns:

the request

Throws:

IOException

get

public DiscoveryEngine.Projects.Locations.Collections.DataStores.Conversations.Get get(String name)
                                                                                throws IOException

Gets a Conversation. Create a request for the method "conversations.get". This request holds the parameters needed by the discoveryengine server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. The resource name of the Conversation to get. Format: `projects/{project}/locations/{locat ion}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`

Returns:

the request

Throws:

IOException

list

public DiscoveryEngine.Projects.Locations.Collections.DataStores.Conversations.List list(String parent)
                                                                                  throws IOException

Lists all Conversations by their parent DataStore. Create a request for the method "conversations.list". This request holds the parameters needed by the discoveryengine server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_i d}`

Returns:

the request

Throws:

IOException

patch

public DiscoveryEngine.Projects.Locations.Collections.DataStores.Conversations.Patch patch(String name,
                                                                                           GoogleCloudDiscoveryengineV1Conversation content)
                                                                                    throws IOException

Updates a Conversation. Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned. Create a request for the method "conversations.patch". This request holds the parameters needed by the discoveryengine server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/dataStore/conversations` or `projects/{project}/locations/global/collections/{collection}/engines/conversations`.

content - the GoogleCloudDiscoveryengineV1Conversation

Returns:

the request

Throws:

IOException