Interface CustomAttributeOrBuilder (2.56.0)

Version latest

• 2.56.0 (latest)
• 2.55.0
• 2.54.0
• 2.53.0
• 2.52.0
• 2.50.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.40.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.6
• 2.2.9

public interface CustomAttributeOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getFilterable()

public abstract boolean getFilterable()

If the filterable flag is true, the custom field values may be used for custom attribute filters JobQuery.custom_attribute_filter. If false, these values may not be used for custom attribute filters.

Default is false.

bool filterable = 3;

Returns
Type	Description
boolean	The filterable.

getKeywordSearchable()

public abstract boolean getKeywordSearchable()

If the keyword_searchable flag is true, the keywords in custom fields are searchable by keyword match. If false, the values are not searchable by keyword match.

Default is false.

bool keyword_searchable = 4;

Returns
Type	Description
boolean	The keywordSearchable.

getLongValues(int index)

public abstract long getLongValues(int index)

Exactly one of string_values or long_values must be specified.

This field is used to perform number range search. (EQ, GT, GE, LE, LT) over filterable long_value.

Currently at most 1 long_values is supported.

repeated int64 long_values = 2;

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
long	The longValues at the given index.

getLongValuesCount()

public abstract int getLongValuesCount()

Exactly one of string_values or long_values must be specified.

This field is used to perform number range search. (EQ, GT, GE, LE, LT) over filterable long_value.

Currently at most 1 long_values is supported.

repeated int64 long_values = 2;

Returns
Type	Description
int	The count of longValues.

getLongValuesList()

public abstract List<Long> getLongValuesList()

Exactly one of string_values or long_values must be specified.

This field is used to perform number range search. (EQ, GT, GE, LE, LT) over filterable long_value.

Currently at most 1 long_values is supported.

repeated int64 long_values = 2;

Returns
Type	Description
List<Long>	A list containing the longValues.

getStringValues(int index)

public abstract String getStringValues(int index)

Exactly one of string_values or long_values must be specified.

This field is used to perform a string match (CASE_SENSITIVE_MATCH or CASE_INSENSITIVE_MATCH) search. For filterable string_values, a maximum total number of 200 values is allowed, with each string_value has a byte size of no more than 500B. For unfilterable string_values, the maximum total byte size of unfilterable string_values is 50KB.

Empty string isn't allowed.

repeated string string_values = 1;

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The stringValues at the given index.

getStringValuesBytes(int index)

public abstract ByteString getStringValuesBytes(int index)

Exactly one of string_values or long_values must be specified.

This field is used to perform a string match (CASE_SENSITIVE_MATCH or CASE_INSENSITIVE_MATCH) search. For filterable string_values, a maximum total number of 200 values is allowed, with each string_value has a byte size of no more than 500B. For unfilterable string_values, the maximum total byte size of unfilterable string_values is 50KB.

Empty string isn't allowed.

repeated string string_values = 1;

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the stringValues at the given index.

getStringValuesCount()

public abstract int getStringValuesCount()

Exactly one of string_values or long_values must be specified.

This field is used to perform a string match (CASE_SENSITIVE_MATCH or CASE_INSENSITIVE_MATCH) search. For filterable string_values, a maximum total number of 200 values is allowed, with each string_value has a byte size of no more than 500B. For unfilterable string_values, the maximum total byte size of unfilterable string_values is 50KB.

Empty string isn't allowed.

repeated string string_values = 1;

Returns
Type	Description
int	The count of stringValues.

getStringValuesList()

public abstract List<String> getStringValuesList()

Exactly one of string_values or long_values must be specified.

This field is used to perform a string match (CASE_SENSITIVE_MATCH or CASE_INSENSITIVE_MATCH) search. For filterable string_values, a maximum total number of 200 values is allowed, with each string_value has a byte size of no more than 500B. For unfilterable string_values, the maximum total byte size of unfilterable string_values is 50KB.

Empty string isn't allowed.

repeated string string_values = 1;

Returns
Type	Description
List<String>	A list containing the stringValues.