Class SpellingCorrection (2.46.0) 

public final class SpellingCorrection extends GeneratedMessageV3 implements SpellingCorrectionOrBuilder

Spell check result.

Protobuf type google.cloud.talent.v4beta1.SpellingCorrection

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > SpellingCorrection

Static Fields

CORRECTED_FIELD_NUMBER

public static final int CORRECTED_FIELD_NUMBER
Field Value
Type Description
int

CORRECTED_HTML_FIELD_NUMBER

public static final int CORRECTED_HTML_FIELD_NUMBER
Field Value
Type Description
int

CORRECTED_TEXT_FIELD_NUMBER

public static final int CORRECTED_TEXT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SpellingCorrection getDefaultInstance()
Returns
Type Description
SpellingCorrection

getDescriptor()

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

newBuilder()

public static SpellingCorrection.Builder newBuilder()
Returns
Type Description
SpellingCorrection.Builder

newBuilder(SpellingCorrection prototype)

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

parseDelimitedFrom(InputStream input)

public static SpellingCorrection parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SpellingCorrection
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static SpellingCorrection parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
SpellingCorrection
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static SpellingCorrection parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
SpellingCorrection
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static SpellingCorrection parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SpellingCorrection
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static SpellingCorrection parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SpellingCorrection
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<SpellingCorrection> parser()
Returns
Type Description
Parser<SpellingCorrection>

Methods

equals(Object obj)

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

getCorrected()

public boolean getCorrected()

Indicates if the query was corrected by the spell checker.

bool corrected = 1;

Returns
Type Description
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
Type Description
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
Type Description
ByteString

The bytes for correctedHtml.

getCorrectedText()

public String getCorrectedText()

Correction output consisting of the corrected keyword string.

string corrected_text = 2;

Returns
Type Description
String

The correctedText.

getCorrectedTextBytes()

public ByteString getCorrectedTextBytes()

Correction output consisting of the corrected keyword string.

string corrected_text = 2;

Returns
Type Description
ByteString

The bytes for correctedText.

getDefaultInstanceForType()

public SpellingCorrection getDefaultInstanceForType()
Returns
Type Description
SpellingCorrection

getParserForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public SpellingCorrection.Builder toBuilder()
Returns
Type Description
SpellingCorrection.Builder

writeTo(CodedOutputStream output)

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