Class IndexDatapoint.SparseEmbedding (3.49.0)

public static final class IndexDatapoint.SparseEmbedding extends GeneratedMessageV3 implements IndexDatapoint.SparseEmbeddingOrBuilder

Feature embedding vector for sparse index. An array of numbers whose values are located in the specified dimensions.

Protobuf type google.cloud.aiplatform.v1.IndexDatapoint.SparseEmbedding

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > IndexDatapoint.SparseEmbedding

Static Fields

DIMENSIONS_FIELD_NUMBER

public static final int DIMENSIONS_FIELD_NUMBER
Field Value
Type Description
int

VALUES_FIELD_NUMBER

public static final int VALUES_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static IndexDatapoint.SparseEmbedding getDefaultInstance()
Returns
Type Description
IndexDatapoint.SparseEmbedding

getDescriptor()

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

newBuilder()

public static IndexDatapoint.SparseEmbedding.Builder newBuilder()
Returns
Type Description
IndexDatapoint.SparseEmbedding.Builder

newBuilder(IndexDatapoint.SparseEmbedding prototype)

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

parseDelimitedFrom(InputStream input)

public static IndexDatapoint.SparseEmbedding parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
IndexDatapoint.SparseEmbedding
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static IndexDatapoint.SparseEmbedding parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
IndexDatapoint.SparseEmbedding
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static IndexDatapoint.SparseEmbedding parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
IndexDatapoint.SparseEmbedding
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static IndexDatapoint.SparseEmbedding parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
IndexDatapoint.SparseEmbedding
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static IndexDatapoint.SparseEmbedding parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
IndexDatapoint.SparseEmbedding
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<IndexDatapoint.SparseEmbedding> parser()
Returns
Type Description
Parser<SparseEmbedding>

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public IndexDatapoint.SparseEmbedding getDefaultInstanceForType()
Returns
Type Description
IndexDatapoint.SparseEmbedding

getDimensions(int index)

public long getDimensions(int index)

Required. The list of indexes for the embedding values of the sparse vector.

repeated int64 dimensions = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
long

The dimensions at the given index.

getDimensionsCount()

public int getDimensionsCount()

Required. The list of indexes for the embedding values of the sparse vector.

repeated int64 dimensions = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The count of dimensions.

getDimensionsList()

public List<Long> getDimensionsList()

Required. The list of indexes for the embedding values of the sparse vector.

repeated int64 dimensions = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<Long>

A list containing the dimensions.

getParserForType()

public Parser<IndexDatapoint.SparseEmbedding> getParserForType()
Returns
Type Description
Parser<SparseEmbedding>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getValues(int index)

public float getValues(int index)

Required. The list of embedding values of the sparse vector.

repeated float values = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
float

The values at the given index.

getValuesCount()

public int getValuesCount()

Required. The list of embedding values of the sparse vector.

repeated float values = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The count of values.

getValuesList()

public List<Float> getValuesList()

Required. The list of embedding values of the sparse vector.

repeated float values = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<Float>

A list containing the values.

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public IndexDatapoint.SparseEmbedding.Builder toBuilder()
Returns
Type Description
IndexDatapoint.SparseEmbedding.Builder

writeTo(CodedOutputStream output)

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