Class IndexDatapoint.SparseEmbedding.Builder (3.52.0)

public static final class IndexDatapoint.SparseEmbedding.Builder extends GeneratedMessageV3.Builder<IndexDatapoint.SparseEmbedding.Builder> 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

Static Methods

getDescriptor()

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

Methods

addAllDimensions(Iterable<? extends Long> values)

public IndexDatapoint.SparseEmbedding.Builder addAllDimensions(Iterable<? extends Long> values)

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
values Iterable<? extends java.lang.Long>

The dimensions to add.

Returns
Type Description
IndexDatapoint.SparseEmbedding.Builder

This builder for chaining.

addAllValues(Iterable<? extends Float> values)

public IndexDatapoint.SparseEmbedding.Builder addAllValues(Iterable<? extends Float> values)

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

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

Parameter
Name Description
values Iterable<? extends java.lang.Float>

The values to add.

Returns
Type Description
IndexDatapoint.SparseEmbedding.Builder

This builder for chaining.

addDimensions(long value)

public IndexDatapoint.SparseEmbedding.Builder addDimensions(long value)

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
value long

The dimensions to add.

Returns
Type Description
IndexDatapoint.SparseEmbedding.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public IndexDatapoint.SparseEmbedding.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
IndexDatapoint.SparseEmbedding.Builder
Overrides

addValues(float value)

public IndexDatapoint.SparseEmbedding.Builder addValues(float value)

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

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

Parameter
Name Description
value float

The values to add.

Returns
Type Description
IndexDatapoint.SparseEmbedding.Builder

This builder for chaining.

build()

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

buildPartial()

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

clear()

public IndexDatapoint.SparseEmbedding.Builder clear()
Returns
Type Description
IndexDatapoint.SparseEmbedding.Builder
Overrides

clearDimensions()

public IndexDatapoint.SparseEmbedding.Builder clearDimensions()

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
IndexDatapoint.SparseEmbedding.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public IndexDatapoint.SparseEmbedding.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
IndexDatapoint.SparseEmbedding.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public IndexDatapoint.SparseEmbedding.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
IndexDatapoint.SparseEmbedding.Builder
Overrides

clearValues()

public IndexDatapoint.SparseEmbedding.Builder clearValues()

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

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

Returns
Type Description
IndexDatapoint.SparseEmbedding.Builder

This builder for chaining.

clone()

public IndexDatapoint.SparseEmbedding.Builder clone()
Returns
Type Description
IndexDatapoint.SparseEmbedding.Builder
Overrides

getDefaultInstanceForType()

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(IndexDatapoint.SparseEmbedding other)

public IndexDatapoint.SparseEmbedding.Builder mergeFrom(IndexDatapoint.SparseEmbedding other)
Parameter
Name Description
other IndexDatapoint.SparseEmbedding
Returns
Type Description
IndexDatapoint.SparseEmbedding.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public IndexDatapoint.SparseEmbedding.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
IndexDatapoint.SparseEmbedding.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public IndexDatapoint.SparseEmbedding.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
IndexDatapoint.SparseEmbedding.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final IndexDatapoint.SparseEmbedding.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
IndexDatapoint.SparseEmbedding.Builder
Overrides

setDimensions(int index, long value)

public IndexDatapoint.SparseEmbedding.Builder setDimensions(int index, long value)

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

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

Parameters
Name Description
index int

The index to set the value at.

value long

The dimensions to set.

Returns
Type Description
IndexDatapoint.SparseEmbedding.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public IndexDatapoint.SparseEmbedding.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
IndexDatapoint.SparseEmbedding.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public IndexDatapoint.SparseEmbedding.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
IndexDatapoint.SparseEmbedding.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final IndexDatapoint.SparseEmbedding.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
IndexDatapoint.SparseEmbedding.Builder
Overrides

setValues(int index, float value)

public IndexDatapoint.SparseEmbedding.Builder setValues(int index, float value)

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

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

Parameters
Name Description
index int

The index to set the value at.

value float

The values to set.

Returns
Type Description
IndexDatapoint.SparseEmbedding.Builder

This builder for chaining.