Class IndexDatapoint.SparseEmbedding.Builder (3.54.0)

Version 3.54.0

• 3.55.0 (latest)
• 3.54.0
• 3.53.0
• 3.52.0
• 3.50.0
• 3.49.0
• 3.48.0
• 3.47.0
• 3.46.0
• 3.45.0
• 3.44.0
• 3.43.0
• 3.42.0
• 3.41.0
• 3.40.0
• 3.38.0
• 3.37.0
• 3.36.0
• 3.35.0
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.30.0
• 3.29.0
• 3.28.0
• 3.25.0
• 3.24.0
• 3.23.0
• 3.22.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.0.0
• 2.9.8
• 2.8.9
• 2.7.4
• 2.5.3
• 2.4.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

Inheritance

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

Implements

IndexDatapoint.SparseEmbeddingOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

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

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

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

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

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.clear()

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

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearOneof(Descriptors.OneofDescriptor oneof)

public IndexDatapoint.SparseEmbedding.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
IndexDatapoint.SparseEmbedding.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

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

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public IndexDatapoint.SparseEmbedding getDefaultInstanceForType()

Returns
Type	Description
IndexDatapoint.SparseEmbedding

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

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

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final IndexDatapoint.SparseEmbedding.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
IndexDatapoint.SparseEmbedding.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

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

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final IndexDatapoint.SparseEmbedding.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
IndexDatapoint.SparseEmbedding.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)

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.