Class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1Barcode

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/documentai_v1/classes.rb,
lib/google/apis/documentai_v1/representations.rb,
lib/google/apis/documentai_v1/representations.rb

Overview

Encodes the detailed information of a barcode.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDocumentaiV1Barcode

Returns a new instance of GoogleCloudDocumentaiV1Barcode.



1437
1438
1439
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 1437

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#format ⇒ 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. Corresponds to the JSON property format

Returns:

  • (String) 


1419
1420
1421
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 1419

def format
  @format
end

#raw_value ⇒ String

Raw value encoded in the barcode. For example: 'MEBKM:TITLE:Google;URL:https:/ /www.google.com;;'. Corresponds to the JSON property rawValue

Returns:

  • (String) 


1425
1426
1427
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 1425

def raw_value
  @raw_value
end

#value_format ⇒ 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. Corresponds to the JSON property valueFormat

Returns:

  • (String) 


1435
1436
1437
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 1435

def value_format
  @value_format
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1442
1443
1444
1445
1446
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 1442

def update!(**args)
  @format = args[:format] if args.key?(:format)
  @raw_value = args[:raw_value] if args.key?(:raw_value)
  @value_format = args[:value_format] if args.key?(:value_format)
end