Document AI V1 API - Class Google::Cloud::DocumentAI::V1::Barcode (v0.17.2)

Reference documentation and code samples for the Document AI V1 API class Google::Cloud::DocumentAI::V1::Barcode.

Encodes the detailed information of a barcode.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#format

def format() -> ::String
Returns
  • (::String) —

    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.

#format=

def format=(value) -> ::String
Parameter
  • value (::String) —

    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.
Returns
  • (::String) —

    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.

#raw_value

def raw_value() -> ::String
Returns
  • (::String) — Raw value encoded in the barcode. For example: 'MEBKM:TITLE:Google;URL:https://www.google.com;;'.

#raw_value=

def raw_value=(value) -> ::String
Parameter
  • value (::String) — Raw value encoded in the barcode. For example: 'MEBKM:TITLE:Google;URL:https://www.google.com;;'.
Returns
  • (::String) — Raw value encoded in the barcode. For example: 'MEBKM:TITLE:Google;URL:https://www.google.com;;'.

#value_format

def value_format() -> ::String
Returns
  • (::String) —

    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.

#value_format=

def value_format=(value) -> ::String
Parameter
  • value (::String) —

    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.
Returns
  • (::String) —

    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.