com.google.cloud.discoveryengine.v1beta

Class RankingRecord

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.discoveryengine.v1beta.RankingRecord

All Implemented Interfaces:

RankingRecordOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class RankingRecord
extends com.google.protobuf.GeneratedMessageV3
implements RankingRecordOrBuilder

 Record message for
 [RankService.Rank][google.cloud.discoveryengine.v1beta.RankService.Rank]
 method.
 

Protobuf type google.cloud.discoveryengine.v1beta.RankingRecord

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RankingRecord.Builder Record message for [RankService.Rank][google.cloud.discoveryengine.v1beta.RankService.Rank] method.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	CONTENT_FIELD_NUMBER
static int	ID_FIELD_NUMBER
static int	SCORE_FIELD_NUMBER
static int	TITLE_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getContent() The content of the record.
com.google.protobuf.ByteString	getContentBytes() The content of the record.
static RankingRecord	getDefaultInstance()
RankingRecord	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getId() The unique ID to represent the record.
com.google.protobuf.ByteString	getIdBytes() The unique ID to represent the record.
com.google.protobuf.Parser<RankingRecord>	getParserForType()
float	getScore() The score of this record based on the given query and selected model.
int	getSerializedSize()
String	getTitle() The title of the record.
com.google.protobuf.ByteString	getTitleBytes() The title of the record.
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static RankingRecord.Builder	newBuilder()
static RankingRecord.Builder	newBuilder(RankingRecord prototype)
RankingRecord.Builder	newBuilderForType()
protected RankingRecord.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static RankingRecord	parseDelimitedFrom(InputStream input)
static RankingRecord	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RankingRecord	parseFrom(byte[] data)
static RankingRecord	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RankingRecord	parseFrom(ByteBuffer data)
static RankingRecord	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RankingRecord	parseFrom(com.google.protobuf.ByteString data)
static RankingRecord	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RankingRecord	parseFrom(com.google.protobuf.CodedInputStream input)
static RankingRecord	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RankingRecord	parseFrom(InputStream input)
static RankingRecord	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<RankingRecord>	parser()
RankingRecord.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER

See Also:

Constant Field Values

TITLE_FIELD_NUMBER

public static final int TITLE_FIELD_NUMBER

See Also:

Constant Field Values

CONTENT_FIELD_NUMBER

public static final int CONTENT_FIELD_NUMBER

See Also:

Constant Field Values

SCORE_FIELD_NUMBER

public static final int SCORE_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getId

public String getId()

 The unique ID to represent the record.
 

string id = 1;

Specified by:

getId in interface RankingRecordOrBuilder

Returns:

The id.

getIdBytes

public com.google.protobuf.ByteString getIdBytes()

 The unique ID to represent the record.
 

string id = 1;

Specified by:

getIdBytes in interface RankingRecordOrBuilder

Returns:

The bytes for id.

getTitle

public String getTitle()

 The title of the record. Empty by default.
 At least one of
 [title][google.cloud.discoveryengine.v1beta.RankingRecord.title] or
 [content][google.cloud.discoveryengine.v1beta.RankingRecord.content] should
 be set otherwise an INVALID_ARGUMENT error is thrown.
 

string title = 2;

Specified by:

getTitle in interface RankingRecordOrBuilder

Returns:

The title.

getTitleBytes

public com.google.protobuf.ByteString getTitleBytes()

 The title of the record. Empty by default.
 At least one of
 [title][google.cloud.discoveryengine.v1beta.RankingRecord.title] or
 [content][google.cloud.discoveryengine.v1beta.RankingRecord.content] should
 be set otherwise an INVALID_ARGUMENT error is thrown.
 

string title = 2;

Specified by:

getTitleBytes in interface RankingRecordOrBuilder

Returns:

The bytes for title.

getContent

public String getContent()

 The content of the record. Empty by default.
 At least one of
 [title][google.cloud.discoveryengine.v1beta.RankingRecord.title] or
 [content][google.cloud.discoveryengine.v1beta.RankingRecord.content] should
 be set otherwise an INVALID_ARGUMENT error is thrown.
 

string content = 3;

Specified by:

getContent in interface RankingRecordOrBuilder

Returns:

The content.

getContentBytes

public com.google.protobuf.ByteString getContentBytes()

 The content of the record. Empty by default.
 At least one of
 [title][google.cloud.discoveryengine.v1beta.RankingRecord.title] or
 [content][google.cloud.discoveryengine.v1beta.RankingRecord.content] should
 be set otherwise an INVALID_ARGUMENT error is thrown.
 

string content = 3;

Specified by:

getContentBytes in interface RankingRecordOrBuilder

Returns:

The bytes for content.

getScore

public float getScore()

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

float score = 4;

Specified by:

getScore in interface RankingRecordOrBuilder

Returns:

The score.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static RankingRecord parseFrom(ByteBuffer data)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RankingRecord parseFrom(ByteBuffer data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RankingRecord parseFrom(com.google.protobuf.ByteString data)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RankingRecord parseFrom(com.google.protobuf.ByteString data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RankingRecord parseFrom(byte[] data)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RankingRecord parseFrom(byte[] data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RankingRecord parseFrom(InputStream input)
                               throws IOException

Throws:

IOException

parseFrom

public static RankingRecord parseFrom(InputStream input,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws IOException

Throws:

IOException

parseDelimitedFrom

public static RankingRecord parseDelimitedFrom(InputStream input)
                                        throws IOException

Throws:

IOException

parseDelimitedFrom

public static RankingRecord parseDelimitedFrom(InputStream input,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws IOException

Throws:

IOException

parseFrom

public static RankingRecord parseFrom(com.google.protobuf.CodedInputStream input)
                               throws IOException

Throws:

IOException

parseFrom

public static RankingRecord parseFrom(com.google.protobuf.CodedInputStream input,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws IOException

Throws:

IOException

newBuilderForType

public RankingRecord.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static RankingRecord.Builder newBuilder()

newBuilder

public static RankingRecord.Builder newBuilder(RankingRecord prototype)

toBuilder

public RankingRecord.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected RankingRecord.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static RankingRecord getDefaultInstance()

parser

public static com.google.protobuf.Parser<RankingRecord> parser()

getParserForType

public com.google.protobuf.Parser<RankingRecord> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public RankingRecord getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder