Class RankResponse (0.40.0)

public final class RankResponse extends GeneratedMessageV3 implements RankResponseOrBuilder

Response message for RankService.Rank method.

Protobuf type google.cloud.discoveryengine.v1alpha.RankResponse

Static Fields

RECORDS_FIELD_NUMBER

public static final int RECORDS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static RankResponse getDefaultInstance()
Returns
Type Description
RankResponse

getDescriptor()

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

newBuilder()

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

newBuilder(RankResponse prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public RankResponse getDefaultInstanceForType()
Returns
Type Description
RankResponse

getParserForType()

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

getRecords(int index)

public RankingRecord getRecords(int index)

A list of records sorted by descending score.

repeated .google.cloud.discoveryengine.v1alpha.RankingRecord records = 5;

Parameter
Name Description
index int
Returns
Type Description
RankingRecord

getRecordsCount()

public int getRecordsCount()

A list of records sorted by descending score.

repeated .google.cloud.discoveryengine.v1alpha.RankingRecord records = 5;

Returns
Type Description
int

getRecordsList()

public List<RankingRecord> getRecordsList()

A list of records sorted by descending score.

repeated .google.cloud.discoveryengine.v1alpha.RankingRecord records = 5;

Returns
Type Description
List<RankingRecord>

getRecordsOrBuilder(int index)

public RankingRecordOrBuilder getRecordsOrBuilder(int index)

A list of records sorted by descending score.

repeated .google.cloud.discoveryengine.v1alpha.RankingRecord records = 5;

Parameter
Name Description
index int
Returns
Type Description
RankingRecordOrBuilder

getRecordsOrBuilderList()

public List<? extends RankingRecordOrBuilder> getRecordsOrBuilderList()

A list of records sorted by descending score.

repeated .google.cloud.discoveryengine.v1alpha.RankingRecord records = 5;

Returns
Type Description
List<? extends com.google.cloud.discoveryengine.v1alpha.RankingRecordOrBuilder>

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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