Class IndexDatapoint.CrowdingTag (3.20.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
TypeDescription
int

Static Methods

getDefaultInstance()

public static IndexDatapoint.CrowdingTag getDefaultInstance()
Returns
TypeDescription
IndexDatapoint.CrowdingTag

getDescriptor()

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

newBuilder()

public static IndexDatapoint.CrowdingTag.Builder newBuilder()
Returns
TypeDescription
IndexDatapoint.CrowdingTag.Builder

newBuilder(IndexDatapoint.CrowdingTag prototype)

public static IndexDatapoint.CrowdingTag.Builder newBuilder(IndexDatapoint.CrowdingTag prototype)
Parameter
NameDescription
prototypeIndexDatapoint.CrowdingTag
Returns
TypeDescription
IndexDatapoint.CrowdingTag.Builder

parseDelimitedFrom(InputStream input)

public static IndexDatapoint.CrowdingTag parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
IndexDatapoint.CrowdingTag
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static IndexDatapoint.CrowdingTag parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
IndexDatapoint.CrowdingTag
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static IndexDatapoint.CrowdingTag parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
IndexDatapoint.CrowdingTag
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static IndexDatapoint.CrowdingTag parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
IndexDatapoint.CrowdingTag
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static IndexDatapoint.CrowdingTag parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
IndexDatapoint.CrowdingTag
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static IndexDatapoint.CrowdingTag parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
IndexDatapoint.CrowdingTag
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static IndexDatapoint.CrowdingTag parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
IndexDatapoint.CrowdingTag
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static IndexDatapoint.CrowdingTag parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
IndexDatapoint.CrowdingTag
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static IndexDatapoint.CrowdingTag parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
IndexDatapoint.CrowdingTag
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static IndexDatapoint.CrowdingTag parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
IndexDatapoint.CrowdingTag
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static IndexDatapoint.CrowdingTag parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
IndexDatapoint.CrowdingTag
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static IndexDatapoint.CrowdingTag parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
IndexDatapoint.CrowdingTag
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for crowdingAttribute.

getDefaultInstanceForType()

public IndexDatapoint.CrowdingTag getDefaultInstanceForType()
Returns
TypeDescription
IndexDatapoint.CrowdingTag

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public IndexDatapoint.CrowdingTag.Builder newBuilderForType()
Returns
TypeDescription
IndexDatapoint.CrowdingTag.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected IndexDatapoint.CrowdingTag.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
IndexDatapoint.CrowdingTag.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public IndexDatapoint.CrowdingTag.Builder toBuilder()
Returns
TypeDescription
IndexDatapoint.CrowdingTag.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException