Class RankingRecord (0.83.0)

public final class RankingRecord extends GeneratedMessage implements RankingRecordOrBuilder

Record message for RankService.Rank method.

Protobuf type google.cloud.discoveryengine.v1.RankingRecord

Inheritance

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

Implements

RankingRecordOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashCode()

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)

com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)

com.google.protobuf.GeneratedMessage.canUseUnsafe()

GeneratedMessage.computeStringSize(int,Object)

GeneratedMessage.computeStringSizeNoTag(Object)

com.google.protobuf.GeneratedMessage.emptyBooleanList()

com.google.protobuf.GeneratedMessage.emptyDoubleList()

com.google.protobuf.GeneratedMessage.emptyFloatList()

com.google.protobuf.GeneratedMessage.emptyIntList()

com.google.protobuf.GeneratedMessage.emptyLongList()

GeneratedMessage.getAllFields()

GeneratedMessage.getDescriptorForType()

GeneratedMessage.getField(Descriptors.FieldDescriptor)

GeneratedMessage.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.getParserForType()

GeneratedMessage.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessage.getSerializedSize()

GeneratedMessage.getUnknownFields()

GeneratedMessage.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.internalGetFieldAccessorTable()

GeneratedMessage.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)

GeneratedMessage.isInitialized()

com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)

GeneratedMessage.makeExtensionsImmutable()

com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)

GeneratedMessage.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.writeReplace()

GeneratedMessage.writeString(CodedOutputStream,int,Object)

GeneratedMessage.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessage.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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

AbstractMessage.equals(Object other)

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

GeneratedMessage.getParserForType()

getScore()

public float getScore()

The score of this record based on the given query and selected model. The score will be rounded to 2 decimal places. If the score is close to 0, it will be rounded to 0.0001 to avoid returning unset.

float score = 4;

Returns
Type	Description
`float`	The score.

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
`int`

Overrides

GeneratedMessage.getSerializedSize()

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

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessage.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessage.isInitialized()

newBuilderForType()

public RankingRecord.Builder newBuilderForType()

Returns
Type	Description
`RankingRecord.Builder`

newBuilderForType(AbstractMessage.BuilderParent parent)

protected RankingRecord.Builder newBuilderForType(AbstractMessage.BuilderParent parent)

Parameter
Name	Description
`parent`	`BuilderParent`

Returns
Type	Description
`RankingRecord.Builder`

Overrides

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent parent)

toBuilder()

public RankingRecord.Builder toBuilder()

Returns
Type	Description
`RankingRecord.Builder`

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
`output`	`CodedOutputStream`

Overrides

GeneratedMessage.writeTo(CodedOutputStream output)

Exceptions
Type	Description
`IOException`

Class RankingRecord (0.83.0) Stay organized with collections Save and categorize content based on your preferences.

Inheritance

Implements

Inherited Members

Static Fields

CONTENT_FIELD_NUMBER

ID_FIELD_NUMBER

SCORE_FIELD_NUMBER

TITLE_FIELD_NUMBER

Static Methods

getDefaultInstance()

getDescriptor()

newBuilder()

newBuilder(RankingRecord prototype)

parseDelimitedFrom(InputStream input)

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

parseFrom(byte[] data)

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

parseFrom(ByteString data)

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

parseFrom(CodedInputStream input)

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

parseFrom(InputStream input)

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

parseFrom(ByteBuffer data)

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

parser()

Methods

equals(Object obj)

getContent()

getContentBytes()

getDefaultInstanceForType()

getId()

getIdBytes()

getParserForType()

getScore()

getSerializedSize()

getTitle()

getTitleBytes()

hashCode()

internalGetFieldAccessorTable()

isInitialized()

newBuilderForType()

newBuilderForType(AbstractMessage.BuilderParent parent)

toBuilder()

writeTo(CodedOutputStream output)

Class RankingRecord (0.83.0)