Class SearchCriteriaProperty (0.5.0)

public final class SearchCriteriaProperty extends GeneratedMessageV3 implements SearchCriteriaPropertyOrBuilder

Central configuration for custom search criteria.

Protobuf type google.cloud.visionai.v1.SearchCriteriaProperty

Static Fields

MAPPED_FIELDS_FIELD_NUMBER

public static final int MAPPED_FIELDS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SearchCriteriaProperty getDefaultInstance()
Returns
Type Description
SearchCriteriaProperty

getDescriptor()

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

newBuilder()

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

newBuilder(SearchCriteriaProperty prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public SearchCriteriaProperty getDefaultInstanceForType()
Returns
Type Description
SearchCriteriaProperty

getMappedFields(int index)

public String getMappedFields(int index)

Each mapped_field corresponds to a UGA key. To understand how this property works, take the following example. In the SearchConfig table, the user adds this entry: search_config { name: "person" search_criteria_property { mapped_fields: "player" mapped_fields: "coach" } }

Now, when a user issues a query like: criteria { field: "person" text_array { txt_values: "Tom Brady" txt_values: "Bill Belichick" } }

MWH search will return search documents where (player=Tom Brady || coach=Tom Brady || player=Bill Belichick || coach=Bill Belichick).

repeated string mapped_fields = 1;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The mappedFields at the given index.

getMappedFieldsBytes(int index)

public ByteString getMappedFieldsBytes(int index)

Each mapped_field corresponds to a UGA key. To understand how this property works, take the following example. In the SearchConfig table, the user adds this entry: search_config { name: "person" search_criteria_property { mapped_fields: "player" mapped_fields: "coach" } }

Now, when a user issues a query like: criteria { field: "person" text_array { txt_values: "Tom Brady" txt_values: "Bill Belichick" } }

MWH search will return search documents where (player=Tom Brady || coach=Tom Brady || player=Bill Belichick || coach=Bill Belichick).

repeated string mapped_fields = 1;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the mappedFields at the given index.

getMappedFieldsCount()

public int getMappedFieldsCount()

Each mapped_field corresponds to a UGA key. To understand how this property works, take the following example. In the SearchConfig table, the user adds this entry: search_config { name: "person" search_criteria_property { mapped_fields: "player" mapped_fields: "coach" } }

Now, when a user issues a query like: criteria { field: "person" text_array { txt_values: "Tom Brady" txt_values: "Bill Belichick" } }

MWH search will return search documents where (player=Tom Brady || coach=Tom Brady || player=Bill Belichick || coach=Bill Belichick).

repeated string mapped_fields = 1;

Returns
Type Description
int

The count of mappedFields.

getMappedFieldsList()

public ProtocolStringList getMappedFieldsList()

Each mapped_field corresponds to a UGA key. To understand how this property works, take the following example. In the SearchConfig table, the user adds this entry: search_config { name: "person" search_criteria_property { mapped_fields: "player" mapped_fields: "coach" } }

Now, when a user issues a query like: criteria { field: "person" text_array { txt_values: "Tom Brady" txt_values: "Bill Belichick" } }

MWH search will return search documents where (player=Tom Brady || coach=Tom Brady || player=Bill Belichick || coach=Bill Belichick).

repeated string mapped_fields = 1;

Returns
Type Description
ProtocolStringList

A list containing the mappedFields.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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