Class SearchRequest.SpellCorrectionSpec (2.56.0)

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

The specification for query spell correction.

Protobuf type google.cloud.retail.v2beta.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
Type Description
int

Static Methods

getDefaultInstance()

public static SearchRequest.SpellCorrectionSpec getDefaultInstance()
Returns
Type Description
SearchRequest.SpellCorrectionSpec

getDescriptor()

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

newBuilder()

public static SearchRequest.SpellCorrectionSpec.Builder newBuilder()
Returns
Type Description
SearchRequest.SpellCorrectionSpec.Builder

newBuilder(SearchRequest.SpellCorrectionSpec prototype)

public static SearchRequest.SpellCorrectionSpec.Builder newBuilder(SearchRequest.SpellCorrectionSpec prototype)
Parameter
Name Description
prototype SearchRequest.SpellCorrectionSpec
Returns
Type Description
SearchRequest.SpellCorrectionSpec.Builder

parseDelimitedFrom(InputStream input)

public static SearchRequest.SpellCorrectionSpec parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SearchRequest.SpellCorrectionSpec
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static SearchRequest.SpellCorrectionSpec parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
SearchRequest.SpellCorrectionSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static SearchRequest.SpellCorrectionSpec parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
SearchRequest.SpellCorrectionSpec
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static SearchRequest.SpellCorrectionSpec parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SearchRequest.SpellCorrectionSpec
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static SearchRequest.SpellCorrectionSpec parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SearchRequest.SpellCorrectionSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public SearchRequest.SpellCorrectionSpec getDefaultInstanceForType()
Returns
Type Description
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.v2beta.SearchRequest.SpellCorrectionSpec.Mode mode = 1;

Returns
Type Description
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.v2beta.SearchRequest.SpellCorrectionSpec.Mode mode = 1;

Returns
Type Description
int

The enum numeric value on the wire for mode.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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 SearchRequest.SpellCorrectionSpec.Builder newBuilderForType()
Returns
Type Description
SearchRequest.SpellCorrectionSpec.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SearchRequest.SpellCorrectionSpec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
SearchRequest.SpellCorrectionSpec.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public SearchRequest.SpellCorrectionSpec.Builder toBuilder()
Returns
Type Description
SearchRequest.SpellCorrectionSpec.Builder

writeTo(CodedOutputStream output)

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