Interface EntityType.EntityOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
EntityType.Entity, EntityType.Entity.Builder
Enclosing class:
EntityType

public static interface EntityType.EntityOrBuilder extends com.google.protobuf.MessageOrBuilder
  • Method Summary

    Modifier and Type
    Method
    Description
    getSynonyms(int index)
    Required.
    com.google.protobuf.ByteString
    getSynonymsBytes(int index)
    Required.
    int
    Required.
    Required.
    Required.
    com.google.protobuf.ByteString
    Required.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
  • Method Details

    • getValue

      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 reference 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:
      The value.
    • getValueBytes

      com.google.protobuf.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 reference 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:
      The bytes for value.
    • getSynonymsList

      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:
      A list containing the synonyms.
    • getSynonymsCount

      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:
      The count of synonyms.
    • getSynonyms

      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];
      Parameters:
      index - The index of the element to return.
      Returns:
      The synonyms at the given index.
    • getSynonymsBytes

      com.google.protobuf.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];
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the synonyms at the given index.