IndexDatapoint.SparseEmbedding.Builder (proto-google-cloud-aiplatform-v1beta1 0.73.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderT>
  - - com.google.protobuf.GeneratedMessageV3.Builder<IndexDatapoint.SparseEmbedding.Builder>
    - - com.google.cloud.aiplatform.v1beta1.IndexDatapoint.SparseEmbedding.Builder

All Implemented Interfaces:

IndexDatapoint.SparseEmbeddingOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

IndexDatapoint.SparseEmbedding
```
public static final class IndexDatapoint.SparseEmbedding.Builder
extends com.google.protobuf.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.v1beta1.IndexDatapoint.SparseEmbedding

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`IndexDatapoint.SparseEmbedding.Builder`	`addAllDimensions(Iterable<? extends Long> values)` Required.
`IndexDatapoint.SparseEmbedding.Builder`	`addAllValues(Iterable<? extends Float> values)` Required.
`IndexDatapoint.SparseEmbedding.Builder`	`addDimensions(long value)` Required.
`IndexDatapoint.SparseEmbedding.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`IndexDatapoint.SparseEmbedding.Builder`	`addValues(float value)` Required.
`IndexDatapoint.SparseEmbedding`	`build()`
`IndexDatapoint.SparseEmbedding`	`buildPartial()`
`IndexDatapoint.SparseEmbedding.Builder`	`clear()`
`IndexDatapoint.SparseEmbedding.Builder`	`clearDimensions()` Required.
`IndexDatapoint.SparseEmbedding.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`IndexDatapoint.SparseEmbedding.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`IndexDatapoint.SparseEmbedding.Builder`	`clearValues()` Required.
`IndexDatapoint.SparseEmbedding.Builder`	`clone()`
`IndexDatapoint.SparseEmbedding`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`long`	`getDimensions(int index)` Required.
`int`	`getDimensionsCount()` Required.
`List<Long>`	`getDimensionsList()` Required.
`float`	`getValues(int index)` Required.
`int`	`getValuesCount()` Required.
`List<Float>`	`getValuesList()` Required.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`IndexDatapoint.SparseEmbedding.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`IndexDatapoint.SparseEmbedding.Builder`	`mergeFrom(IndexDatapoint.SparseEmbedding other)`
`IndexDatapoint.SparseEmbedding.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`IndexDatapoint.SparseEmbedding.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`IndexDatapoint.SparseEmbedding.Builder`	`setDimensions(int index, long value)` Required.
`IndexDatapoint.SparseEmbedding.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`IndexDatapoint.SparseEmbedding.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)`
`IndexDatapoint.SparseEmbedding.Builder`	`setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`IndexDatapoint.SparseEmbedding.Builder`	`setValues(int index, float value)` Required.

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFrom

- Method Detail
  - getDescriptor
```
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
```
  - internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
    Specified by:
    
    internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<IndexDatapoint.SparseEmbedding.Builder>
  - clear
```
public IndexDatapoint.SparseEmbedding.Builder clear()
```
    Specified by:
    
    clear in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    clear in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    clear in class com.google.protobuf.GeneratedMessageV3.Builder<IndexDatapoint.SparseEmbedding.Builder>
  - getDescriptorForType
```
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
```
    Specified by:
    
    getDescriptorForType in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
    
    Overrides:
    
    getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<IndexDatapoint.SparseEmbedding.Builder>
  - getDefaultInstanceForType
```
public IndexDatapoint.SparseEmbedding getDefaultInstanceForType()
```
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
    
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
  - build
```
public IndexDatapoint.SparseEmbedding build()
```
    Specified by:
    
    build in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    build in interface com.google.protobuf.MessageLite.Builder
  - buildPartial
```
public IndexDatapoint.SparseEmbedding buildPartial()
```
    Specified by:
    
    buildPartial in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    buildPartial in interface com.google.protobuf.MessageLite.Builder
  - clone
```
public IndexDatapoint.SparseEmbedding.Builder clone()
```
    Specified by:
    
    clone in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    clone in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    clone in class com.google.protobuf.GeneratedMessageV3.Builder<IndexDatapoint.SparseEmbedding.Builder>
  - setField
```
public IndexDatapoint.SparseEmbedding.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                       Object value)
```
    Specified by:
    
    setField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setField in class com.google.protobuf.GeneratedMessageV3.Builder<IndexDatapoint.SparseEmbedding.Builder>
  - clearField
```
public IndexDatapoint.SparseEmbedding.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
```
    Specified by:
    
    clearField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    clearField in class com.google.protobuf.GeneratedMessageV3.Builder<IndexDatapoint.SparseEmbedding.Builder>
  - clearOneof
```
public IndexDatapoint.SparseEmbedding.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
```
    Specified by:
    
    clearOneof in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<IndexDatapoint.SparseEmbedding.Builder>
  - setRepeatedField
```
public IndexDatapoint.SparseEmbedding.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                               int index,
                                                               Object value)
```
    Specified by:
    
    setRepeatedField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<IndexDatapoint.SparseEmbedding.Builder>
  - addRepeatedField
```
public IndexDatapoint.SparseEmbedding.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                               Object value)
```
    Specified by:
    
    addRepeatedField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<IndexDatapoint.SparseEmbedding.Builder>
  - mergeFrom
```
public IndexDatapoint.SparseEmbedding.Builder mergeFrom(com.google.protobuf.Message other)
```
    Specified by:
    
    mergeFrom in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    mergeFrom in class com.google.protobuf.AbstractMessage.Builder<IndexDatapoint.SparseEmbedding.Builder>
  - mergeFrom
```
public IndexDatapoint.SparseEmbedding.Builder mergeFrom(IndexDatapoint.SparseEmbedding other)
```
  - isInitialized
```
public final boolean isInitialized()
```
    Specified by:
    
    isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
    
    Overrides:
    
    isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<IndexDatapoint.SparseEmbedding.Builder>
  - mergeFrom
```
public IndexDatapoint.SparseEmbedding.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                 throws IOException
```
    Specified by:
    
    mergeFrom in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    mergeFrom in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    mergeFrom in class com.google.protobuf.AbstractMessage.Builder<IndexDatapoint.SparseEmbedding.Builder>
    
    Throws:
    
    IOException
  - getValuesList
```
public List<Float> getValuesList()
```
```
 Required. The list of embedding values of the sparse vector.
 
```
    repeated float values = 1 [(.google.api.field_behavior) = REQUIRED];
    Specified by:
    
    getValuesList in interface IndexDatapoint.SparseEmbeddingOrBuilder
    
    Returns:
    
    A list containing the values.
  - getValuesCount
```
public int getValuesCount()
```
```
 Required. The list of embedding values of the sparse vector.
 
```
    repeated float values = 1 [(.google.api.field_behavior) = REQUIRED];
    Specified by:
    
    getValuesCount in interface IndexDatapoint.SparseEmbeddingOrBuilder
    
    Returns:
    
    The count of values.
  - getValues
```
public float getValues(int index)
```
```
 Required. The list of embedding values of the sparse vector.
 
```
    repeated float values = 1 [(.google.api.field_behavior) = REQUIRED];
    Specified by:
    
    getValues in interface IndexDatapoint.SparseEmbeddingOrBuilder
    
    Parameters:
    
    index - The index of the element to return.
    
    Returns:
    
    The values at the given index.
  - setValues
```
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:
    
    index - The index to set the value at.
    
    value - The values to set.
    
    Returns:
    
    This builder for chaining.
  - addValues
```
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];
    Parameters:
    
    value - The values to add.
    
    Returns:
    
    This builder for chaining.
  - addAllValues
```
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];
    Parameters:
    
    values - The values to add.
    
    Returns:
    
    This builder for chaining.
  - 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:
    
    This builder for chaining.
  - 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];
    Specified by:
    
    getDimensionsList in interface IndexDatapoint.SparseEmbeddingOrBuilder
    
    Returns:
    
    A list containing the dimensions.
  - 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];
    Specified by:
    
    getDimensionsCount in interface IndexDatapoint.SparseEmbeddingOrBuilder
    
    Returns:
    
    The count of dimensions.
  - getDimensions
```
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];
    Specified by:
    
    getDimensions in interface IndexDatapoint.SparseEmbeddingOrBuilder
    
    Parameters:
    
    index - The index of the element to return.
    
    Returns:
    
    The dimensions at the given index.
  - setDimensions
```
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:
    
    index - The index to set the value at.
    
    value - The dimensions to set.
    
    Returns:
    
    This builder for chaining.
  - addDimensions
```
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];
    Parameters:
    
    value - The dimensions to add.
    
    Returns:
    
    This builder for chaining.
  - addAllDimensions
```
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];
    Parameters:
    
    values - The dimensions to add.
    
    Returns:
    
    This builder for chaining.
  - 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:
    
    This builder for chaining.
  - setUnknownFields
```
public final IndexDatapoint.SparseEmbedding.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
```
    Specified by:
    
    setUnknownFields in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<IndexDatapoint.SparseEmbedding.Builder>
  - mergeUnknownFields
```
public final IndexDatapoint.SparseEmbedding.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
```
    Specified by:
    
    mergeUnknownFields in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<IndexDatapoint.SparseEmbedding.Builder>

Class IndexDatapoint.SparseEmbedding.Builder

Method Summary

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Methods inherited from interface com.google.protobuf.Message.Builder

Method Detail

getDescriptor

internalGetFieldAccessorTable

clear

getDescriptorForType

getDefaultInstanceForType

build

buildPartial

clone

setField

clearField

clearOneof

setRepeatedField

addRepeatedField

mergeFrom

mergeFrom

isInitialized

mergeFrom

getValuesList

getValuesCount

getValues

setValues

addValues

addAllValues

clearValues

getDimensionsList

getDimensionsCount

getDimensions

setDimensions

addDimensions

addAllDimensions

clearDimensions

setUnknownFields

mergeUnknownFields