Class IndexDatapoint.CrowdingTag (3.50.0)

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

CROWDING_ATTRIBUTE_FIELD_NUMBER

public static final int CROWDING_ATTRIBUTE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static IndexDatapoint.CrowdingTag getDefaultInstance()
Returns
Type Description
IndexDatapoint.CrowdingTag

getDescriptor()

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

newBuilder()

public static IndexDatapoint.CrowdingTag.Builder newBuilder()
Returns
Type Description
IndexDatapoint.CrowdingTag.Builder

newBuilder(IndexDatapoint.CrowdingTag prototype)

public static IndexDatapoint.CrowdingTag.Builder newBuilder(IndexDatapoint.CrowdingTag prototype)
Parameter
Name Description
prototype IndexDatapoint.CrowdingTag
Returns
Type Description
IndexDatapoint.CrowdingTag.Builder

parseDelimitedFrom(InputStream input)

public static IndexDatapoint.CrowdingTag parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
IndexDatapoint.CrowdingTag
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static IndexDatapoint.CrowdingTag parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
IndexDatapoint.CrowdingTag
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static IndexDatapoint.CrowdingTag parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
IndexDatapoint.CrowdingTag
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static IndexDatapoint.CrowdingTag parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
IndexDatapoint.CrowdingTag
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static IndexDatapoint.CrowdingTag parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
IndexDatapoint.CrowdingTag
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static IndexDatapoint.CrowdingTag parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
IndexDatapoint.CrowdingTag
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static IndexDatapoint.CrowdingTag parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
IndexDatapoint.CrowdingTag
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static IndexDatapoint.CrowdingTag parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
IndexDatapoint.CrowdingTag
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static IndexDatapoint.CrowdingTag parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
IndexDatapoint.CrowdingTag
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static IndexDatapoint.CrowdingTag parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
IndexDatapoint.CrowdingTag
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static IndexDatapoint.CrowdingTag parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
IndexDatapoint.CrowdingTag
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static IndexDatapoint.CrowdingTag parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
IndexDatapoint.CrowdingTag
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<IndexDatapoint.CrowdingTag> parser()
Returns
Type Description
Parser<CrowdingTag>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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

getParserForType()

public Parser<IndexDatapoint.CrowdingTag> getParserForType()
Returns
Type Description
Parser<CrowdingTag>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public IndexDatapoint.CrowdingTag.Builder newBuilderForType()
Returns
Type Description
IndexDatapoint.CrowdingTag.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected IndexDatapoint.CrowdingTag.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
IndexDatapoint.CrowdingTag.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public IndexDatapoint.CrowdingTag.Builder toBuilder()
Returns
Type Description
IndexDatapoint.CrowdingTag.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException