Package com.google.cloud.documentai.v1

Class DocumentSchema.EntityType.Property

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.documentai.v1.DocumentSchema.EntityType.Property
All Implemented Interfaces:
DocumentSchema.EntityType.PropertyOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
Enclosing class:
DocumentSchema.EntityType
public static final class DocumentSchema.EntityType.Property extends com.google.protobuf.GeneratedMessage implements DocumentSchema.EntityType.PropertyOrBuilder
 Defines properties that can be part of the entity type.
Protobuf type google.cloud.documentai.v1.DocumentSchema.EntityType.Property
See Also:

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • DISPLAY_NAME_FIELD_NUMBER

      public static final int DISPLAY_NAME_FIELD_NUMBER
      See Also:

    • VALUE_TYPE_FIELD_NUMBER

      public static final int VALUE_TYPE_FIELD_NUMBER
      See Also:

    • OCCURRENCE_TYPE_FIELD_NUMBER

      public static final int OCCURRENCE_TYPE_FIELD_NUMBER
      See Also:

    • METHOD_FIELD_NUMBER

      public static final int METHOD_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getName

      public String getName()
       The name of the property.  Follows the same guidelines as the
 EntityType name.
      string name = 1;
      Specified by:
      getName in interface DocumentSchema.EntityType.PropertyOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       The name of the property.  Follows the same guidelines as the
 EntityType name.
      string name = 1;
      Specified by:
      getNameBytes in interface DocumentSchema.EntityType.PropertyOrBuilder
      Returns:
      The bytes for name.

    • getDisplayName

      public String getDisplayName()
       User defined name for the property.
      string display_name = 6;
      Specified by:
      getDisplayName in interface DocumentSchema.EntityType.PropertyOrBuilder
      Returns:
      The displayName.

    • getDisplayNameBytes

      public com.google.protobuf.ByteString getDisplayNameBytes()
       User defined name for the property.
      string display_name = 6;
      Specified by:
      getDisplayNameBytes in interface DocumentSchema.EntityType.PropertyOrBuilder
      Returns:
      The bytes for displayName.

    • getValueType

      public 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;
      Specified by:
      getValueType in interface DocumentSchema.EntityType.PropertyOrBuilder
      Returns:
      The valueType.

    • getValueTypeBytes

      public 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;
      Specified by:
      getValueTypeBytes in interface DocumentSchema.EntityType.PropertyOrBuilder
      Returns:
      The bytes for valueType.

    • getOccurrenceTypeValue

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

    • getOccurrenceType

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

    • getMethodValue

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

    • getMethod

      public DocumentSchema.EntityType.Property.Method getMethod()
       Specifies how the entity's value is obtained.
      .google.cloud.documentai.v1.DocumentSchema.EntityType.Property.Method method = 8;
      Specified by:
      getMethod in interface DocumentSchema.EntityType.PropertyOrBuilder
      Returns:
      The method.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static DocumentSchema.EntityType.Property parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DocumentSchema.EntityType.Property parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DocumentSchema.EntityType.Property parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DocumentSchema.EntityType.Property parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DocumentSchema.EntityType.Property parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DocumentSchema.EntityType.Property parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DocumentSchema.EntityType.Property parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static DocumentSchema.EntityType.Property parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static DocumentSchema.EntityType.Property parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static DocumentSchema.EntityType.Property parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static DocumentSchema.EntityType.Property parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static DocumentSchema.EntityType.Property parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public DocumentSchema.EntityType.Property.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static DocumentSchema.EntityType.Property.Builder newBuilder()

    • newBuilder

      public static DocumentSchema.EntityType.Property.Builder newBuilder(DocumentSchema.EntityType.Property prototype)

    • toBuilder

      public DocumentSchema.EntityType.Property.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected DocumentSchema.EntityType.Property.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static DocumentSchema.EntityType.Property getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<DocumentSchema.EntityType.Property> parser()

    • getParserForType

      public com.google.protobuf.Parser<DocumentSchema.EntityType.Property> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public DocumentSchema.EntityType.Property getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder