Class IndexDatapoint.Builder (3.7.0)

public static final class IndexDatapoint.Builder extends GeneratedMessageV3.Builder<IndexDatapoint.Builder> implements IndexDatapointOrBuilder

A datapoint of Index.

Protobuf type google.cloud.aiplatform.v1.IndexDatapoint

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addAllFeatureVector(Iterable<? extends Float> values)

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

Required. Feature embedding vector. An array of numbers with the length of [NearestNeighborSearchConfig.dimensions].

repeated float feature_vector = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valuesIterable<? extends java.lang.Float>

The featureVector to add.

Returns
TypeDescription
IndexDatapoint.Builder

This builder for chaining.

addAllRestricts(Iterable<? extends IndexDatapoint.Restriction> values)

public IndexDatapoint.Builder addAllRestricts(Iterable<? extends IndexDatapoint.Restriction> values)

Optional. List of Restrict of the datapoint, used to perform "restricted searches" where boolean rule are used to filter the subset of the database eligible for matching. See: https://cloud.google.com/vertex-ai/docs/matching-engine/filtering

repeated .google.cloud.aiplatform.v1.IndexDatapoint.Restriction restricts = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valuesIterable<? extends com.google.cloud.aiplatform.v1.IndexDatapoint.Restriction>
Returns
TypeDescription
IndexDatapoint.Builder

addFeatureVector(float value)

public IndexDatapoint.Builder addFeatureVector(float value)

Required. Feature embedding vector. An array of numbers with the length of [NearestNeighborSearchConfig.dimensions].

repeated float feature_vector = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valuefloat

The featureVector to add.

Returns
TypeDescription
IndexDatapoint.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public IndexDatapoint.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
IndexDatapoint.Builder
Overrides

addRestricts(IndexDatapoint.Restriction value)

public IndexDatapoint.Builder addRestricts(IndexDatapoint.Restriction value)

Optional. List of Restrict of the datapoint, used to perform "restricted searches" where boolean rule are used to filter the subset of the database eligible for matching. See: https://cloud.google.com/vertex-ai/docs/matching-engine/filtering

repeated .google.cloud.aiplatform.v1.IndexDatapoint.Restriction restricts = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueIndexDatapoint.Restriction
Returns
TypeDescription
IndexDatapoint.Builder

addRestricts(IndexDatapoint.Restriction.Builder builderForValue)

public IndexDatapoint.Builder addRestricts(IndexDatapoint.Restriction.Builder builderForValue)

Optional. List of Restrict of the datapoint, used to perform "restricted searches" where boolean rule are used to filter the subset of the database eligible for matching. See: https://cloud.google.com/vertex-ai/docs/matching-engine/filtering

repeated .google.cloud.aiplatform.v1.IndexDatapoint.Restriction restricts = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
builderForValueIndexDatapoint.Restriction.Builder
Returns
TypeDescription
IndexDatapoint.Builder

addRestricts(int index, IndexDatapoint.Restriction value)

public IndexDatapoint.Builder addRestricts(int index, IndexDatapoint.Restriction value)

Optional. List of Restrict of the datapoint, used to perform "restricted searches" where boolean rule are used to filter the subset of the database eligible for matching. See: https://cloud.google.com/vertex-ai/docs/matching-engine/filtering

repeated .google.cloud.aiplatform.v1.IndexDatapoint.Restriction restricts = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameters
NameDescription
indexint
valueIndexDatapoint.Restriction
Returns
TypeDescription
IndexDatapoint.Builder

addRestricts(int index, IndexDatapoint.Restriction.Builder builderForValue)

public IndexDatapoint.Builder addRestricts(int index, IndexDatapoint.Restriction.Builder builderForValue)

Optional. List of Restrict of the datapoint, used to perform "restricted searches" where boolean rule are used to filter the subset of the database eligible for matching. See: https://cloud.google.com/vertex-ai/docs/matching-engine/filtering

repeated .google.cloud.aiplatform.v1.IndexDatapoint.Restriction restricts = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameters
NameDescription
indexint
builderForValueIndexDatapoint.Restriction.Builder
Returns
TypeDescription
IndexDatapoint.Builder

addRestrictsBuilder()

public IndexDatapoint.Restriction.Builder addRestrictsBuilder()

Optional. List of Restrict of the datapoint, used to perform "restricted searches" where boolean rule are used to filter the subset of the database eligible for matching. See: https://cloud.google.com/vertex-ai/docs/matching-engine/filtering

repeated .google.cloud.aiplatform.v1.IndexDatapoint.Restriction restricts = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
IndexDatapoint.Restriction.Builder

addRestrictsBuilder(int index)

public IndexDatapoint.Restriction.Builder addRestrictsBuilder(int index)

Optional. List of Restrict of the datapoint, used to perform "restricted searches" where boolean rule are used to filter the subset of the database eligible for matching. See: https://cloud.google.com/vertex-ai/docs/matching-engine/filtering

repeated .google.cloud.aiplatform.v1.IndexDatapoint.Restriction restricts = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
indexint
Returns
TypeDescription
IndexDatapoint.Restriction.Builder

build()

public IndexDatapoint build()
Returns
TypeDescription
IndexDatapoint

buildPartial()

public IndexDatapoint buildPartial()
Returns
TypeDescription
IndexDatapoint

clear()

public IndexDatapoint.Builder clear()
Returns
TypeDescription
IndexDatapoint.Builder
Overrides

clearCrowdingTag()

public IndexDatapoint.Builder clearCrowdingTag()

Optional. CrowdingTag of the datapoint, the number of neighbors to return in each crowding can be configured during query.

.google.cloud.aiplatform.v1.IndexDatapoint.CrowdingTag crowding_tag = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
IndexDatapoint.Builder

clearDatapointId()

public IndexDatapoint.Builder clearDatapointId()

Required. Unique identifier of the datapoint.

string datapoint_id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
IndexDatapoint.Builder

This builder for chaining.

clearFeatureVector()

public IndexDatapoint.Builder clearFeatureVector()

Required. Feature embedding vector. An array of numbers with the length of [NearestNeighborSearchConfig.dimensions].

repeated float feature_vector = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
IndexDatapoint.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public IndexDatapoint.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
IndexDatapoint.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public IndexDatapoint.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
IndexDatapoint.Builder
Overrides

clearRestricts()

public IndexDatapoint.Builder clearRestricts()

Optional. List of Restrict of the datapoint, used to perform "restricted searches" where boolean rule are used to filter the subset of the database eligible for matching. See: https://cloud.google.com/vertex-ai/docs/matching-engine/filtering

repeated .google.cloud.aiplatform.v1.IndexDatapoint.Restriction restricts = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
IndexDatapoint.Builder

clone()

public IndexDatapoint.Builder clone()
Returns
TypeDescription
IndexDatapoint.Builder
Overrides

getCrowdingTag()

public IndexDatapoint.CrowdingTag getCrowdingTag()

Optional. CrowdingTag of the datapoint, the number of neighbors to return in each crowding can be configured during query.

.google.cloud.aiplatform.v1.IndexDatapoint.CrowdingTag crowding_tag = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
IndexDatapoint.CrowdingTag

The crowdingTag.

getCrowdingTagBuilder()

public IndexDatapoint.CrowdingTag.Builder getCrowdingTagBuilder()

Optional. CrowdingTag of the datapoint, the number of neighbors to return in each crowding can be configured during query.

.google.cloud.aiplatform.v1.IndexDatapoint.CrowdingTag crowding_tag = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
IndexDatapoint.CrowdingTag.Builder

getCrowdingTagOrBuilder()

public IndexDatapoint.CrowdingTagOrBuilder getCrowdingTagOrBuilder()

Optional. CrowdingTag of the datapoint, the number of neighbors to return in each crowding can be configured during query.

.google.cloud.aiplatform.v1.IndexDatapoint.CrowdingTag crowding_tag = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
IndexDatapoint.CrowdingTagOrBuilder

getDatapointId()

public String getDatapointId()

Required. Unique identifier of the datapoint.

string datapoint_id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
String

The datapointId.

getDatapointIdBytes()

public ByteString getDatapointIdBytes()

Required. Unique identifier of the datapoint.

string datapoint_id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ByteString

The bytes for datapointId.

getDefaultInstanceForType()

public IndexDatapoint getDefaultInstanceForType()
Returns
TypeDescription
IndexDatapoint

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getFeatureVector(int index)

public float getFeatureVector(int index)

Required. Feature embedding vector. An array of numbers with the length of [NearestNeighborSearchConfig.dimensions].

repeated float feature_vector = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
float

The featureVector at the given index.

getFeatureVectorCount()

public int getFeatureVectorCount()

Required. Feature embedding vector. An array of numbers with the length of [NearestNeighborSearchConfig.dimensions].

repeated float feature_vector = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
int

The count of featureVector.

getFeatureVectorList()

public List<Float> getFeatureVectorList()

Required. Feature embedding vector. An array of numbers with the length of [NearestNeighborSearchConfig.dimensions].

repeated float feature_vector = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
List<Float>

A list containing the featureVector.

getRestricts(int index)

public IndexDatapoint.Restriction getRestricts(int index)

Optional. List of Restrict of the datapoint, used to perform "restricted searches" where boolean rule are used to filter the subset of the database eligible for matching. See: https://cloud.google.com/vertex-ai/docs/matching-engine/filtering

repeated .google.cloud.aiplatform.v1.IndexDatapoint.Restriction restricts = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
indexint
Returns
TypeDescription
IndexDatapoint.Restriction

getRestrictsBuilder(int index)

public IndexDatapoint.Restriction.Builder getRestrictsBuilder(int index)

Optional. List of Restrict of the datapoint, used to perform "restricted searches" where boolean rule are used to filter the subset of the database eligible for matching. See: https://cloud.google.com/vertex-ai/docs/matching-engine/filtering

repeated .google.cloud.aiplatform.v1.IndexDatapoint.Restriction restricts = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
indexint
Returns
TypeDescription
IndexDatapoint.Restriction.Builder

getRestrictsBuilderList()

public List<IndexDatapoint.Restriction.Builder> getRestrictsBuilderList()

Optional. List of Restrict of the datapoint, used to perform "restricted searches" where boolean rule are used to filter the subset of the database eligible for matching. See: https://cloud.google.com/vertex-ai/docs/matching-engine/filtering

repeated .google.cloud.aiplatform.v1.IndexDatapoint.Restriction restricts = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
List<Builder>

getRestrictsCount()

public int getRestrictsCount()

Optional. List of Restrict of the datapoint, used to perform "restricted searches" where boolean rule are used to filter the subset of the database eligible for matching. See: https://cloud.google.com/vertex-ai/docs/matching-engine/filtering

repeated .google.cloud.aiplatform.v1.IndexDatapoint.Restriction restricts = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
int

getRestrictsList()

public List<IndexDatapoint.Restriction> getRestrictsList()

Optional. List of Restrict of the datapoint, used to perform "restricted searches" where boolean rule are used to filter the subset of the database eligible for matching. See: https://cloud.google.com/vertex-ai/docs/matching-engine/filtering

repeated .google.cloud.aiplatform.v1.IndexDatapoint.Restriction restricts = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
List<Restriction>

getRestrictsOrBuilder(int index)

public IndexDatapoint.RestrictionOrBuilder getRestrictsOrBuilder(int index)

Optional. List of Restrict of the datapoint, used to perform "restricted searches" where boolean rule are used to filter the subset of the database eligible for matching. See: https://cloud.google.com/vertex-ai/docs/matching-engine/filtering

repeated .google.cloud.aiplatform.v1.IndexDatapoint.Restriction restricts = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
indexint
Returns
TypeDescription
IndexDatapoint.RestrictionOrBuilder

getRestrictsOrBuilderList()

public List<? extends IndexDatapoint.RestrictionOrBuilder> getRestrictsOrBuilderList()

Optional. List of Restrict of the datapoint, used to perform "restricted searches" where boolean rule are used to filter the subset of the database eligible for matching. See: https://cloud.google.com/vertex-ai/docs/matching-engine/filtering

repeated .google.cloud.aiplatform.v1.IndexDatapoint.Restriction restricts = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
List<? extends com.google.cloud.aiplatform.v1.IndexDatapoint.RestrictionOrBuilder>

hasCrowdingTag()

public boolean hasCrowdingTag()

Optional. CrowdingTag of the datapoint, the number of neighbors to return in each crowding can be configured during query.

.google.cloud.aiplatform.v1.IndexDatapoint.CrowdingTag crowding_tag = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
boolean

Whether the crowdingTag field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeCrowdingTag(IndexDatapoint.CrowdingTag value)

public IndexDatapoint.Builder mergeCrowdingTag(IndexDatapoint.CrowdingTag value)

Optional. CrowdingTag of the datapoint, the number of neighbors to return in each crowding can be configured during query.

.google.cloud.aiplatform.v1.IndexDatapoint.CrowdingTag crowding_tag = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueIndexDatapoint.CrowdingTag
Returns
TypeDescription
IndexDatapoint.Builder

mergeFrom(IndexDatapoint other)

public IndexDatapoint.Builder mergeFrom(IndexDatapoint other)
Parameter
NameDescription
otherIndexDatapoint
Returns
TypeDescription
IndexDatapoint.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public IndexDatapoint.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
IndexDatapoint.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public IndexDatapoint.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
IndexDatapoint.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final IndexDatapoint.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
IndexDatapoint.Builder
Overrides

removeRestricts(int index)

public IndexDatapoint.Builder removeRestricts(int index)

Optional. List of Restrict of the datapoint, used to perform "restricted searches" where boolean rule are used to filter the subset of the database eligible for matching. See: https://cloud.google.com/vertex-ai/docs/matching-engine/filtering

repeated .google.cloud.aiplatform.v1.IndexDatapoint.Restriction restricts = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
indexint
Returns
TypeDescription
IndexDatapoint.Builder

setCrowdingTag(IndexDatapoint.CrowdingTag value)

public IndexDatapoint.Builder setCrowdingTag(IndexDatapoint.CrowdingTag value)

Optional. CrowdingTag of the datapoint, the number of neighbors to return in each crowding can be configured during query.

.google.cloud.aiplatform.v1.IndexDatapoint.CrowdingTag crowding_tag = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueIndexDatapoint.CrowdingTag
Returns
TypeDescription
IndexDatapoint.Builder

setCrowdingTag(IndexDatapoint.CrowdingTag.Builder builderForValue)

public IndexDatapoint.Builder setCrowdingTag(IndexDatapoint.CrowdingTag.Builder builderForValue)

Optional. CrowdingTag of the datapoint, the number of neighbors to return in each crowding can be configured during query.

.google.cloud.aiplatform.v1.IndexDatapoint.CrowdingTag crowding_tag = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
builderForValueIndexDatapoint.CrowdingTag.Builder
Returns
TypeDescription
IndexDatapoint.Builder

setDatapointId(String value)

public IndexDatapoint.Builder setDatapointId(String value)

Required. Unique identifier of the datapoint.

string datapoint_id = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueString

The datapointId to set.

Returns
TypeDescription
IndexDatapoint.Builder

This builder for chaining.

setDatapointIdBytes(ByteString value)

public IndexDatapoint.Builder setDatapointIdBytes(ByteString value)

Required. Unique identifier of the datapoint.

string datapoint_id = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueByteString

The bytes for datapointId to set.

Returns
TypeDescription
IndexDatapoint.Builder

This builder for chaining.

setFeatureVector(int index, float value)

public IndexDatapoint.Builder setFeatureVector(int index, float value)

Required. Feature embedding vector. An array of numbers with the length of [NearestNeighborSearchConfig.dimensions].

repeated float feature_vector = 2 [(.google.api.field_behavior) = REQUIRED];

Parameters
NameDescription
indexint

The index to set the value at.

valuefloat

The featureVector to set.

Returns
TypeDescription
IndexDatapoint.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public IndexDatapoint.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
IndexDatapoint.Builder
Overrides

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

public IndexDatapoint.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
IndexDatapoint.Builder
Overrides

setRestricts(int index, IndexDatapoint.Restriction value)

public IndexDatapoint.Builder setRestricts(int index, IndexDatapoint.Restriction value)

Optional. List of Restrict of the datapoint, used to perform "restricted searches" where boolean rule are used to filter the subset of the database eligible for matching. See: https://cloud.google.com/vertex-ai/docs/matching-engine/filtering

repeated .google.cloud.aiplatform.v1.IndexDatapoint.Restriction restricts = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameters
NameDescription
indexint
valueIndexDatapoint.Restriction
Returns
TypeDescription
IndexDatapoint.Builder

setRestricts(int index, IndexDatapoint.Restriction.Builder builderForValue)

public IndexDatapoint.Builder setRestricts(int index, IndexDatapoint.Restriction.Builder builderForValue)

Optional. List of Restrict of the datapoint, used to perform "restricted searches" where boolean rule are used to filter the subset of the database eligible for matching. See: https://cloud.google.com/vertex-ai/docs/matching-engine/filtering

repeated .google.cloud.aiplatform.v1.IndexDatapoint.Restriction restricts = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameters
NameDescription
indexint
builderForValueIndexDatapoint.Restriction.Builder
Returns
TypeDescription
IndexDatapoint.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final IndexDatapoint.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
IndexDatapoint.Builder
Overrides