Class Criteria.Builder (0.12.0)

public static final class Criteria.Builder extends GeneratedMessageV3.Builder<Criteria.Builder> implements CriteriaOrBuilder

Filter criteria applied to current search results.

Protobuf type google.cloud.visionai.v1.Criteria

Implements

CriteriaOrBuilder

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public Criteria build()
Returns
Type Description
Criteria

buildPartial()

public Criteria buildPartial()
Returns
Type Description
Criteria

clear()

public Criteria.Builder clear()
Returns
Type Description
Criteria.Builder
Overrides

clearBoolValue()

public Criteria.Builder clearBoolValue()

A Boolean value.

.google.cloud.visionai.v1.BoolValue bool_value = 7;

Returns
Type Description
Criteria.Builder

clearDateTimeRangeArray()

public Criteria.Builder clearDateTimeRangeArray()

The datetime ranges associated with the field.

.google.cloud.visionai.v1.DateTimeRangeArray date_time_range_array = 5;

Returns
Type Description
Criteria.Builder

clearFetchMatchedAnnotations()

public Criteria.Builder clearFetchMatchedAnnotations()

If true, return query matched annotations for this criteria. This option is only applicable for inclusion criteria, i.e., not exclusion criteria, with partition level annotations. It supports the following data types:

  • INTEGER
  • FLOAT
  • STRING (DataSchema.SearchStrategy.EXACT_SEARCH only)
  • BOOLEAN

bool fetch_matched_annotations = 8;

Returns
Type Description
Criteria.Builder

This builder for chaining.

clearField()

public Criteria.Builder clearField()

The UGA field or ML field to apply filtering criteria.

string field = 1;

Returns
Type Description
Criteria.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearFloatRangeArray()

public Criteria.Builder clearFloatRangeArray()

The float ranges associated with the field.

.google.cloud.visionai.v1.FloatRangeArray float_range_array = 4;

Returns
Type Description
Criteria.Builder

clearGeoLocationArray()

public Criteria.Builder clearGeoLocationArray()

Geo Location array.

.google.cloud.visionai.v1.GeoLocationArray geo_location_array = 6;

Returns
Type Description
Criteria.Builder

clearIntRangeArray()

public Criteria.Builder clearIntRangeArray()

The integer ranges associated with the field.

.google.cloud.visionai.v1.IntRangeArray int_range_array = 3;

Returns
Type Description
Criteria.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearTextArray()

public Criteria.Builder clearTextArray()

The text values associated with the field.

.google.cloud.visionai.v1.StringArray text_array = 2;

Returns
Type Description
Criteria.Builder

clearValue()

public Criteria.Builder clearValue()
Returns
Type Description
Criteria.Builder

clone()

public Criteria.Builder clone()
Returns
Type Description
Criteria.Builder
Overrides

getBoolValue()

public BoolValue getBoolValue()

A Boolean value.

.google.cloud.visionai.v1.BoolValue bool_value = 7;

Returns
Type Description
BoolValue

The boolValue.

getBoolValueBuilder()

public BoolValue.Builder getBoolValueBuilder()

A Boolean value.

.google.cloud.visionai.v1.BoolValue bool_value = 7;

Returns
Type Description
BoolValue.Builder

getBoolValueOrBuilder()

public BoolValueOrBuilder getBoolValueOrBuilder()

A Boolean value.

.google.cloud.visionai.v1.BoolValue bool_value = 7;

Returns
Type Description
BoolValueOrBuilder

getDateTimeRangeArray()

public DateTimeRangeArray getDateTimeRangeArray()

The datetime ranges associated with the field.

.google.cloud.visionai.v1.DateTimeRangeArray date_time_range_array = 5;

Returns
Type Description
DateTimeRangeArray

The dateTimeRangeArray.

getDateTimeRangeArrayBuilder()

public DateTimeRangeArray.Builder getDateTimeRangeArrayBuilder()

The datetime ranges associated with the field.

.google.cloud.visionai.v1.DateTimeRangeArray date_time_range_array = 5;

Returns
Type Description
DateTimeRangeArray.Builder

getDateTimeRangeArrayOrBuilder()

public DateTimeRangeArrayOrBuilder getDateTimeRangeArrayOrBuilder()

The datetime ranges associated with the field.

.google.cloud.visionai.v1.DateTimeRangeArray date_time_range_array = 5;

Returns
Type Description
DateTimeRangeArrayOrBuilder

getDefaultInstanceForType()

public Criteria getDefaultInstanceForType()
Returns
Type Description
Criteria

getDescriptorForType()

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

getFetchMatchedAnnotations()

public boolean getFetchMatchedAnnotations()

If true, return query matched annotations for this criteria. This option is only applicable for inclusion criteria, i.e., not exclusion criteria, with partition level annotations. It supports the following data types:

  • INTEGER
  • FLOAT
  • STRING (DataSchema.SearchStrategy.EXACT_SEARCH only)
  • BOOLEAN

bool fetch_matched_annotations = 8;

Returns
Type Description
boolean

The fetchMatchedAnnotations.

getField()

public String getField()

The UGA field or ML field to apply filtering criteria.

string field = 1;

Returns
Type Description
String

The field.

getFieldBytes()

public ByteString getFieldBytes()

The UGA field or ML field to apply filtering criteria.

string field = 1;

Returns
Type Description
ByteString

The bytes for field.

getFloatRangeArray()

public FloatRangeArray getFloatRangeArray()

The float ranges associated with the field.

.google.cloud.visionai.v1.FloatRangeArray float_range_array = 4;

Returns
Type Description
FloatRangeArray

The floatRangeArray.

getFloatRangeArrayBuilder()

public FloatRangeArray.Builder getFloatRangeArrayBuilder()

The float ranges associated with the field.

.google.cloud.visionai.v1.FloatRangeArray float_range_array = 4;

Returns
Type Description
FloatRangeArray.Builder

getFloatRangeArrayOrBuilder()

public FloatRangeArrayOrBuilder getFloatRangeArrayOrBuilder()

The float ranges associated with the field.

.google.cloud.visionai.v1.FloatRangeArray float_range_array = 4;

Returns
Type Description
FloatRangeArrayOrBuilder

getGeoLocationArray()

public GeoLocationArray getGeoLocationArray()

Geo Location array.

.google.cloud.visionai.v1.GeoLocationArray geo_location_array = 6;

Returns
Type Description
GeoLocationArray

The geoLocationArray.

getGeoLocationArrayBuilder()

public GeoLocationArray.Builder getGeoLocationArrayBuilder()

Geo Location array.

.google.cloud.visionai.v1.GeoLocationArray geo_location_array = 6;

Returns
Type Description
GeoLocationArray.Builder

getGeoLocationArrayOrBuilder()

public GeoLocationArrayOrBuilder getGeoLocationArrayOrBuilder()

Geo Location array.

.google.cloud.visionai.v1.GeoLocationArray geo_location_array = 6;

Returns
Type Description
GeoLocationArrayOrBuilder

getIntRangeArray()

public IntRangeArray getIntRangeArray()

The integer ranges associated with the field.

.google.cloud.visionai.v1.IntRangeArray int_range_array = 3;

Returns
Type Description
IntRangeArray

The intRangeArray.

getIntRangeArrayBuilder()

public IntRangeArray.Builder getIntRangeArrayBuilder()

The integer ranges associated with the field.

.google.cloud.visionai.v1.IntRangeArray int_range_array = 3;

Returns
Type Description
IntRangeArray.Builder

getIntRangeArrayOrBuilder()

public IntRangeArrayOrBuilder getIntRangeArrayOrBuilder()

The integer ranges associated with the field.

.google.cloud.visionai.v1.IntRangeArray int_range_array = 3;

Returns
Type Description
IntRangeArrayOrBuilder

getTextArray()

public StringArray getTextArray()

The text values associated with the field.

.google.cloud.visionai.v1.StringArray text_array = 2;

Returns
Type Description
StringArray

The textArray.

getTextArrayBuilder()

public StringArray.Builder getTextArrayBuilder()

The text values associated with the field.

.google.cloud.visionai.v1.StringArray text_array = 2;

Returns
Type Description
StringArray.Builder

getTextArrayOrBuilder()

public StringArrayOrBuilder getTextArrayOrBuilder()

The text values associated with the field.

.google.cloud.visionai.v1.StringArray text_array = 2;

Returns
Type Description
StringArrayOrBuilder

getValueCase()

public Criteria.ValueCase getValueCase()
Returns
Type Description
Criteria.ValueCase

hasBoolValue()

public boolean hasBoolValue()

A Boolean value.

.google.cloud.visionai.v1.BoolValue bool_value = 7;

Returns
Type Description
boolean

Whether the boolValue field is set.

hasDateTimeRangeArray()

public boolean hasDateTimeRangeArray()

The datetime ranges associated with the field.

.google.cloud.visionai.v1.DateTimeRangeArray date_time_range_array = 5;

Returns
Type Description
boolean

Whether the dateTimeRangeArray field is set.

hasFloatRangeArray()

public boolean hasFloatRangeArray()

The float ranges associated with the field.

.google.cloud.visionai.v1.FloatRangeArray float_range_array = 4;

Returns
Type Description
boolean

Whether the floatRangeArray field is set.

hasGeoLocationArray()

public boolean hasGeoLocationArray()

Geo Location array.

.google.cloud.visionai.v1.GeoLocationArray geo_location_array = 6;

Returns
Type Description
boolean

Whether the geoLocationArray field is set.

hasIntRangeArray()

public boolean hasIntRangeArray()

The integer ranges associated with the field.

.google.cloud.visionai.v1.IntRangeArray int_range_array = 3;

Returns
Type Description
boolean

Whether the intRangeArray field is set.

hasTextArray()

public boolean hasTextArray()

The text values associated with the field.

.google.cloud.visionai.v1.StringArray text_array = 2;

Returns
Type Description
boolean

Whether the textArray field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeBoolValue(BoolValue value)

public Criteria.Builder mergeBoolValue(BoolValue value)

A Boolean value.

.google.cloud.visionai.v1.BoolValue bool_value = 7;

Parameter
Name Description
value BoolValue
Returns
Type Description
Criteria.Builder

mergeDateTimeRangeArray(DateTimeRangeArray value)

public Criteria.Builder mergeDateTimeRangeArray(DateTimeRangeArray value)

The datetime ranges associated with the field.

.google.cloud.visionai.v1.DateTimeRangeArray date_time_range_array = 5;

Parameter
Name Description
value DateTimeRangeArray
Returns
Type Description
Criteria.Builder

mergeFloatRangeArray(FloatRangeArray value)

public Criteria.Builder mergeFloatRangeArray(FloatRangeArray value)

The float ranges associated with the field.

.google.cloud.visionai.v1.FloatRangeArray float_range_array = 4;

Parameter
Name Description
value FloatRangeArray
Returns
Type Description
Criteria.Builder

mergeFrom(Criteria other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeGeoLocationArray(GeoLocationArray value)

public Criteria.Builder mergeGeoLocationArray(GeoLocationArray value)

Geo Location array.

.google.cloud.visionai.v1.GeoLocationArray geo_location_array = 6;

Parameter
Name Description
value GeoLocationArray
Returns
Type Description
Criteria.Builder

mergeIntRangeArray(IntRangeArray value)

public Criteria.Builder mergeIntRangeArray(IntRangeArray value)

The integer ranges associated with the field.

.google.cloud.visionai.v1.IntRangeArray int_range_array = 3;

Parameter
Name Description
value IntRangeArray
Returns
Type Description
Criteria.Builder

mergeTextArray(StringArray value)

public Criteria.Builder mergeTextArray(StringArray value)

The text values associated with the field.

.google.cloud.visionai.v1.StringArray text_array = 2;

Parameter
Name Description
value StringArray
Returns
Type Description
Criteria.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setBoolValue(BoolValue value)

public Criteria.Builder setBoolValue(BoolValue value)

A Boolean value.

.google.cloud.visionai.v1.BoolValue bool_value = 7;

Parameter
Name Description
value BoolValue
Returns
Type Description
Criteria.Builder

setBoolValue(BoolValue.Builder builderForValue)

public Criteria.Builder setBoolValue(BoolValue.Builder builderForValue)

A Boolean value.

.google.cloud.visionai.v1.BoolValue bool_value = 7;

Parameter
Name Description
builderForValue BoolValue.Builder
Returns
Type Description
Criteria.Builder

setDateTimeRangeArray(DateTimeRangeArray value)

public Criteria.Builder setDateTimeRangeArray(DateTimeRangeArray value)

The datetime ranges associated with the field.

.google.cloud.visionai.v1.DateTimeRangeArray date_time_range_array = 5;

Parameter
Name Description
value DateTimeRangeArray
Returns
Type Description
Criteria.Builder

setDateTimeRangeArray(DateTimeRangeArray.Builder builderForValue)

public Criteria.Builder setDateTimeRangeArray(DateTimeRangeArray.Builder builderForValue)

The datetime ranges associated with the field.

.google.cloud.visionai.v1.DateTimeRangeArray date_time_range_array = 5;

Parameter
Name Description
builderForValue DateTimeRangeArray.Builder
Returns
Type Description
Criteria.Builder

setFetchMatchedAnnotations(boolean value)

public Criteria.Builder setFetchMatchedAnnotations(boolean value)

If true, return query matched annotations for this criteria. This option is only applicable for inclusion criteria, i.e., not exclusion criteria, with partition level annotations. It supports the following data types:

  • INTEGER
  • FLOAT
  • STRING (DataSchema.SearchStrategy.EXACT_SEARCH only)
  • BOOLEAN

bool fetch_matched_annotations = 8;

Parameter
Name Description
value boolean

The fetchMatchedAnnotations to set.

Returns
Type Description
Criteria.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setField(String value)

public Criteria.Builder setField(String value)

The UGA field or ML field to apply filtering criteria.

string field = 1;

Parameter
Name Description
value String

The field to set.

Returns
Type Description
Criteria.Builder

This builder for chaining.

setFieldBytes(ByteString value)

public Criteria.Builder setFieldBytes(ByteString value)

The UGA field or ML field to apply filtering criteria.

string field = 1;

Parameter
Name Description
value ByteString

The bytes for field to set.

Returns
Type Description
Criteria.Builder

This builder for chaining.

setFloatRangeArray(FloatRangeArray value)

public Criteria.Builder setFloatRangeArray(FloatRangeArray value)

The float ranges associated with the field.

.google.cloud.visionai.v1.FloatRangeArray float_range_array = 4;

Parameter
Name Description
value FloatRangeArray
Returns
Type Description
Criteria.Builder

setFloatRangeArray(FloatRangeArray.Builder builderForValue)

public Criteria.Builder setFloatRangeArray(FloatRangeArray.Builder builderForValue)

The float ranges associated with the field.

.google.cloud.visionai.v1.FloatRangeArray float_range_array = 4;

Parameter
Name Description
builderForValue FloatRangeArray.Builder
Returns
Type Description
Criteria.Builder

setGeoLocationArray(GeoLocationArray value)

public Criteria.Builder setGeoLocationArray(GeoLocationArray value)

Geo Location array.

.google.cloud.visionai.v1.GeoLocationArray geo_location_array = 6;

Parameter
Name Description
value GeoLocationArray
Returns
Type Description
Criteria.Builder

setGeoLocationArray(GeoLocationArray.Builder builderForValue)

public Criteria.Builder setGeoLocationArray(GeoLocationArray.Builder builderForValue)

Geo Location array.

.google.cloud.visionai.v1.GeoLocationArray geo_location_array = 6;

Parameter
Name Description
builderForValue GeoLocationArray.Builder
Returns
Type Description
Criteria.Builder

setIntRangeArray(IntRangeArray value)

public Criteria.Builder setIntRangeArray(IntRangeArray value)

The integer ranges associated with the field.

.google.cloud.visionai.v1.IntRangeArray int_range_array = 3;

Parameter
Name Description
value IntRangeArray
Returns
Type Description
Criteria.Builder

setIntRangeArray(IntRangeArray.Builder builderForValue)

public Criteria.Builder setIntRangeArray(IntRangeArray.Builder builderForValue)

The integer ranges associated with the field.

.google.cloud.visionai.v1.IntRangeArray int_range_array = 3;

Parameter
Name Description
builderForValue IntRangeArray.Builder
Returns
Type Description
Criteria.Builder

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

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

setTextArray(StringArray value)

public Criteria.Builder setTextArray(StringArray value)

The text values associated with the field.

.google.cloud.visionai.v1.StringArray text_array = 2;

Parameter
Name Description
value StringArray
Returns
Type Description
Criteria.Builder

setTextArray(StringArray.Builder builderForValue)

public Criteria.Builder setTextArray(StringArray.Builder builderForValue)

The text values associated with the field.

.google.cloud.visionai.v1.StringArray text_array = 2;

Parameter
Name Description
builderForValue StringArray.Builder
Returns
Type Description
Criteria.Builder

setUnknownFields(UnknownFieldSet unknownFields)

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