Class SearchRequest.SearchAsYouTypeSpec.Builder (0.95.0)

0.95.0 (latest) 0.91.0 0.90.0 0.89.0 0.87.0 0.84.0 0.83.0 0.81.0 0.79.0 0.78.0 0.77.0 0.76.0 0.74.0 0.72.0 0.71.0 0.70.0 0.69.0 0.68.0 0.66.0 0.64.0 0.63.0 0.60.0 0.59.0 0.58.0 0.56.0 0.55.0 0.54.0 0.53.0 0.52.0 0.51.0 0.50.0 0.49.0 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 SearchRequest.SearchAsYouTypeSpec.Builder extends GeneratedMessage.Builder<SearchRequest.SearchAsYouTypeSpec.Builder> implements SearchRequest.SearchAsYouTypeSpecOrBuilder

Specification for search as you type in search requests.

Protobuf type google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > SearchRequest.SearchAsYouTypeSpec.Builder

Implements

SearchRequest.SearchAsYouTypeSpecOrBuilder

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)

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

GeneratedMessage.Builder.clear()

GeneratedMessage.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.clone()

GeneratedMessage.Builder.getAllFields()

GeneratedMessage.Builder.getDescriptorForType()

GeneratedMessage.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.getParentForChildren()

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

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

GeneratedMessage.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

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

GeneratedMessage.Builder.getUnknownFields()

GeneratedMessage.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.internalGetFieldAccessorTable()

GeneratedMessage.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMapFieldReflection(int)

GeneratedMessage.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessage.Builder.isClean()

GeneratedMessage.Builder.isInitialized()

GeneratedMessage.Builder.markClean()

GeneratedMessage.Builder.mergeUnknownFields(UnknownFieldSet)

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

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

GeneratedMessage.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.onBuilt()

GeneratedMessage.Builder.onChanged()

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

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

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

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

GeneratedMessage.Builder.setUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldsProto3(com.google.protobuf.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

addAllFields(Iterable<? extends SearchRequest.SearchAsYouTypeSpec.Field> values)

public SearchRequest.SearchAsYouTypeSpec.Builder addAllFields(Iterable<? extends SearchRequest.SearchAsYouTypeSpec.Field> values)

Optional. The list of fields to be used for Search As You Type scoring.

repeated .google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec.Field fields = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
values	Iterable<? extends com.google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec.Field>

Returns
Type	Description
SearchRequest.SearchAsYouTypeSpec.Builder

addFields(SearchRequest.SearchAsYouTypeSpec.Field value)

public SearchRequest.SearchAsYouTypeSpec.Builder addFields(SearchRequest.SearchAsYouTypeSpec.Field value)

Optional. The list of fields to be used for Search As You Type scoring.

repeated .google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec.Field fields = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	SearchRequest.SearchAsYouTypeSpec.Field

Returns
Type	Description
SearchRequest.SearchAsYouTypeSpec.Builder

addFields(SearchRequest.SearchAsYouTypeSpec.Field.Builder builderForValue)

public SearchRequest.SearchAsYouTypeSpec.Builder addFields(SearchRequest.SearchAsYouTypeSpec.Field.Builder builderForValue)

Optional. The list of fields to be used for Search As You Type scoring.

repeated .google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec.Field fields = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
builderForValue	SearchRequest.SearchAsYouTypeSpec.Field.Builder

Returns
Type	Description
SearchRequest.SearchAsYouTypeSpec.Builder

addFields(int index, SearchRequest.SearchAsYouTypeSpec.Field value)

public SearchRequest.SearchAsYouTypeSpec.Builder addFields(int index, SearchRequest.SearchAsYouTypeSpec.Field value)

Optional. The list of fields to be used for Search As You Type scoring.

repeated .google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec.Field fields = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
index	int
value	SearchRequest.SearchAsYouTypeSpec.Field

Returns
Type	Description
SearchRequest.SearchAsYouTypeSpec.Builder

addFields(int index, SearchRequest.SearchAsYouTypeSpec.Field.Builder builderForValue)

public SearchRequest.SearchAsYouTypeSpec.Builder addFields(int index, SearchRequest.SearchAsYouTypeSpec.Field.Builder builderForValue)

Optional. The list of fields to be used for Search As You Type scoring.

repeated .google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec.Field fields = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
index	int
builderForValue	SearchRequest.SearchAsYouTypeSpec.Field.Builder

Returns
Type	Description
SearchRequest.SearchAsYouTypeSpec.Builder

addFieldsBuilder()

public SearchRequest.SearchAsYouTypeSpec.Field.Builder addFieldsBuilder()

Optional. The list of fields to be used for Search As You Type scoring.

repeated .google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec.Field fields = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
SearchRequest.SearchAsYouTypeSpec.Field.Builder

addFieldsBuilder(int index)

public SearchRequest.SearchAsYouTypeSpec.Field.Builder addFieldsBuilder(int index)

Optional. The list of fields to be used for Search As You Type scoring.

repeated .google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec.Field fields = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
SearchRequest.SearchAsYouTypeSpec.Field.Builder

build()

public SearchRequest.SearchAsYouTypeSpec build()

Returns
Type	Description
SearchRequest.SearchAsYouTypeSpec

buildPartial()

public SearchRequest.SearchAsYouTypeSpec buildPartial()

Returns
Type	Description
SearchRequest.SearchAsYouTypeSpec

clear()

public SearchRequest.SearchAsYouTypeSpec.Builder clear()

Returns
Type	Description
SearchRequest.SearchAsYouTypeSpec.Builder

Overrides

GeneratedMessage.Builder<BuilderType>.clear()

clearCondition()

public SearchRequest.SearchAsYouTypeSpec.Builder clearCondition()

The condition under which search as you type should occur. Default to Condition.DISABLED.

.google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec.Condition condition = 1;

Returns
Type	Description
SearchRequest.SearchAsYouTypeSpec.Builder	This builder for chaining.

clearFields()

public SearchRequest.SearchAsYouTypeSpec.Builder clearFields()

Optional. The list of fields to be used for Search As You Type scoring.

repeated .google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec.Field fields = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
SearchRequest.SearchAsYouTypeSpec.Builder

clearScoreThreshold()

public SearchRequest.SearchAsYouTypeSpec.Builder clearScoreThreshold()

Optional. Search As You Type score threshold for filtering purpose. We keep the result if score >= score_threshold.

optional double score_threshold = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
SearchRequest.SearchAsYouTypeSpec.Builder	This builder for chaining.

getCondition()

public SearchRequest.SearchAsYouTypeSpec.Condition getCondition()

The condition under which search as you type should occur. Default to Condition.DISABLED.

.google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec.Condition condition = 1;

Returns
Type	Description
SearchRequest.SearchAsYouTypeSpec.Condition	The condition.

getConditionValue()

public int getConditionValue()

The condition under which search as you type should occur. Default to Condition.DISABLED.

.google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec.Condition condition = 1;

Returns
Type	Description
int	The enum numeric value on the wire for condition.

getDefaultInstanceForType()

public SearchRequest.SearchAsYouTypeSpec getDefaultInstanceForType()

Returns
Type	Description
SearchRequest.SearchAsYouTypeSpec

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessage.Builder<BuilderType>.getDescriptorForType()

getFields(int index)

public SearchRequest.SearchAsYouTypeSpec.Field getFields(int index)

Optional. The list of fields to be used for Search As You Type scoring.

repeated .google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec.Field fields = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
SearchRequest.SearchAsYouTypeSpec.Field

getFieldsBuilder(int index)

public SearchRequest.SearchAsYouTypeSpec.Field.Builder getFieldsBuilder(int index)

Optional. The list of fields to be used for Search As You Type scoring.

repeated .google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec.Field fields = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
SearchRequest.SearchAsYouTypeSpec.Field.Builder

getFieldsBuilderList()

public List<SearchRequest.SearchAsYouTypeSpec.Field.Builder> getFieldsBuilderList()

Optional. The list of fields to be used for Search As You Type scoring.

repeated .google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec.Field fields = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<Builder>

getFieldsCount()

public int getFieldsCount()

Optional. The list of fields to be used for Search As You Type scoring.

repeated .google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec.Field fields = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int

getFieldsList()

public List<SearchRequest.SearchAsYouTypeSpec.Field> getFieldsList()

Optional. The list of fields to be used for Search As You Type scoring.

repeated .google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec.Field fields = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<Field>

getFieldsOrBuilder(int index)

public SearchRequest.SearchAsYouTypeSpec.FieldOrBuilder getFieldsOrBuilder(int index)

Optional. The list of fields to be used for Search As You Type scoring.

repeated .google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec.Field fields = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
SearchRequest.SearchAsYouTypeSpec.FieldOrBuilder

getFieldsOrBuilderList()

public List<? extends SearchRequest.SearchAsYouTypeSpec.FieldOrBuilder> getFieldsOrBuilderList()

Optional. The list of fields to be used for Search As You Type scoring.

repeated .google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec.Field fields = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<? extends com.google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec.FieldOrBuilder>

getScoreThreshold()

public double getScoreThreshold()

Optional. Search As You Type score threshold for filtering purpose. We keep the result if score >= score_threshold.

optional double score_threshold = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
double	The scoreThreshold.

hasScoreThreshold()

public boolean hasScoreThreshold()

Optional. Search As You Type score threshold for filtering purpose. We keep the result if score >= score_threshold.

optional double score_threshold = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the scoreThreshold field is set.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.Builder<BuilderType>.isInitialized()

mergeFrom(SearchRequest.SearchAsYouTypeSpec other)

public SearchRequest.SearchAsYouTypeSpec.Builder mergeFrom(SearchRequest.SearchAsYouTypeSpec other)

Parameter
Name	Description
other	SearchRequest.SearchAsYouTypeSpec

Returns
Type	Description
SearchRequest.SearchAsYouTypeSpec.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SearchRequest.SearchAsYouTypeSpec.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SearchRequest.SearchAsYouTypeSpec.Builder

Overrides

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

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public SearchRequest.SearchAsYouTypeSpec.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
SearchRequest.SearchAsYouTypeSpec.Builder

Overrides

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

removeFields(int index)

public SearchRequest.SearchAsYouTypeSpec.Builder removeFields(int index)

Optional. The list of fields to be used for Search As You Type scoring.

repeated .google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec.Field fields = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
SearchRequest.SearchAsYouTypeSpec.Builder

setCondition(SearchRequest.SearchAsYouTypeSpec.Condition value)

public SearchRequest.SearchAsYouTypeSpec.Builder setCondition(SearchRequest.SearchAsYouTypeSpec.Condition value)

The condition under which search as you type should occur. Default to Condition.DISABLED.

.google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec.Condition condition = 1;

Parameter
Name	Description
value	SearchRequest.SearchAsYouTypeSpec.Condition The condition to set.

Returns
Type	Description
SearchRequest.SearchAsYouTypeSpec.Builder	This builder for chaining.

setConditionValue(int value)

public SearchRequest.SearchAsYouTypeSpec.Builder setConditionValue(int value)

The condition under which search as you type should occur. Default to Condition.DISABLED.

.google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec.Condition condition = 1;

Parameter
Name	Description
value	int The enum numeric value on the wire for condition to set.

Returns
Type	Description
SearchRequest.SearchAsYouTypeSpec.Builder	This builder for chaining.

setFields(int index, SearchRequest.SearchAsYouTypeSpec.Field value)

public SearchRequest.SearchAsYouTypeSpec.Builder setFields(int index, SearchRequest.SearchAsYouTypeSpec.Field value)

Optional. The list of fields to be used for Search As You Type scoring.

repeated .google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec.Field fields = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
index	int
value	SearchRequest.SearchAsYouTypeSpec.Field

Returns
Type	Description
SearchRequest.SearchAsYouTypeSpec.Builder

setFields(int index, SearchRequest.SearchAsYouTypeSpec.Field.Builder builderForValue)

public SearchRequest.SearchAsYouTypeSpec.Builder setFields(int index, SearchRequest.SearchAsYouTypeSpec.Field.Builder builderForValue)

Optional. The list of fields to be used for Search As You Type scoring.

repeated .google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec.Field fields = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
index	int
builderForValue	SearchRequest.SearchAsYouTypeSpec.Field.Builder

Returns
Type	Description
SearchRequest.SearchAsYouTypeSpec.Builder

setScoreThreshold(double value)

public SearchRequest.SearchAsYouTypeSpec.Builder setScoreThreshold(double value)

Optional. Search As You Type score threshold for filtering purpose. We keep the result if score >= score_threshold.

optional double score_threshold = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	double The scoreThreshold to set.

Returns
Type	Description
SearchRequest.SearchAsYouTypeSpec.Builder	This builder for chaining.