xref: /aosp_15_r20/external/googleapis/google/cloud/documentai/v1/barcode.proto (revision d5c09012810ac0c9f33fe448fb6da8260d444cc9)
1// Copyright 2023 Google LLC
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//     http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15syntax = "proto3";
16
17package google.cloud.documentai.v1;
18
19option csharp_namespace = "Google.Cloud.DocumentAI.V1";
20option go_package = "cloud.google.com/go/documentai/apiv1/documentaipb;documentaipb";
21option java_multiple_files = true;
22option java_outer_classname = "BarcodeProto";
23option java_package = "com.google.cloud.documentai.v1";
24option php_namespace = "Google\\Cloud\\DocumentAI\\V1";
25option ruby_package = "Google::Cloud::DocumentAI::V1";
26
27// Encodes the detailed information of a barcode.
28message Barcode {
29  // Format of a barcode.
30  // The supported formats are:
31  //
32  // - `CODE_128`: Code 128 type.
33  // - `CODE_39`: Code 39 type.
34  // - `CODE_93`: Code 93 type.
35  // - `CODABAR`: Codabar type.
36  // - `DATA_MATRIX`: 2D Data Matrix type.
37  // - `ITF`: ITF type.
38  // - `EAN_13`: EAN-13 type.
39  // - `EAN_8`: EAN-8 type.
40  // - `QR_CODE`: 2D QR code type.
41  // - `UPC_A`: UPC-A type.
42  // - `UPC_E`: UPC-E type.
43  // - `PDF417`: PDF417 type.
44  // - `AZTEC`: 2D Aztec code type.
45  // - `DATABAR`: GS1 DataBar code type.
46  string format = 1;
47
48  // Value format describes the format of the value that a barcode
49  // encodes.
50  // The supported formats are:
51  //
52  // - `CONTACT_INFO`: Contact information.
53  // - `EMAIL`: Email address.
54  // - `ISBN`: ISBN identifier.
55  // - `PHONE`: Phone number.
56  // - `PRODUCT`: Product.
57  // - `SMS`: SMS message.
58  // - `TEXT`: Text string.
59  // - `URL`: URL address.
60  // - `WIFI`: Wifi information.
61  // - `GEO`: Geo-localization.
62  // - `CALENDAR_EVENT`: Calendar event.
63  // - `DRIVER_LICENSE`: Driver's license.
64  string value_format = 2;
65
66  // Raw value encoded in the barcode.
67  // For example: `'MEBKM:TITLE:Google;URL:https://www.google.com;;'`.
68  string raw_value = 3;
69}
70