Class Barcode

  • All Implemented Interfaces:
    BarcodeOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

    public final class Barcode
    extends com.google.protobuf.GeneratedMessageV3
    implements BarcodeOrBuilder
     Encodes the detailed information of a barcode.
     
    Protobuf type google.cloud.documentai.v1.Barcode
    See Also:
    Serialized Form
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Barcode.Builder
      Encodes the detailed information of a barcode.
      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int FORMAT_FIELD_NUMBER  
      static int RAW_VALUE_FIELD_NUMBER  
      static int VALUE_FORMAT_FIELD_NUMBER  
      • Fields inherited from class com.google.protobuf.GeneratedMessageV3

        alwaysUseFieldBuilders, unknownFields
      • Fields inherited from class com.google.protobuf.AbstractMessage

        memoizedSize
      • Fields inherited from class com.google.protobuf.AbstractMessageLite

        memoizedHashCode
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(Object obj)  
      static Barcode getDefaultInstance()  
      Barcode getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      String getFormat()
      Format of a barcode.
      com.google.protobuf.ByteString getFormatBytes()
      Format of a barcode.
      com.google.protobuf.Parser<Barcode> getParserForType()  
      String getRawValue()
      Raw value encoded in the barcode.
      com.google.protobuf.ByteString getRawValueBytes()
      Raw value encoded in the barcode.
      int getSerializedSize()  
      String getValueFormat()
      Value format describes the format of the value that a barcode encodes.
      com.google.protobuf.ByteString getValueFormatBytes()
      Value format describes the format of the value that a barcode encodes.
      int hashCode()  
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static Barcode.Builder newBuilder()  
      static Barcode.Builder newBuilder​(Barcode prototype)  
      Barcode.Builder newBuilderForType()  
      protected Barcode.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static Barcode parseDelimitedFrom​(InputStream input)  
      static Barcode parseDelimitedFrom​(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Barcode parseFrom​(byte[] data)  
      static Barcode parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Barcode parseFrom​(com.google.protobuf.ByteString data)  
      static Barcode parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Barcode parseFrom​(com.google.protobuf.CodedInputStream input)  
      static Barcode parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Barcode parseFrom​(InputStream input)  
      static Barcode parseFrom​(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Barcode parseFrom​(ByteBuffer data)  
      static Barcode parseFrom​(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<Barcode> parser()  
      Barcode.Builder toBuilder()  
      void writeTo​(com.google.protobuf.CodedOutputStream output)  
      • Methods inherited from class com.google.protobuf.GeneratedMessageV3

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
      • Methods inherited from class com.google.protobuf.AbstractMessage

        findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
      • Methods inherited from class com.google.protobuf.AbstractMessageLite

        addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
      • Methods inherited from interface com.google.protobuf.MessageLite

        toByteArray, toByteString, writeDelimitedTo, writeTo
      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
    • 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
      • getFormat

        public String getFormat()
         Format of a barcode.
         The supported formats are:
        
         - `CODE_128`: Code 128 type.
         - `CODE_39`: Code 39 type.
         - `CODE_93`: Code 93 type.
         - `CODABAR`: Codabar type.
         - `DATA_MATRIX`: 2D Data Matrix type.
         - `ITF`: ITF type.
         - `EAN_13`: EAN-13 type.
         - `EAN_8`: EAN-8 type.
         - `QR_CODE`: 2D QR code type.
         - `UPC_A`: UPC-A type.
         - `UPC_E`: UPC-E type.
         - `PDF417`: PDF417 type.
         - `AZTEC`: 2D Aztec code type.
         - `DATABAR`: GS1 DataBar code type.
         
        string format = 1;
        Specified by:
        getFormat in interface BarcodeOrBuilder
        Returns:
        The format.
      • getFormatBytes

        public com.google.protobuf.ByteString getFormatBytes()
         Format of a barcode.
         The supported formats are:
        
         - `CODE_128`: Code 128 type.
         - `CODE_39`: Code 39 type.
         - `CODE_93`: Code 93 type.
         - `CODABAR`: Codabar type.
         - `DATA_MATRIX`: 2D Data Matrix type.
         - `ITF`: ITF type.
         - `EAN_13`: EAN-13 type.
         - `EAN_8`: EAN-8 type.
         - `QR_CODE`: 2D QR code type.
         - `UPC_A`: UPC-A type.
         - `UPC_E`: UPC-E type.
         - `PDF417`: PDF417 type.
         - `AZTEC`: 2D Aztec code type.
         - `DATABAR`: GS1 DataBar code type.
         
        string format = 1;
        Specified by:
        getFormatBytes in interface BarcodeOrBuilder
        Returns:
        The bytes for format.
      • getValueFormat

        public String getValueFormat()
         Value format describes the format of the value that a barcode
         encodes.
         The supported formats are:
        
         - `CONTACT_INFO`: Contact information.
         - `EMAIL`: Email address.
         - `ISBN`: ISBN identifier.
         - `PHONE`: Phone number.
         - `PRODUCT`: Product.
         - `SMS`: SMS message.
         - `TEXT`: Text string.
         - `URL`: URL address.
         - `WIFI`: Wifi information.
         - `GEO`: Geo-localization.
         - `CALENDAR_EVENT`: Calendar event.
         - `DRIVER_LICENSE`: Driver's license.
         
        string value_format = 2;
        Specified by:
        getValueFormat in interface BarcodeOrBuilder
        Returns:
        The valueFormat.
      • getValueFormatBytes

        public com.google.protobuf.ByteString getValueFormatBytes()
         Value format describes the format of the value that a barcode
         encodes.
         The supported formats are:
        
         - `CONTACT_INFO`: Contact information.
         - `EMAIL`: Email address.
         - `ISBN`: ISBN identifier.
         - `PHONE`: Phone number.
         - `PRODUCT`: Product.
         - `SMS`: SMS message.
         - `TEXT`: Text string.
         - `URL`: URL address.
         - `WIFI`: Wifi information.
         - `GEO`: Geo-localization.
         - `CALENDAR_EVENT`: Calendar event.
         - `DRIVER_LICENSE`: Driver's license.
         
        string value_format = 2;
        Specified by:
        getValueFormatBytes in interface BarcodeOrBuilder
        Returns:
        The bytes for valueFormat.
      • getRawValue

        public String getRawValue()
         Raw value encoded in the barcode.
         For example: `'MEBKM:TITLE:Google;URL:https://www.google.com;;'`.
         
        string raw_value = 3;
        Specified by:
        getRawValue in interface BarcodeOrBuilder
        Returns:
        The rawValue.
      • getRawValueBytes

        public com.google.protobuf.ByteString getRawValueBytes()
         Raw value encoded in the barcode.
         For example: `'MEBKM:TITLE:Google;URL:https://www.google.com;;'`.
         
        string raw_value = 3;
        Specified by:
        getRawValueBytes in interface BarcodeOrBuilder
        Returns:
        The bytes for rawValue.
      • 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 Barcode parseFrom​(ByteBuffer data)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

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

        public static Barcode parseFrom​(com.google.protobuf.ByteString data,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static Barcode parseFrom​(byte[] data)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

        public static Barcode parseFrom​(com.google.protobuf.CodedInputStream input,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws IOException
        Throws:
        IOException
      • newBuilderForType

        public Barcode.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite
      • toBuilder

        public Barcode.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite
      • newBuilderForType

        protected Barcode.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • getDefaultInstance

        public static Barcode getDefaultInstance()
      • parser

        public static com.google.protobuf.Parser<Barcode> parser()
      • getParserForType

        public com.google.protobuf.Parser<Barcode> 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 Barcode getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder