Class SearchCriteriaProperty.Builder (0.40.0) 

public static final class SearchCriteriaProperty.Builder extends GeneratedMessage.Builder<SearchCriteriaProperty.Builder> implements SearchCriteriaPropertyOrBuilder

Central configuration for custom search criteria.

Protobuf type google.cloud.visionai.v1.SearchCriteriaProperty

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > SearchCriteriaProperty.Builder

Static Methods

getDescriptor()

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

Methods

addAllMappedFields(Iterable<String> values)

public SearchCriteriaProperty.Builder addAllMappedFields(Iterable<String> values)

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
values Iterable<String>

The mappedFields to add.
Returns
Type Description
SearchCriteriaProperty.Builder

This builder for chaining.

addMappedFields(String value)

public SearchCriteriaProperty.Builder addMappedFields(String value)

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
value String

The mappedFields to add.
Returns
Type Description
SearchCriteriaProperty.Builder

This builder for chaining.

addMappedFieldsBytes(ByteString value)

public SearchCriteriaProperty.Builder addMappedFieldsBytes(ByteString value)

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
value ByteString

The bytes of the mappedFields to add.
Returns
Type Description
SearchCriteriaProperty.Builder

This builder for chaining.

build()

public SearchCriteriaProperty build()
Returns
Type Description
SearchCriteriaProperty

buildPartial()

public SearchCriteriaProperty buildPartial()
Returns
Type Description
SearchCriteriaProperty

clear()

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

clearMappedFields()

public SearchCriteriaProperty.Builder clearMappedFields()

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

This builder for chaining.

getDefaultInstanceForType()

public SearchCriteriaProperty getDefaultInstanceForType()
Returns
Type Description
SearchCriteriaProperty

getDescriptorForType()

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

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(SearchCriteriaProperty other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

setMappedFields(int index, String value)

public SearchCriteriaProperty.Builder setMappedFields(int index, String value)

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;

Parameters
Name Description
index int

The index to set the value at.
value String

The mappedFields to set.
Returns
Type Description
SearchCriteriaProperty.Builder

This builder for chaining.