Class IndexDatapoint.SparseEmbedding (3.47.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

Implements

IndexDatapoint.SparseEmbeddingOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

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

AbstractMessage.hashLong(long)

AbstractMessage.toString()

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

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

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

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

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

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

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

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

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

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

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

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

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

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

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

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

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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

AbstractMessage.equals(Object other)

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

GeneratedMessageV3.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
`int`

Overrides

GeneratedMessageV3.getSerializedSize()

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

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.isInitialized()

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

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
`unused`	`UnusedPrivateParameter`

Returns
Type	Description
`Object`

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
`IOException`