Interface EntityType.EntityOrBuilder (0.40.0)

Version 0.40.0

• 0.64.0 (latest)
• 0.63.0
• 0.62.0
• 0.60.0
• 0.59.0
• 0.58.0
• 0.57.0
• 0.56.0
• 0.55.0
• 0.54.0
• 0.53.0
• 0.52.0
• 0.51.0
• 0.50.0
• 0.48.0
• 0.47.0
• 0.46.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.7
• 0.13.1
• 0.12.1
• 0.11.5

public static interface EntityType.EntityOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getSynonyms(int index)

public abstract String getSynonyms(int index)

Required. A collection of value synonyms. For example, if the entity type is vegetable, and value is scallions, a synonym could be green onions.

For KIND_LIST entity types:

• This collection must contain exactly one synonym equal to value.

repeated string synonyms = 2 [(.google.api.field_behavior) = REQUIRED];

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

Returns
Type	Description
String	The synonyms at the given index.

getSynonymsBytes(int index)

public abstract ByteString getSynonymsBytes(int index)

Required. A collection of value synonyms. For example, if the entity type is vegetable, and value is scallions, a synonym could be green onions.

For KIND_LIST entity types:

• This collection must contain exactly one synonym equal to value.

repeated string synonyms = 2 [(.google.api.field_behavior) = REQUIRED];

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

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

getSynonymsCount()

public abstract int getSynonymsCount()

Required. A collection of value synonyms. For example, if the entity type is vegetable, and value is scallions, a synonym could be green onions.

For KIND_LIST entity types:

• This collection must contain exactly one synonym equal to value.

repeated string synonyms = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
int	The count of synonyms.

getSynonymsList()

public abstract List<String> getSynonymsList()

Required. A collection of value synonyms. For example, if the entity type is vegetable, and value is scallions, a synonym could be green onions.

For KIND_LIST entity types:

• This collection must contain exactly one synonym equal to value.

repeated string synonyms = 2 [(.google.api.field_behavior) = REQUIRED];

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

getValue()

public abstract String getValue()

Required. The primary value associated with this entity entry. For example, if the entity type is vegetable, the value could be scallions.

For KIND_MAP entity types:

• A canonical value to be used in place of synonyms.

  For KIND_LIST entity types:

• A string that can contain references to other entity types (with or without aliases).

string value = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The value.

getValueBytes()

public abstract ByteString getValueBytes()

Required. The primary value associated with this entity entry. For example, if the entity type is vegetable, the value could be scallions.

For KIND_MAP entity types:

• A canonical value to be used in place of synonyms.

  For KIND_LIST entity types:

• A string that can contain references to other entity types (with or without aliases).

string value = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for value.