Class SearchRequest.SearchAsYouTypeSpec (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 extends GeneratedMessage implements SearchRequest.SearchAsYouTypeSpecOrBuilder

Specification for search as you type in search requests.

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

Inheritance

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

Implements

SearchRequest.SearchAsYouTypeSpecOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashCode()

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent)

AbstractMessage.toString()

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

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)

com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)

com.google.protobuf.GeneratedMessage.canUseUnsafe()

GeneratedMessage.computeStringSize(int,Object)

GeneratedMessage.computeStringSizeNoTag(Object)

com.google.protobuf.GeneratedMessage.emptyBooleanList()

com.google.protobuf.GeneratedMessage.emptyDoubleList()

com.google.protobuf.GeneratedMessage.emptyFloatList()

com.google.protobuf.GeneratedMessage.emptyIntList()

com.google.protobuf.GeneratedMessage.emptyLongList()

GeneratedMessage.getAllFields()

GeneratedMessage.getDescriptorForType()

GeneratedMessage.getField(Descriptors.FieldDescriptor)

GeneratedMessage.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.getParserForType()

GeneratedMessage.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessage.getSerializedSize()

GeneratedMessage.getUnknownFields()

GeneratedMessage.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.internalGetFieldAccessorTable()

GeneratedMessage.internalGetMapField(int)

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

GeneratedMessage.isInitialized()

com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)

GeneratedMessage.makeExtensionsImmutable()

com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)

GeneratedMessage.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

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

GeneratedMessage.writeReplace()

GeneratedMessage.writeString(CodedOutputStream,int,Object)

GeneratedMessage.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessage.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

CONDITION_FIELD_NUMBER

public static final int CONDITION_FIELD_NUMBER

Field Value
Type	Description
int

FIELDS_FIELD_NUMBER

public static final int FIELDS_FIELD_NUMBER

Field Value
Type	Description
int

SCORE_THRESHOLD_FIELD_NUMBER

public static final int SCORE_THRESHOLD_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static SearchRequest.SearchAsYouTypeSpec getDefaultInstance()

Returns
Type	Description
SearchRequest.SearchAsYouTypeSpec

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static SearchRequest.SearchAsYouTypeSpec.Builder newBuilder()

Returns
Type	Description
SearchRequest.SearchAsYouTypeSpec.Builder

newBuilder(SearchRequest.SearchAsYouTypeSpec prototype)

public static SearchRequest.SearchAsYouTypeSpec.Builder newBuilder(SearchRequest.SearchAsYouTypeSpec prototype)

Parameter
Name	Description
prototype	SearchRequest.SearchAsYouTypeSpec

Returns
Type	Description
SearchRequest.SearchAsYouTypeSpec.Builder

parseDelimitedFrom(InputStream input)

public static SearchRequest.SearchAsYouTypeSpec parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
SearchRequest.SearchAsYouTypeSpec

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.SearchAsYouTypeSpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SearchRequest.SearchAsYouTypeSpec

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static SearchRequest.SearchAsYouTypeSpec parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
SearchRequest.SearchAsYouTypeSpec

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.SearchAsYouTypeSpec parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SearchRequest.SearchAsYouTypeSpec

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SearchRequest.SearchAsYouTypeSpec parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
SearchRequest.SearchAsYouTypeSpec

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.SearchAsYouTypeSpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SearchRequest.SearchAsYouTypeSpec

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SearchRequest.SearchAsYouTypeSpec parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
SearchRequest.SearchAsYouTypeSpec

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.SearchAsYouTypeSpec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SearchRequest.SearchAsYouTypeSpec

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static SearchRequest.SearchAsYouTypeSpec parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
SearchRequest.SearchAsYouTypeSpec

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.SearchAsYouTypeSpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SearchRequest.SearchAsYouTypeSpec

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static SearchRequest.SearchAsYouTypeSpec parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
SearchRequest.SearchAsYouTypeSpec

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.SearchAsYouTypeSpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SearchRequest.SearchAsYouTypeSpec

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<SearchRequest.SearchAsYouTypeSpec> parser()

Returns
Type	Description
Parser<SearchAsYouTypeSpec>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

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

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

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>

getParserForType()

public Parser<SearchRequest.SearchAsYouTypeSpec> getParserForType()

Returns
Type	Description
Parser<SearchAsYouTypeSpec>

Overrides

GeneratedMessage.getParserForType()

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.

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessage.getSerializedSize()

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.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.isInitialized()

newBuilderForType()

public SearchRequest.SearchAsYouTypeSpec.Builder newBuilderForType()

Returns
Type	Description
SearchRequest.SearchAsYouTypeSpec.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected SearchRequest.SearchAsYouTypeSpec.Builder newBuilderForType(AbstractMessage.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
SearchRequest.SearchAsYouTypeSpec.Builder

Overrides

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent parent)

toBuilder()

public SearchRequest.SearchAsYouTypeSpec.Builder toBuilder()

Returns
Type	Description
SearchRequest.SearchAsYouTypeSpec.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessage.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException