Class IndexDatapoint.CrowdingTag.Builder (3.47.0)

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

Crowding tag is a constraint on a neighbor list produced by nearest neighbor search requiring that no more than some value k' of the k neighbors returned have the same value of crowding_attribute.

Protobuf type google.cloud.aiplatform.v1.IndexDatapoint.CrowdingTag

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

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

buildPartial()

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

clear()

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

clearCrowdingAttribute()

public IndexDatapoint.CrowdingTag.Builder clearCrowdingAttribute()

The attribute value used for crowding. The maximum number of neighbors to return per crowding attribute value (per_crowding_attribute_num_neighbors) is configured per-query. This field is ignored if per_crowding_attribute_num_neighbors is larger than the total number of neighbors to return for a given query.

string crowding_attribute = 1;

Returns
Type Description
IndexDatapoint.CrowdingTag.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clone()

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

getCrowdingAttribute()

public String getCrowdingAttribute()

The attribute value used for crowding. The maximum number of neighbors to return per crowding attribute value (per_crowding_attribute_num_neighbors) is configured per-query. This field is ignored if per_crowding_attribute_num_neighbors is larger than the total number of neighbors to return for a given query.

string crowding_attribute = 1;

Returns
Type Description
String

The crowdingAttribute.

getCrowdingAttributeBytes()

public ByteString getCrowdingAttributeBytes()

The attribute value used for crowding. The maximum number of neighbors to return per crowding attribute value (per_crowding_attribute_num_neighbors) is configured per-query. This field is ignored if per_crowding_attribute_num_neighbors is larger than the total number of neighbors to return for a given query.

string crowding_attribute = 1;

Returns
Type Description
ByteString

The bytes for crowdingAttribute.

getDefaultInstanceForType()

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

getDescriptorForType()

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

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(IndexDatapoint.CrowdingTag other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setCrowdingAttribute(String value)

public IndexDatapoint.CrowdingTag.Builder setCrowdingAttribute(String value)

The attribute value used for crowding. The maximum number of neighbors to return per crowding attribute value (per_crowding_attribute_num_neighbors) is configured per-query. This field is ignored if per_crowding_attribute_num_neighbors is larger than the total number of neighbors to return for a given query.

string crowding_attribute = 1;

Parameter
Name Description
value String

The crowdingAttribute to set.

Returns
Type Description
IndexDatapoint.CrowdingTag.Builder

This builder for chaining.

setCrowdingAttributeBytes(ByteString value)

public IndexDatapoint.CrowdingTag.Builder setCrowdingAttributeBytes(ByteString value)

The attribute value used for crowding. The maximum number of neighbors to return per crowding attribute value (per_crowding_attribute_num_neighbors) is configured per-query. This field is ignored if per_crowding_attribute_num_neighbors is larger than the total number of neighbors to return for a given query.

string crowding_attribute = 1;

Parameter
Name Description
value ByteString

The bytes for crowdingAttribute to set.

Returns
Type Description
IndexDatapoint.CrowdingTag.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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