ConverseConversationRequest (proto-google-cloud-discoveryengine-v1alpha 0.45.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - com.google.cloud.discoveryengine.v1alpha.ConverseConversationRequest

All Implemented Interfaces:

ConverseConversationRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
```
public final class ConverseConversationRequest
extends com.google.protobuf.GeneratedMessageV3
implements ConverseConversationRequestOrBuilder
```
```
 Request message for
 [ConversationalSearchService.ConverseConversation][google.cloud.discoveryengine.v1alpha.ConversationalSearchService.ConverseConversation]
 method.
 
```
Protobuf type google.cloud.discoveryengine.v1alpha.ConverseConversationRequest
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ConverseConversationRequest.Builder` Request message for [ConversationalSearchService.ConverseConversation][google.cloud.discoveryengine.v1alpha.ConversationalSearchService.ConverseConversation] method.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`BOOST_SPEC_FIELD_NUMBER`
`static int`	`CONVERSATION_FIELD_NUMBER`
`static int`	`FILTER_FIELD_NUMBER`
`static int`	`NAME_FIELD_NUMBER`
`static int`	`QUERY_FIELD_NUMBER`
`static int`	`SAFE_SEARCH_FIELD_NUMBER`
`static int`	`SERVING_CONFIG_FIELD_NUMBER`
`static int`	`SUMMARY_SPEC_FIELD_NUMBER`
`static int`	`USER_LABELS_FIELD_NUMBER`

Fields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`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
`boolean`	`equals(Object obj)`
`SearchRequest.BoostSpec`	`getBoostSpec()` Boost specification to boost certain documents in search results which may affect the converse response.
`SearchRequest.BoostSpecOrBuilder`	`getBoostSpecOrBuilder()` Boost specification to boost certain documents in search results which may affect the converse response.
`Conversation`	`getConversation()` The conversation to be used by auto session only.
`ConversationOrBuilder`	`getConversationOrBuilder()` The conversation to be used by auto session only.
`static ConverseConversationRequest`	`getDefaultInstance()`
`ConverseConversationRequest`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`String`	`getFilter()` The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered.
`com.google.protobuf.ByteString`	`getFilterBytes()` The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered.
`String`	`getName()` Required.
`com.google.protobuf.ByteString`	`getNameBytes()` Required.
`com.google.protobuf.Parser<ConverseConversationRequest>`	`getParserForType()`
`TextInput`	`getQuery()` Required.
`TextInputOrBuilder`	`getQueryOrBuilder()` Required.
`boolean`	`getSafeSearch()` Whether to turn on safe search.
`int`	`getSerializedSize()`
`String`	`getServingConfig()` The resource name of the Serving Config to use.
`com.google.protobuf.ByteString`	`getServingConfigBytes()` The resource name of the Serving Config to use.
`SearchRequest.ContentSearchSpec.SummarySpec`	`getSummarySpec()` A specification for configuring the summary returned in the response.
`SearchRequest.ContentSearchSpec.SummarySpecOrBuilder`	`getSummarySpecOrBuilder()` A specification for configuring the summary returned in the response.
`Map<String,String>`	`getUserLabels()` Deprecated.
`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
`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
`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
`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
`boolean`	`hasBoostSpec()` Boost specification to boost certain documents in search results which may affect the converse response.
`boolean`	`hasConversation()` The conversation to be used by auto session only.
`int`	`hashCode()`
`boolean`	`hasQuery()` Required.
`boolean`	`hasSummarySpec()` A specification for configuring the summary returned in the response.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`protected com.google.protobuf.MapFieldReflectionAccessor`	`internalGetMapFieldReflection(int number)`
`boolean`	`isInitialized()`
`static ConverseConversationRequest.Builder`	`newBuilder()`
`static ConverseConversationRequest.Builder`	`newBuilder(ConverseConversationRequest prototype)`
`ConverseConversationRequest.Builder`	`newBuilderForType()`
`protected ConverseConversationRequest.Builder`	`newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)`
`protected Object`	`newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)`
`static ConverseConversationRequest`	`parseDelimitedFrom(InputStream input)`
`static ConverseConversationRequest`	`parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static ConverseConversationRequest`	`parseFrom(byte[] data)`
`static ConverseConversationRequest`	`parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static ConverseConversationRequest`	`parseFrom(ByteBuffer data)`
`static ConverseConversationRequest`	`parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static ConverseConversationRequest`	`parseFrom(com.google.protobuf.ByteString data)`
`static ConverseConversationRequest`	`parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static ConverseConversationRequest`	`parseFrom(com.google.protobuf.CodedInputStream input)`
`static ConverseConversationRequest`	`parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static ConverseConversationRequest`	`parseFrom(InputStream input)`
`static ConverseConversationRequest`	`parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static com.google.protobuf.Parser<ConverseConversationRequest>`	`parser()`
`ConverseConversationRequest.Builder`	`toBuilder()`
`void`	`writeTo(com.google.protobuf.CodedOutputStream output)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

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

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail
- NAME_FIELD_NUMBER
```
public static final int NAME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- QUERY_FIELD_NUMBER
```
public static final int QUERY_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- SERVING_CONFIG_FIELD_NUMBER
```
public static final int SERVING_CONFIG_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- CONVERSATION_FIELD_NUMBER
```
public static final int CONVERSATION_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- SAFE_SEARCH_FIELD_NUMBER
```
public static final int SAFE_SEARCH_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- USER_LABELS_FIELD_NUMBER
```
public static final int USER_LABELS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- SUMMARY_SPEC_FIELD_NUMBER
```
public static final int SUMMARY_SPEC_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- FILTER_FIELD_NUMBER
```
public static final int FILTER_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- BOOST_SPEC_FIELD_NUMBER
```
public static final int BOOST_SPEC_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:: newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetMapFieldReflection
```
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
```
Overrides:

internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessageV3

internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

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) = { ... }

Specified by:: getName in interface ConverseConversationRequestOrBuilder
Returns:: The name.

getNameBytes

public com.google.protobuf.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) = { ... }

Specified by:: getNameBytes in interface ConverseConversationRequestOrBuilder
Returns:: The bytes for name.

hasQuery
```
public boolean hasQuery()
```
```
 Required. Current user input.
 
```
.google.cloud.discoveryengine.v1alpha.TextInput query = 2 [(.google.api.field_behavior) = REQUIRED];
Specified by:

hasQuery in interface ConverseConversationRequestOrBuilder

Returns:

Whether the query field is set.

getQuery
```
public TextInput getQuery()
```
```
 Required. Current user input.
 
```
.google.cloud.discoveryengine.v1alpha.TextInput query = 2 [(.google.api.field_behavior) = REQUIRED];
Specified by:

getQuery in interface ConverseConversationRequestOrBuilder

Returns:

The query.

getQueryOrBuilder
```
public TextInputOrBuilder getQueryOrBuilder()
```
```
 Required. Current user input.
 
```
.google.cloud.discoveryengine.v1alpha.TextInput query = 2 [(.google.api.field_behavior) = REQUIRED];
Specified by:

getQueryOrBuilder in interface ConverseConversationRequestOrBuilder

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) = { ... }

Specified by:: getServingConfig in interface ConverseConversationRequestOrBuilder
Returns:: The servingConfig.

getServingConfigBytes

public com.google.protobuf.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) = { ... }

Specified by:: getServingConfigBytes in interface ConverseConversationRequestOrBuilder
Returns:: The bytes for servingConfig.

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.v1alpha.Conversation conversation = 5;
Specified by:

hasConversation in interface ConverseConversationRequestOrBuilder

Returns:

Whether the conversation field is set.

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.v1alpha.Conversation conversation = 5;

Specified by:: getConversation in interface ConverseConversationRequestOrBuilder
Returns:: The conversation.

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.v1alpha.Conversation conversation = 5;

Specified by:: getConversationOrBuilder in interface ConverseConversationRequestOrBuilder

getSafeSearch
```
public boolean getSafeSearch()
```
```
 Whether to turn on safe search.
 
```
bool safe_search = 6;
Specified by:

getSafeSearch in interface ConverseConversationRequestOrBuilder

Returns:

The safeSearch.