Class SpellingCorrection (2.31.0)

public final class SpellingCorrection extends GeneratedMessageV3 implements SpellingCorrectionOrBuilder

Spell check result.

Protobuf type google.cloud.talent.v4beta1.SpellingCorrection

Static Fields

CORRECTED_FIELD_NUMBER

public static final int CORRECTED_FIELD_NUMBER
Field Value
TypeDescription
int

CORRECTED_HTML_FIELD_NUMBER

public static final int CORRECTED_HTML_FIELD_NUMBER
Field Value
TypeDescription
int

CORRECTED_TEXT_FIELD_NUMBER

public static final int CORRECTED_TEXT_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static SpellingCorrection getDefaultInstance()
Returns
TypeDescription
SpellingCorrection

getDescriptor()

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

newBuilder()

public static SpellingCorrection.Builder newBuilder()
Returns
TypeDescription
SpellingCorrection.Builder

newBuilder(SpellingCorrection prototype)

public static SpellingCorrection.Builder newBuilder(SpellingCorrection prototype)
Parameter
NameDescription
prototypeSpellingCorrection
Returns
TypeDescription
SpellingCorrection.Builder

parseDelimitedFrom(InputStream input)

public static SpellingCorrection parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SpellingCorrection
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static SpellingCorrection parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
SpellingCorrection
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static SpellingCorrection parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
SpellingCorrection
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static SpellingCorrection parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SpellingCorrection
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static SpellingCorrection parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
SpellingCorrection
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<SpellingCorrection> parser()
Returns
TypeDescription
Parser<SpellingCorrection>

Methods

equals(Object obj)

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

getCorrected()

public boolean getCorrected()

Indicates if the query was corrected by the spell checker.

bool corrected = 1;

Returns
TypeDescription
boolean

The corrected.

getCorrectedHtml()

public String getCorrectedHtml()

Corrected output with html tags to highlight the corrected words. Corrected words are called out with the "<b><i>...</i></b>" html tags.

For example, the user input query is "software enginear", where the second word, "enginear," is incorrect. It should be "engineer". When spelling correction is enabled, this value is "software <b><i>engineer</i></b>".

string corrected_html = 3;

Returns
TypeDescription
String

The correctedHtml.

getCorrectedHtmlBytes()

public ByteString getCorrectedHtmlBytes()

Corrected output with html tags to highlight the corrected words. Corrected words are called out with the "<b><i>...</i></b>" html tags.

For example, the user input query is "software enginear", where the second word, "enginear," is incorrect. It should be "engineer". When spelling correction is enabled, this value is "software <b><i>engineer</i></b>".

string corrected_html = 3;

Returns
TypeDescription
ByteString

The bytes for correctedHtml.

getCorrectedText()

public String getCorrectedText()

Correction output consisting of the corrected keyword string.

string corrected_text = 2;

Returns
TypeDescription
String

The correctedText.

getCorrectedTextBytes()

public ByteString getCorrectedTextBytes()

Correction output consisting of the corrected keyword string.

string corrected_text = 2;

Returns
TypeDescription
ByteString

The bytes for correctedText.

getDefaultInstanceForType()

public SpellingCorrection getDefaultInstanceForType()
Returns
TypeDescription
SpellingCorrection

getParserForType()

public Parser<SpellingCorrection> getParserForType()
Returns
TypeDescription
Parser<SpellingCorrection>
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 SpellingCorrection.Builder newBuilderForType()
Returns
TypeDescription
SpellingCorrection.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public SpellingCorrection.Builder toBuilder()
Returns
TypeDescription
SpellingCorrection.Builder

writeTo(CodedOutputStream output)

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