Package com.google.cloud.documentai.v1beta3

Class DocumentSchema.EntityType

  • All Implemented Interfaces:
    DocumentSchema.EntityTypeOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    Enclosing class:
    DocumentSchema
    public static final class DocumentSchema.EntityType
extends com.google.protobuf.GeneratedMessageV3
implements DocumentSchema.EntityTypeOrBuilder
     EntityType is the wrapper of a label of the corresponding model with
 detailed attributes and limitations for entity-based processors. Multiple
 types can also compose a dependency tree to represent nested types.
    Protobuf type google.cloud.documentai.v1beta3.DocumentSchema.EntityType
    See Also:
    Serialized Form

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

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

      • internalGetFieldAccessorTable

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

      • hasEnumValues

        public boolean hasEnumValues()
         If specified, lists all the possible values for this entity.  This
 should not be more than a handful of values.  If the number of values
 is >10 or could change frequently use the `EntityType.value_ontology`
 field and specify a list of all possible values in a value ontology
 file.
        .google.cloud.documentai.v1beta3.DocumentSchema.EntityType.EnumValues enum_values = 14;
        Specified by:
        hasEnumValues in interface DocumentSchema.EntityTypeOrBuilder
        Returns:
        Whether the enumValues field is set.

      • getEnumValues

        public DocumentSchema.EntityType.EnumValues getEnumValues()
         If specified, lists all the possible values for this entity.  This
 should not be more than a handful of values.  If the number of values
 is >10 or could change frequently use the `EntityType.value_ontology`
 field and specify a list of all possible values in a value ontology
 file.
        .google.cloud.documentai.v1beta3.DocumentSchema.EntityType.EnumValues enum_values = 14;
        Specified by:
        getEnumValues in interface DocumentSchema.EntityTypeOrBuilder
        Returns:
        The enumValues.

      • getEnumValuesOrBuilder

        public DocumentSchema.EntityType.EnumValuesOrBuilder getEnumValuesOrBuilder()
         If specified, lists all the possible values for this entity.  This
 should not be more than a handful of values.  If the number of values
 is >10 or could change frequently use the `EntityType.value_ontology`
 field and specify a list of all possible values in a value ontology
 file.
        .google.cloud.documentai.v1beta3.DocumentSchema.EntityType.EnumValues enum_values = 14;
        Specified by:
        getEnumValuesOrBuilder in interface DocumentSchema.EntityTypeOrBuilder

      • getName

        public String getName()
         Name of the type. It must be unique within the schema file and
 cannot be a "Common Type".  The following naming conventions are used:

 - Use `snake_casing`.
 - Name matching is case-sensitive.
 - Maximum 64 characters.
 - Must start with a letter.
 - Allowed characters: ASCII letters `[a-z0-9_-]`.  (For backward
   compatibility internal infrastructure and tooling can handle any ascii
   character.)
 - The `/` is sometimes used to denote a property of a type.  For example
   `line_item/amount`.  This convention is deprecated, but will still be
   honored for backward compatibility.
        string name = 1;
        Specified by:
        getName in interface DocumentSchema.EntityTypeOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Name of the type. It must be unique within the schema file and
 cannot be a "Common Type".  The following naming conventions are used:

 - Use `snake_casing`.
 - Name matching is case-sensitive.
 - Maximum 64 characters.
 - Must start with a letter.
 - Allowed characters: ASCII letters `[a-z0-9_-]`.  (For backward
   compatibility internal infrastructure and tooling can handle any ascii
   character.)
 - The `/` is sometimes used to denote a property of a type.  For example
   `line_item/amount`.  This convention is deprecated, but will still be
   honored for backward compatibility.
        string name = 1;
        Specified by:
        getNameBytes in interface DocumentSchema.EntityTypeOrBuilder
        Returns:
        The bytes for name.

      • getBaseTypesList

        public com.google.protobuf.ProtocolStringList getBaseTypesList()
         The entity type that this type is derived from.  For now, one and only
 one should be set.
        repeated string base_types = 2;
        Specified by:
        getBaseTypesList in interface DocumentSchema.EntityTypeOrBuilder
        Returns:
        A list containing the baseTypes.

      • getBaseTypesCount

        public int getBaseTypesCount()
         The entity type that this type is derived from.  For now, one and only
 one should be set.
        repeated string base_types = 2;
        Specified by:
        getBaseTypesCount in interface DocumentSchema.EntityTypeOrBuilder
        Returns:
        The count of baseTypes.

      • getBaseTypes

        public String getBaseTypes​(int index)
         The entity type that this type is derived from.  For now, one and only
 one should be set.
        repeated string base_types = 2;
        Specified by:
        getBaseTypes in interface DocumentSchema.EntityTypeOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The baseTypes at the given index.

      • getBaseTypesBytes

        public com.google.protobuf.ByteString getBaseTypesBytes​(int index)
         The entity type that this type is derived from.  For now, one and only
 one should be set.
        repeated string base_types = 2;
        Specified by:
        getBaseTypesBytes in interface DocumentSchema.EntityTypeOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the baseTypes at the given index.

      • getPropertiesCount

        public int getPropertiesCount()
         Description the nested structure, or composition of an entity.
        repeated .google.cloud.documentai.v1beta3.DocumentSchema.EntityType.Property properties = 6;
        Specified by:
        getPropertiesCount in interface DocumentSchema.EntityTypeOrBuilder

      • hasEntityTypeMetadata

        public boolean hasEntityTypeMetadata()
         Metadata for the entity type.
        .google.cloud.documentai.v1beta3.EntityTypeMetadata entity_type_metadata = 11;
        Specified by:
        hasEntityTypeMetadata in interface DocumentSchema.EntityTypeOrBuilder
        Returns:
        Whether the entityTypeMetadata field is set.

      • isInitialized

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

      • 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.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

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

      • 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 parseFrom​(ByteBuffer data)
                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

        public static DocumentSchema.EntityType 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 parseFrom​(byte[] data)
                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected DocumentSchema.EntityType.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<DocumentSchema.EntityType> 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.GeneratedMessageV3

      • getDefaultInstanceForType

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