Class ConverseConversationRequest.Builder (0.23.0)

Version 0.23.0

• 0.49.0 (latest)
• 0.48.0
• 0.47.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

public static final class ConverseConversationRequest.Builder extends GeneratedMessageV3.Builder<ConverseConversationRequest.Builder> implements ConverseConversationRequestOrBuilder

Request message for ConversationalSearchService.ConverseConversation method.

Protobuf type google.cloud.discoveryengine.v1.ConverseConversationRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ConverseConversationRequest.Builder

Implements

ConverseConversationRequestOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ConverseConversationRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
ConverseConversationRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public ConverseConversationRequest build()

Returns
Type	Description
ConverseConversationRequest

buildPartial()

public ConverseConversationRequest buildPartial()

Returns
Type	Description
ConverseConversationRequest

clear()

public ConverseConversationRequest.Builder clear()

Returns
Type	Description
ConverseConversationRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearConversation()

public ConverseConversationRequest.Builder clearConversation()

The conversation to be used by auto session only. The name field will be ignored as we automatically assign new name for the conversation in auto session.

.google.cloud.discoveryengine.v1.Conversation conversation = 5;

Returns
Type	Description
ConverseConversationRequest.Builder

clearField(Descriptors.FieldDescriptor field)

public ConverseConversationRequest.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
ConverseConversationRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearName()

public ConverseConversationRequest.Builder clearName()

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

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type	Description
ConverseConversationRequest.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ConverseConversationRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
ConverseConversationRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearQuery()

public ConverseConversationRequest.Builder clearQuery()

Required. Current user input.

.google.cloud.discoveryengine.v1.TextInput query = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ConverseConversationRequest.Builder

clearSafeSearch()

public ConverseConversationRequest.Builder clearSafeSearch()

Whether to turn on safe search.

bool safe_search = 6;

Returns
Type	Description
ConverseConversationRequest.Builder	This builder for chaining.

clearServingConfig()

public ConverseConversationRequest.Builder clearServingConfig()

The resource name of the Serving Config to use. Format: projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id} If this is not set, the default serving config will be used.

string serving_config = 3 [(.google.api.resource_reference) = { ... }

Returns
Type	Description
ConverseConversationRequest.Builder	This builder for chaining.

clearSummarySpec()

public ConverseConversationRequest.Builder clearSummarySpec()

A specification for configuring the summary returned in the response.

.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SummarySpec summary_spec = 8;

Returns
Type	Description
ConverseConversationRequest.Builder

clearUserLabels()

public ConverseConversationRequest.Builder clearUserLabels()

Returns
Type	Description
ConverseConversationRequest.Builder

clone()

public ConverseConversationRequest.Builder clone()

Returns
Type	Description
ConverseConversationRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

containsUserLabels(String key)

public boolean containsUserLabels(String key)

The user labels applied to a resource must meet the following requirements:

• Each resource can have multiple labels, up to a maximum of 64.
• Each label must be a key-value pair.
• Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters.
• Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed.
• The key portion of a label must be unique. However, you can use the same key with multiple resources.

• Keys must start with a lowercase letter or international character.

  See Google Cloud Document for more details.

map<string, string> user_labels = 7;

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

getConversation()

public Conversation getConversation()

The conversation to be used by auto session only. The name field will be ignored as we automatically assign new name for the conversation in auto session.

.google.cloud.discoveryengine.v1.Conversation conversation = 5;

Returns
Type	Description
Conversation	The conversation.

getConversationBuilder()

public Conversation.Builder getConversationBuilder()

The conversation to be used by auto session only. The name field will be ignored as we automatically assign new name for the conversation in auto session.

.google.cloud.discoveryengine.v1.Conversation conversation = 5;

Returns
Type	Description
Conversation.Builder

getConversationOrBuilder()

public ConversationOrBuilder getConversationOrBuilder()

The conversation to be used by auto session only. The name field will be ignored as we automatically assign new name for the conversation in auto session.

.google.cloud.discoveryengine.v1.Conversation conversation = 5;

Returns
Type	Description
ConversationOrBuilder

getDefaultInstanceForType()

public ConverseConversationRequest getDefaultInstanceForType()

Returns
Type	Description
ConverseConversationRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getMutableUserLabels()

public Map<String,String> getMutableUserLabels()

Use alternate mutation accessors instead.

Returns
Type	Description
Map<String,String>

getName()

public String getName()

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

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type	Description
String	The name.

getNameBytes()

public ByteString getNameBytes()

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

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type	Description
ByteString	The bytes for name.

getQuery()

public TextInput getQuery()

Required. Current user input.

.google.cloud.discoveryengine.v1.TextInput query = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
TextInput	The query.

getQueryBuilder()

public TextInput.Builder getQueryBuilder()

Required. Current user input.

.google.cloud.discoveryengine.v1.TextInput query = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
TextInput.Builder

getQueryOrBuilder()

public TextInputOrBuilder getQueryOrBuilder()

Required. Current user input.

.google.cloud.discoveryengine.v1.TextInput query = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
TextInputOrBuilder

getSafeSearch()

public boolean getSafeSearch()

Whether to turn on safe search.

bool safe_search = 6;

Returns
Type	Description
boolean	The safeSearch.

getServingConfig()

public String getServingConfig()

The resource name of the Serving Config to use. Format: projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id} If this is not set, the default serving config will be used.

string serving_config = 3 [(.google.api.resource_reference) = { ... }

Returns
Type	Description
String	The servingConfig.

getServingConfigBytes()

public ByteString getServingConfigBytes()

The resource name of the Serving Config to use. Format: projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id} If this is not set, the default serving config will be used.

string serving_config = 3 [(.google.api.resource_reference) = { ... }

Returns
Type	Description
ByteString	The bytes for servingConfig.

getSummarySpec()

public SearchRequest.ContentSearchSpec.SummarySpec getSummarySpec()

A specification for configuring the summary returned in the response.

.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SummarySpec summary_spec = 8;

Returns
Type	Description
SearchRequest.ContentSearchSpec.SummarySpec	The summarySpec.

getSummarySpecBuilder()

public SearchRequest.ContentSearchSpec.SummarySpec.Builder getSummarySpecBuilder()

A specification for configuring the summary returned in the response.

.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SummarySpec summary_spec = 8;

Returns
Type	Description
SearchRequest.ContentSearchSpec.SummarySpec.Builder

getSummarySpecOrBuilder()

public SearchRequest.ContentSearchSpec.SummarySpecOrBuilder getSummarySpecOrBuilder()

A specification for configuring the summary returned in the response.

.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SummarySpec summary_spec = 8;

Returns
Type	Description
SearchRequest.ContentSearchSpec.SummarySpecOrBuilder

getUserLabels()

public Map<String,String> getUserLabels()

Use #getUserLabelsMap() instead.

Returns
Type	Description
Map<String,String>

getUserLabelsCount()

public int getUserLabelsCount()

The user labels applied to a resource must meet the following requirements:

• Each resource can have multiple labels, up to a maximum of 64.
• Each label must be a key-value pair.
• Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters.
• Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed.
• The key portion of a label must be unique. However, you can use the same key with multiple resources.

• Keys must start with a lowercase letter or international character.

  See Google Cloud Document for more details.

map<string, string> user_labels = 7;

Returns
Type	Description
int

getUserLabelsMap()

public Map<String,String> getUserLabelsMap()

The user labels applied to a resource must meet the following requirements:

• Each resource can have multiple labels, up to a maximum of 64.
• Each label must be a key-value pair.
• Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters.
• Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed.
• The key portion of a label must be unique. However, you can use the same key with multiple resources.

• Keys must start with a lowercase letter or international character.

  See Google Cloud Document for more details.

map<string, string> user_labels = 7;

Returns
Type	Description
Map<String,String>

getUserLabelsOrDefault(String key, String defaultValue)

public String getUserLabelsOrDefault(String key, String defaultValue)

The user labels applied to a resource must meet the following requirements:

• Each resource can have multiple labels, up to a maximum of 64.
• Each label must be a key-value pair.
• Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters.
• Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed.
• The key portion of a label must be unique. However, you can use the same key with multiple resources.

• Keys must start with a lowercase letter or international character.

  See Google Cloud Document for more details.

map<string, string> user_labels = 7;

Parameters
Name	Description
key	String
defaultValue	String

Returns
Type	Description
String

getUserLabelsOrThrow(String key)

public String getUserLabelsOrThrow(String key)

The user labels applied to a resource must meet the following requirements:

• Each resource can have multiple labels, up to a maximum of 64.
• Each label must be a key-value pair.
• Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters.
• Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed.
• The key portion of a label must be unique. However, you can use the same key with multiple resources.

• Keys must start with a lowercase letter or international character.

  See Google Cloud Document for more details.

map<string, string> user_labels = 7;

Parameter
Name	Description
key	String

Returns
Type	Description
String

hasConversation()

public boolean hasConversation()

The conversation to be used by auto session only. The name field will be ignored as we automatically assign new name for the conversation in auto session.

.google.cloud.discoveryengine.v1.Conversation conversation = 5;

Returns
Type	Description
boolean	Whether the conversation field is set.

hasQuery()

public boolean hasQuery()

Required. Current user input.

.google.cloud.discoveryengine.v1.TextInput query = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
boolean	Whether the query field is set.

hasSummarySpec()

public boolean hasSummarySpec()

A specification for configuring the summary returned in the response.

.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SummarySpec summary_spec = 8;

Returns
Type	Description
boolean	Whether the summarySpec field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

internalGetMapField(int number)

protected MapField internalGetMapField(int number)

Parameter
Name	Description
number	int

Returns
Type	Description
MapField

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetMapField(int fieldNumber)

internalGetMutableMapField(int number)

protected MapField internalGetMutableMapField(int number)

Parameter
Name	Description
number	int

Returns
Type	Description
MapField

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetMutableMapField(int fieldNumber)

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeConversation(Conversation value)

public ConverseConversationRequest.Builder mergeConversation(Conversation value)

The conversation to be used by auto session only. The name field will be ignored as we automatically assign new name for the conversation in auto session.

.google.cloud.discoveryengine.v1.Conversation conversation = 5;

Parameter
Name	Description
value	Conversation

Returns
Type	Description
ConverseConversationRequest.Builder

mergeFrom(ConverseConversationRequest other)

public ConverseConversationRequest.Builder mergeFrom(ConverseConversationRequest other)

Parameter
Name	Description
other	ConverseConversationRequest

Returns
Type	Description
ConverseConversationRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ConverseConversationRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ConverseConversationRequest.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public ConverseConversationRequest.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
ConverseConversationRequest.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeQuery(TextInput value)

public ConverseConversationRequest.Builder mergeQuery(TextInput value)

Required. Current user input.

.google.cloud.discoveryengine.v1.TextInput query = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
value	TextInput

Returns
Type	Description
ConverseConversationRequest.Builder

mergeSummarySpec(SearchRequest.ContentSearchSpec.SummarySpec value)

public ConverseConversationRequest.Builder mergeSummarySpec(SearchRequest.ContentSearchSpec.SummarySpec value)

A specification for configuring the summary returned in the response.

.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SummarySpec summary_spec = 8;

Parameter
Name	Description
value	SearchRequest.ContentSearchSpec.SummarySpec

Returns
Type	Description
ConverseConversationRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ConverseConversationRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
ConverseConversationRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

putAllUserLabels(Map<String,String> values)

public ConverseConversationRequest.Builder putAllUserLabels(Map<String,String> values)

The user labels applied to a resource must meet the following requirements:

• Each resource can have multiple labels, up to a maximum of 64.
• Each label must be a key-value pair.
• Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters.
• Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed.
• The key portion of a label must be unique. However, you can use the same key with multiple resources.

• Keys must start with a lowercase letter or international character.

  See Google Cloud Document for more details.

map<string, string> user_labels = 7;

Parameter
Name	Description
values	Map<String,String>

Returns
Type	Description
ConverseConversationRequest.Builder

putUserLabels(String key, String value)

public ConverseConversationRequest.Builder putUserLabels(String key, String value)

The user labels applied to a resource must meet the following requirements:

• Each resource can have multiple labels, up to a maximum of 64.
• Each label must be a key-value pair.
• Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters.
• Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed.
• The key portion of a label must be unique. However, you can use the same key with multiple resources.

• Keys must start with a lowercase letter or international character.

  See Google Cloud Document for more details.

map<string, string> user_labels = 7;

Parameters
Name	Description
key	String
value	String

Returns
Type	Description
ConverseConversationRequest.Builder

removeUserLabels(String key)

public ConverseConversationRequest.Builder removeUserLabels(String key)

The user labels applied to a resource must meet the following requirements:

• Each resource can have multiple labels, up to a maximum of 64.
• Each label must be a key-value pair.
• Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters.
• Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed.
• The key portion of a label must be unique. However, you can use the same key with multiple resources.

• Keys must start with a lowercase letter or international character.

  See Google Cloud Document for more details.

map<string, string> user_labels = 7;

Parameter
Name	Description
key	String

Returns
Type	Description
ConverseConversationRequest.Builder

setConversation(Conversation value)

public ConverseConversationRequest.Builder setConversation(Conversation value)

The conversation to be used by auto session only. The name field will be ignored as we automatically assign new name for the conversation in auto session.

.google.cloud.discoveryengine.v1.Conversation conversation = 5;

Parameter
Name	Description
value	Conversation

Returns
Type	Description
ConverseConversationRequest.Builder

setConversation(Conversation.Builder builderForValue)

public ConverseConversationRequest.Builder setConversation(Conversation.Builder builderForValue)

The conversation to be used by auto session only. The name field will be ignored as we automatically assign new name for the conversation in auto session.

.google.cloud.discoveryengine.v1.Conversation conversation = 5;

Parameter
Name	Description
builderForValue	Conversation.Builder

Returns
Type	Description
ConverseConversationRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public ConverseConversationRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
ConverseConversationRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setName(String value)

public ConverseConversationRequest.Builder setName(String value)

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

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name	Description
value	String The name to set.

Returns
Type	Description
ConverseConversationRequest.Builder	This builder for chaining.

setNameBytes(ByteString value)

public ConverseConversationRequest.Builder setNameBytes(ByteString value)

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

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name	Description
value	ByteString The bytes for name to set.

Returns
Type	Description
ConverseConversationRequest.Builder	This builder for chaining.

setQuery(TextInput value)

public ConverseConversationRequest.Builder setQuery(TextInput value)

Required. Current user input.

.google.cloud.discoveryengine.v1.TextInput query = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
value	TextInput

Returns
Type	Description
ConverseConversationRequest.Builder

setQuery(TextInput.Builder builderForValue)

public ConverseConversationRequest.Builder setQuery(TextInput.Builder builderForValue)

Required. Current user input.

.google.cloud.discoveryengine.v1.TextInput query = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
builderForValue	TextInput.Builder

Returns
Type	Description
ConverseConversationRequest.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ConverseConversationRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
ConverseConversationRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setSafeSearch(boolean value)

public ConverseConversationRequest.Builder setSafeSearch(boolean value)

Whether to turn on safe search.

bool safe_search = 6;

Parameter
Name	Description
value	boolean The safeSearch to set.

Returns
Type	Description
ConverseConversationRequest.Builder	This builder for chaining.

setServingConfig(String value)

public ConverseConversationRequest.Builder setServingConfig(String value)

The resource name of the Serving Config to use. Format: projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id} If this is not set, the default serving config will be used.

string serving_config = 3 [(.google.api.resource_reference) = { ... }

Parameter
Name	Description
value	String The servingConfig to set.

Returns
Type	Description
ConverseConversationRequest.Builder	This builder for chaining.

setServingConfigBytes(ByteString value)

public ConverseConversationRequest.Builder setServingConfigBytes(ByteString value)

The resource name of the Serving Config to use. Format: projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id} If this is not set, the default serving config will be used.

string serving_config = 3 [(.google.api.resource_reference) = { ... }

Parameter
Name	Description
value	ByteString The bytes for servingConfig to set.

Returns
Type	Description
ConverseConversationRequest.Builder	This builder for chaining.

setSummarySpec(SearchRequest.ContentSearchSpec.SummarySpec value)

public ConverseConversationRequest.Builder setSummarySpec(SearchRequest.ContentSearchSpec.SummarySpec value)

A specification for configuring the summary returned in the response.

.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SummarySpec summary_spec = 8;

Parameter
Name	Description
value	SearchRequest.ContentSearchSpec.SummarySpec

Returns
Type	Description
ConverseConversationRequest.Builder

setSummarySpec(SearchRequest.ContentSearchSpec.SummarySpec.Builder builderForValue)

public ConverseConversationRequest.Builder setSummarySpec(SearchRequest.ContentSearchSpec.SummarySpec.Builder builderForValue)

A specification for configuring the summary returned in the response.

.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SummarySpec summary_spec = 8;

Parameter
Name	Description
builderForValue	SearchRequest.ContentSearchSpec.SummarySpec.Builder

Returns
Type	Description
ConverseConversationRequest.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final ConverseConversationRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
ConverseConversationRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)