Package com.google.cloud.documentai.v1beta3

Interface DocumentSchema.EntityType.PropertyOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
DocumentSchema.EntityType.Property, DocumentSchema.EntityType.Property.Builder
Enclosing class:
DocumentSchema.EntityType
public static interface DocumentSchema.EntityType.PropertyOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

      String getName()
       The name of the property.  Follows the same guidelines as the
 EntityType name.
      string name = 1;
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       The name of the property.  Follows the same guidelines as the
 EntityType name.
      string name = 1;
      Returns:
      The bytes for name.

    • getDescription

      String getDescription()
       The description of the property. Could be used to provide more
 information about the property for model calls.
      string description = 7;
      Returns:
      The description.

    • getDescriptionBytes

      com.google.protobuf.ByteString getDescriptionBytes()
       The description of the property. Could be used to provide more
 information about the property for model calls.
      string description = 7;
      Returns:
      The bytes for description.

    • getDisplayName

      String getDisplayName()
       User defined name for the property.
      string display_name = 6;
      Returns:
      The displayName.

    • getDisplayNameBytes

      com.google.protobuf.ByteString getDisplayNameBytes()
       User defined name for the property.
      string display_name = 6;
      Returns:
      The bytes for displayName.

    • getValueType

      String getValueType()
       A reference to the value type of the property.  This type is subject
 to the same conventions as the `Entity.base_types` field.
      string value_type = 2;
      Returns:
      The valueType.

    • getValueTypeBytes

      com.google.protobuf.ByteString getValueTypeBytes()
       A reference to the value type of the property.  This type is subject
 to the same conventions as the `Entity.base_types` field.
      string value_type = 2;
      Returns:
      The bytes for valueType.

    • getOccurrenceTypeValue

      int getOccurrenceTypeValue()
       Occurrence type limits the number of instances an entity type appears
 in the document.
      .google.cloud.documentai.v1beta3.DocumentSchema.EntityType.Property.OccurrenceType occurrence_type = 3;
      Returns:
      The enum numeric value on the wire for occurrenceType.

    • getOccurrenceType

      DocumentSchema.EntityType.Property.OccurrenceType getOccurrenceType()
       Occurrence type limits the number of instances an entity type appears
 in the document.
      .google.cloud.documentai.v1beta3.DocumentSchema.EntityType.Property.OccurrenceType occurrence_type = 3;
      Returns:
      The occurrenceType.

    • getMethodValue

      int getMethodValue()
       Specifies how the entity's value is obtained.
      .google.cloud.documentai.v1beta3.DocumentSchema.EntityType.Property.Method method = 8;
      Returns:
      The enum numeric value on the wire for method.

    • getMethod

      DocumentSchema.EntityType.Property.Method getMethod()
       Specifies how the entity's value is obtained.
      .google.cloud.documentai.v1beta3.DocumentSchema.EntityType.Property.Method method = 8;
      Returns:
      The method.

    • hasPropertyMetadata

      boolean hasPropertyMetadata()
       Any additional metadata about the property can be added here.
      .google.cloud.documentai.v1beta3.PropertyMetadata property_metadata = 5;
      Returns:
      Whether the propertyMetadata field is set.

    • getPropertyMetadata

      PropertyMetadata getPropertyMetadata()
       Any additional metadata about the property can be added here.
      .google.cloud.documentai.v1beta3.PropertyMetadata property_metadata = 5;
      Returns:
      The propertyMetadata.

    • getPropertyMetadataOrBuilder

      PropertyMetadataOrBuilder getPropertyMetadataOrBuilder()
       Any additional metadata about the property can be added here.
      .google.cloud.documentai.v1beta3.PropertyMetadata property_metadata = 5;