Class Criteria (0.2.0)

public final class Criteria extends GeneratedMessageV3 implements CriteriaOrBuilder

Filter criteria applied to current search results.

Protobuf type google.cloud.visionai.v1.Criteria

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Criteria

Implements

CriteriaOrBuilder

Static Fields

BOOL_VALUE_FIELD_NUMBER

public static final int BOOL_VALUE_FIELD_NUMBER
Field Value
Type Description
int

DATE_TIME_RANGE_ARRAY_FIELD_NUMBER

public static final int DATE_TIME_RANGE_ARRAY_FIELD_NUMBER
Field Value
Type Description
int

FETCH_MATCHED_ANNOTATIONS_FIELD_NUMBER

public static final int FETCH_MATCHED_ANNOTATIONS_FIELD_NUMBER
Field Value
Type Description
int

FIELD_FIELD_NUMBER

public static final int FIELD_FIELD_NUMBER
Field Value
Type Description
int

FLOAT_RANGE_ARRAY_FIELD_NUMBER

public static final int FLOAT_RANGE_ARRAY_FIELD_NUMBER
Field Value
Type Description
int

GEO_LOCATION_ARRAY_FIELD_NUMBER

public static final int GEO_LOCATION_ARRAY_FIELD_NUMBER
Field Value
Type Description
int

INT_RANGE_ARRAY_FIELD_NUMBER

public static final int INT_RANGE_ARRAY_FIELD_NUMBER
Field Value
Type Description
int

TEXT_ARRAY_FIELD_NUMBER

public static final int TEXT_ARRAY_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Criteria getDefaultInstance()
Returns
Type Description
Criteria

getDescriptor()

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

newBuilder()

public static Criteria.Builder newBuilder()
Returns
Type Description
Criteria.Builder

newBuilder(Criteria prototype)

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

parseDelimitedFrom(InputStream input)

public static Criteria parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Criteria
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static Criteria parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Criteria
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static Criteria parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Criteria
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static Criteria parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Criteria
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static Criteria parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Criteria
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<Criteria> parser()
Returns
Type Description
Parser<Criteria>

Methods

equals(Object obj)

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

getBoolValue()

public BoolValue getBoolValue()

A Boolean value.

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

Returns
Type Description
BoolValue

The boolValue.

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.

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

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.

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.

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.

getIntRangeArrayOrBuilder()

public IntRangeArrayOrBuilder getIntRangeArrayOrBuilder()

The integer ranges associated with the field.

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

Returns
Type Description
IntRangeArrayOrBuilder

getParserForType()

public Parser<Criteria> getParserForType()
Returns
Type Description
Parser<Criteria>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

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.

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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