Class ConversationalSearchRequest.ConversationalFilteringSpec.Builder (2.69.0)

public static final class ConversationalSearchRequest.ConversationalFilteringSpec.Builder extends GeneratedMessageV3.Builder<ConversationalSearchRequest.ConversationalFilteringSpec.Builder> 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.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ConversationalSearchRequest.ConversationalFilteringSpec.Builder

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ConversationalSearchRequest.ConversationalFilteringSpec.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ConversationalSearchRequest.ConversationalFilteringSpec.Builder
Overrides

build()

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

buildPartial()

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

clear()

public ConversationalSearchRequest.ConversationalFilteringSpec.Builder clear()
Returns
Type Description
ConversationalSearchRequest.ConversationalFilteringSpec.Builder
Overrides

clearConversationalFilteringMode()

public ConversationalSearchRequest.ConversationalFilteringSpec.Builder clearConversationalFilteringMode()

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.Builder

This builder for chaining.

clearEnableConversationalFiltering() (deprecated)

public ConversationalSearchRequest.ConversationalFilteringSpec.Builder clearEnableConversationalFiltering()

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
ConversationalSearchRequest.ConversationalFilteringSpec.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public ConversationalSearchRequest.ConversationalFilteringSpec.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ConversationalSearchRequest.ConversationalFilteringSpec.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public ConversationalSearchRequest.ConversationalFilteringSpec.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ConversationalSearchRequest.ConversationalFilteringSpec.Builder
Overrides

clearUserAnswer()

public ConversationalSearchRequest.ConversationalFilteringSpec.Builder clearUserAnswer()

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.ConversationalFilteringSpec.Builder

clone()

public ConversationalSearchRequest.ConversationalFilteringSpec.Builder clone()
Returns
Type Description
ConversationalSearchRequest.ConversationalFilteringSpec.Builder
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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

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.

getUserAnswerBuilder()

public ConversationalSearchRequest.UserAnswer.Builder getUserAnswerBuilder()

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.Builder

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ConversationalSearchRequest.ConversationalFilteringSpec other)

public ConversationalSearchRequest.ConversationalFilteringSpec.Builder mergeFrom(ConversationalSearchRequest.ConversationalFilteringSpec other)
Parameter
Name Description
other ConversationalSearchRequest.ConversationalFilteringSpec
Returns
Type Description
ConversationalSearchRequest.ConversationalFilteringSpec.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ConversationalSearchRequest.ConversationalFilteringSpec.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ConversationalSearchRequest.ConversationalFilteringSpec.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ConversationalSearchRequest.ConversationalFilteringSpec.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ConversationalSearchRequest.ConversationalFilteringSpec.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ConversationalSearchRequest.ConversationalFilteringSpec.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ConversationalSearchRequest.ConversationalFilteringSpec.Builder
Overrides

mergeUserAnswer(ConversationalSearchRequest.UserAnswer value)

public ConversationalSearchRequest.ConversationalFilteringSpec.Builder mergeUserAnswer(ConversationalSearchRequest.UserAnswer value)

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];

Parameter
Name Description
value ConversationalSearchRequest.UserAnswer
Returns
Type Description
ConversationalSearchRequest.ConversationalFilteringSpec.Builder

setConversationalFilteringMode(ConversationalSearchRequest.ConversationalFilteringSpec.Mode value)

public ConversationalSearchRequest.ConversationalFilteringSpec.Builder setConversationalFilteringMode(ConversationalSearchRequest.ConversationalFilteringSpec.Mode value)

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];

Parameter
Name Description
value ConversationalSearchRequest.ConversationalFilteringSpec.Mode

The conversationalFilteringMode to set.

Returns
Type Description
ConversationalSearchRequest.ConversationalFilteringSpec.Builder

This builder for chaining.

setConversationalFilteringModeValue(int value)

public ConversationalSearchRequest.ConversationalFilteringSpec.Builder setConversationalFilteringModeValue(int value)

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];

Parameter
Name Description
value int

The enum numeric value on the wire for conversationalFilteringMode to set.

Returns
Type Description
ConversationalSearchRequest.ConversationalFilteringSpec.Builder

This builder for chaining.

setEnableConversationalFiltering(boolean value) (deprecated)

public ConversationalSearchRequest.ConversationalFilteringSpec.Builder setEnableConversationalFiltering(boolean value)

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];

Parameter
Name Description
value boolean

The enableConversationalFiltering to set.

Returns
Type Description
ConversationalSearchRequest.ConversationalFilteringSpec.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public ConversationalSearchRequest.ConversationalFilteringSpec.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ConversationalSearchRequest.ConversationalFilteringSpec.Builder
Overrides

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

public ConversationalSearchRequest.ConversationalFilteringSpec.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ConversationalSearchRequest.ConversationalFilteringSpec.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ConversationalSearchRequest.ConversationalFilteringSpec.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ConversationalSearchRequest.ConversationalFilteringSpec.Builder
Overrides

setUserAnswer(ConversationalSearchRequest.UserAnswer value)

public ConversationalSearchRequest.ConversationalFilteringSpec.Builder setUserAnswer(ConversationalSearchRequest.UserAnswer value)

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];

Parameter
Name Description
value ConversationalSearchRequest.UserAnswer
Returns
Type Description
ConversationalSearchRequest.ConversationalFilteringSpec.Builder

setUserAnswer(ConversationalSearchRequest.UserAnswer.Builder builderForValue)

public ConversationalSearchRequest.ConversationalFilteringSpec.Builder setUserAnswer(ConversationalSearchRequest.UserAnswer.Builder builderForValue)

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];

Parameter
Name Description
builderForValue ConversationalSearchRequest.UserAnswer.Builder
Returns
Type Description
ConversationalSearchRequest.ConversationalFilteringSpec.Builder