Class ConversationalSearchRequest.ConversationalFilteringSpec (2.64.0)

public static final class ConversationalSearchRequest.ConversationalFilteringSpec extends GeneratedMessageV3 implements ConversationalSearchRequest.ConversationalFilteringSpecOrBuilder

This field specifies all conversational filtering related parameters addition to conversational retail search.

Protobuf type google.cloud.retail.v2alpha.ConversationalSearchRequest.ConversationalFilteringSpec

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ConversationalSearchRequest.ConversationalFilteringSpec

Static Fields

CONVERSATIONAL_FILTERING_MODE_FIELD_NUMBER

public static final int CONVERSATIONAL_FILTERING_MODE_FIELD_NUMBER
Field Value
Type Description
int

ENABLE_CONVERSATIONAL_FILTERING_FIELD_NUMBER

public static final int ENABLE_CONVERSATIONAL_FILTERING_FIELD_NUMBER
Field Value
Type Description
int

USER_ANSWER_FIELD_NUMBER

public static final int USER_ANSWER_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ConversationalSearchRequest.ConversationalFilteringSpec getDefaultInstance()
Returns
Type Description
ConversationalSearchRequest.ConversationalFilteringSpec

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static ConversationalSearchRequest.ConversationalFilteringSpec.Builder newBuilder()
Returns
Type Description
ConversationalSearchRequest.ConversationalFilteringSpec.Builder

newBuilder(ConversationalSearchRequest.ConversationalFilteringSpec prototype)

public static ConversationalSearchRequest.ConversationalFilteringSpec.Builder newBuilder(ConversationalSearchRequest.ConversationalFilteringSpec prototype)
Parameter
Name Description
prototype ConversationalSearchRequest.ConversationalFilteringSpec
Returns
Type Description
ConversationalSearchRequest.ConversationalFilteringSpec.Builder

parseDelimitedFrom(InputStream input)

public static ConversationalSearchRequest.ConversationalFilteringSpec parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ConversationalSearchRequest.ConversationalFilteringSpec
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ConversationalSearchRequest.ConversationalFilteringSpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ConversationalSearchRequest.ConversationalFilteringSpec
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ConversationalSearchRequest.ConversationalFilteringSpec parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ConversationalSearchRequest.ConversationalFilteringSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ConversationalSearchRequest.ConversationalFilteringSpec parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ConversationalSearchRequest.ConversationalFilteringSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ConversationalSearchRequest.ConversationalFilteringSpec parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ConversationalSearchRequest.ConversationalFilteringSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ConversationalSearchRequest.ConversationalFilteringSpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ConversationalSearchRequest.ConversationalFilteringSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ConversationalSearchRequest.ConversationalFilteringSpec parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ConversationalSearchRequest.ConversationalFilteringSpec
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ConversationalSearchRequest.ConversationalFilteringSpec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ConversationalSearchRequest.ConversationalFilteringSpec
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ConversationalSearchRequest.ConversationalFilteringSpec parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ConversationalSearchRequest.ConversationalFilteringSpec
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ConversationalSearchRequest.ConversationalFilteringSpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ConversationalSearchRequest.ConversationalFilteringSpec
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ConversationalSearchRequest.ConversationalFilteringSpec parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ConversationalSearchRequest.ConversationalFilteringSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ConversationalSearchRequest.ConversationalFilteringSpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ConversationalSearchRequest.ConversationalFilteringSpec
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ConversationalSearchRequest.ConversationalFilteringSpec> parser()
Returns
Type Description
Parser<ConversationalFilteringSpec>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getConversationalFilteringMode()

public ConversationalSearchRequest.ConversationalFilteringSpec.Mode getConversationalFilteringMode()

Optional. Mode to control Conversational Filtering. Defaults to Mode.DISABLED if it's unset.

.google.cloud.retail.v2alpha.ConversationalSearchRequest.ConversationalFilteringSpec.Mode conversational_filtering_mode = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ConversationalSearchRequest.ConversationalFilteringSpec.Mode

The conversationalFilteringMode.

getConversationalFilteringModeValue()

public int getConversationalFilteringModeValue()

Optional. Mode to control Conversational Filtering. Defaults to Mode.DISABLED if it's unset.

.google.cloud.retail.v2alpha.ConversationalSearchRequest.ConversationalFilteringSpec.Mode conversational_filtering_mode = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for conversationalFilteringMode.

getDefaultInstanceForType()

public ConversationalSearchRequest.ConversationalFilteringSpec getDefaultInstanceForType()
Returns
Type Description
ConversationalSearchRequest.ConversationalFilteringSpec

getEnableConversationalFiltering() (deprecated)

public boolean getEnableConversationalFiltering()

Deprecated. google.cloud.retail.v2alpha.ConversationalSearchRequest.ConversationalFilteringSpec.enable_conversational_filtering is deprecated. See google/cloud/retail/v2alpha/conversational_search_service.proto;l=135

Optional. This field is deprecated. Please use ConversationalFilteringSpec.conversational_filtering_mode instead.

bool enable_conversational_filtering = 1 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The enableConversationalFiltering.

getParserForType()

public Parser<ConversationalSearchRequest.ConversationalFilteringSpec> getParserForType()
Returns
Type Description
Parser<ConversationalFilteringSpec>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUserAnswer()

public ConversationalSearchRequest.UserAnswer getUserAnswer()

Optional. This field specifies the current user answer during the conversational filtering search. It can be either user selected from suggested answers or user input plain text.

.google.cloud.retail.v2alpha.ConversationalSearchRequest.UserAnswer user_answer = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ConversationalSearchRequest.UserAnswer

The userAnswer.

getUserAnswerOrBuilder()

public ConversationalSearchRequest.UserAnswerOrBuilder getUserAnswerOrBuilder()

Optional. This field specifies the current user answer during the conversational filtering search. It can be either user selected from suggested answers or user input plain text.

.google.cloud.retail.v2alpha.ConversationalSearchRequest.UserAnswer user_answer = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ConversationalSearchRequest.UserAnswerOrBuilder

hasUserAnswer()

public boolean hasUserAnswer()

Optional. This field specifies the current user answer during the conversational filtering search. It can be either user selected from suggested answers or user input plain text.

.google.cloud.retail.v2alpha.ConversationalSearchRequest.UserAnswer user_answer = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the userAnswer field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ConversationalSearchRequest.ConversationalFilteringSpec.Builder newBuilderForType()
Returns
Type Description
ConversationalSearchRequest.ConversationalFilteringSpec.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ConversationalSearchRequest.ConversationalFilteringSpec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ConversationalSearchRequest.ConversationalFilteringSpec.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ConversationalSearchRequest.ConversationalFilteringSpec.Builder toBuilder()
Returns
Type Description
ConversationalSearchRequest.ConversationalFilteringSpec.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException