Class NearestNeighborQuery.NumericFilter.Builder (3.48.0)

public static final class NearestNeighborQuery.NumericFilter.Builder extends GeneratedMessageV3.Builder<NearestNeighborQuery.NumericFilter.Builder> 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

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

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

buildPartial()

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

clear()

public NearestNeighborQuery.NumericFilter.Builder clear()
Returns
Type Description
NearestNeighborQuery.NumericFilter.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public NearestNeighborQuery.NumericFilter.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
NearestNeighborQuery.NumericFilter.Builder
Overrides

clearName()

public NearestNeighborQuery.NumericFilter.Builder clearName()

Required. Column name in BigQuery that used as filters.

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

Returns
Type Description
NearestNeighborQuery.NumericFilter.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public NearestNeighborQuery.NumericFilter.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
NearestNeighborQuery.NumericFilter.Builder
Overrides

clearOp()

public NearestNeighborQuery.NumericFilter.Builder clearOp()

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.Builder

This builder for chaining.

clearValue()

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

clearValueDouble()

public NearestNeighborQuery.NumericFilter.Builder clearValueDouble()

double value type.

double value_double = 4;

Returns
Type Description
NearestNeighborQuery.NumericFilter.Builder

This builder for chaining.

clearValueFloat()

public NearestNeighborQuery.NumericFilter.Builder clearValueFloat()

float value type.

float value_float = 3;

Returns
Type Description
NearestNeighborQuery.NumericFilter.Builder

This builder for chaining.

clearValueInt()

public NearestNeighborQuery.NumericFilter.Builder clearValueInt()

int value type.

int64 value_int = 2;

Returns
Type Description
NearestNeighborQuery.NumericFilter.Builder

This builder for chaining.

clone()

public NearestNeighborQuery.NumericFilter.Builder clone()
Returns
Type Description
NearestNeighborQuery.NumericFilter.Builder
Overrides

getDefaultInstanceForType()

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

getDescriptorForType()

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

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.

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(NearestNeighborQuery.NumericFilter other)

public NearestNeighborQuery.NumericFilter.Builder mergeFrom(NearestNeighborQuery.NumericFilter other)
Parameter
Name Description
other NearestNeighborQuery.NumericFilter
Returns
Type Description
NearestNeighborQuery.NumericFilter.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

public NearestNeighborQuery.NumericFilter.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
NearestNeighborQuery.NumericFilter.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final NearestNeighborQuery.NumericFilter.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
NearestNeighborQuery.NumericFilter.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

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

setName(String value)

public NearestNeighborQuery.NumericFilter.Builder setName(String value)

Required. Column name in BigQuery that used as filters.

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

Parameter
Name Description
value String

The name to set.

Returns
Type Description
NearestNeighborQuery.NumericFilter.Builder

This builder for chaining.

setNameBytes(ByteString value)

public NearestNeighborQuery.NumericFilter.Builder setNameBytes(ByteString value)

Required. Column name in BigQuery that used as filters.

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

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
NearestNeighborQuery.NumericFilter.Builder

This builder for chaining.

setOp(NearestNeighborQuery.NumericFilter.Operator value)

public NearestNeighborQuery.NumericFilter.Builder setOp(NearestNeighborQuery.NumericFilter.Operator value)

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];

Parameter
Name Description
value NearestNeighborQuery.NumericFilter.Operator

The op to set.

Returns
Type Description
NearestNeighborQuery.NumericFilter.Builder

This builder for chaining.

setOpValue(int value)

public NearestNeighborQuery.NumericFilter.Builder setOpValue(int value)

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];

Parameter
Name Description
value int

The enum numeric value on the wire for op to set.

Returns
Type Description
NearestNeighborQuery.NumericFilter.Builder

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

public final NearestNeighborQuery.NumericFilter.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
NearestNeighborQuery.NumericFilter.Builder
Overrides

setValueDouble(double value)

public NearestNeighborQuery.NumericFilter.Builder setValueDouble(double value)

double value type.

double value_double = 4;

Parameter
Name Description
value double

The valueDouble to set.

Returns
Type Description
NearestNeighborQuery.NumericFilter.Builder

This builder for chaining.

setValueFloat(float value)

public NearestNeighborQuery.NumericFilter.Builder setValueFloat(float value)

float value type.

float value_float = 3;

Parameter
Name Description
value float

The valueFloat to set.

Returns
Type Description
NearestNeighborQuery.NumericFilter.Builder

This builder for chaining.

setValueInt(long value)

public NearestNeighborQuery.NumericFilter.Builder setValueInt(long value)

int value type.

int64 value_int = 2;

Parameter
Name Description
value long

The valueInt to set.

Returns
Type Description
NearestNeighborQuery.NumericFilter.Builder

This builder for chaining.