Class SearchRequest.RelevanceScoreSpec (0.58.0)

public static final class SearchRequest.RelevanceScoreSpec extends GeneratedMessageV3 implements SearchRequest.RelevanceScoreSpecOrBuilder

The specification for returning the document relevance score.

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

Inheritance

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

Static Fields

RETURN_RELEVANCE_SCORE_FIELD_NUMBER

public static final int RETURN_RELEVANCE_SCORE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

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

getDescriptor()

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

newBuilder()

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

newBuilder(SearchRequest.RelevanceScoreSpec prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public SearchRequest.RelevanceScoreSpec getDefaultInstanceForType()
Returns
Type Description
SearchRequest.RelevanceScoreSpec

getParserForType()

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

getReturnRelevanceScore()

public boolean getReturnRelevanceScore()

Optional. Whether to return the relevance score for search results. The higher the score, the more relevant the document is to the query.

bool return_relevance_score = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The returnRelevanceScore.

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SearchRequest.RelevanceScoreSpec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
SearchRequest.RelevanceScoreSpec.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.RelevanceScoreSpec.Builder toBuilder()
Returns
Type Description
SearchRequest.RelevanceScoreSpec.Builder

writeTo(CodedOutputStream output)

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