com.google.api.services.discoveryengine.v1

Class DiscoveryEngine.Projects.Locations.Collections.Engines.Conversations.Converse

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>

com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>

com.google.api.services.discoveryengine.v1.DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1ConverseConversationResponse>

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

DiscoveryEngine.Projects.Locations.Collections.Engines.Conversations

public class DiscoveryEngine.Projects.Locations.Collections.Engines.Conversations.Converse
extends DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1ConverseConversationResponse>

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

API_VERSION_HEADER, USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Converse(String name, GoogleCloudDiscoveryengineV1ConverseConversationRequest content) Converses a conversation.

Method Summary

Modifier and Type	Method and Description
String	getName() Required.
DiscoveryEngine.Projects.Locations.Collections.Engines.Conversations.Converse	set(String parameterName, Object value)
DiscoveryEngine.Projects.Locations.Collections.Engines.Conversations.Converse	set$Xgafv(String $Xgafv) V1 error format.
DiscoveryEngine.Projects.Locations.Collections.Engines.Conversations.Converse	setAccessToken(String accessToken) OAuth access token.
DiscoveryEngine.Projects.Locations.Collections.Engines.Conversations.Converse	setAlt(String alt) Data format for response.
DiscoveryEngine.Projects.Locations.Collections.Engines.Conversations.Converse	setCallback(String callback) JSONP
DiscoveryEngine.Projects.Locations.Collections.Engines.Conversations.Converse	setFields(String fields) Selector specifying which fields to include in a partial response.
DiscoveryEngine.Projects.Locations.Collections.Engines.Conversations.Converse	setKey(String key) API key.
DiscoveryEngine.Projects.Locations.Collections.Engines.Conversations.Converse	setName(String name) Required.
DiscoveryEngine.Projects.Locations.Collections.Engines.Conversations.Converse	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
DiscoveryEngine.Projects.Locations.Collections.Engines.Conversations.Converse	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
DiscoveryEngine.Projects.Locations.Collections.Engines.Conversations.Converse	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
DiscoveryEngine.Projects.Locations.Collections.Engines.Conversations.Converse	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
DiscoveryEngine.Projects.Locations.Collections.Engines.Conversations.Converse	setUploadType(String uploadType) Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.discoveryengine.v1.DiscoveryEngineRequest

get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, setDisableGZipContent, setRequestHeaders

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

getJsonContent, newExceptionOnError, queue

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

buildHttpRequest, buildHttpRequestUrl, buildHttpRequestUsingHead, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, executeUsingHead, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream

Methods inherited from class com.google.api.client.util.GenericData

clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

Converse

protected Converse(String name,
                   GoogleCloudDiscoveryengineV1ConverseConversationRequest content)

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

DiscoveryEngine.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

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

Since:

1.13

Method Detail

set$Xgafv

public DiscoveryEngine.Projects.Locations.Collections.Engines.Conversations.Converse set$Xgafv(String $Xgafv)

Description copied from class: DiscoveryEngineRequest

V1 error format.

Overrides:

set$Xgafv in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1ConverseConversationResponse>

setAccessToken

public DiscoveryEngine.Projects.Locations.Collections.Engines.Conversations.Converse setAccessToken(String accessToken)

Description copied from class: DiscoveryEngineRequest

OAuth access token.

Overrides:

setAccessToken in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1ConverseConversationResponse>

setAlt

public DiscoveryEngine.Projects.Locations.Collections.Engines.Conversations.Converse setAlt(String alt)

Description copied from class: DiscoveryEngineRequest

Data format for response.

Overrides:

setAlt in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1ConverseConversationResponse>

setCallback

public DiscoveryEngine.Projects.Locations.Collections.Engines.Conversations.Converse setCallback(String callback)

Description copied from class: DiscoveryEngineRequest

JSONP

Overrides:

setCallback in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1ConverseConversationResponse>

setFields

public DiscoveryEngine.Projects.Locations.Collections.Engines.Conversations.Converse setFields(String fields)

Description copied from class: DiscoveryEngineRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1ConverseConversationResponse>

setKey

public DiscoveryEngine.Projects.Locations.Collections.Engines.Conversations.Converse setKey(String key)

Description copied from class: DiscoveryEngineRequest

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Overrides:

setKey in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1ConverseConversationResponse>

setOauthToken

public DiscoveryEngine.Projects.Locations.Collections.Engines.Conversations.Converse setOauthToken(String oauthToken)

Description copied from class: DiscoveryEngineRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1ConverseConversationResponse>

setPrettyPrint

public DiscoveryEngine.Projects.Locations.Collections.Engines.Conversations.Converse setPrettyPrint(Boolean prettyPrint)

Description copied from class: DiscoveryEngineRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1ConverseConversationResponse>

setQuotaUser

public DiscoveryEngine.Projects.Locations.Collections.Engines.Conversations.Converse setQuotaUser(String quotaUser)

Description copied from class: DiscoveryEngineRequest

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Overrides:

setQuotaUser in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1ConverseConversationResponse>

setUploadType

public DiscoveryEngine.Projects.Locations.Collections.Engines.Conversations.Converse setUploadType(String uploadType)

Description copied from class: DiscoveryEngineRequest

Legacy upload protocol for media (e.g. "media", "multipart").

Overrides:

setUploadType in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1ConverseConversationResponse>

setUploadProtocol

public DiscoveryEngine.Projects.Locations.Collections.Engines.Conversations.Converse setUploadProtocol(String uploadProtocol)

Description copied from class: DiscoveryEngineRequest

Upload protocol for media (e.g. "raw", "multipart").

Overrides:

setUploadProtocol in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1ConverseConversationResponse>

getName

public String getName()

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

setName

public DiscoveryEngine.Projects.Locations.Collections.Engines.Conversations.Converse setName(String name)

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

set

public DiscoveryEngine.Projects.Locations.Collections.Engines.Conversations.Converse set(String parameterName,
                                                                                         Object value)

Overrides:

set in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1ConverseConversationResponse>