Class SearchRequest.SpellCorrectionSpec (2.21.0)

public static final class SearchRequest.SpellCorrectionSpec extends GeneratedMessageV3 implements SearchRequest.SpellCorrectionSpecOrBuilder

The specification for query spell correction.

Protobuf type google.cloud.retail.v2.SearchRequest.SpellCorrectionSpec

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > SearchRequest.SpellCorrectionSpec

Static Fields

MODE_FIELD_NUMBER

public static final int MODE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static SearchRequest.SpellCorrectionSpec getDefaultInstance()
Returns
TypeDescription
SearchRequest.SpellCorrectionSpec

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static SearchRequest.SpellCorrectionSpec.Builder newBuilder()
Returns
TypeDescription
SearchRequest.SpellCorrectionSpec.Builder

newBuilder(SearchRequest.SpellCorrectionSpec prototype)

public static SearchRequest.SpellCorrectionSpec.Builder newBuilder(SearchRequest.SpellCorrectionSpec prototype)
Parameter
NameDescription
prototypeSearchRequest.SpellCorrectionSpec
Returns
TypeDescription
SearchRequest.SpellCorrectionSpec.Builder

parseDelimitedFrom(InputStream input)

public static SearchRequest.SpellCorrectionSpec parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SearchRequest.SpellCorrectionSpec
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.SpellCorrectionSpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchRequest.SpellCorrectionSpec
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static SearchRequest.SpellCorrectionSpec parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
SearchRequest.SpellCorrectionSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.SpellCorrectionSpec parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchRequest.SpellCorrectionSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SearchRequest.SpellCorrectionSpec parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
SearchRequest.SpellCorrectionSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.SpellCorrectionSpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchRequest.SpellCorrectionSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SearchRequest.SpellCorrectionSpec parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
SearchRequest.SpellCorrectionSpec
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.SpellCorrectionSpec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchRequest.SpellCorrectionSpec
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static SearchRequest.SpellCorrectionSpec parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SearchRequest.SpellCorrectionSpec
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.SpellCorrectionSpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchRequest.SpellCorrectionSpec
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static SearchRequest.SpellCorrectionSpec parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
SearchRequest.SpellCorrectionSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.SpellCorrectionSpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchRequest.SpellCorrectionSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<SearchRequest.SpellCorrectionSpec> parser()
Returns
TypeDescription
Parser<SpellCorrectionSpec>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public SearchRequest.SpellCorrectionSpec getDefaultInstanceForType()
Returns
TypeDescription
SearchRequest.SpellCorrectionSpec

getMode()

public SearchRequest.SpellCorrectionSpec.Mode getMode()

The mode under which spell correction should take effect to replace the original search query. Default to Mode.AUTO.

.google.cloud.retail.v2.SearchRequest.SpellCorrectionSpec.Mode mode = 1;

Returns
TypeDescription
SearchRequest.SpellCorrectionSpec.Mode

The mode.

getModeValue()

public int getModeValue()

The mode under which spell correction should take effect to replace the original search query. Default to Mode.AUTO.

.google.cloud.retail.v2.SearchRequest.SpellCorrectionSpec.Mode mode = 1;

Returns
TypeDescription
int

The enum numeric value on the wire for mode.

getParserForType()

public Parser<SearchRequest.SpellCorrectionSpec> getParserForType()
Returns
TypeDescription
Parser<SpellCorrectionSpec>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public SearchRequest.SpellCorrectionSpec.Builder newBuilderForType()
Returns
TypeDescription
SearchRequest.SpellCorrectionSpec.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SearchRequest.SpellCorrectionSpec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
SearchRequest.SpellCorrectionSpec.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public SearchRequest.SpellCorrectionSpec.Builder toBuilder()
Returns
TypeDescription
SearchRequest.SpellCorrectionSpec.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException