Class NearestNeighborQuery.NumericFilter (3.53.0)

public static final class NearestNeighborQuery.NumericFilter extends GeneratedMessageV3 implements NearestNeighborQuery.NumericFilterOrBuilder

Numeric filter is used to search a subset of the entities by using boolean rules on numeric columns. For example: Database Point 0: {name: “a” value_int: 42} {name: “b” value_float: 1.0} Database Point 1: {name: “a” value_int: 10} {name: “b” value_float: 2.0} Database Point 2: {name: “a” value_int: -1} {name: “b” value_float: 3.0} Query: {name: “a” value_int: 12 operator: LESS} // Matches Point 1, 2 {name: “b” value_float: 2.0 operator: EQUAL} // Matches Point 1

Protobuf type google.cloud.aiplatform.v1.NearestNeighborQuery.NumericFilter

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > NearestNeighborQuery.NumericFilter

Static Fields

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

OP_FIELD_NUMBER

public static final int OP_FIELD_NUMBER
Field Value
Type Description
int

VALUE_DOUBLE_FIELD_NUMBER

public static final int VALUE_DOUBLE_FIELD_NUMBER
Field Value
Type Description
int

VALUE_FLOAT_FIELD_NUMBER

public static final int VALUE_FLOAT_FIELD_NUMBER
Field Value
Type Description
int

VALUE_INT_FIELD_NUMBER

public static final int VALUE_INT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static NearestNeighborQuery.NumericFilter getDefaultInstance()
Returns
Type Description
NearestNeighborQuery.NumericFilter

getDescriptor()

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

newBuilder()

public static NearestNeighborQuery.NumericFilter.Builder newBuilder()
Returns
Type Description
NearestNeighborQuery.NumericFilter.Builder

newBuilder(NearestNeighborQuery.NumericFilter prototype)

public static NearestNeighborQuery.NumericFilter.Builder newBuilder(NearestNeighborQuery.NumericFilter prototype)
Parameter
Name Description
prototype NearestNeighborQuery.NumericFilter
Returns
Type Description
NearestNeighborQuery.NumericFilter.Builder

parseDelimitedFrom(InputStream input)

public static NearestNeighborQuery.NumericFilter parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
NearestNeighborQuery.NumericFilter
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static NearestNeighborQuery.NumericFilter parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
NearestNeighborQuery.NumericFilter
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static NearestNeighborQuery.NumericFilter parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
NearestNeighborQuery.NumericFilter
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static NearestNeighborQuery.NumericFilter parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
NearestNeighborQuery.NumericFilter
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static NearestNeighborQuery.NumericFilter parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
NearestNeighborQuery.NumericFilter
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<NearestNeighborQuery.NumericFilter> parser()
Returns
Type Description
Parser<NumericFilter>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public NearestNeighborQuery.NumericFilter getDefaultInstanceForType()
Returns
Type Description
NearestNeighborQuery.NumericFilter

getName()

public String getName()

Required. Column name in BigQuery that used as filters.

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. Column name in BigQuery that used as filters.

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

Returns
Type Description
ByteString

The bytes for name.

getOp()

public NearestNeighborQuery.NumericFilter.Operator getOp()

Optional. This MUST be specified for queries and must NOT be specified for database points.

optional .google.cloud.aiplatform.v1.NearestNeighborQuery.NumericFilter.Operator op = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
NearestNeighborQuery.NumericFilter.Operator

The op.

getOpValue()

public int getOpValue()

Optional. This MUST be specified for queries and must NOT be specified for database points.

optional .google.cloud.aiplatform.v1.NearestNeighborQuery.NumericFilter.Operator op = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for op.

getParserForType()

public Parser<NearestNeighborQuery.NumericFilter> getParserForType()
Returns
Type Description
Parser<NumericFilter>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getValueCase()

public NearestNeighborQuery.NumericFilter.ValueCase getValueCase()
Returns
Type Description
NearestNeighborQuery.NumericFilter.ValueCase

getValueDouble()

public double getValueDouble()

double value type.

double value_double = 4;

Returns
Type Description
double

The valueDouble.

getValueFloat()

public float getValueFloat()

float value type.

float value_float = 3;

Returns
Type Description
float

The valueFloat.

getValueInt()

public long getValueInt()

int value type.

int64 value_int = 2;

Returns
Type Description
long

The valueInt.

hasOp()

public boolean hasOp()

Optional. This MUST be specified for queries and must NOT be specified for database points.

optional .google.cloud.aiplatform.v1.NearestNeighborQuery.NumericFilter.Operator op = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the op field is set.

hasValueDouble()

public boolean hasValueDouble()

double value type.

double value_double = 4;

Returns
Type Description
boolean

Whether the valueDouble field is set.

hasValueFloat()

public boolean hasValueFloat()

float value type.

float value_float = 3;

Returns
Type Description
boolean

Whether the valueFloat field is set.

hasValueInt()

public boolean hasValueInt()

int value type.

int64 value_int = 2;

Returns
Type Description
boolean

Whether the valueInt field is set.

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 NearestNeighborQuery.NumericFilter.Builder newBuilderForType()
Returns
Type Description
NearestNeighborQuery.NumericFilter.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected NearestNeighborQuery.NumericFilter.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
NearestNeighborQuery.NumericFilter.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public NearestNeighborQuery.NumericFilter.Builder toBuilder()
Returns
Type Description
NearestNeighborQuery.NumericFilter.Builder

writeTo(CodedOutputStream output)

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