Class RankingRecord (0.43.0) 

public final class RankingRecord extends GeneratedMessageV3 implements RankingRecordOrBuilder

Record message for RankService.Rank method.

Protobuf type google.cloud.discoveryengine.v1alpha.RankingRecord

Inheritance

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

Static Fields

CONTENT_FIELD_NUMBER

public static final int CONTENT_FIELD_NUMBER
Field Value
Type Description
int

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER
Field Value
Type Description
int

SCORE_FIELD_NUMBER

public static final int SCORE_FIELD_NUMBER
Field Value
Type Description
int

TITLE_FIELD_NUMBER

public static final int TITLE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static RankingRecord getDefaultInstance()
Returns
Type Description
RankingRecord

getDescriptor()

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

newBuilder()

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

newBuilder(RankingRecord prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getContent()

public String getContent()

The content of the record. Empty by default. At least one of title or content should be set otherwise an INVALID_ARGUMENT error is thrown.

string content = 3;

Returns
Type Description
String

The content.

getContentBytes()

public ByteString getContentBytes()

The content of the record. Empty by default. At least one of title or content should be set otherwise an INVALID_ARGUMENT error is thrown.

string content = 3;

Returns
Type Description
ByteString

The bytes for content.

getDefaultInstanceForType()

public RankingRecord getDefaultInstanceForType()
Returns
Type Description
RankingRecord

getId()

public String getId()

The unique ID to represent the record.

string id = 1;

Returns
Type Description
String

The id.

getIdBytes()

public ByteString getIdBytes()

The unique ID to represent the record.

string id = 1;

Returns
Type Description
ByteString

The bytes for id.

getParserForType()

public Parser<RankingRecord> getParserForType()
Returns
Type Description
Parser<RankingRecord>
Overrides

getScore()

public float getScore()

The score of this record based on the given query and selected model.

float score = 4;

Returns
Type Description
float

The score.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTitle()

public String getTitle()

The title of the record. Empty by default. At least one of title or content should be set otherwise an INVALID_ARGUMENT error is thrown.

string title = 2;

Returns
Type Description
String

The title.

getTitleBytes()

public ByteString getTitleBytes()

The title of the record. Empty by default. At least one of title or content should be set otherwise an INVALID_ARGUMENT error is thrown.

string title = 2;

Returns
Type Description
ByteString

The bytes for title.

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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