# Document AI Warehouse API . projects . locations . documents

## Instance Methods

Returns the documentLinks Resource.

Returns the referenceId Resource.

Close httplib2 connections.

Creates a document.

Deletes a document. Returns NOT_FOUND if the document does not exist.

Gets the access control policy for a resource. Returns NOT_FOUND error if the resource does not exist. Returns an empty policy if the resource exists but does not have a policy set.

Gets a document. Returns NOT_FOUND if the document does not exist.

Return all source document-links from the document.

Retrieves the next page of results.

Return all target document-links from the document.

Lock the document so the document cannot be updated by other users.

Updates a document. Returns INVALID_ARGUMENT if the name of the document is non-empty and does not equal the existing name.

Searches for documents using provided SearchDocumentsRequest. This call only returns documents that the caller has permission to search against.

Retrieves the next page of results.

Sets the access control policy for a resource. Replaces any existing policy.

### Method Details

`close()`

    Close httplib2 connections.

`create(parent, body=None, x__xgafv=None)`

    Creates a document.

    Args:
      parent: string, Required. The parent name. Format: projects/{project_number}/locations/{location}. (required)
      body: object, The request body.
        The object takes the form of:

    { # Request message for DocumentService.CreateDocument.
      "cloudAiDocumentOption": { # Request Option for processing Cloud AI Document in CW Document. # Request Option for processing Cloud AI Document in Document Warehouse. This field offers limited support for mapping entities from Cloud AI Document to Warehouse Document. Please consult with product team before using this field and other available options.
        "customizedEntitiesPropertiesConversions": { # If set, only selected entities will be converted to properties.
          "a_key": "A String",
        },
        "enableEntitiesConversions": True or False, # Whether to convert all the entities to properties.
      },
      "createMask": "A String", # Field mask for creating Document fields. If mask path is empty, it means all fields are masked. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask.
      "document": { # Defines the structure for content warehouse document proto. # Required. The document to create.
        "cloudAiDocument": { # Document represents the canonical document resource in Document AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document AI to iterate and optimize for quality. # Document AI format to save the structured content, including OCR.
          "chunkedDocument": { # Represents the chunks that the document is divided into. # Document chunked based on chunking config.
            "chunks": [ # List of chunks.
              { # Represents a chunk.
                "chunkId": "A String", # ID of the chunk.
                "content": "A String", # Text content of the chunk.
                "pageFooters": [ # Page footers associated with the chunk.
                  { # Represents the page footer associated with the chunk.
                    "pageSpan": { # Represents where the chunk starts and ends in the document. # Page span of the footer.
                      "pageEnd": 42, # Page where chunk ends in the document.
                      "pageStart": 42, # Page where chunk starts in the document.
                    },
                    "text": "A String", # Footer in text format.
                  },
                ],
                "pageHeaders": [ # Page headers associated with the chunk.
                  { # Represents the page header associated with the chunk.
                    "pageSpan": { # Represents where the chunk starts and ends in the document. # Page span of the header.
                      "pageEnd": 42, # Page where chunk ends in the document.
                      "pageStart": 42, # Page where chunk starts in the document.
                    },
                    "text": "A String", # Header in text format.
                  },
                ],
                "pageSpan": { # Represents where the chunk starts and ends in the document. # Page span of the chunk.
                  "pageEnd": 42, # Page where chunk ends in the document.
                  "pageStart": 42, # Page where chunk starts in the document.
                },
                "sourceBlockIds": [ # Unused.
                  "A String",
                ],
              },
            ],
          },
          "content": "A String", # Optional. Inline document content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64.
          "documentLayout": { # Represents the parsed layout of a document as a collection of blocks that the document is divided into. # Parsed layout of the document.
            "blocks": [ # List of blocks in the document.
              { # Represents a block. A block could be one of the various types (text, table, list) supported.
                "blockId": "A String", # ID of the block.
                "listBlock": { # Represents a list type block. # Block consisting of list content/structure.
                  "listEntries": [ # List entries that constitute a list block.
                    { # Represents an entry in the list.
                      "blocks": [ # A list entry is a list of blocks. Repeated blocks support further hierarchies and nested blocks.
                        # Object with schema name: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock
                      ],
                    },
                  ],
                  "type": "A String", # Type of the list_entries (if exist). Available options are `ordered` and `unordered`.
                },
                "pageSpan": { # Represents where the block starts and ends in the document. # Page span of the block.
                  "pageEnd": 42, # Page where block ends in the document.
                  "pageStart": 42, # Page where block starts in the document.
                },
                "tableBlock": { # Represents a table type block. # Block consisting of table content/structure.
                  "bodyRows": [ # Body rows containing main table content.
                    { # Represents a row in a table.
                      "cells": [ # A table row is a list of table cells.
                        { # Represents a cell in a table row.
                          "blocks": [ # A table cell is a list of blocks. Repeated blocks support further hierarchies and nested blocks.
                            # Object with schema name: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock
                          ],
                          "colSpan": 42, # How many columns this cell spans.
                          "rowSpan": 42, # How many rows this cell spans.
                        },
                      ],
                    },
                  ],
                  "caption": "A String", # Table caption/title.
                  "headerRows": [ # Header rows at the top of the table.
                    { # Represents a row in a table.
                      "cells": [ # A table row is a list of table cells.
                        { # Represents a cell in a table row.
                          "blocks": [ # A table cell is a list of blocks. Repeated blocks support further hierarchies and nested blocks.
                            # Object with schema name: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock
                          ],
                          "colSpan": 42, # How many columns this cell spans.
                          "rowSpan": 42, # How many rows this cell spans.
                        },
                      ],
                    },
                  ],
                },
                "textBlock": { # Represents a text type block. # Block consisting of text content.
                  "blocks": [ # A text block could further have child blocks. Repeated blocks support further hierarchies and nested blocks.
                    # Object with schema name: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock
                  ],
                  "text": "A String", # Text content stored in the block.
                  "type": "A String", # Type of the text in the block. Available options are: `paragraph`, `subtitle`, `heading-1`, `heading-2`, `heading-3`, `heading-4`, `heading-5`, `header`, `footer`.
                },
              },
            ],
          },
          "entities": [ # A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries.
            { # An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location.
              "confidence": 3.14, # Optional. Confidence of detected Schema entity. Range `[0, 1]`.
              "id": "A String", # Optional. Canonical id. This will be a unique value in the entity list for this document.
              "mentionId": "A String", # Optional. Deprecated. Use `id` field instead.
              "mentionText": "A String", # Optional. Text value of the entity e.g. `1600 Amphitheatre Pkwy`.
              "normalizedValue": { # Parsed and normalized entity value. # Optional. Normalized entity value. Absent if the extracted value could not be converted or the type (e.g. address) is not supported for certain parsers. This field is also only populated for certain supported document types.
                "addressValue": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Postal address. See also: https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto
                  "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
                    "A String",
                  ],
                  "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
                  "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
                  "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
                  "organization": "A String", # Optional. The name of the organization at the address.
                  "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
                  "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
                    "A String",
                  ],
                  "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
                  "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
                  "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
                  "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
                },
                "booleanValue": True or False, # Boolean value. Can be used for entities with binary values, or for checkboxes.
                "dateValue": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Date value. Includes year, month, day. See also: https://github.com/googleapis/googleapis/blob/master/google/type/date.proto
                  "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
                  "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
                  "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
                },
                "datetimeValue": { # Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations. # DateTime value. Includes date, time, and timezone. See also: https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto
                  "day": 42, # Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day.
                  "hours": 42, # Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults to 0 (midnight). An API may choose to allow the value "24:00:00" for scenarios like business closing time.
                  "minutes": 42, # Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.
                  "month": 42, # Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month.
                  "nanos": 42, # Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0.
                  "seconds": 42, # Optional. Seconds of minutes of the time. Must normally be from 0 to 59, defaults to 0. An API may allow the value 60 if it allows leap-seconds.
                  "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Time zone.
                    "id": "A String", # IANA Time Zone Database time zone. For example "America/New_York".
                    "version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a".
                  },
                  "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.
                  "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.
                },
                "floatValue": 3.14, # Float value.
                "integerValue": 42, # Integer value.
                "moneyValue": { # Represents an amount of money with its currency type. # Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto
                  "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
                  "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
                  "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
                },
                "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format.
              },
              "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found.
                "pageRefs": [ # One or more references to visual page elements
                  { # Represents a weak reference to a page element within a document.
                    "boundingPoly": { # A bounding polygon for the detected image annotation. # Optional. Identifies the bounding polygon of a layout element on the page. If `layout_type` is set, the bounding polygon must be exactly the same to the layout element it's referring to.
                      "normalizedVertices": [ # The bounding polygon normalized vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                          "x": 3.14, # X coordinate.
                          "y": 3.14, # Y coordinate (starts from the top of the image).
                        },
                      ],
                      "vertices": [ # The bounding polygon vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                          "x": 42, # X coordinate.
                          "y": 42, # Y coordinate (starts from the top of the image).
                        },
                      ],
                    },
                    "confidence": 3.14, # Optional. Confidence of detected page element, if applicable. Range `[0, 1]`.
                    "layoutId": "A String", # Optional. Deprecated. Use PageRef.bounding_poly instead.
                    "layoutType": "A String", # Optional. The type of the layout element that is being referenced if any.
                    "page": "A String", # Required. Index into the Document.pages element, for example using `Document.pages` to locate the related page element. This field is skipped when its value is the default `0`. See https://developers.google.com/protocol-buffers/docs/proto3#json.
                  },
                ],
              },
              "properties": [ # Optional. Entities can be nested to form a hierarchical data structure representing the content in the document.
                # Object with schema name: GoogleCloudDocumentaiV1DocumentEntity
              ],
              "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # Optional. The history of this annotation.
                "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
                "parents": [ # References to the original elements that are replaced.
                  { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
                    "id": 42, # The id of the parent provenance.
                    "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
                    "revision": 42, # The index of the index into current revision's parent_ids list.
                  },
                ],
                "revision": 42, # The index of the revision that produced this element.
                "type": "A String", # The type of provenance operation.
              },
              "redacted": True or False, # Optional. Whether the entity will be redacted for de-identification purposes.
              "textAnchor": { # Text reference indexing into the Document.text. # Optional. Provenance of the entity. Text anchor indexing into the Document.text.
                "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                "textSegments": [ # The text segments from the Document.text.
                  { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                    "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                    "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                  },
                ],
              },
              "type": "A String", # Required. Entity type from a schema e.g. `Address`.
            },
          ],
          "entityRelations": [ # Placeholder. Relationship among Document.entities.
            { # Relationship between Entities.
              "objectId": "A String", # Object entity id.
              "relation": "A String", # Relationship description.
              "subjectId": "A String", # Subject entity id.
            },
          ],
          "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Any error that occurred while processing this document.
            "code": 42, # The status code, which should be an enum value of google.rpc.Code.
            "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
              {
                "a_key": "", # Properties of the object. Contains field @type with type URL.
              },
            ],
            "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
          },
          "mimeType": "A String", # An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml).
          "pages": [ # Visual page layout for the Document.
            { # A page in a Document.
              "blocks": [ # A list of visually detected text blocks on the page. A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.
                { # A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.
                  "detectedLanguages": [ # A list of detected languages together with confidence.
                    { # Detected language for a structural component.
                      "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
                      "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
                    },
                  ],
                  "layout": { # Visual element describing a layout unit on a page. # Layout for Block.
                    "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                      "normalizedVertices": [ # The bounding polygon normalized vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                          "x": 3.14, # X coordinate.
                          "y": 3.14, # Y coordinate (starts from the top of the image).
                        },
                      ],
                      "vertices": [ # The bounding polygon vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                          "x": 42, # X coordinate.
                          "y": 42, # Y coordinate (starts from the top of the image).
                        },
                      ],
                    },
                    "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                    "orientation": "A String", # Detected orientation for the Layout.
                    "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                      "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                      "textSegments": [ # The text segments from the Document.text.
                        { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                          "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                          "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                        },
                      ],
                    },
                  },
                  "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation.
                    "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
                    "parents": [ # References to the original elements that are replaced.
                      { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
                        "id": 42, # The id of the parent provenance.
                        "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
                        "revision": 42, # The index of the index into current revision's parent_ids list.
                      },
                    ],
                    "revision": 42, # The index of the revision that produced this element.
                    "type": "A String", # The type of provenance operation.
                  },
                },
              ],
              "detectedBarcodes": [ # A list of detected barcodes.
                { # A detected barcode.
                  "barcode": { # Encodes the detailed information of a barcode. # Detailed barcode information of the DetectedBarcode.
                    "format": "A 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.
                    "rawValue": "A String", # Raw value encoded in the barcode. For example: `'MEBKM:TITLE:Google;URL:https://www.google.com;;'`.
                    "valueFormat": "A 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.
                  },
                  "layout": { # Visual element describing a layout unit on a page. # Layout for DetectedBarcode.
                    "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                      "normalizedVertices": [ # The bounding polygon normalized vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                          "x": 3.14, # X coordinate.
                          "y": 3.14, # Y coordinate (starts from the top of the image).
                        },
                      ],
                      "vertices": [ # The bounding polygon vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                          "x": 42, # X coordinate.
                          "y": 42, # Y coordinate (starts from the top of the image).
                        },
                      ],
                    },
                    "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                    "orientation": "A String", # Detected orientation for the Layout.
                    "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                      "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                      "textSegments": [ # The text segments from the Document.text.
                        { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                          "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                          "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                        },
                      ],
                    },
                  },
                },
              ],
              "detectedLanguages": [ # A list of detected languages together with confidence.
                { # Detected language for a structural component.
                  "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
                  "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
                },
              ],
              "dimension": { # Dimension for the page. # Physical dimension of the page.
                "height": 3.14, # Page height.
                "unit": "A String", # Dimension unit.
                "width": 3.14, # Page width.
              },
              "formFields": [ # A list of visually detected form fields on the page.
                { # A form field detected on the page.
                  "correctedKeyText": "A String", # Created for Labeling UI to export key text. If corrections were made to the text identified by the `field_name.text_anchor`, this field will contain the correction.
                  "correctedValueText": "A String", # Created for Labeling UI to export value text. If corrections were made to the text identified by the `field_value.text_anchor`, this field will contain the correction.
                  "fieldName": { # Visual element describing a layout unit on a page. # Layout for the FormField name. e.g. `Address`, `Email`, `Grand total`, `Phone number`, etc.
                    "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                      "normalizedVertices": [ # The bounding polygon normalized vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                          "x": 3.14, # X coordinate.
                          "y": 3.14, # Y coordinate (starts from the top of the image).
                        },
                      ],
                      "vertices": [ # The bounding polygon vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                          "x": 42, # X coordinate.
                          "y": 42, # Y coordinate (starts from the top of the image).
                        },
                      ],
                    },
                    "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                    "orientation": "A String", # Detected orientation for the Layout.
                    "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                      "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                      "textSegments": [ # The text segments from the Document.text.
                        { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                          "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                          "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                        },
                      ],
                    },
                  },
                  "fieldValue": { # Visual element describing a layout unit on a page. # Layout for the FormField value.
                    "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                      "normalizedVertices": [ # The bounding polygon normalized vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                          "x": 3.14, # X coordinate.
                          "y": 3.14, # Y coordinate (starts from the top of the image).
                        },
                      ],
                      "vertices": [ # The bounding polygon vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                          "x": 42, # X coordinate.
                          "y": 42, # Y coordinate (starts from the top of the image).
                        },
                      ],
                    },
                    "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                    "orientation": "A String", # Detected orientation for the Layout.
                    "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                      "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                      "textSegments": [ # The text segments from the Document.text.
                        { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                          "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                          "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                        },
                      ],
                    },
                  },
                  "nameDetectedLanguages": [ # A list of detected languages for name together with confidence.
                    { # Detected language for a structural component.
                      "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
                      "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
                    },
                  ],
                  "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation.
                    "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
                    "parents": [ # References to the original elements that are replaced.
                      { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
                        "id": 42, # The id of the parent provenance.
                        "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
                        "revision": 42, # The index of the index into current revision's parent_ids list.
                      },
                    ],
                    "revision": 42, # The index of the revision that produced this element.
                    "type": "A String", # The type of provenance operation.
                  },
                  "valueDetectedLanguages": [ # A list of detected languages for value together with confidence.
                    { # Detected language for a structural component.
                      "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
                      "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
                    },
                  ],
                  "valueType": "A String", # If the value is non-textual, this field represents the type. Current valid values are: - blank (this indicates the `field_value` is normal text) - `unfilled_checkbox` - `filled_checkbox`
                },
              ],
              "image": { # Rendered image contents for this page. # Rendered image for this page. This image is preprocessed to remove any skew, rotation, and distortions such that the annotation bounding boxes can be upright and axis-aligned.
                "content": "A String", # Raw byte content of the image.
                "height": 42, # Height of the image in pixels.
                "mimeType": "A String", # Encoding [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml) for the image.
                "width": 42, # Width of the image in pixels.
              },
              "imageQualityScores": { # Image quality scores for the page image. # Image quality scores.
                "detectedDefects": [ # A list of detected defects.
                  { # Image Quality Defects
                    "confidence": 3.14, # Confidence of detected defect. Range `[0, 1]` where `1` indicates strong confidence that the defect exists.
                    "type": "A String", # Name of the defect type. Supported values are: - `quality/defect_blurry` - `quality/defect_noisy` - `quality/defect_dark` - `quality/defect_faint` - `quality/defect_text_too_small` - `quality/defect_document_cutoff` - `quality/defect_text_cutoff` - `quality/defect_glare`
                  },
                ],
                "qualityScore": 3.14, # The overall quality score. Range `[0, 1]` where `1` is perfect quality.
              },
              "layout": { # Visual element describing a layout unit on a page. # Layout for the page.
                "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                  "normalizedVertices": [ # The bounding polygon normalized vertices.
                    { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                      "x": 3.14, # X coordinate.
                      "y": 3.14, # Y coordinate (starts from the top of the image).
                    },
                  ],
                  "vertices": [ # The bounding polygon vertices.
                    { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                      "x": 42, # X coordinate.
                      "y": 42, # Y coordinate (starts from the top of the image).
                    },
                  ],
                },
                "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                "orientation": "A String", # Detected orientation for the Layout.
                "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                  "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                  "textSegments": [ # The text segments from the Document.text.
                    { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                      "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                      "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                    },
                  ],
                },
              },
              "lines": [ # A list of visually detected text lines on the page. A collection of tokens that a human would perceive as a line.
                { # A collection of tokens that a human would perceive as a line. Does not cross column boundaries, can be horizontal, vertical, etc.
                  "detectedLanguages": [ # A list of detected languages together with confidence.
                    { # Detected language for a structural component.
                      "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
                      "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
                    },
                  ],
                  "layout": { # Visual element describing a layout unit on a page. # Layout for Line.
                    "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                      "normalizedVertices": [ # The bounding polygon normalized vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                          "x": 3.14, # X coordinate.
                          "y": 3.14, # Y coordinate (starts from the top of the image).
                        },
                      ],
                      "vertices": [ # The bounding polygon vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                          "x": 42, # X coordinate.
                          "y": 42, # Y coordinate (starts from the top of the image).
                        },
                      ],
                    },
                    "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                    "orientation": "A String", # Detected orientation for the Layout.
                    "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                      "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                      "textSegments": [ # The text segments from the Document.text.
                        { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                          "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                          "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                        },
                      ],
                    },
                  },
                  "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation.
                    "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
                    "parents": [ # References to the original elements that are replaced.
                      { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
                        "id": 42, # The id of the parent provenance.
                        "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
                        "revision": 42, # The index of the index into current revision's parent_ids list.
                      },
                    ],
                    "revision": 42, # The index of the revision that produced this element.
                    "type": "A String", # The type of provenance operation.
                  },
                },
              ],
              "pageNumber": 42, # 1-based index for current Page in a parent Document. Useful when a page is taken out of a Document for individual processing.
              "paragraphs": [ # A list of visually detected text paragraphs on the page. A collection of lines that a human would perceive as a paragraph.
                { # A collection of lines that a human would perceive as a paragraph.
                  "detectedLanguages": [ # A list of detected languages together with confidence.
                    { # Detected language for a structural component.
                      "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
                      "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
                    },
                  ],
                  "layout": { # Visual element describing a layout unit on a page. # Layout for Paragraph.
                    "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                      "normalizedVertices": [ # The bounding polygon normalized vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                          "x": 3.14, # X coordinate.
                          "y": 3.14, # Y coordinate (starts from the top of the image).
                        },
                      ],
                      "vertices": [ # The bounding polygon vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                          "x": 42, # X coordinate.
                          "y": 42, # Y coordinate (starts from the top of the image).
                        },
                      ],
                    },
                    "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                    "orientation": "A String", # Detected orientation for the Layout.
                    "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                      "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                      "textSegments": [ # The text segments from the Document.text.
                        { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                          "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                          "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                        },
                      ],
                    },
                  },
                  "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation.
                    "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
                    "parents": [ # References to the original elements that are replaced.
                      { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
                        "id": 42, # The id of the parent provenance.
                        "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
                        "revision": 42, # The index of the index into current revision's parent_ids list.
                      },
                    ],
                    "revision": 42, # The index of the revision that produced this element.
                    "type": "A String", # The type of provenance operation.
                  },
                },
              ],
              "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this page.
                "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
                "parents": [ # References to the original elements that are replaced.
                  { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
                    "id": 42, # The id of the parent provenance.
                    "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
                    "revision": 42, # The index of the index into current revision's parent_ids list.
                  },
                ],
                "revision": 42, # The index of the revision that produced this element.
                "type": "A String", # The type of provenance operation.
              },
              "symbols": [ # A list of visually detected symbols on the page.
                { # A detected symbol.
                  "detectedLanguages": [ # A list of detected languages together with confidence.
                    { # Detected language for a structural component.
                      "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
                      "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
                    },
                  ],
                  "layout": { # Visual element describing a layout unit on a page. # Layout for Symbol.
                    "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                      "normalizedVertices": [ # The bounding polygon normalized vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                          "x": 3.14, # X coordinate.
                          "y": 3.14, # Y coordinate (starts from the top of the image).
                        },
                      ],
                      "vertices": [ # The bounding polygon vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                          "x": 42, # X coordinate.
                          "y": 42, # Y coordinate (starts from the top of the image).
                        },
                      ],
                    },
                    "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                    "orientation": "A String", # Detected orientation for the Layout.
                    "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                      "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                      "textSegments": [ # The text segments from the Document.text.
                        { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                          "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                          "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                        },
                      ],
                    },
                  },
                },
              ],
              "tables": [ # A list of visually detected tables on the page.
                { # A table representation similar to HTML table structure.
                  "bodyRows": [ # Body rows of the table.
                    { # A row of table cells.
                      "cells": [ # Cells that make up this row.
                        { # A cell representation inside the table.
                          "colSpan": 42, # How many columns this cell spans.
                          "detectedLanguages": [ # A list of detected languages together with confidence.
                            { # Detected language for a structural component.
                              "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
                              "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
                            },
                          ],
                          "layout": { # Visual element describing a layout unit on a page. # Layout for TableCell.
                            "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                              "normalizedVertices": [ # The bounding polygon normalized vertices.
                                { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                                  "x": 3.14, # X coordinate.
                                  "y": 3.14, # Y coordinate (starts from the top of the image).
                                },
                              ],
                              "vertices": [ # The bounding polygon vertices.
                                { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                                  "x": 42, # X coordinate.
                                  "y": 42, # Y coordinate (starts from the top of the image).
                                },
                              ],
                            },
                            "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                            "orientation": "A String", # Detected orientation for the Layout.
                            "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                              "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                              "textSegments": [ # The text segments from the Document.text.
                                { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                                  "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                                  "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                                },
                              ],
                            },
                          },
                          "rowSpan": 42, # How many rows this cell spans.
                        },
                      ],
                    },
                  ],
                  "detectedLanguages": [ # A list of detected languages together with confidence.
                    { # Detected language for a structural component.
                      "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
                      "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
                    },
                  ],
                  "headerRows": [ # Header rows of the table.
                    { # A row of table cells.
                      "cells": [ # Cells that make up this row.
                        { # A cell representation inside the table.
                          "colSpan": 42, # How many columns this cell spans.
                          "detectedLanguages": [ # A list of detected languages together with confidence.
                            { # Detected language for a structural component.
                              "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
                              "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
                            },
                          ],
                          "layout": { # Visual element describing a layout unit on a page. # Layout for TableCell.
                            "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                              "normalizedVertices": [ # The bounding polygon normalized vertices.
                                { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                                  "x": 3.14, # X coordinate.
                                  "y": 3.14, # Y coordinate (starts from the top of the image).
                                },
                              ],
                              "vertices": [ # The bounding polygon vertices.
                                { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                                  "x": 42, # X coordinate.
                                  "y": 42, # Y coordinate (starts from the top of the image).
                                },
                              ],
                            },
                            "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                            "orientation": "A String", # Detected orientation for the Layout.
                            "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                              "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                              "textSegments": [ # The text segments from the Document.text.
                                { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                                  "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                                  "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                                },
                              ],
                            },
                          },
                          "rowSpan": 42, # How many rows this cell spans.
                        },
                      ],
                    },
                  ],
                  "layout": { # Visual element describing a layout unit on a page. # Layout for Table.
                    "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                      "normalizedVertices": [ # The bounding polygon normalized vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                          "x": 3.14, # X coordinate.
                          "y": 3.14, # Y coordinate (starts from the top of the image).
                        },
                      ],
                      "vertices": [ # The bounding polygon vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                          "x": 42, # X coordinate.
                          "y": 42, # Y coordinate (starts from the top of the image).
                        },
                      ],
                    },
                    "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                    "orientation": "A String", # Detected orientation for the Layout.
                    "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                      "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                      "textSegments": [ # The text segments from the Document.text.
                        { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                          "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                          "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                        },
                      ],
                    },
                  },
                  "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this table.
                    "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
                    "parents": [ # References to the original elements that are replaced.
                      { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
                        "id": 42, # The id of the parent provenance.
                        "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
                        "revision": 42, # The index of the index into current revision's parent_ids list.
                      },
                    ],
                    "revision": 42, # The index of the revision that produced this element.
                    "type": "A String", # The type of provenance operation.
                  },
                },
              ],
              "tokens": [ # A list of visually detected tokens on the page.
                { # A detected token.
                  "detectedBreak": { # Detected break at the end of a Token. # Detected break at the end of a Token.
                    "type": "A String", # Detected break type.
                  },
                  "detectedLanguages": [ # A list of detected languages together with confidence.
                    { # Detected language for a structural component.
                      "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
                      "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
                    },
                  ],
                  "layout": { # Visual element describing a layout unit on a page. # Layout for Token.
                    "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                      "normalizedVertices": [ # The bounding polygon normalized vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                          "x": 3.14, # X coordinate.
                          "y": 3.14, # Y coordinate (starts from the top of the image).
                        },
                      ],
                      "vertices": [ # The bounding polygon vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                          "x": 42, # X coordinate.
                          "y": 42, # Y coordinate (starts from the top of the image).
                        },
                      ],
                    },
                    "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                    "orientation": "A String", # Detected orientation for the Layout.
                    "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                      "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                      "textSegments": [ # The text segments from the Document.text.
                        { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                          "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                          "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                        },
                      ],
                    },
                  },
                  "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation.
                    "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
                    "parents": [ # References to the original elements that are replaced.
                      { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
                        "id": 42, # The id of the parent provenance.
                        "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
                        "revision": 42, # The index of the index into current revision's parent_ids list.
                      },
                    ],
                    "revision": 42, # The index of the revision that produced this element.
                    "type": "A String", # The type of provenance operation.
                  },
                  "styleInfo": { # Font and other text style attributes. # Text style attributes.
                    "backgroundColor": { # Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ... # Color of the background.
                      "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0).
                      "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                      "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                      "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                    },
                    "bold": True or False, # Whether the text is bold (equivalent to font_weight is at least `700`).
                    "fontSize": 42, # Font size in points (`1` point is `¹⁄₇₂` inches).
                    "fontType": "A String", # Name or style of the font.
                    "fontWeight": 42, # TrueType weight on a scale `100` (thin) to `1000` (ultra-heavy). Normal is `400`, bold is `700`.
                    "handwritten": True or False, # Whether the text is handwritten.
                    "italic": True or False, # Whether the text is italic.
                    "letterSpacing": 3.14, # Letter spacing in points.
                    "pixelFontSize": 3.14, # Font size in pixels, equal to _unrounded font_size_ * _resolution_ ÷ `72.0`.
                    "smallcaps": True or False, # Whether the text is in small caps. This feature is not supported yet.
                    "strikeout": True or False, # Whether the text is strikethrough. This feature is not supported yet.
                    "subscript": True or False, # Whether the text is a subscript. This feature is not supported yet.
                    "superscript": True or False, # Whether the text is a superscript. This feature is not supported yet.
                    "textColor": { # Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ... # Color of the text.
                      "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0).
                      "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                      "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                      "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                    },
                    "underlined": True or False, # Whether the text is underlined.
                  },
                },
              ],
              "transforms": [ # Transformation matrices that were applied to the original document image to produce Page.image.
                { # Representation for transformation matrix, intended to be compatible and used with OpenCV format for image manipulation.
                  "cols": 42, # Number of columns in the matrix.
                  "data": "A String", # The matrix data.
                  "rows": 42, # Number of rows in the matrix.
                  "type": 42, # This encodes information about what data type the matrix uses. For example, 0 (CV_8U) is an unsigned 8-bit image. For the full list of OpenCV primitive data types, please refer to https://docs.opencv.org/4.3.0/d1/d1b/group__core__hal__interface.html
                },
              ],
              "visualElements": [ # A list of detected non-text visual elements e.g. checkbox, signature etc. on the page.
                { # Detected non-text visual elements e.g. checkbox, signature etc. on the page.
                  "detectedLanguages": [ # A list of detected languages together with confidence.
                    { # Detected language for a structural component.
                      "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
                      "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
                    },
                  ],
                  "layout": { # Visual element describing a layout unit on a page. # Layout for VisualElement.
                    "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                      "normalizedVertices": [ # The bounding polygon normalized vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                          "x": 3.14, # X coordinate.
                          "y": 3.14, # Y coordinate (starts from the top of the image).
                        },
                      ],
                      "vertices": [ # The bounding polygon vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                          "x": 42, # X coordinate.
                          "y": 42, # Y coordinate (starts from the top of the image).
                        },
                      ],
                    },
                    "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                    "orientation": "A String", # Detected orientation for the Layout.
                    "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                      "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                      "textSegments": [ # The text segments from the Document.text.
                        { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                          "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                          "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                        },
                      ],
                    },
                  },
                  "type": "A String", # Type of the VisualElement.
                },
              ],
            },
          ],
          "revisions": [ # Placeholder. Revision history of this document.
            { # Contains past or forward revisions of this document.
              "agent": "A String", # If the change was made by a person specify the name or id of that person.
              "createTime": "A String", # The time that the revision was created, internally generated by doc proto storage at the time of create.
              "humanReview": { # Human Review information of the document. # Human Review information of this revision.
                "state": "A String", # Human review state. e.g. `requested`, `succeeded`, `rejected`.
                "stateMessage": "A String", # A message providing more details about the current state of processing. For example, the rejection reason when the state is `rejected`.
              },
              "id": "A String", # Id of the revision, internally generated by doc proto storage. Unique within the context of the document.
              "parent": [ # The revisions that this revision is based on. This can include one or more parent (when documents are merged.) This field represents the index into the `revisions` field.
                42,
              ],
              "parentIds": [ # The revisions that this revision is based on. Must include all the ids that have anything to do with this revision - eg. there are `provenance.parent.revision` fields that index into this field.
                "A String",
              ],
              "processor": "A String", # If the annotation was made by processor identify the processor by its resource name.
            },
          ],
          "shardInfo": { # For a large document, sharding may be performed to produce several document shards. Each document shard contains this field to detail which shard it is. # Information about the sharding if this document is sharded part of a larger document. If the document is not sharded, this message is not specified.
            "shardCount": "A String", # Total number of shards.
            "shardIndex": "A String", # The 0-based index of this shard.
            "textOffset": "A String", # The index of the first character in Document.text in the overall document global text.
          },
          "text": "A String", # Optional. UTF-8 encoded text in reading order from the document.
          "textChanges": [ # Placeholder. A list of text corrections made to Document.text. This is usually used for annotating corrections to OCR mistakes. Text changes for a given revision may not overlap with each other.
            { # This message is used for text changes aka. OCR corrections.
              "changedText": "A String", # The text that replaces the text identified in the `text_anchor`.
              "provenance": [ # The history of this annotation.
                { # Structure to identify provenance relationships between annotations in different revisions.
                  "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
                  "parents": [ # References to the original elements that are replaced.
                    { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
                      "id": 42, # The id of the parent provenance.
                      "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
                      "revision": 42, # The index of the index into current revision's parent_ids list.
                    },
                  ],
                  "revision": 42, # The index of the revision that produced this element.
                  "type": "A String", # The type of provenance operation.
                },
              ],
              "textAnchor": { # Text reference indexing into the Document.text. # Provenance of the correction. Text anchor indexing into the Document.text. There can only be a single `TextAnchor.text_segments` element. If the start and end index of the text segment are the same, the text change is inserted before that index.
                "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                "textSegments": [ # The text segments from the Document.text.
                  { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                    "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                    "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                  },
                ],
              },
            },
          ],
          "textStyles": [ # Styles for the Document.text.
            { # Annotation for common text style attributes. This adheres to CSS conventions as much as possible.
              "backgroundColor": { # Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ... # Text background color.
                "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0).
                "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
              },
              "color": { # Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ... # Text color.
                "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0).
                "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
              },
              "fontFamily": "A String", # Font family such as `Arial`, `Times New Roman`. https://www.w3schools.com/cssref/pr_font_font-family.asp
              "fontSize": { # Font size with unit. # Font size.
                "size": 3.14, # Font size for the text.
                "unit": "A String", # Unit for the font size. Follows CSS naming (such as `in`, `px`, and `pt`).
              },
              "fontWeight": "A String", # [Font weight](https://www.w3schools.com/cssref/pr_font_weight.asp). Possible values are `normal`, `bold`, `bolder`, and `lighter`.
              "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                "textSegments": [ # The text segments from the Document.text.
                  { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                    "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                    "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                  },
                ],
              },
              "textDecoration": "A String", # [Text decoration](https://www.w3schools.com/cssref/pr_text_text-decoration.asp). Follows CSS standard.
              "textStyle": "A String", # [Text style](https://www.w3schools.com/cssref/pr_font_font-style.asp). Possible values are `normal`, `italic`, and `oblique`.
            },
          ],
          "uri": "A String", # Optional. Currently supports Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. For more information, refer to [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-uris).
        },
        "contentCategory": "A String", # Indicates the category (image, audio, video etc.) of the original content.
        "createTime": "A String", # Output only. The time when the document is created.
        "creator": "A String", # The user who creates the document.
        "displayName": "A String", # Required. Display name of the document given by the user. This name will be displayed in the UI. Customer can populate this field with the name of the document. This differs from the 'title' field as 'title' is optional and stores the top heading in the document.
        "displayUri": "A String", # Uri to display the document, for example, in the UI.
        "dispositionTime": "A String", # Output only. If linked to a Collection with RetentionPolicy, the date when the document becomes mutable.
        "documentSchemaName": "A String", # The Document schema name. Format: projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}.
        "inlineRawDocument": "A String", # Raw document content.
        "legalHold": True or False, # Output only. Indicates if the document has a legal hold on it.
        "name": "A String", # The resource name of the document. Format: projects/{project_number}/locations/{location}/documents/{document_id}. The name is ignored when creating a document.
        "plainText": "A String", # Other document format, such as PPTX, XLXS
        "properties": [ # List of values that are user supplied metadata.
          { # Property of a document.
            "dateTimeValues": { # DateTime values. # Date time property values. It is not supported by CMEK compliant deployment.
              "values": [ # List of datetime values. Both OffsetDateTime and ZonedDateTime are supported.
                { # Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations.
                  "day": 42, # Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day.
                  "hours": 42, # Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults to 0 (midnight). An API may choose to allow the value "24:00:00" for scenarios like business closing time.
                  "minutes": 42, # Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.
                  "month": 42, # Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month.
                  "nanos": 42, # Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0.
                  "seconds": 42, # Optional. Seconds of minutes of the time. Must normally be from 0 to 59, defaults to 0. An API may allow the value 60 if it allows leap-seconds.
                  "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Time zone.
                    "id": "A String", # IANA Time Zone Database time zone. For example "America/New_York".
                    "version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a".
                  },
                  "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.
                  "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.
                },
              ],
            },
            "enumValues": { # Enum values. # Enum property values.
              "values": [ # List of enum values.
                "A String",
              ],
            },
            "floatValues": { # Float values. # Float property values.
              "values": [ # List of float values.
                3.14,
              ],
            },
            "integerValues": { # Integer values. # Integer property values.
              "values": [ # List of integer values.
                42,
              ],
            },
            "mapProperty": { # Map property value. Represents a structured entries of key value pairs, consisting of field names which map to dynamically typed values. # Map property values.
              "fields": { # Unordered map of dynamically typed values.
                "a_key": { # `Value` represents a dynamically typed value which can be either be a float, a integer, a string, or a datetime value. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.
                  "booleanValue": True or False, # Represents a boolean value.
                  "datetimeValue": { # Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations. # Represents a datetime value.
                    "day": 42, # Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day.
                    "hours": 42, # Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults to 0 (midnight). An API may choose to allow the value "24:00:00" for scenarios like business closing time.
                    "minutes": 42, # Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.
                    "month": 42, # Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month.
                    "nanos": 42, # Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0.
                    "seconds": 42, # Optional. Seconds of minutes of the time. Must normally be from 0 to 59, defaults to 0. An API may allow the value 60 if it allows leap-seconds.
                    "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Time zone.
                      "id": "A String", # IANA Time Zone Database time zone. For example "America/New_York".
                      "version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a".
                    },
                    "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.
                    "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.
                  },
                  "enumValue": { # Represents the string value of the enum field. # Represents an enum value.
                    "value": "A String", # String value of the enum field. This must match defined set of enums in document schema using EnumTypeOptions.
                  },
                  "floatValue": 3.14, # Represents a float value.
                  "intValue": 42, # Represents a integer value.
                  "stringValue": "A String", # Represents a string value.
                  "timestampValue": { # Timestamp value type. # Represents a timestamp value.
                    "textValue": "A String", # The string must represent a valid instant in UTC and is parsed using java.time.format.DateTimeFormatter.ISO_INSTANT. e.g. "2013-09-29T18:46:19Z"
                    "timestampValue": "A String", # Timestamp value
                  },
                },
              },
            },
            "name": "A String", # Required. Must match the name of a PropertyDefinition in the DocumentSchema.
            "propertyValues": { # Property values. # Nested structured data property values.
              "properties": [ # List of property values.
                # Object with schema name: GoogleCloudContentwarehouseV1Property
              ],
            },
            "textValues": { # String/text values. # String/text property values.
              "values": [ # List of text values.
                "A String",
              ],
            },
            "timestampValues": { # Timestamp values. # Timestamp property values. It is not supported by CMEK compliant deployment.
              "values": [ # List of timestamp values.
                { # Timestamp value type.
                  "textValue": "A String", # The string must represent a valid instant in UTC and is parsed using java.time.format.DateTimeFormatter.ISO_INSTANT. e.g. "2013-09-29T18:46:19Z"
                  "timestampValue": "A String", # Timestamp value
                },
              ],
            },
          },
        ],
        "rawDocumentFileType": "A String", # This is used when DocAI was not used to load the document and parsing/ extracting is needed for the inline_raw_document. For example, if inline_raw_document is the byte representation of a PDF file, then this should be set to: RAW_DOCUMENT_FILE_TYPE_PDF.
        "rawDocumentPath": "A String", # Raw document file in Cloud Storage path.
        "referenceId": "A String", # The reference ID set by customers. Must be unique per project and location.
        "textExtractionDisabled": True or False, # If true, text extraction will not be performed.
        "textExtractionEnabled": True or False, # If true, text extraction will be performed.
        "title": "A String", # Title that describes the document. This can be the top heading or text that describes the document.
        "updateTime": "A String", # Output only. The time when the document is last updated.
        "updater": "A String", # The user who lastly updates the document.
      },
      "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # Default document policy during creation. This refers to an Identity and Access (IAM) policy, which specifies access controls for the Document. Conditions defined in the policy will be ignored.
        "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
          { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
            "auditLogConfigs": [ # The configuration for logging of each type of permission.
              { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
                "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
                  "A String",
                ],
                "logType": "A String", # The log type that this config enables.
              },
            ],
            "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
          },
        ],
        "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
          { # Associates `members`, or principals, with a `role`.
            "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
              "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
              "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
              "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
              "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
            },
            "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
              "A String",
            ],
            "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
          },
        ],
        "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
        "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
      },
      "requestMetadata": { # Meta information is used to improve the performance of the service. # The meta information collected about the end user, used to enforce access control for the service.
        "userInfo": { # The user information. # Provides user unique identification and groups information.
          "groupIds": [ # The unique group identifications which the user is belong to. The format is "group:yyyy@example.com";
            "A String",
          ],
          "id": "A String", # A unique user identification string, as determined by the client. The maximum number of allowed characters is 255. Allowed characters include numbers 0 to 9, uppercase and lowercase letters, and restricted special symbols (:, @, +, -, _, ~) The format is "user:xxxx@example.com";
        },
      },
    }

      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # Response message for DocumentService.CreateDocument.
      "document": { # Defines the structure for content warehouse document proto. # Document created after executing create request.
        "cloudAiDocument": { # Document represents the canonical document resource in Document AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document AI to iterate and optimize for quality. # Document AI format to save the structured content, including OCR.
          "chunkedDocument": { # Represents the chunks that the document is divided into. # Document chunked based on chunking config.
            "chunks": [ # List of chunks.
              { # Represents a chunk.
                "chunkId": "A String", # ID of the chunk.
                "content": "A String", # Text content of the chunk.
                "pageFooters": [ # Page footers associated with the chunk.
                  { # Represents the page footer associated with the chunk.
                    "pageSpan": { # Represents where the chunk starts and ends in the document. # Page span of the footer.
                      "pageEnd": 42, # Page where chunk ends in the document.
                      "pageStart": 42, # Page where chunk starts in the document.
                    },
                    "text": "A String", # Footer in text format.
                  },
                ],
                "pageHeaders": [ # Page headers associated with the chunk.
                  { # Represents the page header associated with the chunk.
                    "pageSpan": { # Represents where the chunk starts and ends in the document. # Page span of the header.
                      "pageEnd": 42, # Page where chunk ends in the document.
                      "pageStart": 42, # Page where chunk starts in the document.
                    },
                    "text": "A String", # Header in text format.
                  },
                ],
                "pageSpan": { # Represents where the chunk starts and ends in the document. # Page span of the chunk.
                  "pageEnd": 42, # Page where chunk ends in the document.
                  "pageStart": 42, # Page where chunk starts in the document.
                },
                "sourceBlockIds": [ # Unused.
                  "A String",
                ],
              },
            ],
          },
          "content": "A String", # Optional. Inline document content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64.
          "documentLayout": { # Represents the parsed layout of a document as a collection of blocks that the document is divided into. # Parsed layout of the document.
            "blocks": [ # List of blocks in the document.
              { # Represents a block. A block could be one of the various types (text, table, list) supported.
                "blockId": "A String", # ID of the block.
                "listBlock": { # Represents a list type block. # Block consisting of list content/structure.
                  "listEntries": [ # List entries that constitute a list block.
                    { # Represents an entry in the list.
                      "blocks": [ # A list entry is a list of blocks. Repeated blocks support further hierarchies and nested blocks.
                        # Object with schema name: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock
                      ],
                    },
                  ],
                  "type": "A String", # Type of the list_entries (if exist). Available options are `ordered` and `unordered`.
                },
                "pageSpan": { # Represents where the block starts and ends in the document. # Page span of the block.
                  "pageEnd": 42, # Page where block ends in the document.
                  "pageStart": 42, # Page where block starts in the document.
                },
                "tableBlock": { # Represents a table type block. # Block consisting of table content/structure.
                  "bodyRows": [ # Body rows containing main table content.
                    { # Represents a row in a table.
                      "cells": [ # A table row is a list of table cells.
                        { # Represents a cell in a table row.
                          "blocks": [ # A table cell is a list of blocks. Repeated blocks support further hierarchies and nested blocks.
                            # Object with schema name: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock
                          ],
                          "colSpan": 42, # How many columns this cell spans.
                          "rowSpan": 42, # How many rows this cell spans.
                        },
                      ],
                    },
                  ],
                  "caption": "A String", # Table caption/title.
                  "headerRows": [ # Header rows at the top of the table.
                    { # Represents a row in a table.
                      "cells": [ # A table row is a list of table cells.
                        { # Represents a cell in a table row.
                          "blocks": [ # A table cell is a list of blocks. Repeated blocks support further hierarchies and nested blocks.
                            # Object with schema name: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock
                          ],
                          "colSpan": 42, # How many columns this cell spans.
                          "rowSpan": 42, # How many rows this cell spans.
                        },
                      ],
                    },
                  ],
                },
                "textBlock": { # Represents a text type block. # Block consisting of text content.
                  "blocks": [ # A text block could further have child blocks. Repeated blocks support further hierarchies and nested blocks.
                    # Object with schema name: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock
                  ],
                  "text": "A String", # Text content stored in the block.
                  "type": "A String", # Type of the text in the block. Available options are: `paragraph`, `subtitle`, `heading-1`, `heading-2`, `heading-3`, `heading-4`, `heading-5`, `header`, `footer`.
                },
              },
            ],
          },
          "entities": [ # A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries.
            { # An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location.
              "confidence": 3.14, # Optional. Confidence of detected Schema entity. Range `[0, 1]`.
              "id": "A String", # Optional. Canonical id. This will be a unique value in the entity list for this document.
              "mentionId": "A String", # Optional. Deprecated. Use `id` field instead.
              "mentionText": "A String", # Optional. Text value of the entity e.g. `1600 Amphitheatre Pkwy`.
              "normalizedValue": { # Parsed and normalized entity value. # Optional. Normalized entity value. Absent if the extracted value could not be converted or the type (e.g. address) is not supported for certain parsers. This field is also only populated for certain supported document types.
                "addressValue": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Postal address. See also: https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto
                  "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
                    "A String",
                  ],
                  "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
                  "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
                  "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
                  "organization": "A String", # Optional. The name of the organization at the address.
                  "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
                  "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
                    "A String",
                  ],
                  "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
                  "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
                  "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
                  "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
                },
                "booleanValue": True or False, # Boolean value. Can be used for entities with binary values, or for checkboxes.
                "dateValue": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Date value. Includes year, month, day. See also: https://github.com/googleapis/googleapis/blob/master/google/type/date.proto
                  "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
                  "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
                  "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
                },
                "datetimeValue": { # Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations. # DateTime value. Includes date, time, and timezone. See also: https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto
                  "day": 42, # Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day.
                  "hours": 42, # Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults to 0 (midnight). An API may choose to allow the value "24:00:00" for scenarios like business closing time.
                  "minutes": 42, # Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.
                  "month": 42, # Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month.
                  "nanos": 42, # Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0.
                  "seconds": 42, # Optional. Seconds of minutes of the time. Must normally be from 0 to 59, defaults to 0. An API may allow the value 60 if it allows leap-seconds.
                  "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Time zone.
                    "id": "A String", # IANA Time Zone Database time zone. For example "America/New_York".
                    "version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a".
                  },
                  "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.
                  "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.
                },
                "floatValue": 3.14, # Float value.
                "integerValue": 42, # Integer value.
                "moneyValue": { # Represents an amount of money with its currency type. # Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto
                  "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
                  "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
                  "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
                },
                "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format.
              },
              "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found.
                "pageRefs": [ # One or more references to visual page elements
                  { # Represents a weak reference to a page element within a document.
                    "boundingPoly": { # A bounding polygon for the detected image annotation. # Optional. Identifies the bounding polygon of a layout element on the page. If `layout_type` is set, the bounding polygon must be exactly the same to the layout element it's referring to.
                      "normalizedVertices": [ # The bounding polygon normalized vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                          "x": 3.14, # X coordinate.
                          "y": 3.14, # Y coordinate (starts from the top of the image).
                        },
                      ],
                      "vertices": [ # The bounding polygon vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                          "x": 42, # X coordinate.
                          "y": 42, # Y coordinate (starts from the top of the image).
                        },
                      ],
                    },
                    "confidence": 3.14, # Optional. Confidence of detected page element, if applicable. Range `[0, 1]`.
                    "layoutId": "A String", # Optional. Deprecated. Use PageRef.bounding_poly instead.
                    "layoutType": "A String", # Optional. The type of the layout element that is being referenced if any.
                    "page": "A String", # Required. Index into the Document.pages element, for example using `Document.pages` to locate the related page element. This field is skipped when its value is the default `0`. See https://developers.google.com/protocol-buffers/docs/proto3#json.
                  },
                ],
              },
              "properties": [ # Optional. Entities can be nested to form a hierarchical data structure representing the content in the document.
                # Object with schema name: GoogleCloudDocumentaiV1DocumentEntity
              ],
              "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # Optional. The history of this annotation.
                "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
                "parents": [ # References to the original elements that are replaced.
                  { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
                    "id": 42, # The id of the parent provenance.
                    "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
                    "revision": 42, # The index of the index into current revision's parent_ids list.
                  },
                ],
                "revision": 42, # The index of the revision that produced this element.
                "type": "A String", # The type of provenance operation.
              },
              "redacted": True or False, # Optional. Whether the entity will be redacted for de-identification purposes.
              "textAnchor": { # Text reference indexing into the Document.text. # Optional. Provenance of the entity. Text anchor indexing into the Document.text.
                "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                "textSegments": [ # The text segments from the Document.text.
                  { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                    "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                    "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                  },
                ],
              },
              "type": "A String", # Required. Entity type from a schema e.g. `Address`.
            },
          ],
          "entityRelations": [ # Placeholder. Relationship among Document.entities.
            { # Relationship between Entities.
              "objectId": "A String", # Object entity id.
              "relation": "A String", # Relationship description.
              "subjectId": "A String", # Subject entity id.
            },
          ],
          "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Any error that occurred while processing this document.
            "code": 42, # The status code, which should be an enum value of google.rpc.Code.
            "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
              {
                "a_key": "", # Properties of the object. Contains field @type with type URL.
              },
            ],
            "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
          },
          "mimeType": "A String", # An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml).
          "pages": [ # Visual page layout for the Document.
            { # A page in a Document.
              "blocks": [ # A list of visually detected text blocks on the page. A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.
                { # A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.
                  "detectedLanguages": [ # A list of detected languages together with confidence.
                    { # Detected language for a structural component.
                      "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
                      "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
                    },
                  ],
                  "layout": { # Visual element describing a layout unit on a page. # Layout for Block.
                    "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                      "normalizedVertices": [ # The bounding polygon normalized vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                          "x": 3.14, # X coordinate.
                          "y": 3.14, # Y coordinate (starts from the top of the image).
                        },
                      ],
                      "vertices": [ # The bounding polygon vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                          "x": 42, # X coordinate.
                          "y": 42, # Y coordinate (starts from the top of the image).
                        },
                      ],
                    },
                    "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                    "orientation": "A String", # Detected orientation for the Layout.
                    "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                      "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                      "textSegments": [ # The text segments from the Document.text.
                        { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                          "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                          "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                        },
                      ],
                    },
                  },
                  "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation.
                    "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
                    "parents": [ # References to the original elements that are replaced.
                      { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
                        "id": 42, # The id of the parent provenance.
                        "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
                        "revision": 42, # The index of the index into current revision's parent_ids list.
                      },
                    ],
                    "revision": 42, # The index of the revision that produced this element.
                    "type": "A String", # The type of provenance operation.
                  },
                },
              ],
              "detectedBarcodes": [ # A list of detected barcodes.
                { # A detected barcode.
                  "barcode": { # Encodes the detailed information of a barcode. # Detailed barcode information of the DetectedBarcode.
                    "format": "A 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.
                    "rawValue": "A String", # Raw value encoded in the barcode. For example: `'MEBKM:TITLE:Google;URL:https://www.google.com;;'`.
                    "valueFormat": "A 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.
                  },
                  "layout": { # Visual element describing a layout unit on a page. # Layout for DetectedBarcode.
                    "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                      "normalizedVertices": [ # The bounding polygon normalized vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                          "x": 3.14, # X coordinate.
                          "y": 3.14, # Y coordinate (starts from the top of the image).
                        },
                      ],
                      "vertices": [ # The bounding polygon vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                          "x": 42, # X coordinate.
                          "y": 42, # Y coordinate (starts from the top of the image).
                        },
                      ],
                    },
                    "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                    "orientation": "A String", # Detected orientation for the Layout.
                    "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                      "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                      "textSegments": [ # The text segments from the Document.text.
                        { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                          "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                          "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                        },
                      ],
                    },
                  },
                },
              ],
              "detectedLanguages": [ # A list of detected languages together with confidence.
                { # Detected language for a structural component.
                  "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
                  "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
                },
              ],
              "dimension": { # Dimension for the page. # Physical dimension of the page.
                "height": 3.14, # Page height.
                "unit": "A String", # Dimension unit.
                "width": 3.14, # Page width.
              },
              "formFields": [ # A list of visually detected form fields on the page.
                { # A form field detected on the page.
                  "correctedKeyText": "A String", # Created for Labeling UI to export key text. If corrections were made to the text identified by the `field_name.text_anchor`, this field will contain the correction.
                  "correctedValueText": "A String", # Created for Labeling UI to export value text. If corrections were made to the text identified by the `field_value.text_anchor`, this field will contain the correction.
                  "fieldName": { # Visual element describing a layout unit on a page. # Layout for the FormField name. e.g. `Address`, `Email`, `Grand total`, `Phone number`, etc.
                    "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                      "normalizedVertices": [ # The bounding polygon normalized vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                          "x": 3.14, # X coordinate.
                          "y": 3.14, # Y coordinate (starts from the top of the image).
                        },
                      ],
                      "vertices": [ # The bounding polygon vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                          "x": 42, # X coordinate.
                          "y": 42, # Y coordinate (starts from the top of the image).
                        },
                      ],
                    },
                    "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                    "orientation": "A String", # Detected orientation for the Layout.
                    "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                      "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                      "textSegments": [ # The text segments from the Document.text.
                        { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                          "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                          "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                        },
                      ],
                    },
                  },
                  "fieldValue": { # Visual element describing a layout unit on a page. # Layout for the FormField value.
                    "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                      "normalizedVertices": [ # The bounding polygon normalized vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                          "x": 3.14, # X coordinate.
                          "y": 3.14, # Y coordinate (starts from the top of the image).
                        },
                      ],
                      "vertices": [ # The bounding polygon vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                          "x": 42, # X coordinate.
                          "y": 42, # Y coordinate (starts from the top of the image).
                        },
                      ],
                    },
                    "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                    "orientation": "A String", # Detected orientation for the Layout.
                    "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                      "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                      "textSegments": [ # The text segments from the Document.text.
                        { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                          "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                          "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                        },
                      ],
                    },
                  },
                  "nameDetectedLanguages": [ # A list of detected languages for name together with confidence.
                    { # Detected language for a structural component.
                      "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
                      "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
                    },
                  ],
                  "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation.
                    "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
                    "parents": [ # References to the original elements that are replaced.
                      { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
                        "id": 42, # The id of the parent provenance.
                        "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
                        "revision": 42, # The index of the index into current revision's parent_ids list.
                      },
                    ],
                    "revision": 42, # The index of the revision that produced this element.
                    "type": "A String", # The type of provenance operation.
                  },
                  "valueDetectedLanguages": [ # A list of detected languages for value together with confidence.
                    { # Detected language for a structural component.
                      "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
                      "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
                    },
                  ],
                  "valueType": "A String", # If the value is non-textual, this field represents the type. Current valid values are: - blank (this indicates the `field_value` is normal text) - `unfilled_checkbox` - `filled_checkbox`
                },
              ],
              "image": { # Rendered image contents for this page. # Rendered image for this page. This image is preprocessed to remove any skew, rotation, and distortions such that the annotation bounding boxes can be upright and axis-aligned.
                "content": "A String", # Raw byte content of the image.
                "height": 42, # Height of the image in pixels.
                "mimeType": "A String", # Encoding [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml) for the image.
                "width": 42, # Width of the image in pixels.
              },
              "imageQualityScores": { # Image quality scores for the page image. # Image quality scores.
                "detectedDefects": [ # A list of detected defects.
                  { # Image Quality Defects
                    "confidence": 3.14, # Confidence of detected defect. Range `[0, 1]` where `1` indicates strong confidence that the defect exists.
                    "type": "A String", # Name of the defect type. Supported values are: - `quality/defect_blurry` - `quality/defect_noisy` - `quality/defect_dark` - `quality/defect_faint` - `quality/defect_text_too_small` - `quality/defect_document_cutoff` - `quality/defect_text_cutoff` - `quality/defect_glare`
                  },
                ],
                "qualityScore": 3.14, # The overall quality score. Range `[0, 1]` where `1` is perfect quality.
              },
              "layout": { # Visual element describing a layout unit on a page. # Layout for the page.
                "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                  "normalizedVertices": [ # The bounding polygon normalized vertices.
                    { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                      "x": 3.14, # X coordinate.
                      "y": 3.14, # Y coordinate (starts from the top of the image).
                    },
                  ],
                  "vertices": [ # The bounding polygon vertices.
                    { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                      "x": 42, # X coordinate.
                      "y": 42, # Y coordinate (starts from the top of the image).
                    },
                  ],
                },
                "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                "orientation": "A String", # Detected orientation for the Layout.
                "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                  "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                  "textSegments": [ # The text segments from the Document.text.
                    { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                      "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                      "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                    },
                  ],
                },
              },
              "lines": [ # A list of visually detected text lines on the page. A collection of tokens that a human would perceive as a line.
                { # A collection of tokens that a human would perceive as a line. Does not cross column boundaries, can be horizontal, vertical, etc.
                  "detectedLanguages": [ # A list of detected languages together with confidence.
                    { # Detected language for a structural component.
                      "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
                      "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
                    },
                  ],
                  "layout": { # Visual element describing a layout unit on a page. # Layout for Line.
                    "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                      "normalizedVertices": [ # The bounding polygon normalized vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                          "x": 3.14, # X coordinate.
                          "y": 3.14, # Y coordinate (starts from the top of the image).
                        },
                      ],
                      "vertices": [ # The bounding polygon vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                          "x": 42, # X coordinate.
                          "y": 42, # Y coordinate (starts from the top of the image).
                        },
                      ],
                    },
                    "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                    "orientation": "A String", # Detected orientation for the Layout.
                    "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                      "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                      "textSegments": [ # The text segments from the Document.text.
                        { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                          "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                          "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                        },
                      ],
                    },
                  },
                  "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation.
                    "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
                    "parents": [ # References to the original elements that are replaced.
                      { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
                        "id": 42, # The id of the parent provenance.
                        "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
                        "revision": 42, # The index of the index into current revision's parent_ids list.
                      },
                    ],
                    "revision": 42, # The index of the revision that produced this element.
                    "type": "A String", # The type of provenance operation.
                  },
                },
              ],
              "pageNumber": 42, # 1-based index for current Page in a parent Document. Useful when a page is taken out of a Document for individual processing.
              "paragraphs": [ # A list of visually detected text paragraphs on the page. A collection of lines that a human would perceive as a paragraph.
                { # A collection of lines that a human would perceive as a paragraph.
                  "detectedLanguages": [ # A list of detected languages together with confidence.
                    { # Detected language for a structural component.
                      "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
                      "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
                    },
                  ],
                  "layout": { # Visual element describing a layout unit on a page. # Layout for Paragraph.
                    "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                      "normalizedVertices": [ # The bounding polygon normalized vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                          "x": 3.14, # X coordinate.
                          "y": 3.14, # Y coordinate (starts from the top of the image).
                        },
                      ],
                      "vertices": [ # The bounding polygon vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                          "x": 42, # X coordinate.
                          "y": 42, # Y coordinate (starts from the top of the image).
                        },
                      ],
                    },
                    "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                    "orientation": "A String", # Detected orientation for the Layout.
                    "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                      "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                      "textSegments": [ # The text segments from the Document.text.
                        { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                          "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                          "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                        },
                      ],
                    },
                  },
                  "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation.
                    "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
                    "parents": [ # References to the original elements that are replaced.
                      { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
                        "id": 42, # The id of the parent provenance.
                        "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
                        "revision": 42, # The index of the index into current revision's parent_ids list.
                      },
                    ],
                    "revision": 42, # The index of the revision that produced this element.
                    "type": "A String", # The type of provenance operation.
                  },
                },
              ],
              "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this page.
                "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
                "parents": [ # References to the original elements that are replaced.
                  { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
                    "id": 42, # The id of the parent provenance.
                    "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
                    "revision": 42, # The index of the index into current revision's parent_ids list.
                  },
                ],
                "revision": 42, # The index of the revision that produced this element.
                "type": "A String", # The type of provenance operation.
              },
              "symbols": [ # A list of visually detected symbols on the page.
                { # A detected symbol.
                  "detectedLanguages": [ # A list of detected languages together with confidence.
                    { # Detected language for a structural component.
                      "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
                      "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
                    },
                  ],
                  "layout": { # Visual element describing a layout unit on a page. # Layout for Symbol.
                    "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                      "normalizedVertices": [ # The bounding polygon normalized vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                          "x": 3.14, # X coordinate.
                          "y": 3.14, # Y coordinate (starts from the top of the image).
                        },
                      ],
                      "vertices": [ # The bounding polygon vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                          "x": 42, # X coordinate.
                          "y": 42, # Y coordinate (starts from the top of the image).
                        },
                      ],
                    },
                    "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                    "orientation": "A String", # Detected orientation for the Layout.
                    "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                      "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                      "textSegments": [ # The text segments from the Document.text.
                        { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                          "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                          "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                        },
                      ],
                    },
                  },
                },
              ],
              "tables": [ # A list of visually detected tables on the page.
                { # A table representation similar to HTML table structure.
                  "bodyRows": [ # Body rows of the table.
                    { # A row of table cells.
                      "cells": [ # Cells that make up this row.
                        { # A cell representation inside the table.
                          "colSpan": 42, # How many columns this cell spans.
                          "detectedLanguages": [ # A list of detected languages together with confidence.
                            { # Detected language for a structural component.
                              "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
                              "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
                            },
                          ],
                          "layout": { # Visual element describing a layout unit on a page. # Layout for TableCell.
                            "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                              "normalizedVertices": [ # The bounding polygon normalized vertices.
                                { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                                  "x": 3.14, # X coordinate.
                                  "y": 3.14, # Y coordinate (starts from the top of the image).
                                },
                              ],
                              "vertices": [ # The bounding polygon vertices.
                                { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                                  "x": 42, # X coordinate.
                                  "y": 42, # Y coordinate (starts from the top of the image).
                                },
                              ],
                            },
                            "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                            "orientation": "A String", # Detected orientation for the Layout.
                            "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                              "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                              "textSegments": [ # The text segments from the Document.text.
                                { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                                  "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                                  "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                                },
                              ],
                            },
                          },
                          "rowSpan": 42, # How many rows this cell spans.
                        },
                      ],
                    },
                  ],
                  "detectedLanguages": [ # A list of detected languages together with confidence.
                    { # Detected language for a structural component.
                      "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
                      "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
                    },
                  ],
                  "headerRows": [ # Header rows of the table.
                    { # A row of table cells.
                      "cells": [ # Cells that make up this row.
                        { # A cell representation inside the table.
                          "colSpan": 42, # How many columns this cell spans.
                          "detectedLanguages": [ # A list of detected languages together with confidence.
                            { # Detected language for a structural component.
                              "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
                              "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
                            },
                          ],
                          "layout": { # Visual element describing a layout unit on a page. # Layout for TableCell.
                            "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                              "normalizedVertices": [ # The bounding polygon normalized vertices.
                                { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                                  "x": 3.14, # X coordinate.
                                  "y": 3.14, # Y coordinate (starts from the top of the image).
                                },
                              ],
                              "vertices": [ # The bounding polygon vertices.
                                { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                                  "x": 42, # X coordinate.
                                  "y": 42, # Y coordinate (starts from the top of the image).
                                },
                              ],
                            },
                            "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                            "orientation": "A String", # Detected orientation for the Layout.
                            "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                              "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                              "textSegments": [ # The text segments from the Document.text.
                                { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                                  "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                                  "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                                },
                              ],
                            },
                          },
                          "rowSpan": 42, # How many rows this cell spans.
                        },
                      ],
                    },
                  ],
                  "layout": { # Visual element describing a layout unit on a page. # Layout for Table.
                    "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                      "normalizedVertices": [ # The bounding polygon normalized vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                          "x": 3.14, # X coordinate.
                          "y": 3.14, # Y coordinate (starts from the top of the image).
                        },
                      ],
                      "vertices": [ # The bounding polygon vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                          "x": 42, # X coordinate.
                          "y": 42, # Y coordinate (starts from the top of the image).
                        },
                      ],
                    },
                    "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                    "orientation": "A String", # Detected orientation for the Layout.
                    "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                      "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                      "textSegments": [ # The text segments from the Document.text.
                        { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                          "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                          "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                        },
                      ],
                    },
                  },
                  "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this table.
                    "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
                    "parents": [ # References to the original elements that are replaced.
                      { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
                        "id": 42, # The id of the parent provenance.
                        "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
                        "revision": 42, # The index of the index into current revision's parent_ids list.
                      },
                    ],
                    "revision": 42, # The index of the revision that produced this element.
                    "type": "A String", # The type of provenance operation.
                  },
                },
              ],
              "tokens": [ # A list of visually detected tokens on the page.
                { # A detected token.
                  "detectedBreak": { # Detected break at the end of a Token. # Detected break at the end of a Token.
                    "type": "A String", # Detected break type.
                  },
                  "detectedLanguages": [ # A list of detected languages together with confidence.
                    { # Detected language for a structural component.
                      "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
                      "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
                    },
                  ],
                  "layout": { # Visual element describing a layout unit on a page. # Layout for Token.
                    "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                      "normalizedVertices": [ # The bounding polygon normalized vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                          "x": 3.14, # X coordinate.
                          "y": 3.14, # Y coordinate (starts from the top of the image).
                        },
                      ],
                      "vertices": [ # The bounding polygon vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                          "x": 42, # X coordinate.
                          "y": 42, # Y coordinate (starts from the top of the image).
                        },
                      ],
                    },
                    "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                    "orientation": "A String", # Detected orientation for the Layout.
                    "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                      "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                      "textSegments": [ # The text segments from the Document.text.
                        { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                          "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                          "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                        },
                      ],
                    },
                  },
                  "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation.
                    "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
                    "parents": [ # References to the original elements that are replaced.
                      { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
                        "id": 42, # The id of the parent provenance.
                        "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
                        "revision": 42, # The index of the index into current revision's parent_ids list.
                      },
                    ],
                    "revision": 42, # The index of the revision that produced this element.
                    "type": "A String", # The type of provenance operation.
                  },
                  "styleInfo": { # Font and other text style attributes. # Text style attributes.
                    "backgroundColor": { # Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ... # Color of the background.
                      "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0).
                      "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                      "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                      "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                    },
                    "bold": True or False, # Whether the text is bold (equivalent to font_weight is at least `700`).
                    "fontSize": 42, # Font size in points (`1` point is `¹⁄₇₂` inches).
                    "fontType": "A String", # Name or style of the font.
                    "fontWeight": 42, # TrueType weight on a scale `100` (thin) to `1000` (ultra-heavy). Normal is `400`, bold is `700`.
                    "handwritten": True or False, # Whether the text is handwritten.
                    "italic": True or False, # Whether the text is italic.
                    "letterSpacing": 3.14, # Letter spacing in points.
                    "pixelFontSize": 3.14, # Font size in pixels, equal to _unrounded font_size_ * _resolution_ ÷ `72.0`.
                    "smallcaps": True or False, # Whether the text is in small caps. This feature is not supported yet.
                    "strikeout": True or False, # Whether the text is strikethrough. This feature is not supported yet.
                    "subscript": True or False, # Whether the text is a subscript. This feature is not supported yet.
                    "superscript": True or False, # Whether the text is a superscript. This feature is not supported yet.
                    "textColor": { # Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ... # Color of the text.
                      "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0).
                      "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                      "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                      "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                    },
                    "underlined": True or False, # Whether the text is underlined.
                  },
                },
              ],
              "transforms": [ # Transformation matrices that were applied to the original document image to produce Page.image.
                { # Representation for transformation matrix, intended to be compatible and used with OpenCV format for image manipulation.
                  "cols": 42, # Number of columns in the matrix.
                  "data": "A String", # The matrix data.
                  "rows": 42, # Number of rows in the matrix.
                  "type": 42, # This encodes information about what data type the matrix uses. For example, 0 (CV_8U) is an unsigned 8-bit image. For the full list of OpenCV primitive data types, please refer to https://docs.opencv.org/4.3.0/d1/d1b/group__core__hal__interface.html
                },
              ],
              "visualElements": [ # A list of detected non-text visual elements e.g. checkbox, signature etc. on the page.
                { # Detected non-text visual elements e.g. checkbox, signature etc. on the page.
                  "detectedLanguages": [ # A list of detected languages together with confidence.
                    { # Detected language for a structural component.
                      "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
                      "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
                    },
                  ],
                  "layout": { # Visual element describing a layout unit on a page. # Layout for VisualElement.
                    "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                      "normalizedVertices": [ # The bounding polygon normalized vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                          "x": 3.14, # X coordinate.
                          "y": 3.14, # Y coordinate (starts from the top of the image).
                        },
                      ],
                      "vertices": [ # The bounding polygon vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                          "x": 42, # X coordinate.
                          "y": 42, # Y coordinate (starts from the top of the image).
                        },
                      ],
                    },
                    "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                    "orientation": "A String", # Detected orientation for the Layout.
                    "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                      "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                      "textSegments": [ # The text segments from the Document.text.
                        { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                          "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                          "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                        },
                      ],
                    },
                  },
                  "type": "A String", # Type of the VisualElement.
                },
              ],
            },
          ],
          "revisions": [ # Placeholder. Revision history of this document.
            { # Contains past or forward revisions of this document.
              "agent": "A String", # If the change was made by a person specify the name or id of that person.
              "createTime": "A String", # The time that the revision was created, internally generated by doc proto storage at the time of create.
              "humanReview": { # Human Review information of the document. # Human Review information of this revision.
                "state": "A String", # Human review state. e.g. `requested`, `succeeded`, `rejected`.
                "stateMessage": "A String", # A message providing more details about the current state of processing. For example, the rejection reason when the state is `rejected`.
              },
              "id": "A String", # Id of the revision, internally generated by doc proto storage. Unique within the context of the document.
              "parent": [ # The revisions that this revision is based on. This can include one or more parent (when documents are merged.) This field represents the index into the `revisions` field.
                42,
              ],
              "parentIds": [ # The revisions that this revision is based on. Must include all the ids that have anything to do with this revision - eg. there are `provenance.parent.revision` fields that index into this field.
                "A String",
              ],
              "processor": "A String", # If the annotation was made by processor identify the processor by its resource name.
            },
          ],
          "shardInfo": { # For a large document, sharding may be performed to produce several document shards. Each document shard contains this field to detail which shard it is. # Information about the sharding if this document is sharded part of a larger document. If the document is not sharded, this message is not specified.
            "shardCount": "A String", # Total number of shards.
            "shardIndex": "A String", # The 0-based index of this shard.
            "textOffset": "A String", # The index of the first character in Document.text in the overall document global text.
          },
          "text": "A String", # Optional. UTF-8 encoded text in reading order from the document.
          "textChanges": [ # Placeholder. A list of text corrections made to Document.text. This is usually used for annotating corrections to OCR mistakes. Text changes for a given revision may not overlap with each other.
            { # This message is used for text changes aka. OCR corrections.
              "changedText": "A String", # The text that replaces the text identified in the `text_anchor`.
              "provenance": [ # The history of this annotation.
                { # Structure to identify provenance relationships between annotations in different revisions.
                  "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
                  "parents": [ # References to the original elements that are replaced.
                    { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
                      "id": 42, # The id of the parent provenance.
                      "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
                      "revision": 42, # The index of the index into current revision's parent_ids list.
                    },
                  ],
                  "revision": 42, # The index of the revision that produced this element.
                  "type": "A String", # The type of provenance operation.
                },
              ],
              "textAnchor": { # Text reference indexing into the Document.text. # Provenance of the correction. Text anchor indexing into the Document.text. There can only be a single `TextAnchor.text_segments` element. If the start and end index of the text segment are the same, the text change is inserted before that index.
                "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                "textSegments": [ # The text segments from the Document.text.
                  { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                    "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                    "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                  },
                ],
              },
            },
          ],
          "textStyles": [ # Styles for the Document.text.
            { # Annotation for common text style attributes. This adheres to CSS conventions as much as possible.
              "backgroundColor": { # Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ... # Text background color.
                "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0).
                "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
              },
              "color": { # Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ... # Text color.
                "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0).
                "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
              },
              "fontFamily": "A String", # Font family such as `Arial`, `Times New Roman`. https://www.w3schools.com/cssref/pr_font_font-family.asp
              "fontSize": { # Font size with unit. # Font size.
                "size": 3.14, # Font size for the text.
                "unit": "A String", # Unit for the font size. Follows CSS naming (such as `in`, `px`, and `pt`).
              },
              "fontWeight": "A String", # [Font weight](https://www.w3schools.com/cssref/pr_font_weight.asp). Possible values are `normal`, `bold`, `bolder`, and `lighter`.
              "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                "textSegments": [ # The text segments from the Document.text.
                  { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                    "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                    "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                  },
                ],
              },
              "textDecoration": "A String", # [Text decoration](https://www.w3schools.com/cssref/pr_text_text-decoration.asp). Follows CSS standard.
              "textStyle": "A String", # [Text style](https://www.w3schools.com/cssref/pr_font_font-style.asp). Possible values are `normal`, `italic`, and `oblique`.
            },
          ],
          "uri": "A String", # Optional. Currently supports Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. For more information, refer to [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-uris).
        },
        "contentCategory": "A String", # Indicates the category (image, audio, video etc.) of the original content.
        "createTime": "A String", # Output only. The time when the document is created.
        "creator": "A String", # The user who creates the document.
        "displayName": "A String", # Required. Display name of the document given by the user. This name will be displayed in the UI. Customer can populate this field with the name of the document. This differs from the 'title' field as 'title' is optional and stores the top heading in the document.
        "displayUri": "A String", # Uri to display the document, for example, in the UI.
        "dispositionTime": "A String", # Output only. If linked to a Collection with RetentionPolicy, the date when the document becomes mutable.
        "documentSchemaName": "A String", # The Document schema name. Format: projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}.
        "inlineRawDocument": "A String", # Raw document content.
        "legalHold": True or False, # Output only. Indicates if the document has a legal hold on it.
        "name": "A String", # The resource name of the document. Format: projects/{project_number}/locations/{location}/documents/{document_id}. The name is ignored when creating a document.
        "plainText": "A String", # Other document format, such as PPTX, XLXS
        "properties": [ # List of values that are user supplied metadata.
          { # Property of a document.
            "dateTimeValues": { # DateTime values. # Date time property values. It is not supported by CMEK compliant deployment.
              "values": [ # List of datetime values. Both OffsetDateTime and ZonedDateTime are supported.
                { # Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations.
                  "day": 42, # Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day.
                  "hours": 42, # Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults to 0 (midnight). An API may choose to allow the value "24:00:00" for scenarios like business closing time.
                  "minutes": 42, # Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.
                  "month": 42, # Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month.
                  "nanos": 42, # Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0.
                  "seconds": 42, # Optional. Seconds of minutes of the time. Must normally be from 0 to 59, defaults to 0. An API may allow the value 60 if it allows leap-seconds.
                  "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Time zone.
                    "id": "A String", # IANA Time Zone Database time zone. For example "America/New_York".
                    "version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a".
                  },
                  "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.
                  "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.
                },
              ],
            },
            "enumValues": { # Enum values. # Enum property values.
              "values": [ # List of enum values.
                "A String",
              ],
            },
            "floatValues": { # Float values. # Float property values.
              "values": [ # List of float values.
                3.14,
              ],
            },
            "integerValues": { # Integer values. # Integer property values.
              "values": [ # List of integer values.
                42,
              ],
            },
            "mapProperty": { # Map property value. Represents a structured entries of key value pairs, consisting of field names which map to dynamically typed values. # Map property values.
              "fields": { # Unordered map of dynamically typed values.
                "a_key": { # `Value` represents a dynamically typed value which can be either be a float, a integer, a string, or a datetime value. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.
                  "booleanValue": True or False, # Represents a boolean value.
                  "datetimeValue": { # Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations. # Represents a datetime value.
                    "day": 42, # Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day.
                    "hours": 42, # Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults to 0 (midnight). An API may choose to allow the value "24:00:00" for scenarios like business closing time.
                    "minutes": 42, # Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.
                    "month": 42, # Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month.
                    "nanos": 42, # Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0.
                    "seconds": 42, # Optional. Seconds of minutes of the time. Must normally be from 0 to 59, defaults to 0. An API may allow the value 60 if it allows leap-seconds.
                    "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Time zone.
                      "id": "A String", # IANA Time Zone Database time zone. For example "America/New_York".
                      "version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a".
                    },
                    "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.
                    "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.
                  },
                  "enumValue": { # Represents the string value of the enum field. # Represents an enum value.
                    "value": "A String", # String value of the enum field. This must match defined set of enums in document schema using EnumTypeOptions.
                  },
                  "floatValue": 3.14, # Represents a float value.
                  "intValue": 42, # Represents a integer value.
                  "stringValue": "A String", # Represents a string value.
                  "timestampValue": { # Timestamp value type. # Represents a timestamp value.
                    "textValue": "A String", # The string must represent a valid instant in UTC and is parsed using java.time.format.DateTimeFormatter.ISO_INSTANT. e.g. "2013-09-29T18:46:19Z"
                    "timestampValue": "A String", # Timestamp value
                  },
                },
              },
            },
            "name": "A String", # Required. Must match the name of a PropertyDefinition in the DocumentSchema.
            "propertyValues": { # Property values. # Nested structured data property values.
              "properties": [ # List of property values.
                # Object with schema name: GoogleCloudContentwarehouseV1Property
              ],
            },
            "textValues": { # String/text values. # String/text property values.
              "values": [ # List of text values.
                "A String",
              ],
            },
            "timestampValues": { # Timestamp values. # Timestamp property values. It is not supported by CMEK compliant deployment.
              "values": [ # List of timestamp values.
                { # Timestamp value type.
                  "textValue": "A String", # The string must represent a valid instant in UTC and is parsed using java.time.format.DateTimeFormatter.ISO_INSTANT. e.g. "2013-09-29T18:46:19Z"
                  "timestampValue": "A String", # Timestamp value
                },
              ],
            },
          },
        ],
        "rawDocumentFileType": "A String", # This is used when DocAI was not used to load the document and parsing/ extracting is needed for the inline_raw_document. For example, if inline_raw_document is the byte representation of a PDF file, then this should be set to: RAW_DOCUMENT_FILE_TYPE_PDF.
        "rawDocumentPath": "A String", # Raw document file in Cloud Storage path.
        "referenceId": "A String", # The reference ID set by customers. Must be unique per project and location.
        "textExtractionDisabled": True or False, # If true, text extraction will not be performed.
        "textExtractionEnabled": True or False, # If true, text extraction will be performed.
        "title": "A String", # Title that describes the document. This can be the top heading or text that describes the document.
        "updateTime": "A String", # Output only. The time when the document is last updated.
        "updater": "A String", # The user who lastly updates the document.
      },
      "longRunningOperations": [ # post-processing LROs
        { # This resource represents a long-running operation that is the result of a network API call.
          "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
          "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
            "code": 42, # The status code, which should be an enum value of google.rpc.Code.
            "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
              {
                "a_key": "", # Properties of the object. Contains field @type with type URL.
              },
            ],
            "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
          },
          "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
            "a_key": "", # Properties of the object. Contains field @type with type URL.
          },
          "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
          "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
            "a_key": "", # Properties of the object. Contains field @type with type URL.
          },
        },
      ],
      "metadata": { # Additional information returned to client, such as debugging information. # Additional information for the API invocation, such as the request tracking id.
        "requestId": "A String", # A unique id associated with this call. This id is logged for tracking purpose.
      },
      "ruleEngineOutput": { # Records the output of Rule Engine including rule evaluation and actions result. # Output from Rule Engine recording the rule evaluator and action executor's output. Refer format in: google/cloud/contentwarehouse/v1/rule_engine.proto
        "actionExecutorOutput": { # Represents the output of the Action Executor. # Output from Action Executor containing rule and corresponding actions execution result.
          "ruleActionsPairs": [ # List of rule and corresponding actions result.
            { # Represents a rule and outputs of associated actions.
              "actionOutputs": [ # Outputs of executing the actions associated with the above rule.
                { # Represents the result of executing an action.
                  "actionId": "A String", # ID of the action.
                  "actionState": "A String", # State of an action.
                  "outputMessage": "A String", # Action execution output message.
                },
              ],
              "rule": { # Represents the rule for a content warehouse trigger. # Represents the rule.
                "actions": [ # List of actions that are executed when the rule is satisfied.
                  { # Represents the action triggered by Rule Engine when the rule is true.
                    "accessControl": { # Represents the action responsible for access control list management operations. # Action triggering access control operations.
                      "operationType": "A String", # Identifies the type of operation.
                      "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # Represents the new policy from which bindings are added, removed or replaced based on the type of the operation. the policy is limited to a few 10s of KB.
                        "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
                          { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
                            "auditLogConfigs": [ # The configuration for logging of each type of permission.
                              { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
                                "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
                                  "A String",
                                ],
                                "logType": "A String", # The log type that this config enables.
                              },
                            ],
                            "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
                          },
                        ],
                        "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
                          { # Associates `members`, or principals, with a `role`.
                            "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
                              "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
                              "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
                              "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
                              "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
                            },
                            "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
                              "A String",
                            ],
                            "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
                          },
                        ],
                        "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
                        "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
                      },
                    },
                    "actionId": "A String", # ID of the action. Managed internally.
                    "addToFolder": { # Represents the action responsible for adding document under a folder. # Action triggering create document link operation.
                      "folders": [ # Names of the folder under which new document is to be added. Format: projects/{project_number}/locations/{location}/documents/{document_id}.
                        "A String",
                      ],
                    },
                    "dataUpdate": { # Represents the action responsible for properties update operations. # Action triggering data update operations.
                      "entries": { # Map of (K, V) -> (valid name of the field, new value of the field) E.g., ("age", "60") entry triggers update of field age with a value of 60. If the field is not present then new entry is added. During update action execution, value strings will be casted to appropriate types.
                        "a_key": "A String",
                      },
                    },
                    "dataValidation": { # Represents the action responsible for data validation operations. # Action triggering data validation operations.
                      "conditions": { # Map of (K, V) -> (field, string condition to be evaluated on the field) E.g., ("age", "age > 18 && age < 60") entry triggers validation of field age with the given condition. Map entries will be ANDed during validation.
                        "a_key": "A String",
                      },
                    },
                    "deleteDocumentAction": { # Represents the action responsible for deleting the document. # Action deleting the document.
                      "enableHardDelete": True or False, # Boolean field to select between hard vs soft delete options. Set 'true' for 'hard delete' and 'false' for 'soft delete'.
                    },
                    "publishToPubSub": { # Represents the action responsible for publishing messages to a Pub/Sub topic. # Action publish to Pub/Sub operation.
                      "messages": [ # Messages to be published.
                        "A String",
                      ],
                      "topicId": "A String", # The topic id in the Pub/Sub service for which messages will be published to.
                    },
                    "removeFromFolderAction": { # Represents the action responsible for remove a document from a specific folder. # Action removing a document from a folder.
                      "condition": "A String", # Condition of the action to be executed.
                      "folder": "A String", # Name of the folder under which new document is to be added. Format: projects/{project_number}/locations/{location}/documents/{document_id}.
                    },
                  },
                ],
                "condition": "A String", # Represents the conditional expression to be evaluated. Expression should evaluate to a boolean result. When the condition is true actions are executed. Example: user_role = "hsbc_role_1" AND doc.salary > 20000
                "description": "A String", # Short description of the rule and its context.
                "ruleId": "A String", # ID of the rule. It has to be unique across all the examples. This is managed internally.
                "triggerType": "A String", # Identifies the trigger type for running the policy.
              },
            },
          ],
        },
        "documentName": "A String", # Name of the document against which the rules and actions were evaluated.
        "ruleEvaluatorOutput": { # Represents the output of the Rule Evaluator. # Output from Rule Evaluator containing matched, unmatched and invalid rules.
          "invalidRules": [ # A subset of triggered rules that failed the validation check(s) after parsing.
            { # A triggered rule that failed the validation check(s) after parsing.
              "error": "A String", # Validation error on a parsed expression.
              "rule": { # Represents the rule for a content warehouse trigger. # Triggered rule.
                "actions": [ # List of actions that are executed when the rule is satisfied.
                  { # Represents the action triggered by Rule Engine when the rule is true.
                    "accessControl": { # Represents the action responsible for access control list management operations. # Action triggering access control operations.
                      "operationType": "A String", # Identifies the type of operation.
                      "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # Represents the new policy from which bindings are added, removed or replaced based on the type of the operation. the policy is limited to a few 10s of KB.
                        "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
                          { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
                            "auditLogConfigs": [ # The configuration for logging of each type of permission.
                              { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
                                "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
                                  "A String",
                                ],
                                "logType": "A String", # The log type that this config enables.
                              },
                            ],
                            "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
                          },
                        ],
                        "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
                          { # Associates `members`, or principals, with a `role`.
                            "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
                              "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
                              "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
                              "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
                              "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
                            },
                            "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
                              "A String",
                            ],
                            "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
                          },
                        ],
                        "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
                        "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
                      },
                    },
                    "actionId": "A String", # ID of the action. Managed internally.
                    "addToFolder": { # Represents the action responsible for adding document under a folder. # Action triggering create document link operation.
                      "folders": [ # Names of the folder under which new document is to be added. Format: projects/{project_number}/locations/{location}/documents/{document_id}.
                        "A String",
                      ],
                    },
                    "dataUpdate": { # Represents the action responsible for properties update operations. # Action triggering data update operations.
                      "entries": { # Map of (K, V) -> (valid name of the field, new value of the field) E.g., ("age", "60") entry triggers update of field age with a value of 60. If the field is not present then new entry is added. During update action execution, value strings will be casted to appropriate types.
                        "a_key": "A String",
                      },
                    },
                    "dataValidation": { # Represents the action responsible for data validation operations. # Action triggering data validation operations.
                      "conditions": { # Map of (K, V) -> (field, string condition to be evaluated on the field) E.g., ("age", "age > 18 && age < 60") entry triggers validation of field age with the given condition. Map entries will be ANDed during validation.
                        "a_key": "A String",
                      },
                    },
                    "deleteDocumentAction": { # Represents the action responsible for deleting the document. # Action deleting the document.
                      "enableHardDelete": True or False, # Boolean field to select between hard vs soft delete options. Set 'true' for 'hard delete' and 'false' for 'soft delete'.
                    },
                    "publishToPubSub": { # Represents the action responsible for publishing messages to a Pub/Sub topic. # Action publish to Pub/Sub operation.
                      "messages": [ # Messages to be published.
                        "A String",
                      ],
                      "topicId": "A String", # The topic id in the Pub/Sub service for which messages will be published to.
                    },
                    "removeFromFolderAction": { # Represents the action responsible for remove a document from a specific folder. # Action removing a document from a folder.
                      "condition": "A String", # Condition of the action to be executed.
                      "folder": "A String", # Name of the folder under which new document is to be added. Format: projects/{project_number}/locations/{location}/documents/{document_id}.
                    },
                  },
                ],
                "condition": "A String", # Represents the conditional expression to be evaluated. Expression should evaluate to a boolean result. When the condition is true actions are executed. Example: user_role = "hsbc_role_1" AND doc.salary > 20000
                "description": "A String", # Short description of the rule and its context.
                "ruleId": "A String", # ID of the rule. It has to be unique across all the examples. This is managed internally.
                "triggerType": "A String", # Identifies the trigger type for running the policy.
              },
            },
          ],
          "matchedRules": [ # A subset of triggered rules that are evaluated true for a given request.
            { # Represents the rule for a content warehouse trigger.
              "actions": [ # List of actions that are executed when the rule is satisfied.
                { # Represents the action triggered by Rule Engine when the rule is true.
                  "accessControl": { # Represents the action responsible for access control list management operations. # Action triggering access control operations.
                    "operationType": "A String", # Identifies the type of operation.
                    "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # Represents the new policy from which bindings are added, removed or replaced based on the type of the operation. the policy is limited to a few 10s of KB.
                      "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
                        { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
                          "auditLogConfigs": [ # The configuration for logging of each type of permission.
                            { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
                              "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
                                "A String",
                              ],
                              "logType": "A String", # The log type that this config enables.
                            },
                          ],
                          "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
                        },
                      ],
                      "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
                        { # Associates `members`, or principals, with a `role`.
                          "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
                            "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
                            "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
                            "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
                            "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
                          },
                          "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
                            "A String",
                          ],
                          "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
                        },
                      ],
                      "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
                      "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
                    },
                  },
                  "actionId": "A String", # ID of the action. Managed internally.
                  "addToFolder": { # Represents the action responsible for adding document under a folder. # Action triggering create document link operation.
                    "folders": [ # Names of the folder under which new document is to be added. Format: projects/{project_number}/locations/{location}/documents/{document_id}.
                      "A String",
                    ],
                  },
                  "dataUpdate": { # Represents the action responsible for properties update operations. # Action triggering data update operations.
                    "entries": { # Map of (K, V) -> (valid name of the field, new value of the field) E.g., ("age", "60") entry triggers update of field age with a value of 60. If the field is not present then new entry is added. During update action execution, value strings will be casted to appropriate types.
                      "a_key": "A String",
                    },
                  },
                  "dataValidation": { # Represents the action responsible for data validation operations. # Action triggering data validation operations.
                    "conditions": { # Map of (K, V) -> (field, string condition to be evaluated on the field) E.g., ("age", "age > 18 && age < 60") entry triggers validation of field age with the given condition. Map entries will be ANDed during validation.
                      "a_key": "A String",
                    },
                  },
                  "deleteDocumentAction": { # Represents the action responsible for deleting the document. # Action deleting the document.
                    "enableHardDelete": True or False, # Boolean field to select between hard vs soft delete options. Set 'true' for 'hard delete' and 'false' for 'soft delete'.
                  },
                  "publishToPubSub": { # Represents the action responsible for publishing messages to a Pub/Sub topic. # Action publish to Pub/Sub operation.
                    "messages": [ # Messages to be published.
                      "A String",
                    ],
                    "topicId": "A String", # The topic id in the Pub/Sub service for which messages will be published to.
                  },
                  "removeFromFolderAction": { # Represents the action responsible for remove a document from a specific folder. # Action removing a document from a folder.
                    "condition": "A String", # Condition of the action to be executed.
                    "folder": "A String", # Name of the folder under which new document is to be added. Format: projects/{project_number}/locations/{location}/documents/{document_id}.
                  },
                },
              ],
              "condition": "A String", # Represents the conditional expression to be evaluated. Expression should evaluate to a boolean result. When the condition is true actions are executed. Example: user_role = "hsbc_role_1" AND doc.salary > 20000
              "description": "A String", # Short description of the rule and its context.
              "ruleId": "A String", # ID of the rule. It has to be unique across all the examples. This is managed internally.
              "triggerType": "A String", # Identifies the trigger type for running the policy.
            },
          ],
          "triggeredRules": [ # List of rules fetched from database for the given request trigger type.
            { # Represents the rule for a content warehouse trigger.
              "actions": [ # List of actions that are executed when the rule is satisfied.
                { # Represents the action triggered by Rule Engine when the rule is true.
                  "accessControl": { # Represents the action responsible for access control list management operations. # Action triggering access control operations.
                    "operationType": "A String", # Identifies the type of operation.
                    "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # Represents the new policy from which bindings are added, removed or replaced based on the type of the operation. the policy is limited to a few 10s of KB.
                      "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
                        { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
                          "auditLogConfigs": [ # The configuration for logging of each type of permission.
                            { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
                              "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
                                "A String",
                              ],
                              "logType": "A String", # The log type that this config enables.
                            },
                          ],
                          "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
                        },
                      ],
                      "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
                        { # Associates `members`, or principals, with a `role`.
                          "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
                            "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
                            "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
                            "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
                            "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
                          },
                          "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
                            "A String",
                          ],
                          "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
                        },
                      ],
                      "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
                      "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
                    },
                  },
                  "actionId": "A String", # ID of the action. Managed internally.
                  "addToFolder": { # Represents the action responsible for adding document under a folder. # Action triggering create document link operation.
                    "folders": [ # Names of the folder under which new document is to be added. Format: projects/{project_number}/locations/{location}/documents/{document_id}.
                      "A String",
                    ],
                  },
                  "dataUpdate": { # Represents the action responsible for properties update operations. # Action triggering data update operations.
                    "entries": { # Map of (K, V) -> (valid name of the field, new value of the field) E.g., ("age", "60") entry triggers update of field age with a value of 60. If the field is not present then new entry is added. During update action execution, value strings will be casted to appropriate types.
                      "a_key": "A String",
                    },
                  },
                  "dataValidation": { # Represents the action responsible for data validation operations. # Action triggering data validation operations.
                    "conditions": { # Map of (K, V) -> (field, string condition to be evaluated on the field) E.g., ("age", "age > 18 && age < 60") entry triggers validation of field age with the given condition. Map entries will be ANDed during validation.
                      "a_key": "A String",
                    },
                  },
                  "deleteDocumentAction": { # Represents the action responsible for deleting the document. # Action deleting the document.
                    "enableHardDelete": True or False, # Boolean field to select between hard vs soft delete options. Set 'true' for 'hard delete' and 'false' for 'soft delete'.
                  },
                  "publishToPubSub": { # Represents the action responsible for publishing messages to a Pub/Sub topic. # Action publish to Pub/Sub operation.
                    "messages": [ # Messages to be published.
                      "A String",
                    ],
                    "topicId": "A String", # The topic id in the Pub/Sub service for which messages will be published to.
                  },
                  "removeFromFolderAction": { # Represents the action responsible for remove a document from a specific folder. # Action removing a document from a folder.
                    "condition": "A String", # Condition of the action to be executed.
                    "folder": "A String", # Name of the folder under which new document is to be added. Format: projects/{project_number}/locations/{location}/documents/{document_id}.
                  },
                },
              ],
              "condition": "A String", # Represents the conditional expression to be evaluated. Expression should evaluate to a boolean result. When the condition is true actions are executed. Example: user_role = "hsbc_role_1" AND doc.salary > 20000
              "description": "A String", # Short description of the rule and its context.
              "ruleId": "A String", # ID of the rule. It has to be unique across all the examples. This is managed internally.
              "triggerType": "A String", # Identifies the trigger type for running the policy.
            },
          ],
        },
      },
    }

`delete(name, body=None, x__xgafv=None)`

    Deletes a document. Returns NOT_FOUND if the document does not exist.

    Args:
      name: string, Required. The name of the document to delete. Format: projects/{project_number}/locations/{location}/documents/{document_id} or projects/{project_number}/locations/{location}/documents/referenceId/{reference_id}. (required)
      body: object, The request body.
        The object takes the form of:

    { # Request message for DocumentService.DeleteDocument.
      "requestMetadata": { # Meta information is used to improve the performance of the service. # The meta information collected about the end user, used to enforce access control for the service.
        "userInfo": { # The user information. # Provides user unique identification and groups information.
          "groupIds": [ # The unique group identifications which the user is belong to. The format is "group:yyyy@example.com";
            "A String",
          ],
          "id": "A String", # A unique user identification string, as determined by the client. The maximum number of allowed characters is 255. Allowed characters include numbers 0 to 9, uppercase and lowercase letters, and restricted special symbols (:, @, +, -, _, ~) The format is "user:xxxx@example.com";
        },
      },
    }

      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
    }

`fetchAcl(resource, body=None, x__xgafv=None)`

    Gets the access control policy for a resource. Returns NOT_FOUND error if the resource does not exist. Returns an empty policy if the resource exists but does not have a policy set.

    Args:
      resource: string, Required. REQUIRED: The resource for which the policy is being requested. Format for document: projects/{project_number}/locations/{location}/documents/{document_id}. Format for collection: projects/{project_number}/locations/{location}/collections/{collection_id}. Format for project: projects/{project_number}. (required)
      body: object, The request body.
        The object takes the form of:

    { # Request message for DocumentService.FetchAcl
      "projectOwner": True or False, # For Get Project ACL only. Authorization check for end user will be ignored when project_owner=true.
      "requestMetadata": { # Meta information is used to improve the performance of the service. # The meta information collected about the end user, used to enforce access control for the service.
        "userInfo": { # The user information. # Provides user unique identification and groups information.
          "groupIds": [ # The unique group identifications which the user is belong to. The format is "group:yyyy@example.com";
            "A String",
          ],
          "id": "A String", # A unique user identification string, as determined by the client. The maximum number of allowed characters is 255. Allowed characters include numbers 0 to 9, uppercase and lowercase letters, and restricted special symbols (:, @, +, -, _, ~) The format is "user:xxxx@example.com";
        },
      },
    }

      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # Response message for DocumentService.FetchAcl.
      "metadata": { # Additional information returned to client, such as debugging information. # Additional information for the API invocation, such as the request tracking id.
        "requestId": "A String", # A unique id associated with this call. This id is logged for tracking purpose.
      },
      "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # The IAM policy.
        "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
          { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
            "auditLogConfigs": [ # The configuration for logging of each type of permission.
              { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
                "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
                  "A String",
                ],
                "logType": "A String", # The log type that this config enables.
              },
            ],
            "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
          },
        ],
        "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
          { # Associates `members`, or principals, with a `role`.
            "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
              "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
              "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
              "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
              "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
            },
            "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
              "A String",
            ],
            "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
          },
        ],
        "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
        "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
      },
    }

`get(name, body=None, x__xgafv=None)`

    Gets a document. Returns NOT_FOUND if the document does not exist.

    Args:
      name: string, Required. The name of the document to retrieve. Format: projects/{project_number}/locations/{location}/documents/{document_id} or projects/{project_number}/locations/{location}/documents/referenceId/{reference_id}. (required)
      body: object, The request body.
        The object takes the form of:

    { # Request message for DocumentService.GetDocument.
      "requestMetadata": { # Meta information is used to improve the performance of the service. # The meta information collected about the end user, used to enforce access control for the service.
        "userInfo": { # The user information. # Provides user unique identification and groups information.
          "groupIds": [ # The unique group identifications which the user is belong to. The format is "group:yyyy@example.com";
            "A String",
          ],
          "id": "A String", # A unique user identification string, as determined by the client. The maximum number of allowed characters is 255. Allowed characters include numbers 0 to 9, uppercase and lowercase letters, and restricted special symbols (:, @, +, -, _, ~) The format is "user:xxxx@example.com";
        },
      },
    }

      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # Defines the structure for content warehouse document proto.
      "cloudAiDocument": { # Document represents the canonical document resource in Document AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document AI to iterate and optimize for quality. # Document AI format to save the structured content, including OCR.
        "chunkedDocument": { # Represents the chunks that the document is divided into. # Document chunked based on chunking config.
          "chunks": [ # List of chunks.
            { # Represents a chunk.
              "chunkId": "A String", # ID of the chunk.
              "content": "A String", # Text content of the chunk.
              "pageFooters": [ # Page footers associated with the chunk.
                { # Represents the page footer associated with the chunk.
                  "pageSpan": { # Represents where the chunk starts and ends in the document. # Page span of the footer.
                    "pageEnd": 42, # Page where chunk ends in the document.
                    "pageStart": 42, # Page where chunk starts in the document.
                  },
                  "text": "A String", # Footer in text format.
                },
              ],
              "pageHeaders": [ # Page headers associated with the chunk.
                { # Represents the page header associated with the chunk.
                  "pageSpan": { # Represents where the chunk starts and ends in the document. # Page span of the header.
                    "pageEnd": 42, # Page where chunk ends in the document.
                    "pageStart": 42, # Page where chunk starts in the document.
                  },
                  "text": "A String", # Header in text format.
                },
              ],
              "pageSpan": { # Represents where the chunk starts and ends in the document. # Page span of the chunk.
                "pageEnd": 42, # Page where chunk ends in the document.
                "pageStart": 42, # Page where chunk starts in the document.
              },
              "sourceBlockIds": [ # Unused.
                "A String",
              ],
            },
          ],
        },
        "content": "A String", # Optional. Inline document content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64.
        "documentLayout": { # Represents the parsed layout of a document as a collection of blocks that the document is divided into. # Parsed layout of the document.
          "blocks": [ # List of blocks in the document.
            { # Represents a block. A block could be one of the various types (text, table, list) supported.
              "blockId": "A String", # ID of the block.
              "listBlock": { # Represents a list type block. # Block consisting of list content/structure.
                "listEntries": [ # List entries that constitute a list block.
                  { # Represents an entry in the list.
                    "blocks": [ # A list entry is a list of blocks. Repeated blocks support further hierarchies and nested blocks.
                      # Object with schema name: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock
                    ],
                  },
                ],
                "type": "A String", # Type of the list_entries (if exist). Available options are `ordered` and `unordered`.
              },
              "pageSpan": { # Represents where the block starts and ends in the document. # Page span of the block.
                "pageEnd": 42, # Page where block ends in the document.
                "pageStart": 42, # Page where block starts in the document.
              },
              "tableBlock": { # Represents a table type block. # Block consisting of table content/structure.
                "bodyRows": [ # Body rows containing main table content.
                  { # Represents a row in a table.
                    "cells": [ # A table row is a list of table cells.
                      { # Represents a cell in a table row.
                        "blocks": [ # A table cell is a list of blocks. Repeated blocks support further hierarchies and nested blocks.
                          # Object with schema name: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock
                        ],
                        "colSpan": 42, # How many columns this cell spans.
                        "rowSpan": 42, # How many rows this cell spans.
                      },
                    ],
                  },
                ],
                "caption": "A String", # Table caption/title.
                "headerRows": [ # Header rows at the top of the table.
                  { # Represents a row in a table.
                    "cells": [ # A table row is a list of table cells.
                      { # Represents a cell in a table row.
                        "blocks": [ # A table cell is a list of blocks. Repeated blocks support further hierarchies and nested blocks.
                          # Object with schema name: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock
                        ],
                        "colSpan": 42, # How many columns this cell spans.
                        "rowSpan": 42, # How many rows this cell spans.
                      },
                    ],
                  },
                ],
              },
              "textBlock": { # Represents a text type block. # Block consisting of text content.
                "blocks": [ # A text block could further have child blocks. Repeated blocks support further hierarchies and nested blocks.
                  # Object with schema name: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock
                ],
                "text": "A String", # Text content stored in the block.
                "type": "A String", # Type of the text in the block. Available options are: `paragraph`, `subtitle`, `heading-1`, `heading-2`, `heading-3`, `heading-4`, `heading-5`, `header`, `footer`.
              },
            },
          ],
        },
        "entities": [ # A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries.
          { # An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location.
            "confidence": 3.14, # Optional. Confidence of detected Schema entity. Range `[0, 1]`.
            "id": "A String", # Optional. Canonical id. This will be a unique value in the entity list for this document.
            "mentionId": "A String", # Optional. Deprecated. Use `id` field instead.
            "mentionText": "A String", # Optional. Text value of the entity e.g. `1600 Amphitheatre Pkwy`.
            "normalizedValue": { # Parsed and normalized entity value. # Optional. Normalized entity value. Absent if the extracted value could not be converted or the type (e.g. address) is not supported for certain parsers. This field is also only populated for certain supported document types.
              "addressValue": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Postal address. See also: https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto
                "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
                  "A String",
                ],
                "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
                "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
                "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
                "organization": "A String", # Optional. The name of the organization at the address.
                "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
                "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
                  "A String",
                ],
                "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
                "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
                "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
                "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
              },
              "booleanValue": True or False, # Boolean value. Can be used for entities with binary values, or for checkboxes.
              "dateValue": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Date value. Includes year, month, day. See also: https://github.com/googleapis/googleapis/blob/master/google/type/date.proto
                "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
                "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
                "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
              },
              "datetimeValue": { # Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations. # DateTime value. Includes date, time, and timezone. See also: https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto
                "day": 42, # Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day.
                "hours": 42, # Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults to 0 (midnight). An API may choose to allow the value "24:00:00" for scenarios like business closing time.
                "minutes": 42, # Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.
                "month": 42, # Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month.
                "nanos": 42, # Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0.
                "seconds": 42, # Optional. Seconds of minutes of the time. Must normally be from 0 to 59, defaults to 0. An API may allow the value 60 if it allows leap-seconds.
                "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Time zone.
                  "id": "A String", # IANA Time Zone Database time zone. For example "America/New_York".
                  "version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a".
                },
                "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.
                "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.
              },
              "floatValue": 3.14, # Float value.
              "integerValue": 42, # Integer value.
              "moneyValue": { # Represents an amount of money with its currency type. # Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto
                "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
                "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
                "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
              },
              "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format.
            },
            "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found.
              "pageRefs": [ # One or more references to visual page elements
                { # Represents a weak reference to a page element within a document.
                  "boundingPoly": { # A bounding polygon for the detected image annotation. # Optional. Identifies the bounding polygon of a layout element on the page. If `layout_type` is set, the bounding polygon must be exactly the same to the layout element it's referring to.
                    "normalizedVertices": [ # The bounding polygon normalized vertices.
                      { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                        "x": 3.14, # X coordinate.
                        "y": 3.14, # Y coordinate (starts from the top of the image).
                      },
                    ],
                    "vertices": [ # The bounding polygon vertices.
                      { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                        "x": 42, # X coordinate.
                        "y": 42, # Y coordinate (starts from the top of the image).
                      },
                    ],
                  },
                  "confidence": 3.14, # Optional. Confidence of detected page element, if applicable. Range `[0, 1]`.
                  "layoutId": "A String", # Optional. Deprecated. Use PageRef.bounding_poly instead.
                  "layoutType": "A String", # Optional. The type of the layout element that is being referenced if any.
                  "page": "A String", # Required. Index into the Document.pages element, for example using `Document.pages` to locate the related page element. This field is skipped when its value is the default `0`. See https://developers.google.com/protocol-buffers/docs/proto3#json.
                },
              ],
            },
            "properties": [ # Optional. Entities can be nested to form a hierarchical data structure representing the content in the document.
              # Object with schema name: GoogleCloudDocumentaiV1DocumentEntity
            ],
            "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # Optional. The history of this annotation.
              "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
              "parents": [ # References to the original elements that are replaced.
                { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
                  "id": 42, # The id of the parent provenance.
                  "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
                  "revision": 42, # The index of the index into current revision's parent_ids list.
                },
              ],
              "revision": 42, # The index of the revision that produced this element.
              "type": "A String", # The type of provenance operation.
            },
            "redacted": True or False, # Optional. Whether the entity will be redacted for de-identification purposes.
            "textAnchor": { # Text reference indexing into the Document.text. # Optional. Provenance of the entity. Text anchor indexing into the Document.text.
              "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
              "textSegments": [ # The text segments from the Document.text.
                { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                  "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                  "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                },
              ],
            },
            "type": "A String", # Required. Entity type from a schema e.g. `Address`.
          },
        ],
        "entityRelations": [ # Placeholder. Relationship among Document.entities.
          { # Relationship between Entities.
            "objectId": "A String", # Object entity id.
            "relation": "A String", # Relationship description.
            "subjectId": "A String", # Subject entity id.
          },
        ],
        "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Any error that occurred while processing this document.
          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
          "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
            {
              "a_key": "", # Properties of the object. Contains field @type with type URL.
            },
          ],
          "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
        },
        "mimeType": "A String", # An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml).
        "pages": [ # Visual page layout for the Document.
          { # A page in a Document.
            "blocks": [ # A list of visually detected text blocks on the page. A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.
              { # A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.
                "detectedLanguages": [ # A list of detected languages together with confidence.
                  { # Detected language for a structural component.
                    "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
                    "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
                  },
                ],
                "layout": { # Visual element describing a layout unit on a page. # Layout for Block.
                  "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                    "normalizedVertices": [ # The bounding polygon normalized vertices.
                      { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                        "x": 3.14, # X coordinate.
                        "y": 3.14, # Y coordinate (starts from the top of the image).
                      },
                    ],
                    "vertices": [ # The bounding polygon vertices.
                      { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                        "x": 42, # X coordinate.
                        "y": 42, # Y coordinate (starts from the top of the image).
                      },
                    ],
                  },
                  "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                  "orientation": "A String", # Detected orientation for the Layout.
                  "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                    "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                    "textSegments": [ # The text segments from the Document.text.
                      { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                        "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                        "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                      },
                    ],
                  },
                },
                "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation.
                  "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
                  "parents": [ # References to the original elements that are replaced.
                    { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
                      "id": 42, # The id of the parent provenance.
                      "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
                      "revision": 42, # The index of the index into current revision's parent_ids list.
                    },
                  ],
                  "revision": 42, # The index of the revision that produced this element.
                  "type": "A String", # The type of provenance operation.
                },
              },
            ],
            "detectedBarcodes": [ # A list of detected barcodes.
              { # A detected barcode.
                "barcode": { # Encodes the detailed information of a barcode. # Detailed barcode information of the DetectedBarcode.
                  "format": "A 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.
                  "rawValue": "A String", # Raw value encoded in the barcode. For example: `'MEBKM:TITLE:Google;URL:https://www.google.com;;'`.
                  "valueFormat": "A 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.
                },
                "layout": { # Visual element describing a layout unit on a page. # Layout for DetectedBarcode.
                  "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                    "normalizedVertices": [ # The bounding polygon normalized vertices.
                      { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                        "x": 3.14, # X coordinate.
                        "y": 3.14, # Y coordinate (starts from the top of the image).
                      },
                    ],
                    "vertices": [ # The bounding polygon vertices.
                      { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                        "x": 42, # X coordinate.
                        "y": 42, # Y coordinate (starts from the top of the image).
                      },
                    ],
                  },
                  "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                  "orientation": "A String", # Detected orientation for the Layout.
                  "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                    "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                    "textSegments": [ # The text segments from the Document.text.
                      { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                        "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                        "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                      },
                    ],
                  },
                },
              },
            ],
            "detectedLanguages": [ # A list of detected languages together with confidence.
              { # Detected language for a structural component.
                "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
                "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
              },
            ],
            "dimension": { # Dimension for the page. # Physical dimension of the page.
              "height": 3.14, # Page height.
              "unit": "A String", # Dimension unit.
              "width": 3.14, # Page width.
            },
            "formFields": [ # A list of visually detected form fields on the page.
              { # A form field detected on the page.
                "correctedKeyText": "A String", # Created for Labeling UI to export key text. If corrections were made to the text identified by the `field_name.text_anchor`, this field will contain the correction.
                "correctedValueText": "A String", # Created for Labeling UI to export value text. If corrections were made to the text identified by the `field_value.text_anchor`, this field will contain the correction.
                "fieldName": { # Visual element describing a layout unit on a page. # Layout for the FormField name. e.g. `Address`, `Email`, `Grand total`, `Phone number`, etc.
                  "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                    "normalizedVertices": [ # The bounding polygon normalized vertices.
                      { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                        "x": 3.14, # X coordinate.
                        "y": 3.14, # Y coordinate (starts from the top of the image).
                      },
                    ],
                    "vertices": [ # The bounding polygon vertices.
                      { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                        "x": 42, # X coordinate.
                        "y": 42, # Y coordinate (starts from the top of the image).
                      },
                    ],
                  },
                  "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                  "orientation": "A String", # Detected orientation for the Layout.
                  "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                    "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                    "textSegments": [ # The text segments from the Document.text.
                      { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                        "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                        "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                      },
                    ],
                  },
                },
                "fieldValue": { # Visual element describing a layout unit on a page. # Layout for the FormField value.
                  "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                    "normalizedVertices": [ # The bounding polygon normalized vertices.
                      { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                        "x": 3.14, # X coordinate.
                        "y": 3.14, # Y coordinate (starts from the top of the image).
                      },
                    ],
                    "vertices": [ # The bounding polygon vertices.
                      { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                        "x": 42, # X coordinate.
                        "y": 42, # Y coordinate (starts from the top of the image).
                      },
                    ],
                  },
                  "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                  "orientation": "A String", # Detected orientation for the Layout.
                  "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                    "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                    "textSegments": [ # The text segments from the Document.text.
                      { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                        "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                        "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                      },
                    ],
                  },
                },
                "nameDetectedLanguages": [ # A list of detected languages for name together with confidence.
                  { # Detected language for a structural component.
                    "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
                    "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
                  },
                ],
                "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation.
                  "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
                  "parents": [ # References to the original elements that are replaced.
                    { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
                      "id": 42, # The id of the parent provenance.
                      "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
                      "revision": 42, # The index of the index into current revision's parent_ids list.
                    },
                  ],
                  "revision": 42, # The index of the revision that produced this element.
                  "type": "A String", # The type of provenance operation.
                },
                "valueDetectedLanguages": [ # A list of detected languages for value together with confidence.
                  { # Detected language for a structural component.
                    "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
                    "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
                  },
                ],
                "valueType": "A String", # If the value is non-textual, this field represents the type. Current valid values are: - blank (this indicates the `field_value` is normal text) - `unfilled_checkbox` - `filled_checkbox`
              },
            ],
            "image": { # Rendered image contents for this page. # Rendered image for this page. This image is preprocessed to remove any skew, rotation, and distortions such that the annotation bounding boxes can be upright and axis-aligned.
              "content": "A String", # Raw byte content of the image.
              "height": 42, # Height of the image in pixels.
              "mimeType": "A String", # Encoding [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml) for the image.
              "width": 42, # Width of the image in pixels.
            },
            "imageQualityScores": { # Image quality scores for the page image. # Image quality scores.
              "detectedDefects": [ # A list of detected defects.
                { # Image Quality Defects
                  "confidence": 3.14, # Confidence of detected defect. Range `[0, 1]` where `1` indicates strong confidence that the defect exists.
                  "type": "A String", # Name of the defect type. Supported values are: - `quality/defect_blurry` - `quality/defect_noisy` - `quality/defect_dark` - `quality/defect_faint` - `quality/defect_text_too_small` - `quality/defect_document_cutoff` - `quality/defect_text_cutoff` - `quality/defect_glare`
                },
              ],
              "qualityScore": 3.14, # The overall quality score. Range `[0, 1]` where `1` is perfect quality.
            },
            "layout": { # Visual element describing a layout unit on a page. # Layout for the page.
              "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                "normalizedVertices": [ # The bounding polygon normalized vertices.
                  { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                    "x": 3.14, # X coordinate.
                    "y": 3.14, # Y coordinate (starts from the top of the image).
                  },
                ],
                "vertices": [ # The bounding polygon vertices.
                  { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                    "x": 42, # X coordinate.
                    "y": 42, # Y coordinate (starts from the top of the image).
                  },
                ],
              },
              "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
              "orientation": "A String", # Detected orientation for the Layout.
              "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                "textSegments": [ # The text segments from the Document.text.
                  { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                    "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                    "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                  },
                ],
              },
            },
            "lines": [ # A list of visually detected text lines on the page. A collection of tokens that a human would perceive as a line.
              { # A collection of tokens that a human would perceive as a line. Does not cross column boundaries, can be horizontal, vertical, etc.
                "detectedLanguages": [ # A list of detected languages together with confidence.
                  { # Detected language for a structural component.
                    "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
                    "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
                  },
                ],
                "layout": { # Visual element describing a layout unit on a page. # Layout for Line.
                  "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                    "normalizedVertices": [ # The bounding polygon normalized vertices.
                      { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                        "x": 3.14, # X coordinate.
                        "y": 3.14, # Y coordinate (starts from the top of the image).
                      },
                    ],
                    "vertices": [ # The bounding polygon vertices.
                      { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                        "x": 42, # X coordinate.
                        "y": 42, # Y coordinate (starts from the top of the image).
                      },
                    ],
                  },
                  "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                  "orientation": "A String", # Detected orientation for the Layout.
                  "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                    "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                    "textSegments": [ # The text segments from the Document.text.
                      { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                        "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                        "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                      },
                    ],
                  },
                },
                "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation.
                  "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
                  "parents": [ # References to the original elements that are replaced.
                    { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
                      "id": 42, # The id of the parent provenance.
                      "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
                      "revision": 42, # The index of the index into current revision's parent_ids list.
                    },
                  ],
                  "revision": 42, # The index of the revision that produced this element.
                  "type": "A String", # The type of provenance operation.
                },
              },
            ],
            "pageNumber": 42, # 1-based index for current Page in a parent Document. Useful when a page is taken out of a Document for individual processing.
            "paragraphs": [ # A list of visually detected text paragraphs on the page. A collection of lines that a human would perceive as a paragraph.
              { # A collection of lines that a human would perceive as a paragraph.
                "detectedLanguages": [ # A list of detected languages together with confidence.
                  { # Detected language for a structural component.
                    "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
                    "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
                  },
                ],
                "layout": { # Visual element describing a layout unit on a page. # Layout for Paragraph.
                  "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                    "normalizedVertices": [ # The bounding polygon normalized vertices.
                      { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                        "x": 3.14, # X coordinate.
                        "y": 3.14, # Y coordinate (starts from the top of the image).
                      },
                    ],
                    "vertices": [ # The bounding polygon vertices.
                      { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                        "x": 42, # X coordinate.
                        "y": 42, # Y coordinate (starts from the top of the image).
                      },
                    ],
                  },
                  "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                  "orientation": "A String", # Detected orientation for the Layout.
                  "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                    "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                    "textSegments": [ # The text segments from the Document.text.
                      { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                        "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                        "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                      },
                    ],
                  },
                },
                "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation.
                  "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
                  "parents": [ # References to the original elements that are replaced.
                    { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
                      "id": 42, # The id of the parent provenance.
                      "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
                      "revision": 42, # The index of the index into current revision's parent_ids list.
                    },
                  ],
                  "revision": 42, # The index of the revision that produced this element.
                  "type": "A String", # The type of provenance operation.
                },
              },
            ],
            "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this page.
              "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
              "parents": [ # References to the original elements that are replaced.
                { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
                  "id": 42, # The id of the parent provenance.
                  "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
                  "revision": 42, # The index of the index into current revision's parent_ids list.
                },
              ],
              "revision": 42, # The index of the revision that produced this element.
              "type": "A String", # The type of provenance operation.
            },
            "symbols": [ # A list of visually detected symbols on the page.
              { # A detected symbol.
                "detectedLanguages": [ # A list of detected languages together with confidence.
                  { # Detected language for a structural component.
                    "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
                    "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
                  },
                ],
                "layout": { # Visual element describing a layout unit on a page. # Layout for Symbol.
                  "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                    "normalizedVertices": [ # The bounding polygon normalized vertices.
                      { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                        "x": 3.14, # X coordinate.
                        "y": 3.14, # Y coordinate (starts from the top of the image).
                      },
                    ],
                    "vertices": [ # The bounding polygon vertices.
                      { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                        "x": 42, # X coordinate.
                        "y": 42, # Y coordinate (starts from the top of the image).
                      },
                    ],
                  },
                  "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                  "orientation": "A String", # Detected orientation for the Layout.
                  "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                    "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                    "textSegments": [ # The text segments from the Document.text.
                      { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                        "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                        "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                      },
                    ],
                  },
                },
              },
            ],
            "tables": [ # A list of visually detected tables on the page.
              { # A table representation similar to HTML table structure.
                "bodyRows": [ # Body rows of the table.
                  { # A row of table cells.
                    "cells": [ # Cells that make up this row.
                      { # A cell representation inside the table.
                        "colSpan": 42, # How many columns this cell spans.
                        "detectedLanguages": [ # A list of detected languages together with confidence.
                          { # Detected language for a structural component.
                            "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
                            "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
                          },
                        ],
                        "layout": { # Visual element describing a layout unit on a page. # Layout for TableCell.
                          "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                            "normalizedVertices": [ # The bounding polygon normalized vertices.
                              { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                                "x": 3.14, # X coordinate.
                                "y": 3.14, # Y coordinate (starts from the top of the image).
                              },
                            ],
                            "vertices": [ # The bounding polygon vertices.
                              { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                                "x": 42, # X coordinate.
                                "y": 42, # Y coordinate (starts from the top of the image).
                              },
                            ],
                          },
                          "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                          "orientation": "A String", # Detected orientation for the Layout.
                          "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                            "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                            "textSegments": [ # The text segments from the Document.text.
                              { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                                "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                                "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                              },
                            ],
                          },
                        },
                        "rowSpan": 42, # How many rows this cell spans.
                      },
                    ],
                  },
                ],
                "detectedLanguages": [ # A list of detected languages together with confidence.
                  { # Detected language for a structural component.
                    "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
                    "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
                  },
                ],
                "headerRows": [ # Header rows of the table.
                  { # A row of table cells.
                    "cells": [ # Cells that make up this row.
                      { # A cell representation inside the table.
                        "colSpan": 42, # How many columns this cell spans.
                        "detectedLanguages": [ # A list of detected languages together with confidence.
                          { # Detected language for a structural component.
                            "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
                            "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
                          },
                        ],
                        "layout": { # Visual element describing a layout unit on a page. # Layout for TableCell.
                          "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                            "normalizedVertices": [ # The bounding polygon normalized vertices.
                              { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                                "x": 3.14, # X coordinate.
                                "y": 3.14, # Y coordinate (starts from the top of the image).
                              },
                            ],
                            "vertices": [ # The bounding polygon vertices.
                              { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                                "x": 42, # X coordinate.
                                "y": 42, # Y coordinate (starts from the top of the image).
                              },
                            ],
                          },
                          "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                          "orientation": "A String", # Detected orientation for the Layout.
                          "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                            "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                            "textSegments": [ # The text segments from the Document.text.
                              { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                                "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                                "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                              },
                            ],
                          },
                        },
                        "rowSpan": 42, # How many rows this cell spans.
                      },
                    ],
                  },
                ],
                "layout": { # Visual element describing a layout unit on a page. # Layout for Table.
                  "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                    "normalizedVertices": [ # The bounding polygon normalized vertices.
                      { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                        "x": 3.14, # X coordinate.
                        "y": 3.14, # Y coordinate (starts from the top of the image).
                      },
                    ],
                    "vertices": [ # The bounding polygon vertices.
                      { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                        "x": 42, # X coordinate.
                        "y": 42, # Y coordinate (starts from the top of the image).
                      },
                    ],
                  },
                  "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                  "orientation": "A String", # Detected orientation for the Layout.
                  "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                    "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                    "textSegments": [ # The text segments from the Document.text.
                      { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                        "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                        "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                      },
                    ],
                  },
                },
                "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this table.
                  "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
                  "parents": [ # References to the original elements that are replaced.
                    { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
                      "id": 42, # The id of the parent provenance.
                      "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
                      "revision": 42, # The index of the index into current revision's parent_ids list.
                    },
                  ],
                  "revision": 42, # The index of the revision that produced this element.
                  "type": "A String", # The type of provenance operation.
                },
              },
            ],
            "tokens": [ # A list of visually detected tokens on the page.
              { # A detected token.
                "detectedBreak": { # Detected break at the end of a Token. # Detected break at the end of a Token.
                  "type": "A String", # Detected break type.
                },
                "detectedLanguages": [ # A list of detected languages together with confidence.
                  { # Detected language for a structural component.
                    "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
                    "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
                  },
                ],
                "layout": { # Visual element describing a layout unit on a page. # Layout for Token.
                  "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                    "normalizedVertices": [ # The bounding polygon normalized vertices.
                      { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                        "x": 3.14, # X coordinate.
                        "y": 3.14, # Y coordinate (starts from the top of the image).
                      },
                    ],
                    "vertices": [ # The bounding polygon vertices.
                      { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                        "x": 42, # X coordinate.
                        "y": 42, # Y coordinate (starts from the top of the image).
                      },
                    ],
                  },
                  "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                  "orientation": "A String", # Detected orientation for the Layout.
                  "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                    "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                    "textSegments": [ # The text segments from the Document.text.
                      { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                        "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                        "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                      },
                    ],
                  },
                },
                "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation.
                  "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
                  "parents": [ # References to the original elements that are replaced.
                    { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
                      "id": 42, # The id of the parent provenance.
                      "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
                      "revision": 42, # The index of the index into current revision's parent_ids list.
                    },
                  ],
                  "revision": 42, # The index of the revision that produced this element.
                  "type": "A String", # The type of provenance operation.
                },
                "styleInfo": { # Font and other text style attributes. # Text style attributes.
                  "backgroundColor": { # Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ... # Color of the background.
                    "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0).
                    "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                    "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                    "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                  },
                  "bold": True or False, # Whether the text is bold (equivalent to font_weight is at least `700`).
                  "fontSize": 42, # Font size in points (`1` point is `¹⁄₇₂` inches).
                  "fontType": "A String", # Name or style of the font.
                  "fontWeight": 42, # TrueType weight on a scale `100` (thin) to `1000` (ultra-heavy). Normal is `400`, bold is `700`.
                  "handwritten": True or False, # Whether the text is handwritten.
                  "italic": True or False, # Whether the text is italic.
                  "letterSpacing": 3.14, # Letter spacing in points.
                  "pixelFontSize": 3.14, # Font size in pixels, equal to _unrounded font_size_ * _resolution_ ÷ `72.0`.
                  "smallcaps": True or False, # Whether the text is in small caps. This feature is not supported yet.
                  "strikeout": True or False, # Whether the text is strikethrough. This feature is not supported yet.
                  "subscript": True or False, # Whether the text is a subscript. This feature is not supported yet.
                  "superscript": True or False, # Whether the text is a superscript. This feature is not supported yet.
                  "textColor": { # Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ... # Color of the text.
                    "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0).
                    "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                    "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                    "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                  },
                  "underlined": True or False, # Whether the text is underlined.
                },
              },
            ],
            "transforms": [ # Transformation matrices that were applied to the original document image to produce Page.image.
              { # Representation for transformation matrix, intended to be compatible and used with OpenCV format for image manipulation.
                "cols": 42, # Number of columns in the matrix.
                "data": "A String", # The matrix data.
                "rows": 42, # Number of rows in the matrix.
                "type": 42, # This encodes information about what data type the matrix uses. For example, 0 (CV_8U) is an unsigned 8-bit image. For the full list of OpenCV primitive data types, please refer to https://docs.opencv.org/4.3.0/d1/d1b/group__core__hal__interface.html
              },
            ],
            "visualElements": [ # A list of detected non-text visual elements e.g. checkbox, signature etc. on the page.
              { # Detected non-text visual elements e.g. checkbox, signature etc. on the page.
                "detectedLanguages": [ # A list of detected languages together with confidence.
                  { # Detected language for a structural component.
                    "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
                    "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
                  },
                ],
                "layout": { # Visual element describing a layout unit on a page. # Layout for VisualElement.
                  "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                    "normalizedVertices": [ # The bounding polygon normalized vertices.
                      { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                        "x": 3.14, # X coordinate.
                        "y": 3.14, # Y coordinate (starts from the top of the image).
                      },
                    ],
                    "vertices": [ # The bounding polygon vertices.
                      { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                        "x": 42, # X coordinate.
                        "y": 42, # Y coordinate (starts from the top of the image).
                      },
                    ],
                  },
                  "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                  "orientation": "A String", # Detected orientation for the Layout.
                  "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                    "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                    "textSegments": [ # The text segments from the Document.text.
                      { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                        "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                        "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                      },
                    ],
                  },
                },
                "type": "A String", # Type of the VisualElement.
              },
            ],
          },
        ],
        "revisions": [ # Placeholder. Revision history of this document.
          { # Contains past or forward revisions of this document.
            "agent": "A String", # If the change was made by a person specify the name or id of that person.
            "createTime": "A String", # The time that the revision was created, internally generated by doc proto storage at the time of create.
            "humanReview": { # Human Review information of the document. # Human Review information of this revision.
              "state": "A String", # Human review state. e.g. `requested`, `succeeded`, `rejected`.
              "stateMessage": "A String", # A message providing more details about the current state of processing. For example, the rejection reason when the state is `rejected`.
            },
            "id": "A String", # Id of the revision, internally generated by doc proto storage. Unique within the context of the document.
            "parent": [ # The revisions that this revision is based on. This can include one or more parent (when documents are merged.) This field represents the index into the `revisions` field.
              42,
            ],
            "parentIds": [ # The revisions that this revision is based on. Must include all the ids that have anything to do with this revision - eg. there are `provenance.parent.revision` fields that index into this field.
              "A String",
            ],
            "processor": "A String", # If the annotation was made by processor identify the processor by its resource name.
          },
        ],
        "shardInfo": { # For a large document, sharding may be performed to produce several document shards. Each document shard contains this field to detail which shard it is. # Information about the sharding if this document is sharded part of a larger document. If the document is not sharded, this message is not specified.
          "shardCount": "A String", # Total number of shards.
          "shardIndex": "A String", # The 0-based index of this shard.
          "textOffset": "A String", # The index of the first character in Document.text in the overall document global text.
        },
        "text": "A String", # Optional. UTF-8 encoded text in reading order from the document.
        "textChanges": [ # Placeholder. A list of text corrections made to Document.text. This is usually used for annotating corrections to OCR mistakes. Text changes for a given revision may not overlap with each other.
          { # This message is used for text changes aka. OCR corrections.
            "changedText": "A String", # The text that replaces the text identified in the `text_anchor`.
            "provenance": [ # The history of this annotation.
              { # Structure to identify provenance relationships between annotations in different revisions.
                "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
                "parents": [ # References to the original elements that are replaced.
                  { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
                    "id": 42, # The id of the parent provenance.
                    "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
                    "revision": 42, # The index of the index into current revision's parent_ids list.
                  },
                ],
                "revision": 42, # The index of the revision that produced this element.
                "type": "A String", # The type of provenance operation.
              },
            ],
            "textAnchor": { # Text reference indexing into the Document.text. # Provenance of the correction. Text anchor indexing into the Document.text. There can only be a single `TextAnchor.text_segments` element. If the start and end index of the text segment are the same, the text change is inserted before that index.
              "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
              "textSegments": [ # The text segments from the Document.text.
                { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                  "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                  "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                },
              ],
            },
          },
        ],
        "textStyles": [ # Styles for the Document.text.
          { # Annotation for common text style attributes. This adheres to CSS conventions as much as possible.
            "backgroundColor": { # Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ... # Text background color.
              "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0).
              "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
              "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
              "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
            },
            "color": { # Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ... # Text color.
              "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0).
              "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
              "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
              "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
            },
            "fontFamily": "A String", # Font family such as `Arial`, `Times New Roman`. https://www.w3schools.com/cssref/pr_font_font-family.asp
            "fontSize": { # Font size with unit. # Font size.
              "size": 3.14, # Font size for the text.
              "unit": "A String", # Unit for the font size. Follows CSS naming (such as `in`, `px`, and `pt`).
            },
            "fontWeight": "A String", # [Font weight](https://www.w3schools.com/cssref/pr_font_weight.asp). Possible values are `normal`, `bold`, `bolder`, and `lighter`.
            "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
              "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
              "textSegments": [ # The text segments from the Document.text.
                { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                  "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                  "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                },
              ],
            },
            "textDecoration": "A String", # [Text decoration](https://www.w3schools.com/cssref/pr_text_text-decoration.asp). Follows CSS standard.
            "textStyle": "A String", # [Text style](https://www.w3schools.com/cssref/pr_font_font-style.asp). Possible values are `normal`, `italic`, and `oblique`.
          },
        ],
        "uri": "A String", # Optional. Currently supports Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. For more information, refer to [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-uris).
      },
      "contentCategory": "A String", # Indicates the category (image, audio, video etc.) of the original content.
      "createTime": "A String", # Output only. The time when the document is created.
      "creator": "A String", # The user who creates the document.
      "displayName": "A String", # Required. Display name of the document given by the user. This name will be displayed in the UI. Customer can populate this field with the name of the document. This differs from the 'title' field as 'title' is optional and stores the top heading in the document.
      "displayUri": "A String", # Uri to display the document, for example, in the UI.
      "dispositionTime": "A String", # Output only. If linked to a Collection with RetentionPolicy, the date when the document becomes mutable.
      "documentSchemaName": "A String", # The Document schema name. Format: projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}.
      "inlineRawDocument": "A String", # Raw document content.
      "legalHold": True or False, # Output only. Indicates if the document has a legal hold on it.
      "name": "A String", # The resource name of the document. Format: projects/{project_number}/locations/{location}/documents/{document_id}. The name is ignored when creating a document.
      "plainText": "A String", # Other document format, such as PPTX, XLXS
      "properties": [ # List of values that are user supplied metadata.
        { # Property of a document.
          "dateTimeValues": { # DateTime values. # Date time property values. It is not supported by CMEK compliant deployment.
            "values": [ # List of datetime values. Both OffsetDateTime and ZonedDateTime are supported.
              { # Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations.
                "day": 42, # Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day.
                "hours": 42, # Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults to 0 (midnight). An API may choose to allow the value "24:00:00" for scenarios like business closing time.
                "minutes": 42, # Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.
                "month": 42, # Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month.
                "nanos": 42, # Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0.
                "seconds": 42, # Optional. Seconds of minutes of the time. Must normally be from 0 to 59, defaults to 0. An API may allow the value 60 if it allows leap-seconds.
                "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Time zone.
                  "id": "A String", # IANA Time Zone Database time zone. For example "America/New_York".
                  "version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a".
                },
                "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.
                "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.
              },
            ],
          },
          "enumValues": { # Enum values. # Enum property values.
            "values": [ # List of enum values.
              "A String",
            ],
          },
          "floatValues": { # Float values. # Float property values.
            "values": [ # List of float values.
              3.14,
            ],
          },
          "integerValues": { # Integer values. # Integer property values.
            "values": [ # List of integer values.
              42,
            ],
          },
          "mapProperty": { # Map property value. Represents a structured entries of key value pairs, consisting of field names which map to dynamically typed values. # Map property values.
            "fields": { # Unordered map of dynamically typed values.
              "a_key": { # `Value` represents a dynamically typed value which can be either be a float, a integer, a string, or a datetime value. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.
                "booleanValue": True or False, # Represents a boolean value.
                "datetimeValue": { # Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations. # Represents a datetime value.
                  "day": 42, # Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day.
                  "hours": 42, # Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults to 0 (midnight). An API may choose to allow the value "24:00:00" for scenarios like business closing time.
                  "minutes": 42, # Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.
                  "month": 42, # Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month.
                  "nanos": 42, # Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0.
                  "seconds": 42, # Optional. Seconds of minutes of the time. Must normally be from 0 to 59, defaults to 0. An API may allow the value 60 if it allows leap-seconds.
                  "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Time zone.
                    "id": "A String", # IANA Time Zone Database time zone. For example "America/New_York".
                    "version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a".
                  },
                  "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.
                  "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.
                },
                "enumValue": { # Represents the string value of the enum field. # Represents an enum value.
                  "value": "A String", # String value of the enum field. This must match defined set of enums in document schema using EnumTypeOptions.
                },
                "floatValue": 3.14, # Represents a float value.
                "intValue": 42, # Represents a integer value.
                "stringValue": "A String", # Represents a string value.
                "timestampValue": { # Timestamp value type. # Represents a timestamp value.
                  "textValue": "A String", # The string must represent a valid instant in UTC and is parsed using java.time.format.DateTimeFormatter.ISO_INSTANT. e.g. "2013-09-29T18:46:19Z"
                  "timestampValue": "A String", # Timestamp value
                },
              },
            },
          },
          "name": "A String", # Required. Must match the name of a PropertyDefinition in the DocumentSchema.
          "propertyValues": { # Property values. # Nested structured data property values.
            "properties": [ # List of property values.
              # Object with schema name: GoogleCloudContentwarehouseV1Property
            ],
          },
          "textValues": { # String/text values. # String/text property values.
            "values": [ # List of text values.
              "A String",
            ],
          },
          "timestampValues": { # Timestamp values. # Timestamp property values. It is not supported by CMEK compliant deployment.
            "values": [ # List of timestamp values.
              { # Timestamp value type.
                "textValue": "A String", # The string must represent a valid instant in UTC and is parsed using java.time.format.DateTimeFormatter.ISO_INSTANT. e.g. "2013-09-29T18:46:19Z"
                "timestampValue": "A String", # Timestamp value
              },
            ],
          },
        },
      ],
      "rawDocumentFileType": "A String", # This is used when DocAI was not used to load the document and parsing/ extracting is needed for the inline_raw_document. For example, if inline_raw_document is the byte representation of a PDF file, then this should be set to: RAW_DOCUMENT_FILE_TYPE_PDF.
      "rawDocumentPath": "A String", # Raw document file in Cloud Storage path.
      "referenceId": "A String", # The reference ID set by customers. Must be unique per project and location.
      "textExtractionDisabled": True or False, # If true, text extraction will not be performed.
      "textExtractionEnabled": True or False, # If true, text extraction will be performed.
      "title": "A String", # Title that describes the document. This can be the top heading or text that describes the document.
      "updateTime": "A String", # Output only. The time when the document is last updated.
      "updater": "A String", # The user who lastly updates the document.
    }

`linkedSources(parent, body=None, x__xgafv=None)`

    Return all source document-links from the document.

    Args:
      parent: string, Required. The name of the document, for which all source links are returned. Format: projects/{project_number}/locations/{location}/documents/{source_document_id}. (required)
      body: object, The request body.
        The object takes the form of:

    { # Response message for DocumentLinkService.ListLinkedSources.
      "pageSize": 42, # The maximum number of document-links to return. The service may return fewer than this value. If unspecified, at most 50 document-links will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
      "pageToken": "A String", # A page token, received from a previous `ListLinkedSources` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListLinkedSources` must match the call that provided the page token.
      "requestMetadata": { # Meta information is used to improve the performance of the service. # The meta information collected about the document creator, used to enforce access control for the service.
        "userInfo": { # The user information. # Provides user unique identification and groups information.
          "groupIds": [ # The unique group identifications which the user is belong to. The format is "group:yyyy@example.com";
            "A String",
          ],
          "id": "A String", # A unique user identification string, as determined by the client. The maximum number of allowed characters is 255. Allowed characters include numbers 0 to 9, uppercase and lowercase letters, and restricted special symbols (:, @, +, -, _, ~) The format is "user:xxxx@example.com";
        },
      },
    }

      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # Response message for DocumentLinkService.ListLinkedSources.
      "documentLinks": [ # Source document-links.
        { # A document-link between source and target document.
          "createTime": "A String", # Output only. The time when the documentLink is created.
          "description": "A String", # Description of this document-link.
          "name": "A String", # Name of this document-link. It is required that the parent derived form the name to be consistent with the source document reference. Otherwise an exception will be thrown. Format: projects/{project_number}/locations/{location}/documents/{source_document_id}/documentLinks/{document_link_id}.
          "sourceDocumentReference": { # References to the documents. # Document references of the source document.
            "createTime": "A String", # Output only. The time when the document is created.
            "deleteTime": "A String", # Output only. The time when the document is deleted.
            "displayName": "A String", # display_name of the referenced document; this name does not need to be consistent to the display_name in the Document proto, depending on the ACL constraint.
            "documentIsFolder": True or False, # The document type of the document being referenced.
            "documentIsLegalHoldFolder": True or False, # Document is a folder with legal hold.
            "documentIsRetentionFolder": True or False, # Document is a folder with retention policy.
            "documentName": "A String", # Required. Name of the referenced document.
            "snippet": "A String", # Stores the subset of the referenced document's content. This is useful to allow user peek the information of the referenced document.
            "updateTime": "A String", # Output only. The time when the document is last updated.
          },
          "state": "A String", # The state of the documentlink. If target node has been deleted, the link is marked as invalid. Removing a source node will result in removal of all associated links.
          "targetDocumentReference": { # References to the documents. # Document references of the target document.
            "createTime": "A String", # Output only. The time when the document is created.
            "deleteTime": "A String", # Output only. The time when the document is deleted.
            "displayName": "A String", # display_name of the referenced document; this name does not need to be consistent to the display_name in the Document proto, depending on the ACL constraint.
            "documentIsFolder": True or False, # The document type of the document being referenced.
            "documentIsLegalHoldFolder": True or False, # Document is a folder with legal hold.
            "documentIsRetentionFolder": True or False, # Document is a folder with retention policy.
            "documentName": "A String", # Required. Name of the referenced document.
            "snippet": "A String", # Stores the subset of the referenced document's content. This is useful to allow user peek the information of the referenced document.
            "updateTime": "A String", # Output only. The time when the document is last updated.
          },
          "updateTime": "A String", # Output only. The time when the documentLink is last updated.
        },
      ],
      "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
    }

`linkedSources_next()`

    Retrieves the next page of results.

            Args:
              previous_request: The request for the previous page. (required)
              previous_response: The response from the request for the previous page. (required)

            Returns:
              A request object that you can call 'execute()' on to request the next
              page. Returns None if there are no more items in the collection.

`linkedTargets(parent, body=None, x__xgafv=None)`

    Return all target document-links from the document.

    Args:
      parent: string, Required. The name of the document, for which all target links are returned. Format: projects/{project_number}/locations/{location}/documents/{target_document_id}. (required)
      body: object, The request body.
        The object takes the form of:

    { # Request message for DocumentLinkService.ListLinkedTargets.
      "requestMetadata": { # Meta information is used to improve the performance of the service. # The meta information collected about the document creator, used to enforce access control for the service.
        "userInfo": { # The user information. # Provides user unique identification and groups information.
          "groupIds": [ # The unique group identifications which the user is belong to. The format is "group:yyyy@example.com";
            "A String",
          ],
          "id": "A String", # A unique user identification string, as determined by the client. The maximum number of allowed characters is 255. Allowed characters include numbers 0 to 9, uppercase and lowercase letters, and restricted special symbols (:, @, +, -, _, ~) The format is "user:xxxx@example.com";
        },
      },
    }

      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # Response message for DocumentLinkService.ListLinkedTargets.
      "documentLinks": [ # Target document-links.
        { # A document-link between source and target document.
          "createTime": "A String", # Output only. The time when the documentLink is created.
          "description": "A String", # Description of this document-link.
          "name": "A String", # Name of this document-link. It is required that the parent derived form the name to be consistent with the source document reference. Otherwise an exception will be thrown. Format: projects/{project_number}/locations/{location}/documents/{source_document_id}/documentLinks/{document_link_id}.
          "sourceDocumentReference": { # References to the documents. # Document references of the source document.
            "createTime": "A String", # Output only. The time when the document is created.
            "deleteTime": "A String", # Output only. The time when the document is deleted.
            "displayName": "A String", # display_name of the referenced document; this name does not need to be consistent to the display_name in the Document proto, depending on the ACL constraint.
            "documentIsFolder": True or False, # The document type of the document being referenced.
            "documentIsLegalHoldFolder": True or False, # Document is a folder with legal hold.
            "documentIsRetentionFolder": True or False, # Document is a folder with retention policy.
            "documentName": "A String", # Required. Name of the referenced document.
            "snippet": "A String", # Stores the subset of the referenced document's content. This is useful to allow user peek the information of the referenced document.
            "updateTime": "A String", # Output only. The time when the document is last updated.
          },
          "state": "A String", # The state of the documentlink. If target node has been deleted, the link is marked as invalid. Removing a source node will result in removal of all associated links.
          "targetDocumentReference": { # References to the documents. # Document references of the target document.
            "createTime": "A String", # Output only. The time when the document is created.
            "deleteTime": "A String", # Output only. The time when the document is deleted.
            "displayName": "A String", # display_name of the referenced document; this name does not need to be consistent to the display_name in the Document proto, depending on the ACL constraint.
            "documentIsFolder": True or False, # The document type of the document being referenced.
            "documentIsLegalHoldFolder": True or False, # Document is a folder with legal hold.
            "documentIsRetentionFolder": True or False, # Document is a folder with retention policy.
            "documentName": "A String", # Required. Name of the referenced document.
            "snippet": "A String", # Stores the subset of the referenced document's content. This is useful to allow user peek the information of the referenced document.
            "updateTime": "A String", # Output only. The time when the document is last updated.
          },
          "updateTime": "A String", # Output only. The time when the documentLink is last updated.
        },
      ],
      "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
    }

`lock(name, body=None, x__xgafv=None)`

    Lock the document so the document cannot be updated by other users.

    Args:
      name: string, Required. The name of the document to lock. Format: projects/{project_number}/locations/{location}/documents/{document}. (required)
      body: object, The request body.
        The object takes the form of:

    { # Request message for DocumentService.LockDocument.
      "collectionId": "A String", # The collection the document connects to.
      "lockingUser": { # The user information. # The user information who locks the document.
        "groupIds": [ # The unique group identifications which the user is belong to. The format is "group:yyyy@example.com";
          "A String",
        ],
        "id": "A String", # A unique user identification string, as determined by the client. The maximum number of allowed characters is 255. Allowed characters include numbers 0 to 9, uppercase and lowercase letters, and restricted special symbols (:, @, +, -, _, ~) The format is "user:xxxx@example.com";
      },
    }

      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # Defines the structure for content warehouse document proto.
      "cloudAiDocument": { # Document represents the canonical document resource in Document AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document AI to iterate and optimize for quality. # Document AI format to save the structured content, including OCR.
        "chunkedDocument": { # Represents the chunks that the document is divided into. # Document chunked based on chunking config.
          "chunks": [ # List of chunks.
            { # Represents a chunk.
              "chunkId": "A String", # ID of the chunk.
              "content": "A String", # Text content of the chunk.
              "pageFooters": [ # Page footers associated with the chunk.
                { # Represents the page footer associated with the chunk.
                  "pageSpan": { # Represents where the chunk starts and ends in the document. # Page span of the footer.
                    "pageEnd": 42, # Page where chunk ends in the document.
                    "pageStart": 42, # Page where chunk starts in the document.
                  },
                  "text": "A String", # Footer in text format.
                },
              ],
              "pageHeaders": [ # Page headers associated with the chunk.
                { # Represents the page header associated with the chunk.
                  "pageSpan": { # Represents where the chunk starts and ends in the document. # Page span of the header.
                    "pageEnd": 42, # Page where chunk ends in the document.
                    "pageStart": 42, # Page where chunk starts in the document.
                  },
                  "text": "A String", # Header in text format.
                },
              ],
              "pageSpan": { # Represents where the chunk starts and ends in the document. # Page span of the chunk.
                "pageEnd": 42, # Page where chunk ends in the document.
                "pageStart": 42, # Page where chunk starts in the document.
              },
              "sourceBlockIds": [ # Unused.
                "A String",
              ],
            },
          ],
        },
        "content": "A String", # Optional. Inline document content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64.
        "documentLayout": { # Represents the parsed layout of a document as a collection of blocks that the document is divided into. # Parsed layout of the document.
          "blocks": [ # List of blocks in the document.
            { # Represents a block. A block could be one of the various types (text, table, list) supported.
              "blockId": "A String", # ID of the block.
              "listBlock": { # Represents a list type block. # Block consisting of list content/structure.
                "listEntries": [ # List entries that constitute a list block.
                  { # Represents an entry in the list.
                    "blocks": [ # A list entry is a list of blocks. Repeated blocks support further hierarchies and nested blocks.
                      # Object with schema name: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock
                    ],
                  },
                ],
                "type": "A String", # Type of the list_entries (if exist). Available options are `ordered` and `unordered`.
              },
              "pageSpan": { # Represents where the block starts and ends in the document. # Page span of the block.
                "pageEnd": 42, # Page where block ends in the document.
                "pageStart": 42, # Page where block starts in the document.
              },
              "tableBlock": { # Represents a table type block. # Block consisting of table content/structure.
                "bodyRows": [ # Body rows containing main table content.
                  { # Represents a row in a table.
                    "cells": [ # A table row is a list of table cells.
                      { # Represents a cell in a table row.
                        "blocks": [ # A table cell is a list of blocks. Repeated blocks support further hierarchies and nested blocks.
                          # Object with schema name: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock
                        ],
                        "colSpan": 42, # How many columns this cell spans.
                        "rowSpan": 42, # How many rows this cell spans.
                      },
                    ],
                  },
                ],
                "caption": "A String", # Table caption/title.
                "headerRows": [ # Header rows at the top of the table.
                  { # Represents a row in a table.
                    "cells": [ # A table row is a list of table cells.
                      { # Represents a cell in a table row.
                        "blocks": [ # A table cell is a list of blocks. Repeated blocks support further hierarchies and nested blocks.
                          # Object with schema name: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock
                        ],
                        "colSpan": 42, # How many columns this cell spans.
                        "rowSpan": 42, # How many rows this cell spans.
                      },
                    ],
                  },
                ],
              },
              "textBlock": { # Represents a text type block. # Block consisting of text content.
                "blocks": [ # A text block could further have child blocks. Repeated blocks support further hierarchies and nested blocks.
                  # Object with schema name: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock
                ],
                "text": "A String", # Text content stored in the block.
                "type": "A String", # Type of the text in the block. Available options are: `paragraph`, `subtitle`, `heading-1`, `heading-2`, `heading-3`, `heading-4`, `heading-5`, `header`, `footer`.
              },
            },
          ],
        },
        "entities": [ # A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries.
          { # An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location.
            "confidence": 3.14, # Optional. Confidence of detected Schema entity. Range `[0, 1]`.
            "id": "A String", # Optional. Canonical id. This will be a unique value in the entity list for this document.
            "mentionId": "A String", # Optional. Deprecated. Use `id` field instead.
            "mentionText": "A String", # Optional. Text value of the entity e.g. `1600 Amphitheatre Pkwy`.
            "normalizedValue": { # Parsed and normalized entity value. # Optional. Normalized entity value. Absent if the extracted value could not be converted or the type (e.g. address) is not supported for certain parsers. This field is also only populated for certain supported document types.
              "addressValue": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Postal address. See also: https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto
                "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
                  "A String",
                ],
                "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
                "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
                "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
                "organization": "A String", # Optional. The name of the organization at the address.
                "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
                "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
                  "A String",
                ],
                "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
                "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
                "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
                "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
              },
              "booleanValue": True or False, # Boolean value. Can be used for entities with binary values, or for checkboxes.
              "dateValue": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Date value. Includes year, month, day. See also: https://github.com/googleapis/googleapis/blob/master/google/type/date.proto
                "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
                "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
                "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
              },
              "datetimeValue": { # Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations. # DateTime value. Includes date, time, and timezone. See also: https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto
                "day": 42, # Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day.
                "hours": 42, # Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults to 0 (midnight). An API may choose to allow the value "24:00:00" for scenarios like business closing time.
                "minutes": 42, # Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.
                "month": 42, # Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month.
                "nanos": 42, # Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0.
                "seconds": 42, # Optional. Seconds of minutes of the time. Must normally be from 0 to 59, defaults to 0. An API may allow the value 60 if it allows leap-seconds.
                "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Time zone.
                  "id": "A String", # IANA Time Zone Database time zone. For example "America/New_York".
                  "version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a".
                },
                "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.
                "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.
              },
              "floatValue": 3.14, # Float value.
              "integerValue": 42, # Integer value.
              "moneyValue": { # Represents an amount of money with its currency type. # Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto
                "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
                "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
                "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
              },
              "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format.
            },
            "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found.
              "pageRefs": [ # One or more references to visual page elements
                { # Represents a weak reference to a page element within a document.
                  "boundingPoly": { # A bounding polygon for the detected image annotation. # Optional. Identifies the bounding polygon of a layout element on the page. If `layout_type` is set, the bounding polygon must be exactly the same to the layout element it's referring to.
                    "normalizedVertices": [ # The bounding polygon normalized vertices.
                      { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                        "x": 3.14, # X coordinate.
                        "y": 3.14, # Y coordinate (starts from the top of the image).
                      },
                    ],
                    "vertices": [ # The bounding polygon vertices.
                      { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                        "x": 42, # X coordinate.
                        "y": 42, # Y coordinate (starts from the top of the image).
                      },
                    ],
                  },
                  "confidence": 3.14, # Optional. Confidence of detected page element, if applicable. Range `[0, 1]`.
                  "layoutId": "A String", # Optional. Deprecated. Use PageRef.bounding_poly instead.
                  "layoutType": "A String", # Optional. The type of the layout element that is being referenced if any.
                  "page": "A String", # Required. Index into the Document.pages element, for example using `Document.pages` to locate the related page element. This field is skipped when its value is the default `0`. See https://developers.google.com/protocol-buffers/docs/proto3#json.
                },
              ],
            },
            "properties": [ # Optional. Entities can be nested to form a hierarchical data structure representing the content in the document.
              # Object with schema name: GoogleCloudDocumentaiV1DocumentEntity
            ],
            "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # Optional. The history of this annotation.
              "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
              "parents": [ # References to the original elements that are replaced.
                { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
                  "id": 42, # The id of the parent provenance.
                  "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
                  "revision": 42, # The index of the index into current revision's parent_ids list.
                },
              ],
              "revision": 42, # The index of the revision that produced this element.
              "type": "A String", # The type of provenance operation.
            },
            "redacted": True or False, # Optional. Whether the entity will be redacted for de-identification purposes.
            "textAnchor": { # Text reference indexing into the Document.text. # Optional. Provenance of the entity. Text anchor indexing into the Document.text.
              "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
              "textSegments": [ # The text segments from the Document.text.
                { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                  "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                  "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                },
              ],
            },
            "type": "A String", # Required. Entity type from a schema e.g. `Address`.
          },
        ],
        "entityRelations": [ # Placeholder. Relationship among Document.entities.
          { # Relationship between Entities.
            "objectId": "A String", # Object entity id.
            "relation": "A String", # Relationship description.
            "subjectId": "A String", # Subject entity id.
          },
        ],
        "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Any error that occurred while processing this document.
          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
          "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
            {
              "a_key": "", # Properties of the object. Contains field @type with type URL.
            },
          ],
          "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
        },
        "mimeType": "A String", # An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml).
        "pages": [ # Visual page layout for the Document.
          { # A page in a Document.
            "blocks": [ # A list of visually detected text blocks on the page. A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.
              { # A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.
                "detectedLanguages": [ # A list of detected languages together with confidence.
                  { # Detected language for a structural component.
                    "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
                    "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
                  },
                ],
                "layout": { # Visual element describing a layout unit on a page. # Layout for Block.
                  "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                    "normalizedVertices": [ # The bounding polygon normalized vertices.
                      { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                        "x": 3.14, # X coordinate.
                        "y": 3.14, # Y coordinate (starts from the top of the image).
                      },
                    ],
                    "vertices": [ # The bounding polygon vertices.
                      { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                        "x": 42, # X coordinate.
                        "y": 42, # Y coordinate (starts from the top of the image).
                      },
                    ],
                  },
                  "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                  "orientation": "A String", # Detected orientation for the Layout.
                  "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                    "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                    "textSegments": [ # The text segments from the Document.text.
                      { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                        "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                        "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                      },
                    ],
                  },
                },
                "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation.
                  "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
                  "parents": [ # References to the original elements that are replaced.
                    { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
                      "id": 42, # The id of the parent provenance.
                      "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
                      "revision": 42, # The index of the index into current revision's parent_ids list.
                    },
                  ],
                  "revision": 42, # The index of the revision that produced this element.
                  "type": "A String", # The type of provenance operation.
                },
              },
            ],
            "detectedBarcodes": [ # A list of detected barcodes.
              { # A detected barcode.
                "barcode": { # Encodes the detailed information of a barcode. # Detailed barcode information of the DetectedBarcode.
                  "format": "A 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.
                  "rawValue": "A String", # Raw value encoded in the barcode. For example: `'MEBKM:TITLE:Google;URL:https://www.google.com;;'`.
                  "valueFormat": "A 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.
                },
                "layout": { # Visual element describing a layout unit on a page. # Layout for DetectedBarcode.
                  "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                    "normalizedVertices": [ # The bounding polygon normalized vertices.
                      { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                        "x": 3.14, # X coordinate.
                        "y": 3.14, # Y coordinate (starts from the top of the image).
                      },
                    ],
                    "vertices": [ # The bounding polygon vertices.
                      { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                        "x": 42, # X coordinate.
                        "y": 42, # Y coordinate (starts from the top of the image).
                      },
                    ],
                  },
                  "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                  "orientation": "A String", # Detected orientation for the Layout.
                  "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                    "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                    "textSegments": [ # The text segments from the Document.text.
                      { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                        "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                        "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                      },
                    ],
                  },
                },
              },
            ],
            "detectedLanguages": [ # A list of detected languages together with confidence.
              { # Detected language for a structural component.
                "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
                "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
              },
            ],
            "dimension": { # Dimension for the page. # Physical dimension of the page.
              "height": 3.14, # Page height.
              "unit": "A String", # Dimension unit.
              "width": 3.14, # Page width.
            },
            "formFields": [ # A list of visually detected form fields on the page.
              { # A form field detected on the page.
                "correctedKeyText": "A String", # Created for Labeling UI to export key text. If corrections were made to the text identified by the `field_name.text_anchor`, this field will contain the correction.
                "correctedValueText": "A String", # Created for Labeling UI to export value text. If corrections were made to the text identified by the `field_value.text_anchor`, this field will contain the correction.
                "fieldName": { # Visual element describing a layout unit on a page. # Layout for the FormField name. e.g. `Address`, `Email`, `Grand total`, `Phone number`, etc.
                  "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                    "normalizedVertices": [ # The bounding polygon normalized vertices.
                      { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                        "x": 3.14, # X coordinate.
                        "y": 3.14, # Y coordinate (starts from the top of the image).
                      },
                    ],
                    "vertices": [ # The bounding polygon vertices.
                      { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                        "x": 42, # X coordinate.
                        "y": 42, # Y coordinate (starts from the top of the image).
                      },
                    ],
                  },
                  "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                  "orientation": "A String", # Detected orientation for the Layout.
                  "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                    "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                    "textSegments": [ # The text segments from the Document.text.
                      { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                        "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                        "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                      },
                    ],
                  },
                },
                "fieldValue": { # Visual element describing a layout unit on a page. # Layout for the FormField value.
                  "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                    "normalizedVertices": [ # The bounding polygon normalized vertices.
                      { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                        "x": 3.14, # X coordinate.
                        "y": 3.14, # Y coordinate (starts from the top of the image).
                      },
                    ],
                    "vertices": [ # The bounding polygon vertices.
                      { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                        "x": 42, # X coordinate.
                        "y": 42, # Y coordinate (starts from the top of the image).
                      },
                    ],
                  },
                  "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                  "orientation": "A String", # Detected orientation for the Layout.
                  "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                    "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                    "textSegments": [ # The text segments from the Document.text.
                      { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                        "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                        "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                      },
                    ],
                  },
                },
                "nameDetectedLanguages": [ # A list of detected languages for name together with confidence.
                  { # Detected language for a structural component.
                    "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
                    "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
                  },
                ],
                "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation.
                  "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
                  "parents": [ # References to the original elements that are replaced.
                    { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
                      "id": 42, # The id of the parent provenance.
                      "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
                      "revision": 42, # The index of the index into current revision's parent_ids list.
                    },
                  ],
                  "revision": 42, # The index of the revision that produced this element.
                  "type": "A String", # The type of provenance operation.
                },
                "valueDetectedLanguages": [ # A list of detected languages for value together with confidence.
                  { # Detected language for a structural component.
                    "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
                    "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
                  },
                ],
                "valueType": "A String", # If the value is non-textual, this field represents the type. Current valid values are: - blank (this indicates the `field_value` is normal text) - `unfilled_checkbox` - `filled_checkbox`
              },
            ],
            "image": { # Rendered image contents for this page. # Rendered image for this page. This image is preprocessed to remove any skew, rotation, and distortions such that the annotation bounding boxes can be upright and axis-aligned.
              "content": "A String", # Raw byte content of the image.
              "height": 42, # Height of the image in pixels.
              "mimeType": "A String", # Encoding [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml) for the image.
              "width": 42, # Width of the image in pixels.
            },
            "imageQualityScores": { # Image quality scores for the page image. # Image quality scores.
              "detectedDefects": [ # A list of detected defects.
                { # Image Quality Defects
                  "confidence": 3.14, # Confidence of detected defect. Range `[0, 1]` where `1` indicates strong confidence that the defect exists.
                  "type": "A String", # Name of the defect type. Supported values are: - `quality/defect_blurry` - `quality/defect_noisy` - `quality/defect_dark` - `quality/defect_faint` - `quality/defect_text_too_small` - `quality/defect_document_cutoff` - `quality/defect_text_cutoff` - `quality/defect_glare`
                },
              ],
              "qualityScore": 3.14, # The overall quality score. Range `[0, 1]` where `1` is perfect quality.
            },
            "layout": { # Visual element describing a layout unit on a page. # Layout for the page.
              "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                "normalizedVertices": [ # The bounding polygon normalized vertices.
                  { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                    "x": 3.14, # X coordinate.
                    "y": 3.14, # Y coordinate (starts from the top of the image).
                  },
                ],
                "vertices": [ # The bounding polygon vertices.
                  { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                    "x": 42, # X coordinate.
                    "y": 42, # Y coordinate (starts from the top of the image).
                  },
                ],
              },
              "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
              "orientation": "A String", # Detected orientation for the Layout.
              "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                "textSegments": [ # The text segments from the Document.text.
                  { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                    "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                    "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                  },
                ],
              },
            },
            "lines": [ # A list of visually detected text lines on the page. A collection of tokens that a human would perceive as a line.
              { # A collection of tokens that a human would perceive as a line. Does not cross column boundaries, can be horizontal, vertical, etc.
                "detectedLanguages": [ # A list of detected languages together with confidence.
                  { # Detected language for a structural component.
                    "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
                    "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
                  },
                ],
                "layout": { # Visual element describing a layout unit on a page. # Layout for Line.
                  "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                    "normalizedVertices": [ # The bounding polygon normalized vertices.
                      { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                        "x": 3.14, # X coordinate.
                        "y": 3.14, # Y coordinate (starts from the top of the image).
                      },
                    ],
                    "vertices": [ # The bounding polygon vertices.
                      { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                        "x": 42, # X coordinate.
                        "y": 42, # Y coordinate (starts from the top of the image).
                      },
                    ],
                  },
                  "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                  "orientation": "A String", # Detected orientation for the Layout.
                  "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                    "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                    "textSegments": [ # The text segments from the Document.text.
                      { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                        "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                        "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                      },
                    ],
                  },
                },
                "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation.
                  "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
                  "parents": [ # References to the original elements that are replaced.
                    { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
                      "id": 42, # The id of the parent provenance.
                      "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
                      "revision": 42, # The index of the index into current revision's parent_ids list.
                    },
                  ],
                  "revision": 42, # The index of the revision that produced this element.
                  "type": "A String", # The type of provenance operation.
                },
              },
            ],
            "pageNumber": 42, # 1-based index for current Page in a parent Document. Useful when a page is taken out of a Document for individual processing.
            "paragraphs": [ # A list of visually detected text paragraphs on the page. A collection of lines that a human would perceive as a paragraph.
              { # A collection of lines that a human would perceive as a paragraph.
                "detectedLanguages": [ # A list of detected languages together with confidence.
                  { # Detected language for a structural component.
                    "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
                    "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
                  },
                ],
                "layout": { # Visual element describing a layout unit on a page. # Layout for Paragraph.
                  "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                    "normalizedVertices": [ # The bounding polygon normalized vertices.
                      { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                        "x": 3.14, # X coordinate.
                        "y": 3.14, # Y coordinate (starts from the top of the image).
                      },
                    ],
                    "vertices": [ # The bounding polygon vertices.
                      { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                        "x": 42, # X coordinate.
                        "y": 42, # Y coordinate (starts from the top of the image).
                      },
                    ],
                  },
                  "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                  "orientation": "A String", # Detected orientation for the Layout.
                  "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                    "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                    "textSegments": [ # The text segments from the Document.text.
                      { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                        "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                        "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                      },
                    ],
                  },
                },
                "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation.
                  "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
                  "parents": [ # References to the original elements that are replaced.
                    { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
                      "id": 42, # The id of the parent provenance.
                      "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
                      "revision": 42, # The index of the index into current revision's parent_ids list.
                    },
                  ],
                  "revision": 42, # The index of the revision that produced this element.
                  "type": "A String", # The type of provenance operation.
                },
              },
            ],
            "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this page.
              "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
              "parents": [ # References to the original elements that are replaced.
                { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
                  "id": 42, # The id of the parent provenance.
                  "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
                  "revision": 42, # The index of the index into current revision's parent_ids list.
                },
              ],
              "revision": 42, # The index of the revision that produced this element.
              "type": "A String", # The type of provenance operation.
            },
            "symbols": [ # A list of visually detected symbols on the page.
              { # A detected symbol.
                "detectedLanguages": [ # A list of detected languages together with confidence.
                  { # Detected language for a structural component.
                    "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
                    "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
                  },
                ],
                "layout": { # Visual element describing a layout unit on a page. # Layout for Symbol.
                  "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                    "normalizedVertices": [ # The bounding polygon normalized vertices.
                      { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                        "x": 3.14, # X coordinate.
                        "y": 3.14, # Y coordinate (starts from the top of the image).
                      },
                    ],
                    "vertices": [ # The bounding polygon vertices.
                      { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                        "x": 42, # X coordinate.
                        "y": 42, # Y coordinate (starts from the top of the image).
                      },
                    ],
                  },
                  "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                  "orientation": "A String", # Detected orientation for the Layout.
                  "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                    "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                    "textSegments": [ # The text segments from the Document.text.
                      { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                        "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                        "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                      },
                    ],
                  },
                },
              },
            ],
            "tables": [ # A list of visually detected tables on the page.
              { # A table representation similar to HTML table structure.
                "bodyRows": [ # Body rows of the table.
                  { # A row of table cells.
                    "cells": [ # Cells that make up this row.
                      { # A cell representation inside the table.
                        "colSpan": 42, # How many columns this cell spans.
                        "detectedLanguages": [ # A list of detected languages together with confidence.
                          { # Detected language for a structural component.
                            "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
                            "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
                          },
                        ],
                        "layout": { # Visual element describing a layout unit on a page. # Layout for TableCell.
                          "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                            "normalizedVertices": [ # The bounding polygon normalized vertices.
                              { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                                "x": 3.14, # X coordinate.
                                "y": 3.14, # Y coordinate (starts from the top of the image).
                              },
                            ],
                            "vertices": [ # The bounding polygon vertices.
                              { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                                "x": 42, # X coordinate.
                                "y": 42, # Y coordinate (starts from the top of the image).
                              },
                            ],
                          },
                          "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                          "orientation": "A String", # Detected orientation for the Layout.
                          "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                            "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                            "textSegments": [ # The text segments from the Document.text.
                              { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                                "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                                "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                              },
                            ],
                          },
                        },
                        "rowSpan": 42, # How many rows this cell spans.
                      },
                    ],
                  },
                ],
                "detectedLanguages": [ # A list of detected languages together with confidence.
                  { # Detected language for a structural component.
                    "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
                    "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
                  },
                ],
                "headerRows": [ # Header rows of the table.
                  { # A row of table cells.
                    "cells": [ # Cells that make up this row.
                      { # A cell representation inside the table.
                        "colSpan": 42, # How many columns this cell spans.
                        "detectedLanguages": [ # A list of detected languages together with confidence.
                          { # Detected language for a structural component.
                            "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
                            "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
                          },
                        ],
                        "layout": { # Visual element describing a layout unit on a page. # Layout for TableCell.
                          "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                            "normalizedVertices": [ # The bounding polygon normalized vertices.
                              { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                                "x": 3.14, # X coordinate.
                                "y": 3.14, # Y coordinate (starts from the top of the image).
                              },
                            ],
                            "vertices": [ # The bounding polygon vertices.
                              { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                                "x": 42, # X coordinate.
                                "y": 42, # Y coordinate (starts from the top of the image).
                              },
                            ],
                          },
                          "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                          "orientation": "A String", # Detected orientation for the Layout.
                          "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                            "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                            "textSegments": [ # The text segments from the Document.text.
                              { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                                "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                                "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                              },
                            ],
                          },
                        },
                        "rowSpan": 42, # How many rows this cell spans.
                      },
                    ],
                  },
                ],
                "layout": { # Visual element describing a layout unit on a page. # Layout for Table.
                  "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                    "normalizedVertices": [ # The bounding polygon normalized vertices.
                      { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                        "x": 3.14, # X coordinate.
                        "y": 3.14, # Y coordinate (starts from the top of the image).
                      },
                    ],
                    "vertices": [ # The bounding polygon vertices.
                      { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                        "x": 42, # X coordinate.
                        "y": 42, # Y coordinate (starts from the top of the image).
                      },
                    ],
                  },
                  "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                  "orientation": "A String", # Detected orientation for the Layout.
                  "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                    "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                    "textSegments": [ # The text segments from the Document.text.
                      { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                        "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                        "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                      },
                    ],
                  },
                },
                "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this table.
                  "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
                  "parents": [ # References to the original elements that are replaced.
                    { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
                      "id": 42, # The id of the parent provenance.
                      "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
                      "revision": 42, # The index of the index into current revision's parent_ids list.
                    },
                  ],
                  "revision": 42, # The index of the revision that produced this element.
                  "type": "A String", # The type of provenance operation.
                },
              },
            ],
            "tokens": [ # A list of visually detected tokens on the page.
              { # A detected token.
                "detectedBreak": { # Detected break at the end of a Token. # Detected break at the end of a Token.
                  "type": "A String", # Detected break type.
                },
                "detectedLanguages": [ # A list of detected languages together with confidence.
                  { # Detected language for a structural component.
                    "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
                    "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
                  },
                ],
                "layout": { # Visual element describing a layout unit on a page. # Layout for Token.
                  "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                    "normalizedVertices": [ # The bounding polygon normalized vertices.
                      { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                        "x": 3.14, # X coordinate.
                        "y": 3.14, # Y coordinate (starts from the top of the image).
                      },
                    ],
                    "vertices": [ # The bounding polygon vertices.
                      { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                        "x": 42, # X coordinate.
                        "y": 42, # Y coordinate (starts from the top of the image).
                      },
                    ],
                  },
                  "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                  "orientation": "A String", # Detected orientation for the Layout.
                  "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                    "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                    "textSegments": [ # The text segments from the Document.text.
                      { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                        "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                        "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                      },
                    ],
                  },
                },
                "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation.
                  "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
                  "parents": [ # References to the original elements that are replaced.
                    { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
                      "id": 42, # The id of the parent provenance.
                      "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
                      "revision": 42, # The index of the index into current revision's parent_ids list.
                    },
                  ],
                  "revision": 42, # The index of the revision that produced this element.
                  "type": "A String", # The type of provenance operation.
                },
                "styleInfo": { # Font and other text style attributes. # Text style attributes.
                  "backgroundColor": { # Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ... # Color of the background.
                    "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0).
                    "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                    "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                    "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                  },
                  "bold": True or False, # Whether the text is bold (equivalent to font_weight is at least `700`).
                  "fontSize": 42, # Font size in points (`1` point is `¹⁄₇₂` inches).
                  "fontType": "A String", # Name or style of the font.
                  "fontWeight": 42, # TrueType weight on a scale `100` (thin) to `1000` (ultra-heavy). Normal is `400`, bold is `700`.
                  "handwritten": True or False, # Whether the text is handwritten.
                  "italic": True or False, # Whether the text is italic.
                  "letterSpacing": 3.14, # Letter spacing in points.
                  "pixelFontSize": 3.14, # Font size in pixels, equal to _unrounded font_size_ * _resolution_ ÷ `72.0`.
                  "smallcaps": True or False, # Whether the text is in small caps. This feature is not supported yet.
                  "strikeout": True or False, # Whether the text is strikethrough. This feature is not supported yet.
                  "subscript": True or False, # Whether the text is a subscript. This feature is not supported yet.
                  "superscript": True or False, # Whether the text is a superscript. This feature is not supported yet.
                  "textColor": { # Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ... # Color of the text.
                    "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0).
                    "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                    "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                    "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                  },
                  "underlined": True or False, # Whether the text is underlined.
                },
              },
            ],
            "transforms": [ # Transformation matrices that were applied to the original document image to produce Page.image.
              { # Representation for transformation matrix, intended to be compatible and used with OpenCV format for image manipulation.
                "cols": 42, # Number of columns in the matrix.
                "data": "A String", # The matrix data.
                "rows": 42, # Number of rows in the matrix.
                "type": 42, # This encodes information about what data type the matrix uses. For example, 0 (CV_8U) is an unsigned 8-bit image. For the full list of OpenCV primitive data types, please refer to https://docs.opencv.org/4.3.0/d1/d1b/group__core__hal__interface.html
              },
            ],
            "visualElements": [ # A list of detected non-text visual elements e.g. checkbox, signature etc. on the page.
              { # Detected non-text visual elements e.g. checkbox, signature etc. on the page.
                "detectedLanguages": [ # A list of detected languages together with confidence.
                  { # Detected language for a structural component.
                    "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
                    "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
                  },
                ],
                "layout": { # Visual element describing a layout unit on a page. # Layout for VisualElement.
                  "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                    "normalizedVertices": [ # The bounding polygon normalized vertices.
                      { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                        "x": 3.14, # X coordinate.
                        "y": 3.14, # Y coordinate (starts from the top of the image).
                      },
                    ],
                    "vertices": [ # The bounding polygon vertices.
                      { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                        "x": 42, # X coordinate.
                        "y": 42, # Y coordinate (starts from the top of the image).
                      },
                    ],
                  },
                  "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                  "orientation": "A String", # Detected orientation for the Layout.
                  "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                    "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                    "textSegments": [ # The text segments from the Document.text.
                      { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                        "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                        "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                      },
                    ],
                  },
                },
                "type": "A String", # Type of the VisualElement.
              },
            ],
          },
        ],
        "revisions": [ # Placeholder. Revision history of this document.
          { # Contains past or forward revisions of this document.
            "agent": "A String", # If the change was made by a person specify the name or id of that person.
            "createTime": "A String", # The time that the revision was created, internally generated by doc proto storage at the time of create.
            "humanReview": { # Human Review information of the document. # Human Review information of this revision.
              "state": "A String", # Human review state. e.g. `requested`, `succeeded`, `rejected`.
              "stateMessage": "A String", # A message providing more details about the current state of processing. For example, the rejection reason when the state is `rejected`.
            },
            "id": "A String", # Id of the revision, internally generated by doc proto storage. Unique within the context of the document.
            "parent": [ # The revisions that this revision is based on. This can include one or more parent (when documents are merged.) This field represents the index into the `revisions` field.
              42,
            ],
            "parentIds": [ # The revisions that this revision is based on. Must include all the ids that have anything to do with this revision - eg. there are `provenance.parent.revision` fields that index into this field.
              "A String",
            ],
            "processor": "A String", # If the annotation was made by processor identify the processor by its resource name.
          },
        ],
        "shardInfo": { # For a large document, sharding may be performed to produce several document shards. Each document shard contains this field to detail which shard it is. # Information about the sharding if this document is sharded part of a larger document. If the document is not sharded, this message is not specified.
          "shardCount": "A String", # Total number of shards.
          "shardIndex": "A String", # The 0-based index of this shard.
          "textOffset": "A String", # The index of the first character in Document.text in the overall document global text.
        },
        "text": "A String", # Optional. UTF-8 encoded text in reading order from the document.
        "textChanges": [ # Placeholder. A list of text corrections made to Document.text. This is usually used for annotating corrections to OCR mistakes. Text changes for a given revision may not overlap with each other.
          { # This message is used for text changes aka. OCR corrections.
            "changedText": "A String", # The text that replaces the text identified in the `text_anchor`.
            "provenance": [ # The history of this annotation.
              { # Structure to identify provenance relationships between annotations in different revisions.
                "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
                "parents": [ # References to the original elements that are replaced.
                  { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
                    "id": 42, # The id of the parent provenance.
                    "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
                    "revision": 42, # The index of the index into current revision's parent_ids list.
                  },
                ],
                "revision": 42, # The index of the revision that produced this element.
                "type": "A String", # The type of provenance operation.
              },
            ],
            "textAnchor": { # Text reference indexing into the Document.text. # Provenance of the correction. Text anchor indexing into the Document.text. There can only be a single `TextAnchor.text_segments` element. If the start and end index of the text segment are the same, the text change is inserted before that index.
              "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
              "textSegments": [ # The text segments from the Document.text.
                { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                  "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                  "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                },
              ],
            },
          },
        ],
        "textStyles": [ # Styles for the Document.text.
          { # Annotation for common text style attributes. This adheres to CSS conventions as much as possible.
            "backgroundColor": { # Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ... # Text background color.
              "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0).
              "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
              "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
              "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
            },
            "color": { # Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ... # Text color.
              "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0).
              "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
              "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
              "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
            },
            "fontFamily": "A String", # Font family such as `Arial`, `Times New Roman`. https://www.w3schools.com/cssref/pr_font_font-family.asp
            "fontSize": { # Font size with unit. # Font size.
              "size": 3.14, # Font size for the text.
              "unit": "A String", # Unit for the font size. Follows CSS naming (such as `in`, `px`, and `pt`).
            },
            "fontWeight": "A String", # [Font weight](https://www.w3schools.com/cssref/pr_font_weight.asp). Possible values are `normal`, `bold`, `bolder`, and `lighter`.
            "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
              "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
              "textSegments": [ # The text segments from the Document.text.
                { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                  "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                  "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                },
              ],
            },
            "textDecoration": "A String", # [Text decoration](https://www.w3schools.com/cssref/pr_text_text-decoration.asp). Follows CSS standard.
            "textStyle": "A String", # [Text style](https://www.w3schools.com/cssref/pr_font_font-style.asp). Possible values are `normal`, `italic`, and `oblique`.
          },
        ],
        "uri": "A String", # Optional. Currently supports Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. For more information, refer to [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-uris).
      },
      "contentCategory": "A String", # Indicates the category (image, audio, video etc.) of the original content.
      "createTime": "A String", # Output only. The time when the document is created.
      "creator": "A String", # The user who creates the document.
      "displayName": "A String", # Required. Display name of the document given by the user. This name will be displayed in the UI. Customer can populate this field with the name of the document. This differs from the 'title' field as 'title' is optional and stores the top heading in the document.
      "displayUri": "A String", # Uri to display the document, for example, in the UI.
      "dispositionTime": "A String", # Output only. If linked to a Collection with RetentionPolicy, the date when the document becomes mutable.
      "documentSchemaName": "A String", # The Document schema name. Format: projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}.
      "inlineRawDocument": "A String", # Raw document content.
      "legalHold": True or False, # Output only. Indicates if the document has a legal hold on it.
      "name": "A String", # The resource name of the document. Format: projects/{project_number}/locations/{location}/documents/{document_id}. The name is ignored when creating a document.
      "plainText": "A String", # Other document format, such as PPTX, XLXS
      "properties": [ # List of values that are user supplied metadata.
        { # Property of a document.
          "dateTimeValues": { # DateTime values. # Date time property values. It is not supported by CMEK compliant deployment.
            "values": [ # List of datetime values. Both OffsetDateTime and ZonedDateTime are supported.
              { # Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations.
                "day": 42, # Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day.
                "hours": 42, # Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults to 0 (midnight). An API may choose to allow the value "24:00:00" for scenarios like business closing time.
                "minutes": 42, # Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.
                "month": 42, # Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month.
                "nanos": 42, # Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0.
                "seconds": 42, # Optional. Seconds of minutes of the time. Must normally be from 0 to 59, defaults to 0. An API may allow the value 60 if it allows leap-seconds.
                "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Time zone.
                  "id": "A String", # IANA Time Zone Database time zone. For example "America/New_York".
                  "version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a".
                },
                "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.
                "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.
              },
            ],
          },
          "enumValues": { # Enum values. # Enum property values.
            "values": [ # List of enum values.
              "A String",
            ],
          },
          "floatValues": { # Float values. # Float property values.
            "values": [ # List of float values.
              3.14,
            ],
          },
          "integerValues": { # Integer values. # Integer property values.
            "values": [ # List of integer values.
              42,
            ],
          },
          "mapProperty": { # Map property value. Represents a structured entries of key value pairs, consisting of field names which map to dynamically typed values. # Map property values.
            "fields": { # Unordered map of dynamically typed values.
              "a_key": { # `Value` represents a dynamically typed value which can be either be a float, a integer, a string, or a datetime value. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.
                "booleanValue": True or False, # Represents a boolean value.
                "datetimeValue": { # Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations. # Represents a datetime value.
                  "day": 42, # Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day.
                  "hours": 42, # Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults to 0 (midnight). An API may choose to allow the value "24:00:00" for scenarios like business closing time.
                  "minutes": 42, # Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.
                  "month": 42, # Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month.
                  "nanos": 42, # Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0.
                  "seconds": 42, # Optional. Seconds of minutes of the time. Must normally be from 0 to 59, defaults to 0. An API may allow the value 60 if it allows leap-seconds.
                  "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Time zone.
                    "id": "A String", # IANA Time Zone Database time zone. For example "America/New_York".
                    "version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a".
                  },
                  "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.
                  "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.
                },
                "enumValue": { # Represents the string value of the enum field. # Represents an enum value.
                  "value": "A String", # String value of the enum field. This must match defined set of enums in document schema using EnumTypeOptions.
                },
                "floatValue": 3.14, # Represents a float value.
                "intValue": 42, # Represents a integer value.
                "stringValue": "A String", # Represents a string value.
                "timestampValue": { # Timestamp value type. # Represents a timestamp value.
                  "textValue": "A String", # The string must represent a valid instant in UTC and is parsed using java.time.format.DateTimeFormatter.ISO_INSTANT. e.g. "2013-09-29T18:46:19Z"
                  "timestampValue": "A String", # Timestamp value
                },
              },
            },
          },
          "name": "A String", # Required. Must match the name of a PropertyDefinition in the DocumentSchema.
          "propertyValues": { # Property values. # Nested structured data property values.
            "properties": [ # List of property values.
              # Object with schema name: GoogleCloudContentwarehouseV1Property
            ],
          },
          "textValues": { # String/text values. # String/text property values.
            "values": [ # List of text values.
              "A String",
            ],
          },
          "timestampValues": { # Timestamp values. # Timestamp property values. It is not supported by CMEK compliant deployment.
            "values": [ # List of timestamp values.
              { # Timestamp value type.
                "textValue": "A String", # The string must represent a valid instant in UTC and is parsed using java.time.format.DateTimeFormatter.ISO_INSTANT. e.g. "2013-09-29T18:46:19Z"
                "timestampValue": "A String", # Timestamp value
              },
            ],
          },
        },
      ],
      "rawDocumentFileType": "A String", # This is used when DocAI was not used to load the document and parsing/ extracting is needed for the inline_raw_document. For example, if inline_raw_document is the byte representation of a PDF file, then this should be set to: RAW_DOCUMENT_FILE_TYPE_PDF.
      "rawDocumentPath": "A String", # Raw document file in Cloud Storage path.
      "referenceId": "A String", # The reference ID set by customers. Must be unique per project and location.
      "textExtractionDisabled": True or False, # If true, text extraction will not be performed.
      "textExtractionEnabled": True or False, # If true, text extraction will be performed.
      "title": "A String", # Title that describes the document. This can be the top heading or text that describes the document.
      "updateTime": "A String", # Output only. The time when the document is last updated.
      "updater": "A String", # The user who lastly updates the document.
    }

`patch(name, body=None, x__xgafv=None)`

    Updates a document. Returns INVALID_ARGUMENT if the name of the document is non-empty and does not equal the existing name.

    Args:
      name: string, Required. The name of the document to update. Format: projects/{project_number}/locations/{location}/documents/{document_id} or projects/{project_number}/locations/{location}/documents/referenceId/{reference_id}. (required)
      body: object, The request body.
        The object takes the form of:

    { # Request message for DocumentService.UpdateDocument.
      "cloudAiDocumentOption": { # Request Option for processing Cloud AI Document in CW Document. # Request Option for processing Cloud AI Document in Document Warehouse. This field offers limited support for mapping entities from Cloud AI Document to Warehouse Document. Please consult with product team before using this field and other available options.
        "customizedEntitiesPropertiesConversions": { # If set, only selected entities will be converted to properties.
          "a_key": "A String",
        },
        "enableEntitiesConversions": True or False, # Whether to convert all the entities to properties.
      },
      "document": { # Defines the structure for content warehouse document proto. # Required. The document to update.
        "cloudAiDocument": { # Document represents the canonical document resource in Document AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document AI to iterate and optimize for quality. # Document AI format to save the structured content, including OCR.
          "chunkedDocument": { # Represents the chunks that the document is divided into. # Document chunked based on chunking config.
            "chunks": [ # List of chunks.
              { # Represents a chunk.
                "chunkId": "A String", # ID of the chunk.
                "content": "A String", # Text content of the chunk.
                "pageFooters": [ # Page footers associated with the chunk.
                  { # Represents the page footer associated with the chunk.
                    "pageSpan": { # Represents where the chunk starts and ends in the document. # Page span of the footer.
                      "pageEnd": 42, # Page where chunk ends in the document.
                      "pageStart": 42, # Page where chunk starts in the document.
                    },
                    "text": "A String", # Footer in text format.
                  },
                ],
                "pageHeaders": [ # Page headers associated with the chunk.
                  { # Represents the page header associated with the chunk.
                    "pageSpan": { # Represents where the chunk starts and ends in the document. # Page span of the header.
                      "pageEnd": 42, # Page where chunk ends in the document.
                      "pageStart": 42, # Page where chunk starts in the document.
                    },
                    "text": "A String", # Header in text format.
                  },
                ],
                "pageSpan": { # Represents where the chunk starts and ends in the document. # Page span of the chunk.
                  "pageEnd": 42, # Page where chunk ends in the document.
                  "pageStart": 42, # Page where chunk starts in the document.
                },
                "sourceBlockIds": [ # Unused.
                  "A String",
                ],
              },
            ],
          },
          "content": "A String", # Optional. Inline document content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64.
          "documentLayout": { # Represents the parsed layout of a document as a collection of blocks that the document is divided into. # Parsed layout of the document.
            "blocks": [ # List of blocks in the document.
              { # Represents a block. A block could be one of the various types (text, table, list) supported.
                "blockId": "A String", # ID of the block.
                "listBlock": { # Represents a list type block. # Block consisting of list content/structure.
                  "listEntries": [ # List entries that constitute a list block.
                    { # Represents an entry in the list.
                      "blocks": [ # A list entry is a list of blocks. Repeated blocks support further hierarchies and nested blocks.
                        # Object with schema name: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock
                      ],
                    },
                  ],
                  "type": "A String", # Type of the list_entries (if exist). Available options are `ordered` and `unordered`.
                },
                "pageSpan": { # Represents where the block starts and ends in the document. # Page span of the block.
                  "pageEnd": 42, # Page where block ends in the document.
                  "pageStart": 42, # Page where block starts in the document.
                },
                "tableBlock": { # Represents a table type block. # Block consisting of table content/structure.
                  "bodyRows": [ # Body rows containing main table content.
                    { # Represents a row in a table.
                      "cells": [ # A table row is a list of table cells.
                        { # Represents a cell in a table row.
                          "blocks": [ # A table cell is a list of blocks. Repeated blocks support further hierarchies and nested blocks.
                            # Object with schema name: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock
                          ],
                          "colSpan": 42, # How many columns this cell spans.
                          "rowSpan": 42, # How many rows this cell spans.
                        },
                      ],
                    },
                  ],
                  "caption": "A String", # Table caption/title.
                  "headerRows": [ # Header rows at the top of the table.
                    { # Represents a row in a table.
                      "cells": [ # A table row is a list of table cells.
                        { # Represents a cell in a table row.
                          "blocks": [ # A table cell is a list of blocks. Repeated blocks support further hierarchies and nested blocks.
                            # Object with schema name: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock
                          ],
                          "colSpan": 42, # How many columns this cell spans.
                          "rowSpan": 42, # How many rows this cell spans.
                        },
                      ],
                    },
                  ],
                },
                "textBlock": { # Represents a text type block. # Block consisting of text content.
                  "blocks": [ # A text block could further have child blocks. Repeated blocks support further hierarchies and nested blocks.
                    # Object with schema name: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock
                  ],
                  "text": "A String", # Text content stored in the block.
                  "type": "A String", # Type of the text in the block. Available options are: `paragraph`, `subtitle`, `heading-1`, `heading-2`, `heading-3`, `heading-4`, `heading-5`, `header`, `footer`.
                },
              },
            ],
          },
          "entities": [ # A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries.
            { # An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location.
              "confidence": 3.14, # Optional. Confidence of detected Schema entity. Range `[0, 1]`.
              "id": "A String", # Optional. Canonical id. This will be a unique value in the entity list for this document.
              "mentionId": "A String", # Optional. Deprecated. Use `id` field instead.
              "mentionText": "A String", # Optional. Text value of the entity e.g. `1600 Amphitheatre Pkwy`.
              "normalizedValue": { # Parsed and normalized entity value. # Optional. Normalized entity value. Absent if the extracted value could not be converted or the type (e.g. address) is not supported for certain parsers. This field is also only populated for certain supported document types.
                "addressValue": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Postal address. See also: https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto
                  "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
                    "A String",
                  ],
                  "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
                  "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
                  "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
                  "organization": "A String", # Optional. The name of the organization at the address.
                  "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
                  "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
                    "A String",
                  ],
                  "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
                  "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
                  "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
                  "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
                },
                "booleanValue": True or False, # Boolean value. Can be used for entities with binary values, or for checkboxes.
                "dateValue": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Date value. Includes year, month, day. See also: https://github.com/googleapis/googleapis/blob/master/google/type/date.proto
                  "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
                  "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
                  "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
                },
                "datetimeValue": { # Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations. # DateTime value. Includes date, time, and timezone. See also: https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto
                  "day": 42, # Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day.
                  "hours": 42, # Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults to 0 (midnight). An API may choose to allow the value "24:00:00" for scenarios like business closing time.
                  "minutes": 42, # Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.
                  "month": 42, # Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month.
                  "nanos": 42, # Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0.
                  "seconds": 42, # Optional. Seconds of minutes of the time. Must normally be from 0 to 59, defaults to 0. An API may allow the value 60 if it allows leap-seconds.
                  "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Time zone.
                    "id": "A String", # IANA Time Zone Database time zone. For example "America/New_York".
                    "version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a".
                  },
                  "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.
                  "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.
                },
                "floatValue": 3.14, # Float value.
                "integerValue": 42, # Integer value.
                "moneyValue": { # Represents an amount of money with its currency type. # Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto
                  "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
                  "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
                  "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
                },
                "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format.
              },
              "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found.
                "pageRefs": [ # One or more references to visual page elements
                  { # Represents a weak reference to a page element within a document.
                    "boundingPoly": { # A bounding polygon for the detected image annotation. # Optional. Identifies the bounding polygon of a layout element on the page. If `layout_type` is set, the bounding polygon must be exactly the same to the layout element it's referring to.
                      "normalizedVertices": [ # The bounding polygon normalized vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                          "x": 3.14, # X coordinate.
                          "y": 3.14, # Y coordinate (starts from the top of the image).
                        },
                      ],
                      "vertices": [ # The bounding polygon vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                          "x": 42, # X coordinate.
                          "y": 42, # Y coordinate (starts from the top of the image).
                        },
                      ],
                    },
                    "confidence": 3.14, # Optional. Confidence of detected page element, if applicable. Range `[0, 1]`.
                    "layoutId": "A String", # Optional. Deprecated. Use PageRef.bounding_poly instead.
                    "layoutType": "A String", # Optional. The type of the layout element that is being referenced if any.
                    "page": "A String", # Required. Index into the Document.pages element, for example using `Document.pages` to locate the related page element. This field is skipped when its value is the default `0`. See https://developers.google.com/protocol-buffers/docs/proto3#json.
                  },
                ],
              },
              "properties": [ # Optional. Entities can be nested to form a hierarchical data structure representing the content in the document.
                # Object with schema name: GoogleCloudDocumentaiV1DocumentEntity
              ],
              "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # Optional. The history of this annotation.
                "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
                "parents": [ # References to the original elements that are replaced.
                  { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
                    "id": 42, # The id of the parent provenance.
                    "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
                    "revision": 42, # The index of the index into current revision's parent_ids list.
                  },
                ],
                "revision": 42, # The index of the revision that produced this element.
                "type": "A String", # The type of provenance operation.
              },
              "redacted": True or False, # Optional. Whether the entity will be redacted for de-identification purposes.
              "textAnchor": { # Text reference indexing into the Document.text. # Optional. Provenance of the entity. Text anchor indexing into the Document.text.
                "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                "textSegments": [ # The text segments from the Document.text.
                  { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                    "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                    "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                  },
                ],
              },
              "type": "A String", # Required. Entity type from a schema e.g. `Address`.
            },
          ],
          "entityRelations": [ # Placeholder. Relationship among Document.entities.
            { # Relationship between Entities.
              "objectId": "A String", # Object entity id.
              "relation": "A String", # Relationship description.
              "subjectId": "A String", # Subject entity id.
            },
          ],
          "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Any error that occurred while processing this document.
            "code": 42, # The status code, which should be an enum value of google.rpc.Code.
            "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
              {
                "a_key": "", # Properties of the object. Contains field @type with type URL.
              },
            ],
            "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
          },
          "mimeType": "A String", # An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml).
          "pages": [ # Visual page layout for the Document.
            { # A page in a Document.
              "blocks": [ # A list of visually detected text blocks on the page. A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.
                { # A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.
                  "detectedLanguages": [ # A list of detected languages together with confidence.
                    { # Detected language for a structural component.
                      "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
                      "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
                    },
                  ],
                  "layout": { # Visual element describing a layout unit on a page. # Layout for Block.
                    "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                      "normalizedVertices": [ # The bounding polygon normalized vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                          "x": 3.14, # X coordinate.
                          "y": 3.14, # Y coordinate (starts from the top of the image).
                        },
                      ],
                      "vertices": [ # The bounding polygon vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                          "x": 42, # X coordinate.
                          "y": 42, # Y coordinate (starts from the top of the image).
                        },
                      ],
                    },
                    "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                    "orientation": "A String", # Detected orientation for the Layout.
                    "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                      "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                      "textSegments": [ # The text segments from the Document.text.
                        { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                          "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                          "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                        },
                      ],
                    },
                  },
                  "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation.
                    "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
                    "parents": [ # References to the original elements that are replaced.
                      { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
                        "id": 42, # The id of the parent provenance.
                        "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
                        "revision": 42, # The index of the index into current revision's parent_ids list.
                      },
                    ],
                    "revision": 42, # The index of the revision that produced this element.
                    "type": "A String", # The type of provenance operation.
                  },
                },
              ],
              "detectedBarcodes": [ # A list of detected barcodes.
                { # A detected barcode.
                  "barcode": { # Encodes the detailed information of a barcode. # Detailed barcode information of the DetectedBarcode.
                    "format": "A 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.
                    "rawValue": "A String", # Raw value encoded in the barcode. For example: `'MEBKM:TITLE:Google;URL:https://www.google.com;;'`.
                    "valueFormat": "A 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.
                  },
                  "layout": { # Visual element describing a layout unit on a page. # Layout for DetectedBarcode.
                    "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                      "normalizedVertices": [ # The bounding polygon normalized vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                          "x": 3.14, # X coordinate.
                          "y": 3.14, # Y coordinate (starts from the top of the image).
                        },
                      ],
                      "vertices": [ # The bounding polygon vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                          "x": 42, # X coordinate.
                          "y": 42, # Y coordinate (starts from the top of the image).
                        },
                      ],
                    },
                    "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                    "orientation": "A String", # Detected orientation for the Layout.
                    "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                      "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                      "textSegments": [ # The text segments from the Document.text.
                        { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                          "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                          "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                        },
                      ],
                    },
                  },
                },
              ],
              "detectedLanguages": [ # A list of detected languages together with confidence.
                { # Detected language for a structural component.
                  "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
                  "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
                },
              ],
              "dimension": { # Dimension for the page. # Physical dimension of the page.
                "height": 3.14, # Page height.
                "unit": "A String", # Dimension unit.
                "width": 3.14, # Page width.
              },
              "formFields": [ # A list of visually detected form fields on the page.
                { # A form field detected on the page.
                  "correctedKeyText": "A String", # Created for Labeling UI to export key text. If corrections were made to the text identified by the `field_name.text_anchor`, this field will contain the correction.
                  "correctedValueText": "A String", # Created for Labeling UI to export value text. If corrections were made to the text identified by the `field_value.text_anchor`, this field will contain the correction.
                  "fieldName": { # Visual element describing a layout unit on a page. # Layout for the FormField name. e.g. `Address`, `Email`, `Grand total`, `Phone number`, etc.
                    "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                      "normalizedVertices": [ # The bounding polygon normalized vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                          "x": 3.14, # X coordinate.
                          "y": 3.14, # Y coordinate (starts from the top of the image).
                        },
                      ],
                      "vertices": [ # The bounding polygon vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                          "x": 42, # X coordinate.
                          "y": 42, # Y coordinate (starts from the top of the image).
                        },
                      ],
                    },
                    "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                    "orientation": "A String", # Detected orientation for the Layout.
                    "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                      "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                      "textSegments": [ # The text segments from the Document.text.
                        { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                          "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                          "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                        },
                      ],
                    },
                  },
                  "fieldValue": { # Visual element describing a layout unit on a page. # Layout for the FormField value.
                    "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                      "normalizedVertices": [ # The bounding polygon normalized vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                          "x": 3.14, # X coordinate.
                          "y": 3.14, # Y coordinate (starts from the top of the image).
                        },
                      ],
                      "vertices": [ # The bounding polygon vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                          "x": 42, # X coordinate.
                          "y": 42, # Y coordinate (starts from the top of the image).
                        },
                      ],
                    },
                    "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                    "orientation": "A String", # Detected orientation for the Layout.
                    "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                      "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                      "textSegments": [ # The text segments from the Document.text.
                        { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                          "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                          "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                        },
                      ],
                    },
                  },
                  "nameDetectedLanguages": [ # A list of detected languages for name together with confidence.
                    { # Detected language for a structural component.
                      "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
                      "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
                    },
                  ],
                  "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation.
                    "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
                    "parents": [ # References to the original elements that are replaced.
                      { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
                        "id": 42, # The id of the parent provenance.
                        "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
                        "revision": 42, # The index of the index into current revision's parent_ids list.
                      },
                    ],
                    "revision": 42, # The index of the revision that produced this element.
                    "type": "A String", # The type of provenance operation.
                  },
                  "valueDetectedLanguages": [ # A list of detected languages for value together with confidence.
                    { # Detected language for a structural component.
                      "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
                      "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
                    },
                  ],
                  "valueType": "A String", # If the value is non-textual, this field represents the type. Current valid values are: - blank (this indicates the `field_value` is normal text) - `unfilled_checkbox` - `filled_checkbox`
                },
              ],
              "image": { # Rendered image contents for this page. # Rendered image for this page. This image is preprocessed to remove any skew, rotation, and distortions such that the annotation bounding boxes can be upright and axis-aligned.
                "content": "A String", # Raw byte content of the image.
                "height": 42, # Height of the image in pixels.
                "mimeType": "A String", # Encoding [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml) for the image.
                "width": 42, # Width of the image in pixels.
              },
              "imageQualityScores": { # Image quality scores for the page image. # Image quality scores.
                "detectedDefects": [ # A list of detected defects.
                  { # Image Quality Defects
                    "confidence": 3.14, # Confidence of detected defect. Range `[0, 1]` where `1` indicates strong confidence that the defect exists.
                    "type": "A String", # Name of the defect type. Supported values are: - `quality/defect_blurry` - `quality/defect_noisy` - `quality/defect_dark` - `quality/defect_faint` - `quality/defect_text_too_small` - `quality/defect_document_cutoff` - `quality/defect_text_cutoff` - `quality/defect_glare`
                  },
                ],
                "qualityScore": 3.14, # The overall quality score. Range `[0, 1]` where `1` is perfect quality.
              },
              "layout": { # Visual element describing a layout unit on a page. # Layout for the page.
                "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                  "normalizedVertices": [ # The bounding polygon normalized vertices.
                    { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                      "x": 3.14, # X coordinate.
                      "y": 3.14, # Y coordinate (starts from the top of the image).
                    },
                  ],
                  "vertices": [ # The bounding polygon vertices.
                    { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                      "x": 42, # X coordinate.
                      "y": 42, # Y coordinate (starts from the top of the image).
                    },
                  ],
                },
                "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                "orientation": "A String", # Detected orientation for the Layout.
                "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                  "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                  "textSegments": [ # The text segments from the Document.text.
                    { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                      "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                      "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                    },
                  ],
                },
              },
              "lines": [ # A list of visually detected text lines on the page. A collection of tokens that a human would perceive as a line.
                { # A collection of tokens that a human would perceive as a line. Does not cross column boundaries, can be horizontal, vertical, etc.
                  "detectedLanguages": [ # A list of detected languages together with confidence.
                    { # Detected language for a structural component.
                      "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
                      "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
                    },
                  ],
                  "layout": { # Visual element describing a layout unit on a page. # Layout for Line.
                    "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                      "normalizedVertices": [ # The bounding polygon normalized vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                          "x": 3.14, # X coordinate.
                          "y": 3.14, # Y coordinate (starts from the top of the image).
                        },
                      ],
                      "vertices": [ # The bounding polygon vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                          "x": 42, # X coordinate.
                          "y": 42, # Y coordinate (starts from the top of the image).
                        },
                      ],
                    },
                    "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                    "orientation": "A String", # Detected orientation for the Layout.
                    "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                      "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                      "textSegments": [ # The text segments from the Document.text.
                        { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                          "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                          "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                        },
                      ],
                    },
                  },
                  "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation.
                    "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
                    "parents": [ # References to the original elements that are replaced.
                      { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
                        "id": 42, # The id of the parent provenance.
                        "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
                        "revision": 42, # The index of the index into current revision's parent_ids list.
                      },
                    ],
                    "revision": 42, # The index of the revision that produced this element.
                    "type": "A String", # The type of provenance operation.
                  },
                },
              ],
              "pageNumber": 42, # 1-based index for current Page in a parent Document. Useful when a page is taken out of a Document for individual processing.
              "paragraphs": [ # A list of visually detected text paragraphs on the page. A collection of lines that a human would perceive as a paragraph.
                { # A collection of lines that a human would perceive as a paragraph.
                  "detectedLanguages": [ # A list of detected languages together with confidence.
                    { # Detected language for a structural component.
                      "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
                      "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
                    },
                  ],
                  "layout": { # Visual element describing a layout unit on a page. # Layout for Paragraph.
                    "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                      "normalizedVertices": [ # The bounding polygon normalized vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                          "x": 3.14, # X coordinate.
                          "y": 3.14, # Y coordinate (starts from the top of the image).
                        },
                      ],
                      "vertices": [ # The bounding polygon vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                          "x": 42, # X coordinate.
                          "y": 42, # Y coordinate (starts from the top of the image).
                        },
                      ],
                    },
                    "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                    "orientation": "A String", # Detected orientation for the Layout.
                    "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                      "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                      "textSegments": [ # The text segments from the Document.text.
                        { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                          "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                          "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                        },
                      ],
                    },
                  },
                  "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation.
                    "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
                    "parents": [ # References to the original elements that are replaced.
                      { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
                        "id": 42, # The id of the parent provenance.
                        "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
                        "revision": 42, # The index of the index into current revision's parent_ids list.
                      },
                    ],
                    "revision": 42, # The index of the revision that produced this element.
                    "type": "A String", # The type of provenance operation.
                  },
                },
              ],
              "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this page.
                "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
                "parents": [ # References to the original elements that are replaced.
                  { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
                    "id": 42, # The id of the parent provenance.
                    "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
                    "revision": 42, # The index of the index into current revision's parent_ids list.
                  },
                ],
                "revision": 42, # The index of the revision that produced this element.
                "type": "A String", # The type of provenance operation.
              },
              "symbols": [ # A list of visually detected symbols on the page.
                { # A detected symbol.
                  "detectedLanguages": [ # A list of detected languages together with confidence.
                    { # Detected language for a structural component.
                      "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
                      "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
                    },
                  ],
                  "layout": { # Visual element describing a layout unit on a page. # Layout for Symbol.
                    "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                      "normalizedVertices": [ # The bounding polygon normalized vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                          "x": 3.14, # X coordinate.
                          "y": 3.14, # Y coordinate (starts from the top of the image).
                        },
                      ],
                      "vertices": [ # The bounding polygon vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                          "x": 42, # X coordinate.
                          "y": 42, # Y coordinate (starts from the top of the image).
                        },
                      ],
                    },
                    "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                    "orientation": "A String", # Detected orientation for the Layout.
                    "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                      "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                      "textSegments": [ # The text segments from the Document.text.
                        { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                          "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                          "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                        },
                      ],
                    },
                  },
                },
              ],
              "tables": [ # A list of visually detected tables on the page.
                { # A table representation similar to HTML table structure.
                  "bodyRows": [ # Body rows of the table.
                    { # A row of table cells.
                      "cells": [ # Cells that make up this row.
                        { # A cell representation inside the table.
                          "colSpan": 42, # How many columns this cell spans.
                          "detectedLanguages": [ # A list of detected languages together with confidence.
                            { # Detected language for a structural component.
                              "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
                              "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
                            },
                          ],
                          "layout": { # Visual element describing a layout unit on a page. # Layout for TableCell.
                            "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                              "normalizedVertices": [ # The bounding polygon normalized vertices.
                                { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                                  "x": 3.14, # X coordinate.
                                  "y": 3.14, # Y coordinate (starts from the top of the image).
                                },
                              ],
                              "vertices": [ # The bounding polygon vertices.
                                { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                                  "x": 42, # X coordinate.
                                  "y": 42, # Y coordinate (starts from the top of the image).
                                },
                              ],
                            },
                            "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                            "orientation": "A String", # Detected orientation for the Layout.
                            "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                              "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                              "textSegments": [ # The text segments from the Document.text.
                                { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                                  "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                                  "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                                },
                              ],
                            },
                          },
                          "rowSpan": 42, # How many rows this cell spans.
                        },
                      ],
                    },
                  ],
                  "detectedLanguages": [ # A list of detected languages together with confidence.
                    { # Detected language for a structural component.
                      "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
                      "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
                    },
                  ],
                  "headerRows": [ # Header rows of the table.
                    { # A row of table cells.
                      "cells": [ # Cells that make up this row.
                        { # A cell representation inside the table.
                          "colSpan": 42, # How many columns this cell spans.
                          "detectedLanguages": [ # A list of detected languages together with confidence.
                            { # Detected language for a structural component.
                              "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
                              "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
                            },
                          ],
                          "layout": { # Visual element describing a layout unit on a page. # Layout for TableCell.
                            "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                              "normalizedVertices": [ # The bounding polygon normalized vertices.
                                { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                                  "x": 3.14, # X coordinate.
                                  "y": 3.14, # Y coordinate (starts from the top of the image).
                                },
                              ],
                              "vertices": [ # The bounding polygon vertices.
                                { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                                  "x": 42, # X coordinate.
                                  "y": 42, # Y coordinate (starts from the top of the image).
                                },
                              ],
                            },
                            "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                            "orientation": "A String", # Detected orientation for the Layout.
                            "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                              "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                              "textSegments": [ # The text segments from the Document.text.
                                { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                                  "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                                  "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                                },
                              ],
                            },
                          },
                          "rowSpan": 42, # How many rows this cell spans.
                        },
                      ],
                    },
                  ],
                  "layout": { # Visual element describing a layout unit on a page. # Layout for Table.
                    "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                      "normalizedVertices": [ # The bounding polygon normalized vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                          "x": 3.14, # X coordinate.
                          "y": 3.14, # Y coordinate (starts from the top of the image).
                        },
                      ],
                      "vertices": [ # The bounding polygon vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                          "x": 42, # X coordinate.
                          "y": 42, # Y coordinate (starts from the top of the image).
                        },
                      ],
                    },
                    "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                    "orientation": "A String", # Detected orientation for the Layout.
                    "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                      "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                      "textSegments": [ # The text segments from the Document.text.
                        { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                          "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                          "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                        },
                      ],
                    },
                  },
                  "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this table.
                    "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
                    "parents": [ # References to the original elements that are replaced.
                      { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
                        "id": 42, # The id of the parent provenance.
                        "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
                        "revision": 42, # The index of the index into current revision's parent_ids list.
                      },
                    ],
                    "revision": 42, # The index of the revision that produced this element.
                    "type": "A String", # The type of provenance operation.
                  },
                },
              ],
              "tokens": [ # A list of visually detected tokens on the page.
                { # A detected token.
                  "detectedBreak": { # Detected break at the end of a Token. # Detected break at the end of a Token.
                    "type": "A String", # Detected break type.
                  },
                  "detectedLanguages": [ # A list of detected languages together with confidence.
                    { # Detected language for a structural component.
                      "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
                      "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
                    },
                  ],
                  "layout": { # Visual element describing a layout unit on a page. # Layout for Token.
                    "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                      "normalizedVertices": [ # The bounding polygon normalized vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                          "x": 3.14, # X coordinate.
                          "y": 3.14, # Y coordinate (starts from the top of the image).
                        },
                      ],
                      "vertices": [ # The bounding polygon vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                          "x": 42, # X coordinate.
                          "y": 42, # Y coordinate (starts from the top of the image).
                        },
                      ],
                    },
                    "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                    "orientation": "A String", # Detected orientation for the Layout.
                    "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                      "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                      "textSegments": [ # The text segments from the Document.text.
                        { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                          "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                          "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                        },
                      ],
                    },
                  },
                  "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation.
                    "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
                    "parents": [ # References to the original elements that are replaced.
                      { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
                        "id": 42, # The id of the parent provenance.
                        "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
                        "revision": 42, # The index of the index into current revision's parent_ids list.
                      },
                    ],
                    "revision": 42, # The index of the revision that produced this element.
                    "type": "A String", # The type of provenance operation.
                  },
                  "styleInfo": { # Font and other text style attributes. # Text style attributes.
                    "backgroundColor": { # Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ... # Color of the background.
                      "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0).
                      "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                      "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                      "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                    },
                    "bold": True or False, # Whether the text is bold (equivalent to font_weight is at least `700`).
                    "fontSize": 42, # Font size in points (`1` point is `¹⁄₇₂` inches).
                    "fontType": "A String", # Name or style of the font.
                    "fontWeight": 42, # TrueType weight on a scale `100` (thin) to `1000` (ultra-heavy). Normal is `400`, bold is `700`.
                    "handwritten": True or False, # Whether the text is handwritten.
                    "italic": True or False, # Whether the text is italic.
                    "letterSpacing": 3.14, # Letter spacing in points.
                    "pixelFontSize": 3.14, # Font size in pixels, equal to _unrounded font_size_ * _resolution_ ÷ `72.0`.
                    "smallcaps": True or False, # Whether the text is in small caps. This feature is not supported yet.
                    "strikeout": True or False, # Whether the text is strikethrough. This feature is not supported yet.
                    "subscript": True or False, # Whether the text is a subscript. This feature is not supported yet.
                    "superscript": True or False, # Whether the text is a superscript. This feature is not supported yet.
                    "textColor": { # Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ... # Color of the text.
                      "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0).
                      "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                      "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                      "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                    },
                    "underlined": True or False, # Whether the text is underlined.
                  },
                },
              ],
              "transforms": [ # Transformation matrices that were applied to the original document image to produce Page.image.
                { # Representation for transformation matrix, intended to be compatible and used with OpenCV format for image manipulation.
                  "cols": 42, # Number of columns in the matrix.
                  "data": "A String", # The matrix data.
                  "rows": 42, # Number of rows in the matrix.
                  "type": 42, # This encodes information about what data type the matrix uses. For example, 0 (CV_8U) is an unsigned 8-bit image. For the full list of OpenCV primitive data types, please refer to https://docs.opencv.org/4.3.0/d1/d1b/group__core__hal__interface.html
                },
              ],
              "visualElements": [ # A list of detected non-text visual elements e.g. checkbox, signature etc. on the page.
                { # Detected non-text visual elements e.g. checkbox, signature etc. on the page.
                  "detectedLanguages": [ # A list of detected languages together with confidence.
                    { # Detected language for a structural component.
                      "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
                      "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
                    },
                  ],
                  "layout": { # Visual element describing a layout unit on a page. # Layout for VisualElement.
                    "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                      "normalizedVertices": [ # The bounding polygon normalized vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                          "x": 3.14, # X coordinate.
                          "y": 3.14, # Y coordinate (starts from the top of the image).
                        },
                      ],
                      "vertices": [ # The bounding polygon vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                          "x": 42, # X coordinate.
                          "y": 42, # Y coordinate (starts from the top of the image).
                        },
                      ],
                    },
                    "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                    "orientation": "A String", # Detected orientation for the Layout.
                    "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                      "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                      "textSegments": [ # The text segments from the Document.text.
                        { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                          "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                          "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                        },
                      ],
                    },
                  },
                  "type": "A String", # Type of the VisualElement.
                },
              ],
            },
          ],
          "revisions": [ # Placeholder. Revision history of this document.
            { # Contains past or forward revisions of this document.
              "agent": "A String", # If the change was made by a person specify the name or id of that person.
              "createTime": "A String", # The time that the revision was created, internally generated by doc proto storage at the time of create.
              "humanReview": { # Human Review information of the document. # Human Review information of this revision.
                "state": "A String", # Human review state. e.g. `requested`, `succeeded`, `rejected`.
                "stateMessage": "A String", # A message providing more details about the current state of processing. For example, the rejection reason when the state is `rejected`.
              },
              "id": "A String", # Id of the revision, internally generated by doc proto storage. Unique within the context of the document.
              "parent": [ # The revisions that this revision is based on. This can include one or more parent (when documents are merged.) This field represents the index into the `revisions` field.
                42,
              ],
              "parentIds": [ # The revisions that this revision is based on. Must include all the ids that have anything to do with this revision - eg. there are `provenance.parent.revision` fields that index into this field.
                "A String",
              ],
              "processor": "A String", # If the annotation was made by processor identify the processor by its resource name.
            },
          ],
          "shardInfo": { # For a large document, sharding may be performed to produce several document shards. Each document shard contains this field to detail which shard it is. # Information about the sharding if this document is sharded part of a larger document. If the document is not sharded, this message is not specified.
            "shardCount": "A String", # Total number of shards.
            "shardIndex": "A String", # The 0-based index of this shard.
            "textOffset": "A String", # The index of the first character in Document.text in the overall document global text.
          },
          "text": "A String", # Optional. UTF-8 encoded text in reading order from the document.
          "textChanges": [ # Placeholder. A list of text corrections made to Document.text. This is usually used for annotating corrections to OCR mistakes. Text changes for a given revision may not overlap with each other.
            { # This message is used for text changes aka. OCR corrections.
              "changedText": "A String", # The text that replaces the text identified in the `text_anchor`.
              "provenance": [ # The history of this annotation.
                { # Structure to identify provenance relationships between annotations in different revisions.
                  "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
                  "parents": [ # References to the original elements that are replaced.
                    { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
                      "id": 42, # The id of the parent provenance.
                      "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
                      "revision": 42, # The index of the index into current revision's parent_ids list.
                    },
                  ],
                  "revision": 42, # The index of the revision that produced this element.
                  "type": "A String", # The type of provenance operation.
                },
              ],
              "textAnchor": { # Text reference indexing into the Document.text. # Provenance of the correction. Text anchor indexing into the Document.text. There can only be a single `TextAnchor.text_segments` element. If the start and end index of the text segment are the same, the text change is inserted before that index.
                "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                "textSegments": [ # The text segments from the Document.text.
                  { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                    "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                    "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                  },
                ],
              },
            },
          ],
          "textStyles": [ # Styles for the Document.text.
            { # Annotation for common text style attributes. This adheres to CSS conventions as much as possible.
              "backgroundColor": { # Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ... # Text background color.
                "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0).
                "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
              },
              "color": { # Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ... # Text color.
                "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0).
                "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
              },
              "fontFamily": "A String", # Font family such as `Arial`, `Times New Roman`. https://www.w3schools.com/cssref/pr_font_font-family.asp
              "fontSize": { # Font size with unit. # Font size.
                "size": 3.14, # Font size for the text.
                "unit": "A String", # Unit for the font size. Follows CSS naming (such as `in`, `px`, and `pt`).
              },
              "fontWeight": "A String", # [Font weight](https://www.w3schools.com/cssref/pr_font_weight.asp). Possible values are `normal`, `bold`, `bolder`, and `lighter`.
              "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                "textSegments": [ # The text segments from the Document.text.
                  { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                    "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                    "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                  },
                ],
              },
              "textDecoration": "A String", # [Text decoration](https://www.w3schools.com/cssref/pr_text_text-decoration.asp). Follows CSS standard.
              "textStyle": "A String", # [Text style](https://www.w3schools.com/cssref/pr_font_font-style.asp). Possible values are `normal`, `italic`, and `oblique`.
            },
          ],
          "uri": "A String", # Optional. Currently supports Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. For more information, refer to [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-uris).
        },
        "contentCategory": "A String", # Indicates the category (image, audio, video etc.) of the original content.
        "createTime": "A String", # Output only. The time when the document is created.
        "creator": "A String", # The user who creates the document.
        "displayName": "A String", # Required. Display name of the document given by the user. This name will be displayed in the UI. Customer can populate this field with the name of the document. This differs from the 'title' field as 'title' is optional and stores the top heading in the document.
        "displayUri": "A String", # Uri to display the document, for example, in the UI.
        "dispositionTime": "A String", # Output only. If linked to a Collection with RetentionPolicy, the date when the document becomes mutable.
        "documentSchemaName": "A String", # The Document schema name. Format: projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}.
        "inlineRawDocument": "A String", # Raw document content.
        "legalHold": True or False, # Output only. Indicates if the document has a legal hold on it.
        "name": "A String", # The resource name of the document. Format: projects/{project_number}/locations/{location}/documents/{document_id}. The name is ignored when creating a document.
        "plainText": "A String", # Other document format, such as PPTX, XLXS
        "properties": [ # List of values that are user supplied metadata.
          { # Property of a document.
            "dateTimeValues": { # DateTime values. # Date time property values. It is not supported by CMEK compliant deployment.
              "values": [ # List of datetime values. Both OffsetDateTime and ZonedDateTime are supported.
                { # Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations.
                  "day": 42, # Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day.
                  "hours": 42, # Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults to 0 (midnight). An API may choose to allow the value "24:00:00" for scenarios like business closing time.
                  "minutes": 42, # Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.
                  "month": 42, # Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month.
                  "nanos": 42, # Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0.
                  "seconds": 42, # Optional. Seconds of minutes of the time. Must normally be from 0 to 59, defaults to 0. An API may allow the value 60 if it allows leap-seconds.
                  "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Time zone.
                    "id": "A String", # IANA Time Zone Database time zone. For example "America/New_York".
                    "version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a".
                  },
                  "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.
                  "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.
                },
              ],
            },
            "enumValues": { # Enum values. # Enum property values.
              "values": [ # List of enum values.
                "A String",
              ],
            },
            "floatValues": { # Float values. # Float property values.
              "values": [ # List of float values.
                3.14,
              ],
            },
            "integerValues": { # Integer values. # Integer property values.
              "values": [ # List of integer values.
                42,
              ],
            },
            "mapProperty": { # Map property value. Represents a structured entries of key value pairs, consisting of field names which map to dynamically typed values. # Map property values.
              "fields": { # Unordered map of dynamically typed values.
                "a_key": { # `Value` represents a dynamically typed value which can be either be a float, a integer, a string, or a datetime value. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.
                  "booleanValue": True or False, # Represents a boolean value.
                  "datetimeValue": { # Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations. # Represents a datetime value.
                    "day": 42, # Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day.
                    "hours": 42, # Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults to 0 (midnight). An API may choose to allow the value "24:00:00" for scenarios like business closing time.
                    "minutes": 42, # Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.
                    "month": 42, # Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month.
                    "nanos": 42, # Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0.
                    "seconds": 42, # Optional. Seconds of minutes of the time. Must normally be from 0 to 59, defaults to 0. An API may allow the value 60 if it allows leap-seconds.
                    "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Time zone.
                      "id": "A String", # IANA Time Zone Database time zone. For example "America/New_York".
                      "version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a".
                    },
                    "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.
                    "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.
                  },
                  "enumValue": { # Represents the string value of the enum field. # Represents an enum value.
                    "value": "A String", # String value of the enum field. This must match defined set of enums in document schema using EnumTypeOptions.
                  },
                  "floatValue": 3.14, # Represents a float value.
                  "intValue": 42, # Represents a integer value.
                  "stringValue": "A String", # Represents a string value.
                  "timestampValue": { # Timestamp value type. # Represents a timestamp value.
                    "textValue": "A String", # The string must represent a valid instant in UTC and is parsed using java.time.format.DateTimeFormatter.ISO_INSTANT. e.g. "2013-09-29T18:46:19Z"
                    "timestampValue": "A String", # Timestamp value
                  },
                },
              },
            },
            "name": "A String", # Required. Must match the name of a PropertyDefinition in the DocumentSchema.
            "propertyValues": { # Property values. # Nested structured data property values.
              "properties": [ # List of property values.
                # Object with schema name: GoogleCloudContentwarehouseV1Property
              ],
            },
            "textValues": { # String/text values. # String/text property values.
              "values": [ # List of text values.
                "A String",
              ],
            },
            "timestampValues": { # Timestamp values. # Timestamp property values. It is not supported by CMEK compliant deployment.
              "values": [ # List of timestamp values.
                { # Timestamp value type.
                  "textValue": "A String", # The string must represent a valid instant in UTC and is parsed using java.time.format.DateTimeFormatter.ISO_INSTANT. e.g. "2013-09-29T18:46:19Z"
                  "timestampValue": "A String", # Timestamp value
                },
              ],
            },
          },
        ],
        "rawDocumentFileType": "A String", # This is used when DocAI was not used to load the document and parsing/ extracting is needed for the inline_raw_document. For example, if inline_raw_document is the byte representation of a PDF file, then this should be set to: RAW_DOCUMENT_FILE_TYPE_PDF.
        "rawDocumentPath": "A String", # Raw document file in Cloud Storage path.
        "referenceId": "A String", # The reference ID set by customers. Must be unique per project and location.
        "textExtractionDisabled": True or False, # If true, text extraction will not be performed.
        "textExtractionEnabled": True or False, # If true, text extraction will be performed.
        "title": "A String", # Title that describes the document. This can be the top heading or text that describes the document.
        "updateTime": "A String", # Output only. The time when the document is last updated.
        "updater": "A String", # The user who lastly updates the document.
      },
      "requestMetadata": { # Meta information is used to improve the performance of the service. # The meta information collected about the end user, used to enforce access control for the service.
        "userInfo": { # The user information. # Provides user unique identification and groups information.
          "groupIds": [ # The unique group identifications which the user is belong to. The format is "group:yyyy@example.com";
            "A String",
          ],
          "id": "A String", # A unique user identification string, as determined by the client. The maximum number of allowed characters is 255. Allowed characters include numbers 0 to 9, uppercase and lowercase letters, and restricted special symbols (:, @, +, -, _, ~) The format is "user:xxxx@example.com";
        },
      },
      "updateOptions": { # Options for Update operations. # Options for the update operation.
        "mergeFieldsOptions": { # Options for merging updated fields. # Options for merging.
          "replaceMessageFields": True or False, # When merging message fields, the default behavior is to merge the content of two message fields together. If you instead want to use the field from the source message to replace the corresponding field in the destination message, set this flag to true. When this flag is set, specified submessage fields that are missing in source will be cleared in destination.
          "replaceRepeatedFields": True or False, # When merging repeated fields, the default behavior is to append entries from the source repeated field to the destination repeated field. If you instead want to keep only the entries from the source repeated field, set this flag to true. If you want to replace a repeated field within a message field on the destination message, you must set both replace_repeated_fields and replace_message_fields to true, otherwise the repeated fields will be appended.
        },
        "updateMask": "A String", # Field mask for merging Document fields. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
        "updateType": "A String", # Type for update.
      },
    }

      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # Response message for DocumentService.UpdateDocument.
      "document": { # Defines the structure for content warehouse document proto. # Updated document after executing update request.
        "cloudAiDocument": { # Document represents the canonical document resource in Document AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document AI to iterate and optimize for quality. # Document AI format to save the structured content, including OCR.
          "chunkedDocument": { # Represents the chunks that the document is divided into. # Document chunked based on chunking config.
            "chunks": [ # List of chunks.
              { # Represents a chunk.
                "chunkId": "A String", # ID of the chunk.
                "content": "A String", # Text content of the chunk.
                "pageFooters": [ # Page footers associated with the chunk.
                  { # Represents the page footer associated with the chunk.
                    "pageSpan": { # Represents where the chunk starts and ends in the document. # Page span of the footer.
                      "pageEnd": 42, # Page where chunk ends in the document.
                      "pageStart": 42, # Page where chunk starts in the document.
                    },
                    "text": "A String", # Footer in text format.
                  },
                ],
                "pageHeaders": [ # Page headers associated with the chunk.
                  { # Represents the page header associated with the chunk.
                    "pageSpan": { # Represents where the chunk starts and ends in the document. # Page span of the header.
                      "pageEnd": 42, # Page where chunk ends in the document.
                      "pageStart": 42, # Page where chunk starts in the document.
                    },
                    "text": "A String", # Header in text format.
                  },
                ],
                "pageSpan": { # Represents where the chunk starts and ends in the document. # Page span of the chunk.
                  "pageEnd": 42, # Page where chunk ends in the document.
                  "pageStart": 42, # Page where chunk starts in the document.
                },
                "sourceBlockIds": [ # Unused.
                  "A String",
                ],
              },
            ],
          },
          "content": "A String", # Optional. Inline document content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64.
          "documentLayout": { # Represents the parsed layout of a document as a collection of blocks that the document is divided into. # Parsed layout of the document.
            "blocks": [ # List of blocks in the document.
              { # Represents a block. A block could be one of the various types (text, table, list) supported.
                "blockId": "A String", # ID of the block.
                "listBlock": { # Represents a list type block. # Block consisting of list content/structure.
                  "listEntries": [ # List entries that constitute a list block.
                    { # Represents an entry in the list.
                      "blocks": [ # A list entry is a list of blocks. Repeated blocks support further hierarchies and nested blocks.
                        # Object with schema name: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock
                      ],
                    },
                  ],
                  "type": "A String", # Type of the list_entries (if exist). Available options are `ordered` and `unordered`.
                },
                "pageSpan": { # Represents where the block starts and ends in the document. # Page span of the block.
                  "pageEnd": 42, # Page where block ends in the document.
                  "pageStart": 42, # Page where block starts in the document.
                },
                "tableBlock": { # Represents a table type block. # Block consisting of table content/structure.
                  "bodyRows": [ # Body rows containing main table content.
                    { # Represents a row in a table.
                      "cells": [ # A table row is a list of table cells.
                        { # Represents a cell in a table row.
                          "blocks": [ # A table cell is a list of blocks. Repeated blocks support further hierarchies and nested blocks.
                            # Object with schema name: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock
                          ],
                          "colSpan": 42, # How many columns this cell spans.
                          "rowSpan": 42, # How many rows this cell spans.
                        },
                      ],
                    },
                  ],
                  "caption": "A String", # Table caption/title.
                  "headerRows": [ # Header rows at the top of the table.
                    { # Represents a row in a table.
                      "cells": [ # A table row is a list of table cells.
                        { # Represents a cell in a table row.
                          "blocks": [ # A table cell is a list of blocks. Repeated blocks support further hierarchies and nested blocks.
                            # Object with schema name: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock
                          ],
                          "colSpan": 42, # How many columns this cell spans.
                          "rowSpan": 42, # How many rows this cell spans.
                        },
                      ],
                    },
                  ],
                },
                "textBlock": { # Represents a text type block. # Block consisting of text content.
                  "blocks": [ # A text block could further have child blocks. Repeated blocks support further hierarchies and nested blocks.
                    # Object with schema name: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock
                  ],
                  "text": "A String", # Text content stored in the block.
                  "type": "A String", # Type of the text in the block. Available options are: `paragraph`, `subtitle`, `heading-1`, `heading-2`, `heading-3`, `heading-4`, `heading-5`, `header`, `footer`.
                },
              },
            ],
          },
          "entities": [ # A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries.
            { # An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location.
              "confidence": 3.14, # Optional. Confidence of detected Schema entity. Range `[0, 1]`.
              "id": "A String", # Optional. Canonical id. This will be a unique value in the entity list for this document.
              "mentionId": "A String", # Optional. Deprecated. Use `id` field instead.
              "mentionText": "A String", # Optional. Text value of the entity e.g. `1600 Amphitheatre Pkwy`.
              "normalizedValue": { # Parsed and normalized entity value. # Optional. Normalized entity value. Absent if the extracted value could not be converted or the type (e.g. address) is not supported for certain parsers. This field is also only populated for certain supported document types.
                "addressValue": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Postal address. See also: https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto
                  "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
                    "A String",
                  ],
                  "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
                  "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
                  "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
                  "organization": "A String", # Optional. The name of the organization at the address.
                  "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
                  "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
                    "A String",
                  ],
                  "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
                  "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
                  "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
                  "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
                },
                "booleanValue": True or False, # Boolean value. Can be used for entities with binary values, or for checkboxes.
                "dateValue": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Date value. Includes year, month, day. See also: https://github.com/googleapis/googleapis/blob/master/google/type/date.proto
                  "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
                  "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
                  "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
                },
                "datetimeValue": { # Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations. # DateTime value. Includes date, time, and timezone. See also: https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto
                  "day": 42, # Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day.
                  "hours": 42, # Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults to 0 (midnight). An API may choose to allow the value "24:00:00" for scenarios like business closing time.
                  "minutes": 42, # Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.
                  "month": 42, # Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month.
                  "nanos": 42, # Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0.
                  "seconds": 42, # Optional. Seconds of minutes of the time. Must normally be from 0 to 59, defaults to 0. An API may allow the value 60 if it allows leap-seconds.
                  "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Time zone.
                    "id": "A String", # IANA Time Zone Database time zone. For example "America/New_York".
                    "version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a".
                  },
                  "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.
                  "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.
                },
                "floatValue": 3.14, # Float value.
                "integerValue": 42, # Integer value.
                "moneyValue": { # Represents an amount of money with its currency type. # Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto
                  "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
                  "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
                  "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
                },
                "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format.
              },
              "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found.
                "pageRefs": [ # One or more references to visual page elements
                  { # Represents a weak reference to a page element within a document.
                    "boundingPoly": { # A bounding polygon for the detected image annotation. # Optional. Identifies the bounding polygon of a layout element on the page. If `layout_type` is set, the bounding polygon must be exactly the same to the layout element it's referring to.
                      "normalizedVertices": [ # The bounding polygon normalized vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                          "x": 3.14, # X coordinate.
                          "y": 3.14, # Y coordinate (starts from the top of the image).
                        },
                      ],
                      "vertices": [ # The bounding polygon vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                          "x": 42, # X coordinate.
                          "y": 42, # Y coordinate (starts from the top of the image).
                        },
                      ],
                    },
                    "confidence": 3.14, # Optional. Confidence of detected page element, if applicable. Range `[0, 1]`.
                    "layoutId": "A String", # Optional. Deprecated. Use PageRef.bounding_poly instead.
                    "layoutType": "A String", # Optional. The type of the layout element that is being referenced if any.
                    "page": "A String", # Required. Index into the Document.pages element, for example using `Document.pages` to locate the related page element. This field is skipped when its value is the default `0`. See https://developers.google.com/protocol-buffers/docs/proto3#json.
                  },
                ],
              },
              "properties": [ # Optional. Entities can be nested to form a hierarchical data structure representing the content in the document.
                # Object with schema name: GoogleCloudDocumentaiV1DocumentEntity
              ],
              "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # Optional. The history of this annotation.
                "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
                "parents": [ # References to the original elements that are replaced.
                  { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
                    "id": 42, # The id of the parent provenance.
                    "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
                    "revision": 42, # The index of the index into current revision's parent_ids list.
                  },
                ],
                "revision": 42, # The index of the revision that produced this element.
                "type": "A String", # The type of provenance operation.
              },
              "redacted": True or False, # Optional. Whether the entity will be redacted for de-identification purposes.
              "textAnchor": { # Text reference indexing into the Document.text. # Optional. Provenance of the entity. Text anchor indexing into the Document.text.
                "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                "textSegments": [ # The text segments from the Document.text.
                  { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                    "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                    "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                  },
                ],
              },
              "type": "A String", # Required. Entity type from a schema e.g. `Address`.
            },
          ],
          "entityRelations": [ # Placeholder. Relationship among Document.entities.
            { # Relationship between Entities.
              "objectId": "A String", # Object entity id.
              "relation": "A String", # Relationship description.
              "subjectId": "A String", # Subject entity id.
            },
          ],
          "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Any error that occurred while processing this document.
            "code": 42, # The status code, which should be an enum value of google.rpc.Code.
            "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
              {
                "a_key": "", # Properties of the object. Contains field @type with type URL.
              },
            ],
            "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
          },
          "mimeType": "A String", # An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml).
          "pages": [ # Visual page layout for the Document.
            { # A page in a Document.
              "blocks": [ # A list of visually detected text blocks on the page. A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.
                { # A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.
                  "detectedLanguages": [ # A list of detected languages together with confidence.
                    { # Detected language for a structural component.
                      "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
                      "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
                    },
                  ],
                  "layout": { # Visual element describing a layout unit on a page. # Layout for Block.
                    "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                      "normalizedVertices": [ # The bounding polygon normalized vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                          "x": 3.14, # X coordinate.
                          "y": 3.14, # Y coordinate (starts from the top of the image).
                        },
                      ],
                      "vertices": [ # The bounding polygon vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                          "x": 42, # X coordinate.
                          "y": 42, # Y coordinate (starts from the top of the image).
                        },
                      ],
                    },
                    "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                    "orientation": "A String", # Detected orientation for the Layout.
                    "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                      "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                      "textSegments": [ # The text segments from the Document.text.
                        { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                          "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                          "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                        },
                      ],
                    },
                  },
                  "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation.
                    "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
                    "parents": [ # References to the original elements that are replaced.
                      { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
                        "id": 42, # The id of the parent provenance.
                        "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
                        "revision": 42, # The index of the index into current revision's parent_ids list.
                      },
                    ],
                    "revision": 42, # The index of the revision that produced this element.
                    "type": "A String", # The type of provenance operation.
                  },
                },
              ],
              "detectedBarcodes": [ # A list of detected barcodes.
                { # A detected barcode.
                  "barcode": { # Encodes the detailed information of a barcode. # Detailed barcode information of the DetectedBarcode.
                    "format": "A 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.
                    "rawValue": "A String", # Raw value encoded in the barcode. For example: `'MEBKM:TITLE:Google;URL:https://www.google.com;;'`.
                    "valueFormat": "A 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.
                  },
                  "layout": { # Visual element describing a layout unit on a page. # Layout for DetectedBarcode.
                    "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                      "normalizedVertices": [ # The bounding polygon normalized vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                          "x": 3.14, # X coordinate.
                          "y": 3.14, # Y coordinate (starts from the top of the image).
                        },
                      ],
                      "vertices": [ # The bounding polygon vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                          "x": 42, # X coordinate.
                          "y": 42, # Y coordinate (starts from the top of the image).
                        },
                      ],
                    },
                    "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                    "orientation": "A String", # Detected orientation for the Layout.
                    "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                      "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                      "textSegments": [ # The text segments from the Document.text.
                        { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                          "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                          "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                        },
                      ],
                    },
                  },
                },
              ],
              "detectedLanguages": [ # A list of detected languages together with confidence.
                { # Detected language for a structural component.
                  "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
                  "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
                },
              ],
              "dimension": { # Dimension for the page. # Physical dimension of the page.
                "height": 3.14, # Page height.
                "unit": "A String", # Dimension unit.
                "width": 3.14, # Page width.
              },
              "formFields": [ # A list of visually detected form fields on the page.
                { # A form field detected on the page.
                  "correctedKeyText": "A String", # Created for Labeling UI to export key text. If corrections were made to the text identified by the `field_name.text_anchor`, this field will contain the correction.
                  "correctedValueText": "A String", # Created for Labeling UI to export value text. If corrections were made to the text identified by the `field_value.text_anchor`, this field will contain the correction.
                  "fieldName": { # Visual element describing a layout unit on a page. # Layout for the FormField name. e.g. `Address`, `Email`, `Grand total`, `Phone number`, etc.
                    "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                      "normalizedVertices": [ # The bounding polygon normalized vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                          "x": 3.14, # X coordinate.
                          "y": 3.14, # Y coordinate (starts from the top of the image).
                        },
                      ],
                      "vertices": [ # The bounding polygon vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                          "x": 42, # X coordinate.
                          "y": 42, # Y coordinate (starts from the top of the image).
                        },
                      ],
                    },
                    "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                    "orientation": "A String", # Detected orientation for the Layout.
                    "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                      "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                      "textSegments": [ # The text segments from the Document.text.
                        { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                          "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                          "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                        },
                      ],
                    },
                  },
                  "fieldValue": { # Visual element describing a layout unit on a page. # Layout for the FormField value.
                    "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                      "normalizedVertices": [ # The bounding polygon normalized vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                          "x": 3.14, # X coordinate.
                          "y": 3.14, # Y coordinate (starts from the top of the image).
                        },
                      ],
                      "vertices": [ # The bounding polygon vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                          "x": 42, # X coordinate.
                          "y": 42, # Y coordinate (starts from the top of the image).
                        },
                      ],
                    },
                    "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                    "orientation": "A String", # Detected orientation for the Layout.
                    "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                      "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                      "textSegments": [ # The text segments from the Document.text.
                        { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                          "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                          "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                        },
                      ],
                    },
                  },
                  "nameDetectedLanguages": [ # A list of detected languages for name together with confidence.
                    { # Detected language for a structural component.
                      "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
                      "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
                    },
                  ],
                  "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation.
                    "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
                    "parents": [ # References to the original elements that are replaced.
                      { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
                        "id": 42, # The id of the parent provenance.
                        "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
                        "revision": 42, # The index of the index into current revision's parent_ids list.
                      },
                    ],
                    "revision": 42, # The index of the revision that produced this element.
                    "type": "A String", # The type of provenance operation.
                  },
                  "valueDetectedLanguages": [ # A list of detected languages for value together with confidence.
                    { # Detected language for a structural component.
                      "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
                      "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
                    },
                  ],
                  "valueType": "A String", # If the value is non-textual, this field represents the type. Current valid values are: - blank (this indicates the `field_value` is normal text) - `unfilled_checkbox` - `filled_checkbox`
                },
              ],
              "image": { # Rendered image contents for this page. # Rendered image for this page. This image is preprocessed to remove any skew, rotation, and distortions such that the annotation bounding boxes can be upright and axis-aligned.
                "content": "A String", # Raw byte content of the image.
                "height": 42, # Height of the image in pixels.
                "mimeType": "A String", # Encoding [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml) for the image.
                "width": 42, # Width of the image in pixels.
              },
              "imageQualityScores": { # Image quality scores for the page image. # Image quality scores.
                "detectedDefects": [ # A list of detected defects.
                  { # Image Quality Defects
                    "confidence": 3.14, # Confidence of detected defect. Range `[0, 1]` where `1` indicates strong confidence that the defect exists.
                    "type": "A String", # Name of the defect type. Supported values are: - `quality/defect_blurry` - `quality/defect_noisy` - `quality/defect_dark` - `quality/defect_faint` - `quality/defect_text_too_small` - `quality/defect_document_cutoff` - `quality/defect_text_cutoff` - `quality/defect_glare`
                  },
                ],
                "qualityScore": 3.14, # The overall quality score. Range `[0, 1]` where `1` is perfect quality.
              },
              "layout": { # Visual element describing a layout unit on a page. # Layout for the page.
                "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                  "normalizedVertices": [ # The bounding polygon normalized vertices.
                    { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                      "x": 3.14, # X coordinate.
                      "y": 3.14, # Y coordinate (starts from the top of the image).
                    },
                  ],
                  "vertices": [ # The bounding polygon vertices.
                    { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                      "x": 42, # X coordinate.
                      "y": 42, # Y coordinate (starts from the top of the image).
                    },
                  ],
                },
                "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                "orientation": "A String", # Detected orientation for the Layout.
                "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                  "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                  "textSegments": [ # The text segments from the Document.text.
                    { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                      "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                      "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                    },
                  ],
                },
              },
              "lines": [ # A list of visually detected text lines on the page. A collection of tokens that a human would perceive as a line.
                { # A collection of tokens that a human would perceive as a line. Does not cross column boundaries, can be horizontal, vertical, etc.
                  "detectedLanguages": [ # A list of detected languages together with confidence.
                    { # Detected language for a structural component.
                      "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
                      "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
                    },
                  ],
                  "layout": { # Visual element describing a layout unit on a page. # Layout for Line.
                    "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                      "normalizedVertices": [ # The bounding polygon normalized vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                          "x": 3.14, # X coordinate.
                          "y": 3.14, # Y coordinate (starts from the top of the image).
                        },
                      ],
                      "vertices": [ # The bounding polygon vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                          "x": 42, # X coordinate.
                          "y": 42, # Y coordinate (starts from the top of the image).
                        },
                      ],
                    },
                    "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                    "orientation": "A String", # Detected orientation for the Layout.
                    "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                      "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                      "textSegments": [ # The text segments from the Document.text.
                        { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                          "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                          "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                        },
                      ],
                    },
                  },
                  "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation.
                    "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
                    "parents": [ # References to the original elements that are replaced.
                      { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
                        "id": 42, # The id of the parent provenance.
                        "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
                        "revision": 42, # The index of the index into current revision's parent_ids list.
                      },
                    ],
                    "revision": 42, # The index of the revision that produced this element.
                    "type": "A String", # The type of provenance operation.
                  },
                },
              ],
              "pageNumber": 42, # 1-based index for current Page in a parent Document. Useful when a page is taken out of a Document for individual processing.
              "paragraphs": [ # A list of visually detected text paragraphs on the page. A collection of lines that a human would perceive as a paragraph.
                { # A collection of lines that a human would perceive as a paragraph.
                  "detectedLanguages": [ # A list of detected languages together with confidence.
                    { # Detected language for a structural component.
                      "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
                      "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
                    },
                  ],
                  "layout": { # Visual element describing a layout unit on a page. # Layout for Paragraph.
                    "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                      "normalizedVertices": [ # The bounding polygon normalized vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                          "x": 3.14, # X coordinate.
                          "y": 3.14, # Y coordinate (starts from the top of the image).
                        },
                      ],
                      "vertices": [ # The bounding polygon vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                          "x": 42, # X coordinate.
                          "y": 42, # Y coordinate (starts from the top of the image).
                        },
                      ],
                    },
                    "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                    "orientation": "A String", # Detected orientation for the Layout.
                    "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                      "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                      "textSegments": [ # The text segments from the Document.text.
                        { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                          "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                          "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                        },
                      ],
                    },
                  },
                  "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation.
                    "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
                    "parents": [ # References to the original elements that are replaced.
                      { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
                        "id": 42, # The id of the parent provenance.
                        "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
                        "revision": 42, # The index of the index into current revision's parent_ids list.
                      },
                    ],
                    "revision": 42, # The index of the revision that produced this element.
                    "type": "A String", # The type of provenance operation.
                  },
                },
              ],
              "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this page.
                "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
                "parents": [ # References to the original elements that are replaced.
                  { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
                    "id": 42, # The id of the parent provenance.
                    "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
                    "revision": 42, # The index of the index into current revision's parent_ids list.
                  },
                ],
                "revision": 42, # The index of the revision that produced this element.
                "type": "A String", # The type of provenance operation.
              },
              "symbols": [ # A list of visually detected symbols on the page.
                { # A detected symbol.
                  "detectedLanguages": [ # A list of detected languages together with confidence.
                    { # Detected language for a structural component.
                      "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
                      "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
                    },
                  ],
                  "layout": { # Visual element describing a layout unit on a page. # Layout for Symbol.
                    "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                      "normalizedVertices": [ # The bounding polygon normalized vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                          "x": 3.14, # X coordinate.
                          "y": 3.14, # Y coordinate (starts from the top of the image).
                        },
                      ],
                      "vertices": [ # The bounding polygon vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                          "x": 42, # X coordinate.
                          "y": 42, # Y coordinate (starts from the top of the image).
                        },
                      ],
                    },
                    "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                    "orientation": "A String", # Detected orientation for the Layout.
                    "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                      "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                      "textSegments": [ # The text segments from the Document.text.
                        { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                          "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                          "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                        },
                      ],
                    },
                  },
                },
              ],
              "tables": [ # A list of visually detected tables on the page.
                { # A table representation similar to HTML table structure.
                  "bodyRows": [ # Body rows of the table.
                    { # A row of table cells.
                      "cells": [ # Cells that make up this row.
                        { # A cell representation inside the table.
                          "colSpan": 42, # How many columns this cell spans.
                          "detectedLanguages": [ # A list of detected languages together with confidence.
                            { # Detected language for a structural component.
                              "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
                              "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
                            },
                          ],
                          "layout": { # Visual element describing a layout unit on a page. # Layout for TableCell.
                            "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                              "normalizedVertices": [ # The bounding polygon normalized vertices.
                                { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                                  "x": 3.14, # X coordinate.
                                  "y": 3.14, # Y coordinate (starts from the top of the image).
                                },
                              ],
                              "vertices": [ # The bounding polygon vertices.
                                { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                                  "x": 42, # X coordinate.
                                  "y": 42, # Y coordinate (starts from the top of the image).
                                },
                              ],
                            },
                            "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                            "orientation": "A String", # Detected orientation for the Layout.
                            "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                              "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                              "textSegments": [ # The text segments from the Document.text.
                                { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                                  "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                                  "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                                },
                              ],
                            },
                          },
                          "rowSpan": 42, # How many rows this cell spans.
                        },
                      ],
                    },
                  ],
                  "detectedLanguages": [ # A list of detected languages together with confidence.
                    { # Detected language for a structural component.
                      "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
                      "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
                    },
                  ],
                  "headerRows": [ # Header rows of the table.
                    { # A row of table cells.
                      "cells": [ # Cells that make up this row.
                        { # A cell representation inside the table.
                          "colSpan": 42, # How many columns this cell spans.
                          "detectedLanguages": [ # A list of detected languages together with confidence.
                            { # Detected language for a structural component.
                              "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
                              "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
                            },
                          ],
                          "layout": { # Visual element describing a layout unit on a page. # Layout for TableCell.
                            "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                              "normalizedVertices": [ # The bounding polygon normalized vertices.
                                { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                                  "x": 3.14, # X coordinate.
                                  "y": 3.14, # Y coordinate (starts from the top of the image).
                                },
                              ],
                              "vertices": [ # The bounding polygon vertices.
                                { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                                  "x": 42, # X coordinate.
                                  "y": 42, # Y coordinate (starts from the top of the image).
                                },
                              ],
                            },
                            "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                            "orientation": "A String", # Detected orientation for the Layout.
                            "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                              "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                              "textSegments": [ # The text segments from the Document.text.
                                { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                                  "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                                  "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                                },
                              ],
                            },
                          },
                          "rowSpan": 42, # How many rows this cell spans.
                        },
                      ],
                    },
                  ],
                  "layout": { # Visual element describing a layout unit on a page. # Layout for Table.
                    "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                      "normalizedVertices": [ # The bounding polygon normalized vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                          "x": 3.14, # X coordinate.
                          "y": 3.14, # Y coordinate (starts from the top of the image).
                        },
                      ],
                      "vertices": [ # The bounding polygon vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                          "x": 42, # X coordinate.
                          "y": 42, # Y coordinate (starts from the top of the image).
                        },
                      ],
                    },
                    "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                    "orientation": "A String", # Detected orientation for the Layout.
                    "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                      "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                      "textSegments": [ # The text segments from the Document.text.
                        { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                          "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                          "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                        },
                      ],
                    },
                  },
                  "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this table.
                    "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
                    "parents": [ # References to the original elements that are replaced.
                      { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
                        "id": 42, # The id of the parent provenance.
                        "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
                        "revision": 42, # The index of the index into current revision's parent_ids list.
                      },
                    ],
                    "revision": 42, # The index of the revision that produced this element.
                    "type": "A String", # The type of provenance operation.
                  },
                },
              ],
              "tokens": [ # A list of visually detected tokens on the page.
                { # A detected token.
                  "detectedBreak": { # Detected break at the end of a Token. # Detected break at the end of a Token.
                    "type": "A String", # Detected break type.
                  },
                  "detectedLanguages": [ # A list of detected languages together with confidence.
                    { # Detected language for a structural component.
                      "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
                      "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
                    },
                  ],
                  "layout": { # Visual element describing a layout unit on a page. # Layout for Token.
                    "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                      "normalizedVertices": [ # The bounding polygon normalized vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                          "x": 3.14, # X coordinate.
                          "y": 3.14, # Y coordinate (starts from the top of the image).
                        },
                      ],
                      "vertices": [ # The bounding polygon vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                          "x": 42, # X coordinate.
                          "y": 42, # Y coordinate (starts from the top of the image).
                        },
                      ],
                    },
                    "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                    "orientation": "A String", # Detected orientation for the Layout.
                    "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                      "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                      "textSegments": [ # The text segments from the Document.text.
                        { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                          "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                          "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                        },
                      ],
                    },
                  },
                  "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation.
                    "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
                    "parents": [ # References to the original elements that are replaced.
                      { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
                        "id": 42, # The id of the parent provenance.
                        "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
                        "revision": 42, # The index of the index into current revision's parent_ids list.
                      },
                    ],
                    "revision": 42, # The index of the revision that produced this element.
                    "type": "A String", # The type of provenance operation.
                  },
                  "styleInfo": { # Font and other text style attributes. # Text style attributes.
                    "backgroundColor": { # Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ... # Color of the background.
                      "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0).
                      "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                      "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                      "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                    },
                    "bold": True or False, # Whether the text is bold (equivalent to font_weight is at least `700`).
                    "fontSize": 42, # Font size in points (`1` point is `¹⁄₇₂` inches).
                    "fontType": "A String", # Name or style of the font.
                    "fontWeight": 42, # TrueType weight on a scale `100` (thin) to `1000` (ultra-heavy). Normal is `400`, bold is `700`.
                    "handwritten": True or False, # Whether the text is handwritten.
                    "italic": True or False, # Whether the text is italic.
                    "letterSpacing": 3.14, # Letter spacing in points.
                    "pixelFontSize": 3.14, # Font size in pixels, equal to _unrounded font_size_ * _resolution_ ÷ `72.0`.
                    "smallcaps": True or False, # Whether the text is in small caps. This feature is not supported yet.
                    "strikeout": True or False, # Whether the text is strikethrough. This feature is not supported yet.
                    "subscript": True or False, # Whether the text is a subscript. This feature is not supported yet.
                    "superscript": True or False, # Whether the text is a superscript. This feature is not supported yet.
                    "textColor": { # Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ... # Color of the text.
                      "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0).
                      "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                      "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                      "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                    },
                    "underlined": True or False, # Whether the text is underlined.
                  },
                },
              ],
              "transforms": [ # Transformation matrices that were applied to the original document image to produce Page.image.
                { # Representation for transformation matrix, intended to be compatible and used with OpenCV format for image manipulation.
                  "cols": 42, # Number of columns in the matrix.
                  "data": "A String", # The matrix data.
                  "rows": 42, # Number of rows in the matrix.
                  "type": 42, # This encodes information about what data type the matrix uses. For example, 0 (CV_8U) is an unsigned 8-bit image. For the full list of OpenCV primitive data types, please refer to https://docs.opencv.org/4.3.0/d1/d1b/group__core__hal__interface.html
                },
              ],
              "visualElements": [ # A list of detected non-text visual elements e.g. checkbox, signature etc. on the page.
                { # Detected non-text visual elements e.g. checkbox, signature etc. on the page.
                  "detectedLanguages": [ # A list of detected languages together with confidence.
                    { # Detected language for a structural component.
                      "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
                      "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
                    },
                  ],
                  "layout": { # Visual element describing a layout unit on a page. # Layout for VisualElement.
                    "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                      "normalizedVertices": [ # The bounding polygon normalized vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                          "x": 3.14, # X coordinate.
                          "y": 3.14, # Y coordinate (starts from the top of the image).
                        },
                      ],
                      "vertices": [ # The bounding polygon vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                          "x": 42, # X coordinate.
                          "y": 42, # Y coordinate (starts from the top of the image).
                        },
                      ],
                    },
                    "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                    "orientation": "A String", # Detected orientation for the Layout.
                    "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                      "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                      "textSegments": [ # The text segments from the Document.text.
                        { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                          "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                          "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                        },
                      ],
                    },
                  },
                  "type": "A String", # Type of the VisualElement.
                },
              ],
            },
          ],
          "revisions": [ # Placeholder. Revision history of this document.
            { # Contains past or forward revisions of this document.
              "agent": "A String", # If the change was made by a person specify the name or id of that person.
              "createTime": "A String", # The time that the revision was created, internally generated by doc proto storage at the time of create.
              "humanReview": { # Human Review information of the document. # Human Review information of this revision.
                "state": "A String", # Human review state. e.g. `requested`, `succeeded`, `rejected`.
                "stateMessage": "A String", # A message providing more details about the current state of processing. For example, the rejection reason when the state is `rejected`.
              },
              "id": "A String", # Id of the revision, internally generated by doc proto storage. Unique within the context of the document.
              "parent": [ # The revisions that this revision is based on. This can include one or more parent (when documents are merged.) This field represents the index into the `revisions` field.
                42,
              ],
              "parentIds": [ # The revisions that this revision is based on. Must include all the ids that have anything to do with this revision - eg. there are `provenance.parent.revision` fields that index into this field.
                "A String",
              ],
              "processor": "A String", # If the annotation was made by processor identify the processor by its resource name.
            },
          ],
          "shardInfo": { # For a large document, sharding may be performed to produce several document shards. Each document shard contains this field to detail which shard it is. # Information about the sharding if this document is sharded part of a larger document. If the document is not sharded, this message is not specified.
            "shardCount": "A String", # Total number of shards.
            "shardIndex": "A String", # The 0-based index of this shard.
            "textOffset": "A String", # The index of the first character in Document.text in the overall document global text.
          },
          "text": "A String", # Optional. UTF-8 encoded text in reading order from the document.
          "textChanges": [ # Placeholder. A list of text corrections made to Document.text. This is usually used for annotating corrections to OCR mistakes. Text changes for a given revision may not overlap with each other.
            { # This message is used for text changes aka. OCR corrections.
              "changedText": "A String", # The text that replaces the text identified in the `text_anchor`.
              "provenance": [ # The history of this annotation.
                { # Structure to identify provenance relationships between annotations in different revisions.
                  "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
                  "parents": [ # References to the original elements that are replaced.
                    { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
                      "id": 42, # The id of the parent provenance.
                      "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
                      "revision": 42, # The index of the index into current revision's parent_ids list.
                    },
                  ],
                  "revision": 42, # The index of the revision that produced this element.
                  "type": "A String", # The type of provenance operation.
                },
              ],
              "textAnchor": { # Text reference indexing into the Document.text. # Provenance of the correction. Text anchor indexing into the Document.text. There can only be a single `TextAnchor.text_segments` element. If the start and end index of the text segment are the same, the text change is inserted before that index.
                "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                "textSegments": [ # The text segments from the Document.text.
                  { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                    "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                    "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                  },
                ],
              },
            },
          ],
          "textStyles": [ # Styles for the Document.text.
            { # Annotation for common text style attributes. This adheres to CSS conventions as much as possible.
              "backgroundColor": { # Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ... # Text background color.
                "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0).
                "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
              },
              "color": { # Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ... # Text color.
                "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0).
                "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
              },
              "fontFamily": "A String", # Font family such as `Arial`, `Times New Roman`. https://www.w3schools.com/cssref/pr_font_font-family.asp
              "fontSize": { # Font size with unit. # Font size.
                "size": 3.14, # Font size for the text.
                "unit": "A String", # Unit for the font size. Follows CSS naming (such as `in`, `px`, and `pt`).
              },
              "fontWeight": "A String", # [Font weight](https://www.w3schools.com/cssref/pr_font_weight.asp). Possible values are `normal`, `bold`, `bolder`, and `lighter`.
              "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                "textSegments": [ # The text segments from the Document.text.
                  { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                    "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                    "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                  },
                ],
              },
              "textDecoration": "A String", # [Text decoration](https://www.w3schools.com/cssref/pr_text_text-decoration.asp). Follows CSS standard.
              "textStyle": "A String", # [Text style](https://www.w3schools.com/cssref/pr_font_font-style.asp). Possible values are `normal`, `italic`, and `oblique`.
            },
          ],
          "uri": "A String", # Optional. Currently supports Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. For more information, refer to [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-uris).
        },
        "contentCategory": "A String", # Indicates the category (image, audio, video etc.) of the original content.
        "createTime": "A String", # Output only. The time when the document is created.
        "creator": "A String", # The user who creates the document.
        "displayName": "A String", # Required. Display name of the document given by the user. This name will be displayed in the UI. Customer can populate this field with the name of the document. This differs from the 'title' field as 'title' is optional and stores the top heading in the document.
        "displayUri": "A String", # Uri to display the document, for example, in the UI.
        "dispositionTime": "A String", # Output only. If linked to a Collection with RetentionPolicy, the date when the document becomes mutable.
        "documentSchemaName": "A String", # The Document schema name. Format: projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}.
        "inlineRawDocument": "A String", # Raw document content.
        "legalHold": True or False, # Output only. Indicates if the document has a legal hold on it.
        "name": "A String", # The resource name of the document. Format: projects/{project_number}/locations/{location}/documents/{document_id}. The name is ignored when creating a document.
        "plainText": "A String", # Other document format, such as PPTX, XLXS
        "properties": [ # List of values that are user supplied metadata.
          { # Property of a document.
            "dateTimeValues": { # DateTime values. # Date time property values. It is not supported by CMEK compliant deployment.
              "values": [ # List of datetime values. Both OffsetDateTime and ZonedDateTime are supported.
                { # Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations.
                  "day": 42, # Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day.
                  "hours": 42, # Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults to 0 (midnight). An API may choose to allow the value "24:00:00" for scenarios like business closing time.
                  "minutes": 42, # Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.
                  "month": 42, # Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month.
                  "nanos": 42, # Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0.
                  "seconds": 42, # Optional. Seconds of minutes of the time. Must normally be from 0 to 59, defaults to 0. An API may allow the value 60 if it allows leap-seconds.
                  "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Time zone.
                    "id": "A String", # IANA Time Zone Database time zone. For example "America/New_York".
                    "version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a".
                  },
                  "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.
                  "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.
                },
              ],
            },
            "enumValues": { # Enum values. # Enum property values.
              "values": [ # List of enum values.
                "A String",
              ],
            },
            "floatValues": { # Float values. # Float property values.
              "values": [ # List of float values.
                3.14,
              ],
            },
            "integerValues": { # Integer values. # Integer property values.
              "values": [ # List of integer values.
                42,
              ],
            },
            "mapProperty": { # Map property value. Represents a structured entries of key value pairs, consisting of field names which map to dynamically typed values. # Map property values.
              "fields": { # Unordered map of dynamically typed values.
                "a_key": { # `Value` represents a dynamically typed value which can be either be a float, a integer, a string, or a datetime value. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.
                  "booleanValue": True or False, # Represents a boolean value.
                  "datetimeValue": { # Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations. # Represents a datetime value.
                    "day": 42, # Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day.
                    "hours": 42, # Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults to 0 (midnight). An API may choose to allow the value "24:00:00" for scenarios like business closing time.
                    "minutes": 42, # Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.
                    "month": 42, # Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month.
                    "nanos": 42, # Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0.
                    "seconds": 42, # Optional. Seconds of minutes of the time. Must normally be from 0 to 59, defaults to 0. An API may allow the value 60 if it allows leap-seconds.
                    "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Time zone.
                      "id": "A String", # IANA Time Zone Database time zone. For example "America/New_York".
                      "version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a".
                    },
                    "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.
                    "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.
                  },
                  "enumValue": { # Represents the string value of the enum field. # Represents an enum value.
                    "value": "A String", # String value of the enum field. This must match defined set of enums in document schema using EnumTypeOptions.
                  },
                  "floatValue": 3.14, # Represents a float value.
                  "intValue": 42, # Represents a integer value.
                  "stringValue": "A String", # Represents a string value.
                  "timestampValue": { # Timestamp value type. # Represents a timestamp value.
                    "textValue": "A String", # The string must represent a valid instant in UTC and is parsed using java.time.format.DateTimeFormatter.ISO_INSTANT. e.g. "2013-09-29T18:46:19Z"
                    "timestampValue": "A String", # Timestamp value
                  },
                },
              },
            },
            "name": "A String", # Required. Must match the name of a PropertyDefinition in the DocumentSchema.
            "propertyValues": { # Property values. # Nested structured data property values.
              "properties": [ # List of property values.
                # Object with schema name: GoogleCloudContentwarehouseV1Property
              ],
            },
            "textValues": { # String/text values. # String/text property values.
              "values": [ # List of text values.
                "A String",
              ],
            },
            "timestampValues": { # Timestamp values. # Timestamp property values. It is not supported by CMEK compliant deployment.
              "values": [ # List of timestamp values.
                { # Timestamp value type.
                  "textValue": "A String", # The string must represent a valid instant in UTC and is parsed using java.time.format.DateTimeFormatter.ISO_INSTANT. e.g. "2013-09-29T18:46:19Z"
                  "timestampValue": "A String", # Timestamp value
                },
              ],
            },
          },
        ],
        "rawDocumentFileType": "A String", # This is used when DocAI was not used to load the document and parsing/ extracting is needed for the inline_raw_document. For example, if inline_raw_document is the byte representation of a PDF file, then this should be set to: RAW_DOCUMENT_FILE_TYPE_PDF.
        "rawDocumentPath": "A String", # Raw document file in Cloud Storage path.
        "referenceId": "A String", # The reference ID set by customers. Must be unique per project and location.
        "textExtractionDisabled": True or False, # If true, text extraction will not be performed.
        "textExtractionEnabled": True or False, # If true, text extraction will be performed.
        "title": "A String", # Title that describes the document. This can be the top heading or text that describes the document.
        "updateTime": "A String", # Output only. The time when the document is last updated.
        "updater": "A String", # The user who lastly updates the document.
      },
      "metadata": { # Additional information returned to client, such as debugging information. # Additional information for the API invocation, such as the request tracking id.
        "requestId": "A String", # A unique id associated with this call. This id is logged for tracking purpose.
      },
      "ruleEngineOutput": { # Records the output of Rule Engine including rule evaluation and actions result. # Output from Rule Engine recording the rule evaluator and action executor's output. Refer format in: google/cloud/contentwarehouse/v1/rule_engine.proto
        "actionExecutorOutput": { # Represents the output of the Action Executor. # Output from Action Executor containing rule and corresponding actions execution result.
          "ruleActionsPairs": [ # List of rule and corresponding actions result.
            { # Represents a rule and outputs of associated actions.
              "actionOutputs": [ # Outputs of executing the actions associated with the above rule.
                { # Represents the result of executing an action.
                  "actionId": "A String", # ID of the action.
                  "actionState": "A String", # State of an action.
                  "outputMessage": "A String", # Action execution output message.
                },
              ],
              "rule": { # Represents the rule for a content warehouse trigger. # Represents the rule.
                "actions": [ # List of actions that are executed when the rule is satisfied.
                  { # Represents the action triggered by Rule Engine when the rule is true.
                    "accessControl": { # Represents the action responsible for access control list management operations. # Action triggering access control operations.
                      "operationType": "A String", # Identifies the type of operation.
                      "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # Represents the new policy from which bindings are added, removed or replaced based on the type of the operation. the policy is limited to a few 10s of KB.
                        "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
                          { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
                            "auditLogConfigs": [ # The configuration for logging of each type of permission.
                              { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
                                "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
                                  "A String",
                                ],
                                "logType": "A String", # The log type that this config enables.
                              },
                            ],
                            "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
                          },
                        ],
                        "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
                          { # Associates `members`, or principals, with a `role`.
                            "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
                              "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
                              "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
                              "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
                              "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
                            },
                            "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
                              "A String",
                            ],
                            "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
                          },
                        ],
                        "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
                        "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
                      },
                    },
                    "actionId": "A String", # ID of the action. Managed internally.
                    "addToFolder": { # Represents the action responsible for adding document under a folder. # Action triggering create document link operation.
                      "folders": [ # Names of the folder under which new document is to be added. Format: projects/{project_number}/locations/{location}/documents/{document_id}.
                        "A String",
                      ],
                    },
                    "dataUpdate": { # Represents the action responsible for properties update operations. # Action triggering data update operations.
                      "entries": { # Map of (K, V) -> (valid name of the field, new value of the field) E.g., ("age", "60") entry triggers update of field age with a value of 60. If the field is not present then new entry is added. During update action execution, value strings will be casted to appropriate types.
                        "a_key": "A String",
                      },
                    },
                    "dataValidation": { # Represents the action responsible for data validation operations. # Action triggering data validation operations.
                      "conditions": { # Map of (K, V) -> (field, string condition to be evaluated on the field) E.g., ("age", "age > 18 && age < 60") entry triggers validation of field age with the given condition. Map entries will be ANDed during validation.
                        "a_key": "A String",
                      },
                    },
                    "deleteDocumentAction": { # Represents the action responsible for deleting the document. # Action deleting the document.
                      "enableHardDelete": True or False, # Boolean field to select between hard vs soft delete options. Set 'true' for 'hard delete' and 'false' for 'soft delete'.
                    },
                    "publishToPubSub": { # Represents the action responsible for publishing messages to a Pub/Sub topic. # Action publish to Pub/Sub operation.
                      "messages": [ # Messages to be published.
                        "A String",
                      ],
                      "topicId": "A String", # The topic id in the Pub/Sub service for which messages will be published to.
                    },
                    "removeFromFolderAction": { # Represents the action responsible for remove a document from a specific folder. # Action removing a document from a folder.
                      "condition": "A String", # Condition of the action to be executed.
                      "folder": "A String", # Name of the folder under which new document is to be added. Format: projects/{project_number}/locations/{location}/documents/{document_id}.
                    },
                  },
                ],
                "condition": "A String", # Represents the conditional expression to be evaluated. Expression should evaluate to a boolean result. When the condition is true actions are executed. Example: user_role = "hsbc_role_1" AND doc.salary > 20000
                "description": "A String", # Short description of the rule and its context.
                "ruleId": "A String", # ID of the rule. It has to be unique across all the examples. This is managed internally.
                "triggerType": "A String", # Identifies the trigger type for running the policy.
              },
            },
          ],
        },
        "documentName": "A String", # Name of the document against which the rules and actions were evaluated.
        "ruleEvaluatorOutput": { # Represents the output of the Rule Evaluator. # Output from Rule Evaluator containing matched, unmatched and invalid rules.
          "invalidRules": [ # A subset of triggered rules that failed the validation check(s) after parsing.
            { # A triggered rule that failed the validation check(s) after parsing.
              "error": "A String", # Validation error on a parsed expression.
              "rule": { # Represents the rule for a content warehouse trigger. # Triggered rule.
                "actions": [ # List of actions that are executed when the rule is satisfied.
                  { # Represents the action triggered by Rule Engine when the rule is true.
                    "accessControl": { # Represents the action responsible for access control list management operations. # Action triggering access control operations.
                      "operationType": "A String", # Identifies the type of operation.
                      "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # Represents the new policy from which bindings are added, removed or replaced based on the type of the operation. the policy is limited to a few 10s of KB.
                        "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
                          { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
                            "auditLogConfigs": [ # The configuration for logging of each type of permission.
                              { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
                                "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
                                  "A String",
                                ],
                                "logType": "A String", # The log type that this config enables.
                              },
                            ],
                            "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
                          },
                        ],
                        "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
                          { # Associates `members`, or principals, with a `role`.
                            "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
                              "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
                              "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
                              "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
                              "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
                            },
                            "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
                              "A String",
                            ],
                            "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
                          },
                        ],
                        "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
                        "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
                      },
                    },
                    "actionId": "A String", # ID of the action. Managed internally.
                    "addToFolder": { # Represents the action responsible for adding document under a folder. # Action triggering create document link operation.
                      "folders": [ # Names of the folder under which new document is to be added. Format: projects/{project_number}/locations/{location}/documents/{document_id}.
                        "A String",
                      ],
                    },
                    "dataUpdate": { # Represents the action responsible for properties update operations. # Action triggering data update operations.
                      "entries": { # Map of (K, V) -> (valid name of the field, new value of the field) E.g., ("age", "60") entry triggers update of field age with a value of 60. If the field is not present then new entry is added. During update action execution, value strings will be casted to appropriate types.
                        "a_key": "A String",
                      },
                    },
                    "dataValidation": { # Represents the action responsible for data validation operations. # Action triggering data validation operations.
                      "conditions": { # Map of (K, V) -> (field, string condition to be evaluated on the field) E.g., ("age", "age > 18 && age < 60") entry triggers validation of field age with the given condition. Map entries will be ANDed during validation.
                        "a_key": "A String",
                      },
                    },
                    "deleteDocumentAction": { # Represents the action responsible for deleting the document. # Action deleting the document.
                      "enableHardDelete": True or False, # Boolean field to select between hard vs soft delete options. Set 'true' for 'hard delete' and 'false' for 'soft delete'.
                    },
                    "publishToPubSub": { # Represents the action responsible for publishing messages to a Pub/Sub topic. # Action publish to Pub/Sub operation.
                      "messages": [ # Messages to be published.
                        "A String",
                      ],
                      "topicId": "A String", # The topic id in the Pub/Sub service for which messages will be published to.
                    },
                    "removeFromFolderAction": { # Represents the action responsible for remove a document from a specific folder. # Action removing a document from a folder.
                      "condition": "A String", # Condition of the action to be executed.
                      "folder": "A String", # Name of the folder under which new document is to be added. Format: projects/{project_number}/locations/{location}/documents/{document_id}.
                    },
                  },
                ],
                "condition": "A String", # Represents the conditional expression to be evaluated. Expression should evaluate to a boolean result. When the condition is true actions are executed. Example: user_role = "hsbc_role_1" AND doc.salary > 20000
                "description": "A String", # Short description of the rule and its context.
                "ruleId": "A String", # ID of the rule. It has to be unique across all the examples. This is managed internally.
                "triggerType": "A String", # Identifies the trigger type for running the policy.
              },
            },
          ],
          "matchedRules": [ # A subset of triggered rules that are evaluated true for a given request.
            { # Represents the rule for a content warehouse trigger.
              "actions": [ # List of actions that are executed when the rule is satisfied.
                { # Represents the action triggered by Rule Engine when the rule is true.
                  "accessControl": { # Represents the action responsible for access control list management operations. # Action triggering access control operations.
                    "operationType": "A String", # Identifies the type of operation.
                    "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # Represents the new policy from which bindings are added, removed or replaced based on the type of the operation. the policy is limited to a few 10s of KB.
                      "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
                        { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
                          "auditLogConfigs": [ # The configuration for logging of each type of permission.
                            { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
                              "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
                                "A String",
                              ],
                              "logType": "A String", # The log type that this config enables.
                            },
                          ],
                          "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
                        },
                      ],
                      "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
                        { # Associates `members`, or principals, with a `role`.
                          "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
                            "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
                            "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
                            "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
                            "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
                          },
                          "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
                            "A String",
                          ],
                          "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
                        },
                      ],
                      "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
                      "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
                    },
                  },
                  "actionId": "A String", # ID of the action. Managed internally.
                  "addToFolder": { # Represents the action responsible for adding document under a folder. # Action triggering create document link operation.
                    "folders": [ # Names of the folder under which new document is to be added. Format: projects/{project_number}/locations/{location}/documents/{document_id}.
                      "A String",
                    ],
                  },
                  "dataUpdate": { # Represents the action responsible for properties update operations. # Action triggering data update operations.
                    "entries": { # Map of (K, V) -> (valid name of the field, new value of the field) E.g., ("age", "60") entry triggers update of field age with a value of 60. If the field is not present then new entry is added. During update action execution, value strings will be casted to appropriate types.
                      "a_key": "A String",
                    },
                  },
                  "dataValidation": { # Represents the action responsible for data validation operations. # Action triggering data validation operations.
                    "conditions": { # Map of (K, V) -> (field, string condition to be evaluated on the field) E.g., ("age", "age > 18 && age < 60") entry triggers validation of field age with the given condition. Map entries will be ANDed during validation.
                      "a_key": "A String",
                    },
                  },
                  "deleteDocumentAction": { # Represents the action responsible for deleting the document. # Action deleting the document.
                    "enableHardDelete": True or False, # Boolean field to select between hard vs soft delete options. Set 'true' for 'hard delete' and 'false' for 'soft delete'.
                  },
                  "publishToPubSub": { # Represents the action responsible for publishing messages to a Pub/Sub topic. # Action publish to Pub/Sub operation.
                    "messages": [ # Messages to be published.
                      "A String",
                    ],
                    "topicId": "A String", # The topic id in the Pub/Sub service for which messages will be published to.
                  },
                  "removeFromFolderAction": { # Represents the action responsible for remove a document from a specific folder. # Action removing a document from a folder.
                    "condition": "A String", # Condition of the action to be executed.
                    "folder": "A String", # Name of the folder under which new document is to be added. Format: projects/{project_number}/locations/{location}/documents/{document_id}.
                  },
                },
              ],
              "condition": "A String", # Represents the conditional expression to be evaluated. Expression should evaluate to a boolean result. When the condition is true actions are executed. Example: user_role = "hsbc_role_1" AND doc.salary > 20000
              "description": "A String", # Short description of the rule and its context.
              "ruleId": "A String", # ID of the rule. It has to be unique across all the examples. This is managed internally.
              "triggerType": "A String", # Identifies the trigger type for running the policy.
            },
          ],
          "triggeredRules": [ # List of rules fetched from database for the given request trigger type.
            { # Represents the rule for a content warehouse trigger.
              "actions": [ # List of actions that are executed when the rule is satisfied.
                { # Represents the action triggered by Rule Engine when the rule is true.
                  "accessControl": { # Represents the action responsible for access control list management operations. # Action triggering access control operations.
                    "operationType": "A String", # Identifies the type of operation.
                    "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # Represents the new policy from which bindings are added, removed or replaced based on the type of the operation. the policy is limited to a few 10s of KB.
                      "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
                        { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
                          "auditLogConfigs": [ # The configuration for logging of each type of permission.
                            { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
                              "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
                                "A String",
                              ],
                              "logType": "A String", # The log type that this config enables.
                            },
                          ],
                          "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
                        },
                      ],
                      "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
                        { # Associates `members`, or principals, with a `role`.
                          "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
                            "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
                            "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
                            "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
                            "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
                          },
                          "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
                            "A String",
                          ],
                          "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
                        },
                      ],
                      "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
                      "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
                    },
                  },
                  "actionId": "A String", # ID of the action. Managed internally.
                  "addToFolder": { # Represents the action responsible for adding document under a folder. # Action triggering create document link operation.
                    "folders": [ # Names of the folder under which new document is to be added. Format: projects/{project_number}/locations/{location}/documents/{document_id}.
                      "A String",
                    ],
                  },
                  "dataUpdate": { # Represents the action responsible for properties update operations. # Action triggering data update operations.
                    "entries": { # Map of (K, V) -> (valid name of the field, new value of the field) E.g., ("age", "60") entry triggers update of field age with a value of 60. If the field is not present then new entry is added. During update action execution, value strings will be casted to appropriate types.
                      "a_key": "A String",
                    },
                  },
                  "dataValidation": { # Represents the action responsible for data validation operations. # Action triggering data validation operations.
                    "conditions": { # Map of (K, V) -> (field, string condition to be evaluated on the field) E.g., ("age", "age > 18 && age < 60") entry triggers validation of field age with the given condition. Map entries will be ANDed during validation.
                      "a_key": "A String",
                    },
                  },
                  "deleteDocumentAction": { # Represents the action responsible for deleting the document. # Action deleting the document.
                    "enableHardDelete": True or False, # Boolean field to select between hard vs soft delete options. Set 'true' for 'hard delete' and 'false' for 'soft delete'.
                  },
                  "publishToPubSub": { # Represents the action responsible for publishing messages to a Pub/Sub topic. # Action publish to Pub/Sub operation.
                    "messages": [ # Messages to be published.
                      "A String",
                    ],
                    "topicId": "A String", # The topic id in the Pub/Sub service for which messages will be published to.
                  },
                  "removeFromFolderAction": { # Represents the action responsible for remove a document from a specific folder. # Action removing a document from a folder.
                    "condition": "A String", # Condition of the action to be executed.
                    "folder": "A String", # Name of the folder under which new document is to be added. Format: projects/{project_number}/locations/{location}/documents/{document_id}.
                  },
                },
              ],
              "condition": "A String", # Represents the conditional expression to be evaluated. Expression should evaluate to a boolean result. When the condition is true actions are executed. Example: user_role = "hsbc_role_1" AND doc.salary > 20000
              "description": "A String", # Short description of the rule and its context.
              "ruleId": "A String", # ID of the rule. It has to be unique across all the examples. This is managed internally.
              "triggerType": "A String", # Identifies the trigger type for running the policy.
            },
          ],
        },
      },
    }

`search(parent, body=None, x__xgafv=None)`

    Searches for documents using provided SearchDocumentsRequest. This call only returns documents that the caller has permission to search against.

    Args:
      parent: string, Required. The parent, which owns this collection of documents. Format: projects/{project_number}/locations/{location}. (required)
      body: object, The request body.
        The object takes the form of:

    { # Request message for DocumentService.SearchDocuments.
      "documentQuery": { # Query used to search against documents (keyword, filters, etc.).
        "customPropertyFilter": "A String", # This filter specifies a structured syntax to match against the [PropertyDefinition].is_filterable marked as `true`. The syntax for this expression is a subset of SQL syntax. Supported operators are: `=`, `!=`, `<`, `<=`, `>`, and `>=` where the left of the operator is a property name and the right of the operator is a number or a quoted string. You must escape backslash (\\) and quote (\") characters. Supported functions are `LOWER([property_name])` to perform a case insensitive match and `EMPTY([property_name])` to filter on the existence of a key. Boolean expressions (AND/OR/NOT) are supported up to 3 levels of nesting (for example, "((A AND B AND C) OR NOT D) AND E"), a maximum of 100 comparisons or functions are allowed in the expression. The expression must be < 6000 bytes in length. Sample Query: `(LOWER(driving_license)="class \"a\"" OR EMPTY(driving_license)) AND driving_years > 10`
        "customWeightsMetadata": { # To support the custom weighting across document schemas. # To support the custom weighting across document schemas, customers need to provide the properties to be used to boost the ranking in the search request. For a search query with CustomWeightsMetadata specified, only the RetrievalImportance for the properties in the CustomWeightsMetadata will be honored.
          "weightedSchemaProperties": [ # List of schema and property name. Allows a maximum of 10 schemas to be specified for relevance boosting.
            { # Specifies the schema property name.
              "documentSchemaName": "A String", # The document schema name.
              "propertyNames": [ # The property definition names in the schema.
                "A String",
              ],
            },
          ],
        },
        "documentCreatorFilter": [ # The exact creator(s) of the documents to search against. If a value isn't specified, documents within the search results are associated with any creator. If multiple values are specified, documents within the search results may be associated with any of the specified creators.
          "A String",
        ],
        "documentNameFilter": [ # Search the documents in the list. Format: projects/{project_number}/locations/{location}/documents/{document_id}.
          "A String",
        ],
        "documentSchemaNames": [ # This filter specifies the exact document schema Document.document_schema_name of the documents to search against. If a value isn't specified, documents within the search results are associated with any schema. If multiple values are specified, documents within the search results may be associated with any of the specified schemas. At most 20 document schema names are allowed.
          "A String",
        ],
        "fileTypeFilter": { # Filter for the specific types of documents returned. # This filter specifies the types of files to return: ALL, FOLDER, or FILE. If FOLDER or FILE is specified, then only either folders or files will be returned, respectively. If ALL is specified, both folders and files will be returned. If no value is specified, ALL files will be returned.
          "fileType": "A String", # The type of files to return.
        },
        "folderNameFilter": "A String", # Search all the documents under this specified folder. Format: projects/{project_number}/locations/{location}/documents/{document_id}.
        "isNlQuery": True or False, # Experimental, do not use. If the query is a natural language question. False by default. If true, then the question-answering feature will be used instead of search, and `result_count` in SearchDocumentsRequest must be set. In addition, all other input fields related to search (pagination, histograms, etc.) will be ignored.
        "propertyFilter": [ # This filter specifies a structured syntax to match against the PropertyDefinition.is_filterable marked as `true`. The relationship between the PropertyFilters is OR.
          {
            "condition": "A String", # The filter condition. The syntax for this expression is a subset of SQL syntax. Supported operators are: `=`, `!=`, `<`, `<=`, `>`, `>=`, and `~~` where the left of the operator is a property name and the right of the operator is a number or a quoted string. You must escape backslash (\\) and quote (\") characters. `~~` is the LIKE operator. The right of the operator must be a string. The only supported property data type for LIKE is text_values. It provides semantic search functionality by parsing, stemming and doing synonyms expansion against the input query. It matches if the property contains semantic similar content to the query. It is not regex matching or wildcard matching. For example, "property.company ~~ \"google\"" will match records whose property `property.compnay` have values like "Google Inc.", "Google LLC" or "Google Company". Supported functions are `LOWER([property_name])` to perform a case insensitive match and `EMPTY([property_name])` to filter on the existence of a key. Boolean expressions (AND/OR/NOT) are supported up to 3 levels of nesting (for example, "((A AND B AND C) OR NOT D) AND E"), a maximum of 100 comparisons or functions are allowed in the expression. The expression must be < 6000 bytes in length. Only properties that are marked filterable are allowed (PropertyDefinition.is_filterable). Property names do not need to be prefixed by the document schema id (as is the case with histograms), however property names will need to be prefixed by its parent hierarchy, if any. For example: top_property_name.sub_property_name. Sample Query: `(LOWER(driving_license)="class \"a\"" OR EMPTY(driving_license)) AND driving_years > 10` CMEK compliant deployment only supports: * Operators: `=`, `<`, `<=`, `>`, and `>=`. * Boolean expressions: AND and OR.
            "documentSchemaName": "A String", # The Document schema name Document.document_schema_name. Format: projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}.
          },
        ],
        "query": "A String", # The query string that matches against the full text of the document and the searchable properties. The query partially supports [Google AIP style syntax](https://google.aip.dev/160). Specifically, the query supports literals, logical operators, negation operators, comparison operators, and functions. Literals: A bare literal value (examples: "42", "Hugo") is a value to be matched against. It searches over the full text of the document and the searchable properties. Logical operators: "AND", "and", "OR", and "or" are binary logical operators (example: "engineer OR developer"). Negation operators: "NOT" and "!" are negation operators (example: "NOT software"). Comparison operators: support the binary comparison operators =, !=, <, >, <= and >= for string, numeric, enum, boolean. Also support like operator `~~` for string. It provides semantic search functionality by parsing, stemming and doing synonyms expansion against the input query. To specify a property in the query, the left hand side expression in the comparison must be the property ID including the parent. The right hand side must be literals. For example: "\"projects/123/locations/us\".property_a < 1" matches results whose "property_a" is less than 1 in project 123 and us location. The literals and comparison expression can be connected in a single query (example: "software engineer \"projects/123/locations/us\".salary > 100"). Functions: supported functions are `LOWER([property_name])` to perform a case insensitive match and `EMPTY([property_name])` to filter on the existence of a key. Support nested expressions connected using parenthesis and logical operators. The default logical operators is `AND` if there is no operators between expressions. The query can be used with other filters e.g. `time_filters` and `folder_name_filter`. They are connected with `AND` operator under the hood. The maximum number of allowed characters is 255.
        "queryContext": [ # For custom synonyms. Customers provide the synonyms based on context. One customer can provide multiple set of synonyms based on different context. The search query will be expanded based on the custom synonyms of the query context set. By default, no custom synonyms wll be applied if no query context is provided. It is not supported for CMEK compliant deployment.
          "A String",
        ],
        "timeFilters": [ # Documents created/updated within a range specified by this filter are searched against.
          { # Filter on create timestamp or update timestamp of documents.
            "timeField": "A String", # Specifies which time field to filter documents on. Defaults to TimeField.UPLOAD_TIME.
            "timeRange": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time.
              "endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
              "startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
            },
          },
        ],
      },
      "histogramQueries": [ # An expression specifying a histogram request against matching documents. Expression syntax is an aggregation function call with histogram facets and other options. The following aggregation functions are supported: * `count(string_histogram_facet)`: Count the number of matching entities for each distinct attribute value. Data types: * Histogram facet (aka filterable properties): Facet names with format <schema id>.<facet>. Facets will have the format of: `a-zA-Z`. If the facet is a child facet, then the parent hierarchy needs to be specified separated by dots in the prefix after the schema id. Thus, the format for a multi- level facet is: <schema id>.<parent facet name>. <child facet name>. Example: schema123.root_parent_facet.middle_facet.child_facet * DocumentSchemaId: (with no schema id prefix) to get histograms for each document type (returns the schema id path, e.g. projects/12345/locations/us-west/documentSchemas/abc123). Example expression: * Document type counts: count('DocumentSchemaId') * For schema id, abc123, get the counts for MORTGAGE_TYPE: count('abc123.MORTGAGE_TYPE')
        { # The histogram request.
          "filters": { # Optional. Filter the result of histogram query by the property names. It only works with histogram query count('FilterableProperties'). It is an optional. It will perform histogram on all the property names for all the document schemas. Setting this field will have a better performance.
            "documentSchemas": [ # This filter specifies the exact document schema(s) Document.document_schema_name to run histogram query against. It is optional. It will perform histogram for property names for all the document schemas if it is not set. At most 10 document schema names are allowed. Format: projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}.
              "A String",
            ],
            "propertyNames": [ # It is optional. It will perform histogram for all the property names if it is not set. The properties need to be defined with the is_filterable flag set to true and the name of the property should be in the format: "schemaId.propertyName". The property needs to be defined in the schema. Example: the schema id is abc. Then the name of property for property MORTGAGE_TYPE will be "abc.MORTGAGE_TYPE".
              "A String",
            ],
            "yAxis": "A String", # By default, the y_axis is HISTOGRAM_YAXIS_DOCUMENT if this field is not set.
          },
          "histogramQuery": "A String", # An expression specifies a histogram request against matching documents for searches. See SearchDocumentsRequest.histogram_queries for details about syntax.
          "requirePreciseResultSize": True or False, # Controls if the histogram query requires the return of a precise count. Enable this flag may adversely impact performance. Defaults to true.
        },
      ],
      "offset": 42, # An integer that specifies the current offset (that is, starting result location, amongst the documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. The maximum allowed value is 5000. Otherwise an error is thrown. For example, 0 means to return results starting from the first matching document, and 10 means to return from the 11th document. This can be used for pagination, (for example, pageSize = 10 and offset = 10 means to return from the second page).
      "orderBy": "A String", # The criteria determining how search results are sorted. For non-empty query, default is `"relevance desc"`. For empty query, default is `"upload_date desc"`. Supported options are: * `"relevance desc"`: By relevance descending, as determined by the API algorithms. * `"upload_date desc"`: By upload date descending. * `"upload_date"`: By upload date ascending. * `"update_date desc"`: By last updated date descending. * `"update_date"`: By last updated date ascending. * `"retrieval_importance desc"`: By retrieval importance of properties descending. This feature is still under development, please do not use unless otherwise instructed to do so.
      "pageSize": 42, # A limit on the number of documents returned in the search results. Increasing this value above the default value of 10 can increase search response time. The value can be between 1 and 100.
      "pageToken": "A String", # The token specifying the current offset within search results. See SearchDocumentsResponse.next_page_token for an explanation of how to obtain the next set of query results.
      "qaSizeLimit": 42, # Experimental, do not use. The limit on the number of documents returned for the question-answering feature. To enable the question-answering feature, set [DocumentQuery].is_nl_query to true.
      "requestMetadata": { # Meta information is used to improve the performance of the service. # The meta information collected about the end user, used to enforce access control and improve the search quality of the service.
        "userInfo": { # The user information. # Provides user unique identification and groups information.
          "groupIds": [ # The unique group identifications which the user is belong to. The format is "group:yyyy@example.com";
            "A String",
          ],
          "id": "A String", # A unique user identification string, as determined by the client. The maximum number of allowed characters is 255. Allowed characters include numbers 0 to 9, uppercase and lowercase letters, and restricted special symbols (:, @, +, -, _, ~) The format is "user:xxxx@example.com";
        },
      },
      "requireTotalSize": True or False, # Controls if the search document request requires the return of a total size of matched documents. See SearchDocumentsResponse.total_size. Enabling this flag may adversely impact performance. Hint: If this is used with pagination, set this flag on the initial query but set this to false on subsequent page calls (keep the total count locally). Defaults to false.
      "totalResultSize": "A String", # Controls if the search document request requires the return of a total size of matched documents. See SearchDocumentsResponse.total_size.
    }

      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # Response message for DocumentService.SearchDocuments.
      "histogramQueryResults": [ # The histogram results that match with the specified SearchDocumentsRequest.histogram_queries.
        { # Histogram result that matches HistogramQuery specified in searches.
          "histogram": { # A map from the values of the facet associated with distinct values to the number of matching entries with corresponding value. The key format is: * (for string histogram) string values stored in the field.
            "a_key": "A String",
          },
          "histogramQuery": "A String", # Requested histogram expression.
        },
      ],
      "matchingDocuments": [ # The document entities that match the specified SearchDocumentsRequest.
        { # Document entry with metadata inside SearchDocumentsResponse
          "document": { # Defines the structure for content warehouse document proto. # Document that matches the specified SearchDocumentsRequest. This document only contains indexed metadata information.
            "cloudAiDocument": { # Document represents the canonical document resource in Document AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document AI to iterate and optimize for quality. # Document AI format to save the structured content, including OCR.
              "chunkedDocument": { # Represents the chunks that the document is divided into. # Document chunked based on chunking config.
                "chunks": [ # List of chunks.
                  { # Represents a chunk.
                    "chunkId": "A String", # ID of the chunk.
                    "content": "A String", # Text content of the chunk.
                    "pageFooters": [ # Page footers associated with the chunk.
                      { # Represents the page footer associated with the chunk.
                        "pageSpan": { # Represents where the chunk starts and ends in the document. # Page span of the footer.
                          "pageEnd": 42, # Page where chunk ends in the document.
                          "pageStart": 42, # Page where chunk starts in the document.
                        },
                        "text": "A String", # Footer in text format.
                      },
                    ],
                    "pageHeaders": [ # Page headers associated with the chunk.
                      { # Represents the page header associated with the chunk.
                        "pageSpan": { # Represents where the chunk starts and ends in the document. # Page span of the header.
                          "pageEnd": 42, # Page where chunk ends in the document.
                          "pageStart": 42, # Page where chunk starts in the document.
                        },
                        "text": "A String", # Header in text format.
                      },
                    ],
                    "pageSpan": { # Represents where the chunk starts and ends in the document. # Page span of the chunk.
                      "pageEnd": 42, # Page where chunk ends in the document.
                      "pageStart": 42, # Page where chunk starts in the document.
                    },
                    "sourceBlockIds": [ # Unused.
                      "A String",
                    ],
                  },
                ],
              },
              "content": "A String", # Optional. Inline document content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64.
              "documentLayout": { # Represents the parsed layout of a document as a collection of blocks that the document is divided into. # Parsed layout of the document.
                "blocks": [ # List of blocks in the document.
                  { # Represents a block. A block could be one of the various types (text, table, list) supported.
                    "blockId": "A String", # ID of the block.
                    "listBlock": { # Represents a list type block. # Block consisting of list content/structure.
                      "listEntries": [ # List entries that constitute a list block.
                        { # Represents an entry in the list.
                          "blocks": [ # A list entry is a list of blocks. Repeated blocks support further hierarchies and nested blocks.
                            # Object with schema name: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock
                          ],
                        },
                      ],
                      "type": "A String", # Type of the list_entries (if exist). Available options are `ordered` and `unordered`.
                    },
                    "pageSpan": { # Represents where the block starts and ends in the document. # Page span of the block.
                      "pageEnd": 42, # Page where block ends in the document.
                      "pageStart": 42, # Page where block starts in the document.
                    },
                    "tableBlock": { # Represents a table type block. # Block consisting of table content/structure.
                      "bodyRows": [ # Body rows containing main table content.
                        { # Represents a row in a table.
                          "cells": [ # A table row is a list of table cells.
                            { # Represents a cell in a table row.
                              "blocks": [ # A table cell is a list of blocks. Repeated blocks support further hierarchies and nested blocks.
                                # Object with schema name: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock
                              ],
                              "colSpan": 42, # How many columns this cell spans.
                              "rowSpan": 42, # How many rows this cell spans.
                            },
                          ],
                        },
                      ],
                      "caption": "A String", # Table caption/title.
                      "headerRows": [ # Header rows at the top of the table.
                        { # Represents a row in a table.
                          "cells": [ # A table row is a list of table cells.
                            { # Represents a cell in a table row.
                              "blocks": [ # A table cell is a list of blocks. Repeated blocks support further hierarchies and nested blocks.
                                # Object with schema name: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock
                              ],
                              "colSpan": 42, # How many columns this cell spans.
                              "rowSpan": 42, # How many rows this cell spans.
                            },
                          ],
                        },
                      ],
                    },
                    "textBlock": { # Represents a text type block. # Block consisting of text content.
                      "blocks": [ # A text block could further have child blocks. Repeated blocks support further hierarchies and nested blocks.
                        # Object with schema name: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock
                      ],
                      "text": "A String", # Text content stored in the block.
                      "type": "A String", # Type of the text in the block. Available options are: `paragraph`, `subtitle`, `heading-1`, `heading-2`, `heading-3`, `heading-4`, `heading-5`, `header`, `footer`.
                    },
                  },
                ],
              },
              "entities": [ # A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries.
                { # An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location.
                  "confidence": 3.14, # Optional. Confidence of detected Schema entity. Range `[0, 1]`.
                  "id": "A String", # Optional. Canonical id. This will be a unique value in the entity list for this document.
                  "mentionId": "A String", # Optional. Deprecated. Use `id` field instead.
                  "mentionText": "A String", # Optional. Text value of the entity e.g. `1600 Amphitheatre Pkwy`.
                  "normalizedValue": { # Parsed and normalized entity value. # Optional. Normalized entity value. Absent if the extracted value could not be converted or the type (e.g. address) is not supported for certain parsers. This field is also only populated for certain supported document types.
                    "addressValue": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Postal address. See also: https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto
                      "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
                        "A String",
                      ],
                      "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
                      "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
                      "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
                      "organization": "A String", # Optional. The name of the organization at the address.
                      "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
                      "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
                        "A String",
                      ],
                      "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
                      "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
                      "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
                      "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
                    },
                    "booleanValue": True or False, # Boolean value. Can be used for entities with binary values, or for checkboxes.
                    "dateValue": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Date value. Includes year, month, day. See also: https://github.com/googleapis/googleapis/blob/master/google/type/date.proto
                      "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
                      "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
                      "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
                    },
                    "datetimeValue": { # Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations. # DateTime value. Includes date, time, and timezone. See also: https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto
                      "day": 42, # Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day.
                      "hours": 42, # Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults to 0 (midnight). An API may choose to allow the value "24:00:00" for scenarios like business closing time.
                      "minutes": 42, # Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.
                      "month": 42, # Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month.
                      "nanos": 42, # Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0.
                      "seconds": 42, # Optional. Seconds of minutes of the time. Must normally be from 0 to 59, defaults to 0. An API may allow the value 60 if it allows leap-seconds.
                      "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Time zone.
                        "id": "A String", # IANA Time Zone Database time zone. For example "America/New_York".
                        "version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a".
                      },
                      "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.
                      "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.
                    },
                    "floatValue": 3.14, # Float value.
                    "integerValue": 42, # Integer value.
                    "moneyValue": { # Represents an amount of money with its currency type. # Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto
                      "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
                      "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
                      "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
                    },
                    "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format.
                  },
                  "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found.
                    "pageRefs": [ # One or more references to visual page elements
                      { # Represents a weak reference to a page element within a document.
                        "boundingPoly": { # A bounding polygon for the detected image annotation. # Optional. Identifies the bounding polygon of a layout element on the page. If `layout_type` is set, the bounding polygon must be exactly the same to the layout element it's referring to.
                          "normalizedVertices": [ # The bounding polygon normalized vertices.
                            { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                              "x": 3.14, # X coordinate.
                              "y": 3.14, # Y coordinate (starts from the top of the image).
                            },
                          ],
                          "vertices": [ # The bounding polygon vertices.
                            { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                              "x": 42, # X coordinate.
                              "y": 42, # Y coordinate (starts from the top of the image).
                            },
                          ],
                        },
                        "confidence": 3.14, # Optional. Confidence of detected page element, if applicable. Range `[0, 1]`.
                        "layoutId": "A String", # Optional. Deprecated. Use PageRef.bounding_poly instead.
                        "layoutType": "A String", # Optional. The type of the layout element that is being referenced if any.
                        "page": "A String", # Required. Index into the Document.pages element, for example using `Document.pages` to locate the related page element. This field is skipped when its value is the default `0`. See https://developers.google.com/protocol-buffers/docs/proto3#json.
                      },
                    ],
                  },
                  "properties": [ # Optional. Entities can be nested to form a hierarchical data structure representing the content in the document.
                    # Object with schema name: GoogleCloudDocumentaiV1DocumentEntity
                  ],
                  "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # Optional. The history of this annotation.
                    "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
                    "parents": [ # References to the original elements that are replaced.
                      { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
                        "id": 42, # The id of the parent provenance.
                        "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
                        "revision": 42, # The index of the index into current revision's parent_ids list.
                      },
                    ],
                    "revision": 42, # The index of the revision that produced this element.
                    "type": "A String", # The type of provenance operation.
                  },
                  "redacted": True or False, # Optional. Whether the entity will be redacted for de-identification purposes.
                  "textAnchor": { # Text reference indexing into the Document.text. # Optional. Provenance of the entity. Text anchor indexing into the Document.text.
                    "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                    "textSegments": [ # The text segments from the Document.text.
                      { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                        "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                        "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                      },
                    ],
                  },
                  "type": "A String", # Required. Entity type from a schema e.g. `Address`.
                },
              ],
              "entityRelations": [ # Placeholder. Relationship among Document.entities.
                { # Relationship between Entities.
                  "objectId": "A String", # Object entity id.
                  "relation": "A String", # Relationship description.
                  "subjectId": "A String", # Subject entity id.
                },
              ],
              "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Any error that occurred while processing this document.
                "code": 42, # The status code, which should be an enum value of google.rpc.Code.
                "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
                  {
                    "a_key": "", # Properties of the object. Contains field @type with type URL.
                  },
                ],
                "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
              },
              "mimeType": "A String", # An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml).
              "pages": [ # Visual page layout for the Document.
                { # A page in a Document.
                  "blocks": [ # A list of visually detected text blocks on the page. A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.
                    { # A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.
                      "detectedLanguages": [ # A list of detected languages together with confidence.
                        { # Detected language for a structural component.
                          "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
                          "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
                        },
                      ],
                      "layout": { # Visual element describing a layout unit on a page. # Layout for Block.
                        "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                          "normalizedVertices": [ # The bounding polygon normalized vertices.
                            { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                              "x": 3.14, # X coordinate.
                              "y": 3.14, # Y coordinate (starts from the top of the image).
                            },
                          ],
                          "vertices": [ # The bounding polygon vertices.
                            { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                              "x": 42, # X coordinate.
                              "y": 42, # Y coordinate (starts from the top of the image).
                            },
                          ],
                        },
                        "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                        "orientation": "A String", # Detected orientation for the Layout.
                        "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                          "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                          "textSegments": [ # The text segments from the Document.text.
                            { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                              "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                              "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                            },
                          ],
                        },
                      },
                      "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation.
                        "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
                        "parents": [ # References to the original elements that are replaced.
                          { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
                            "id": 42, # The id of the parent provenance.
                            "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
                            "revision": 42, # The index of the index into current revision's parent_ids list.
                          },
                        ],
                        "revision": 42, # The index of the revision that produced this element.
                        "type": "A String", # The type of provenance operation.
                      },
                    },
                  ],
                  "detectedBarcodes": [ # A list of detected barcodes.
                    { # A detected barcode.
                      "barcode": { # Encodes the detailed information of a barcode. # Detailed barcode information of the DetectedBarcode.
                        "format": "A 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.
                        "rawValue": "A String", # Raw value encoded in the barcode. For example: `'MEBKM:TITLE:Google;URL:https://www.google.com;;'`.
                        "valueFormat": "A 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.
                      },
                      "layout": { # Visual element describing a layout unit on a page. # Layout for DetectedBarcode.
                        "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                          "normalizedVertices": [ # The bounding polygon normalized vertices.
                            { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                              "x": 3.14, # X coordinate.
                              "y": 3.14, # Y coordinate (starts from the top of the image).
                            },
                          ],
                          "vertices": [ # The bounding polygon vertices.
                            { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                              "x": 42, # X coordinate.
                              "y": 42, # Y coordinate (starts from the top of the image).
                            },
                          ],
                        },
                        "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                        "orientation": "A String", # Detected orientation for the Layout.
                        "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                          "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                          "textSegments": [ # The text segments from the Document.text.
                            { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                              "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                              "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                            },
                          ],
                        },
                      },
                    },
                  ],
                  "detectedLanguages": [ # A list of detected languages together with confidence.
                    { # Detected language for a structural component.
                      "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
                      "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
                    },
                  ],
                  "dimension": { # Dimension for the page. # Physical dimension of the page.
                    "height": 3.14, # Page height.
                    "unit": "A String", # Dimension unit.
                    "width": 3.14, # Page width.
                  },
                  "formFields": [ # A list of visually detected form fields on the page.
                    { # A form field detected on the page.
                      "correctedKeyText": "A String", # Created for Labeling UI to export key text. If corrections were made to the text identified by the `field_name.text_anchor`, this field will contain the correction.
                      "correctedValueText": "A String", # Created for Labeling UI to export value text. If corrections were made to the text identified by the `field_value.text_anchor`, this field will contain the correction.
                      "fieldName": { # Visual element describing a layout unit on a page. # Layout for the FormField name. e.g. `Address`, `Email`, `Grand total`, `Phone number`, etc.
                        "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                          "normalizedVertices": [ # The bounding polygon normalized vertices.
                            { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                              "x": 3.14, # X coordinate.
                              "y": 3.14, # Y coordinate (starts from the top of the image).
                            },
                          ],
                          "vertices": [ # The bounding polygon vertices.
                            { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                              "x": 42, # X coordinate.
                              "y": 42, # Y coordinate (starts from the top of the image).
                            },
                          ],
                        },
                        "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                        "orientation": "A String", # Detected orientation for the Layout.
                        "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                          "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                          "textSegments": [ # The text segments from the Document.text.
                            { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                              "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                              "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                            },
                          ],
                        },
                      },
                      "fieldValue": { # Visual element describing a layout unit on a page. # Layout for the FormField value.
                        "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                          "normalizedVertices": [ # The bounding polygon normalized vertices.
                            { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                              "x": 3.14, # X coordinate.
                              "y": 3.14, # Y coordinate (starts from the top of the image).
                            },
                          ],
                          "vertices": [ # The bounding polygon vertices.
                            { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                              "x": 42, # X coordinate.
                              "y": 42, # Y coordinate (starts from the top of the image).
                            },
                          ],
                        },
                        "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                        "orientation": "A String", # Detected orientation for the Layout.
                        "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                          "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                          "textSegments": [ # The text segments from the Document.text.
                            { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                              "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                              "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                            },
                          ],
                        },
                      },
                      "nameDetectedLanguages": [ # A list of detected languages for name together with confidence.
                        { # Detected language for a structural component.
                          "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
                          "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
                        },
                      ],
                      "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation.
                        "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
                        "parents": [ # References to the original elements that are replaced.
                          { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
                            "id": 42, # The id of the parent provenance.
                            "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
                            "revision": 42, # The index of the index into current revision's parent_ids list.
                          },
                        ],
                        "revision": 42, # The index of the revision that produced this element.
                        "type": "A String", # The type of provenance operation.
                      },
                      "valueDetectedLanguages": [ # A list of detected languages for value together with confidence.
                        { # Detected language for a structural component.
                          "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
                          "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
                        },
                      ],
                      "valueType": "A String", # If the value is non-textual, this field represents the type. Current valid values are: - blank (this indicates the `field_value` is normal text) - `unfilled_checkbox` - `filled_checkbox`
                    },
                  ],
                  "image": { # Rendered image contents for this page. # Rendered image for this page. This image is preprocessed to remove any skew, rotation, and distortions such that the annotation bounding boxes can be upright and axis-aligned.
                    "content": "A String", # Raw byte content of the image.
                    "height": 42, # Height of the image in pixels.
                    "mimeType": "A String", # Encoding [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml) for the image.
                    "width": 42, # Width of the image in pixels.
                  },
                  "imageQualityScores": { # Image quality scores for the page image. # Image quality scores.
                    "detectedDefects": [ # A list of detected defects.
                      { # Image Quality Defects
                        "confidence": 3.14, # Confidence of detected defect. Range `[0, 1]` where `1` indicates strong confidence that the defect exists.
                        "type": "A String", # Name of the defect type. Supported values are: - `quality/defect_blurry` - `quality/defect_noisy` - `quality/defect_dark` - `quality/defect_faint` - `quality/defect_text_too_small` - `quality/defect_document_cutoff` - `quality/defect_text_cutoff` - `quality/defect_glare`
                      },
                    ],
                    "qualityScore": 3.14, # The overall quality score. Range `[0, 1]` where `1` is perfect quality.
                  },
                  "layout": { # Visual element describing a layout unit on a page. # Layout for the page.
                    "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                      "normalizedVertices": [ # The bounding polygon normalized vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                          "x": 3.14, # X coordinate.
                          "y": 3.14, # Y coordinate (starts from the top of the image).
                        },
                      ],
                      "vertices": [ # The bounding polygon vertices.
                        { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                          "x": 42, # X coordinate.
                          "y": 42, # Y coordinate (starts from the top of the image).
                        },
                      ],
                    },
                    "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                    "orientation": "A String", # Detected orientation for the Layout.
                    "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                      "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                      "textSegments": [ # The text segments from the Document.text.
                        { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                          "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                          "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                        },
                      ],
                    },
                  },
                  "lines": [ # A list of visually detected text lines on the page. A collection of tokens that a human would perceive as a line.
                    { # A collection of tokens that a human would perceive as a line. Does not cross column boundaries, can be horizontal, vertical, etc.
                      "detectedLanguages": [ # A list of detected languages together with confidence.
                        { # Detected language for a structural component.
                          "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
                          "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
                        },
                      ],
                      "layout": { # Visual element describing a layout unit on a page. # Layout for Line.
                        "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                          "normalizedVertices": [ # The bounding polygon normalized vertices.
                            { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                              "x": 3.14, # X coordinate.
                              "y": 3.14, # Y coordinate (starts from the top of the image).
                            },
                          ],
                          "vertices": [ # The bounding polygon vertices.
                            { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                              "x": 42, # X coordinate.
                              "y": 42, # Y coordinate (starts from the top of the image).
                            },
                          ],
                        },
                        "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                        "orientation": "A String", # Detected orientation for the Layout.
                        "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                          "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                          "textSegments": [ # The text segments from the Document.text.
                            { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                              "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                              "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                            },
                          ],
                        },
                      },
                      "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation.
                        "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
                        "parents": [ # References to the original elements that are replaced.
                          { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
                            "id": 42, # The id of the parent provenance.
                            "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
                            "revision": 42, # The index of the index into current revision's parent_ids list.
                          },
                        ],
                        "revision": 42, # The index of the revision that produced this element.
                        "type": "A String", # The type of provenance operation.
                      },
                    },
                  ],
                  "pageNumber": 42, # 1-based index for current Page in a parent Document. Useful when a page is taken out of a Document for individual processing.
                  "paragraphs": [ # A list of visually detected text paragraphs on the page. A collection of lines that a human would perceive as a paragraph.
                    { # A collection of lines that a human would perceive as a paragraph.
                      "detectedLanguages": [ # A list of detected languages together with confidence.
                        { # Detected language for a structural component.
                          "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
                          "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
                        },
                      ],
                      "layout": { # Visual element describing a layout unit on a page. # Layout for Paragraph.
                        "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                          "normalizedVertices": [ # The bounding polygon normalized vertices.
                            { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                              "x": 3.14, # X coordinate.
                              "y": 3.14, # Y coordinate (starts from the top of the image).
                            },
                          ],
                          "vertices": [ # The bounding polygon vertices.
                            { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                              "x": 42, # X coordinate.
                              "y": 42, # Y coordinate (starts from the top of the image).
                            },
                          ],
                        },
                        "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                        "orientation": "A String", # Detected orientation for the Layout.
                        "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                          "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                          "textSegments": [ # The text segments from the Document.text.
                            { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                              "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                              "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                            },
                          ],
                        },
                      },
                      "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation.
                        "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
                        "parents": [ # References to the original elements that are replaced.
                          { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
                            "id": 42, # The id of the parent provenance.
                            "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
                            "revision": 42, # The index of the index into current revision's parent_ids list.
                          },
                        ],
                        "revision": 42, # The index of the revision that produced this element.
                        "type": "A String", # The type of provenance operation.
                      },
                    },
                  ],
                  "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this page.
                    "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
                    "parents": [ # References to the original elements that are replaced.
                      { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
                        "id": 42, # The id of the parent provenance.
                        "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
                        "revision": 42, # The index of the index into current revision's parent_ids list.
                      },
                    ],
                    "revision": 42, # The index of the revision that produced this element.
                    "type": "A String", # The type of provenance operation.
                  },
                  "symbols": [ # A list of visually detected symbols on the page.
                    { # A detected symbol.
                      "detectedLanguages": [ # A list of detected languages together with confidence.
                        { # Detected language for a structural component.
                          "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
                          "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
                        },
                      ],
                      "layout": { # Visual element describing a layout unit on a page. # Layout for Symbol.
                        "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                          "normalizedVertices": [ # The bounding polygon normalized vertices.
                            { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                              "x": 3.14, # X coordinate.
                              "y": 3.14, # Y coordinate (starts from the top of the image).
                            },
                          ],
                          "vertices": [ # The bounding polygon vertices.
                            { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                              "x": 42, # X coordinate.
                              "y": 42, # Y coordinate (starts from the top of the image).
                            },
                          ],
                        },
                        "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                        "orientation": "A String", # Detected orientation for the Layout.
                        "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                          "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                          "textSegments": [ # The text segments from the Document.text.
                            { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                              "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                              "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                            },
                          ],
                        },
                      },
                    },
                  ],
                  "tables": [ # A list of visually detected tables on the page.
                    { # A table representation similar to HTML table structure.
                      "bodyRows": [ # Body rows of the table.
                        { # A row of table cells.
                          "cells": [ # Cells that make up this row.
                            { # A cell representation inside the table.
                              "colSpan": 42, # How many columns this cell spans.
                              "detectedLanguages": [ # A list of detected languages together with confidence.
                                { # Detected language for a structural component.
                                  "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
                                  "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
                                },
                              ],
                              "layout": { # Visual element describing a layout unit on a page. # Layout for TableCell.
                                "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                                  "normalizedVertices": [ # The bounding polygon normalized vertices.
                                    { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                                      "x": 3.14, # X coordinate.
                                      "y": 3.14, # Y coordinate (starts from the top of the image).
                                    },
                                  ],
                                  "vertices": [ # The bounding polygon vertices.
                                    { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                                      "x": 42, # X coordinate.
                                      "y": 42, # Y coordinate (starts from the top of the image).
                                    },
                                  ],
                                },
                                "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                                "orientation": "A String", # Detected orientation for the Layout.
                                "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                                  "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                                  "textSegments": [ # The text segments from the Document.text.
                                    { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                                      "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                                      "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                                    },
                                  ],
                                },
                              },
                              "rowSpan": 42, # How many rows this cell spans.
                            },
                          ],
                        },
                      ],
                      "detectedLanguages": [ # A list of detected languages together with confidence.
                        { # Detected language for a structural component.
                          "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
                          "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
                        },
                      ],
                      "headerRows": [ # Header rows of the table.
                        { # A row of table cells.
                          "cells": [ # Cells that make up this row.
                            { # A cell representation inside the table.
                              "colSpan": 42, # How many columns this cell spans.
                              "detectedLanguages": [ # A list of detected languages together with confidence.
                                { # Detected language for a structural component.
                                  "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
                                  "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
                                },
                              ],
                              "layout": { # Visual element describing a layout unit on a page. # Layout for TableCell.
                                "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                                  "normalizedVertices": [ # The bounding polygon normalized vertices.
                                    { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                                      "x": 3.14, # X coordinate.
                                      "y": 3.14, # Y coordinate (starts from the top of the image).
                                    },
                                  ],
                                  "vertices": [ # The bounding polygon vertices.
                                    { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                                      "x": 42, # X coordinate.
                                      "y": 42, # Y coordinate (starts from the top of the image).
                                    },
                                  ],
                                },
                                "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                                "orientation": "A String", # Detected orientation for the Layout.
                                "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                                  "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                                  "textSegments": [ # The text segments from the Document.text.
                                    { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                                      "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                                      "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                                    },
                                  ],
                                },
                              },
                              "rowSpan": 42, # How many rows this cell spans.
                            },
                          ],
                        },
                      ],
                      "layout": { # Visual element describing a layout unit on a page. # Layout for Table.
                        "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                          "normalizedVertices": [ # The bounding polygon normalized vertices.
                            { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                              "x": 3.14, # X coordinate.
                              "y": 3.14, # Y coordinate (starts from the top of the image).
                            },
                          ],
                          "vertices": [ # The bounding polygon vertices.
                            { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                              "x": 42, # X coordinate.
                              "y": 42, # Y coordinate (starts from the top of the image).
                            },
                          ],
                        },
                        "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                        "orientation": "A String", # Detected orientation for the Layout.
                        "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                          "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                          "textSegments": [ # The text segments from the Document.text.
                            { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                              "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                              "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                            },
                          ],
                        },
                      },
                      "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this table.
                        "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
                        "parents": [ # References to the original elements that are replaced.
                          { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
                            "id": 42, # The id of the parent provenance.
                            "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
                            "revision": 42, # The index of the index into current revision's parent_ids list.
                          },
                        ],
                        "revision": 42, # The index of the revision that produced this element.
                        "type": "A String", # The type of provenance operation.
                      },
                    },
                  ],
                  "tokens": [ # A list of visually detected tokens on the page.
                    { # A detected token.
                      "detectedBreak": { # Detected break at the end of a Token. # Detected break at the end of a Token.
                        "type": "A String", # Detected break type.
                      },
                      "detectedLanguages": [ # A list of detected languages together with confidence.
                        { # Detected language for a structural component.
                          "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
                          "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
                        },
                      ],
                      "layout": { # Visual element describing a layout unit on a page. # Layout for Token.
                        "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                          "normalizedVertices": [ # The bounding polygon normalized vertices.
                            { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                              "x": 3.14, # X coordinate.
                              "y": 3.14, # Y coordinate (starts from the top of the image).
                            },
                          ],
                          "vertices": [ # The bounding polygon vertices.
                            { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                              "x": 42, # X coordinate.
                              "y": 42, # Y coordinate (starts from the top of the image).
                            },
                          ],
                        },
                        "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                        "orientation": "A String", # Detected orientation for the Layout.
                        "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                          "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                          "textSegments": [ # The text segments from the Document.text.
                            { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                              "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                              "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                            },
                          ],
                        },
                      },
                      "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation.
                        "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
                        "parents": [ # References to the original elements that are replaced.
                          { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
                            "id": 42, # The id of the parent provenance.
                            "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
                            "revision": 42, # The index of the index into current revision's parent_ids list.
                          },
                        ],
                        "revision": 42, # The index of the revision that produced this element.
                        "type": "A String", # The type of provenance operation.
                      },
                      "styleInfo": { # Font and other text style attributes. # Text style attributes.
                        "backgroundColor": { # Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ... # Color of the background.
                          "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0).
                          "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                          "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                          "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                        },
                        "bold": True or False, # Whether the text is bold (equivalent to font_weight is at least `700`).
                        "fontSize": 42, # Font size in points (`1` point is `¹⁄₇₂` inches).
                        "fontType": "A String", # Name or style of the font.
                        "fontWeight": 42, # TrueType weight on a scale `100` (thin) to `1000` (ultra-heavy). Normal is `400`, bold is `700`.
                        "handwritten": True or False, # Whether the text is handwritten.
                        "italic": True or False, # Whether the text is italic.
                        "letterSpacing": 3.14, # Letter spacing in points.
                        "pixelFontSize": 3.14, # Font size in pixels, equal to _unrounded font_size_ * _resolution_ ÷ `72.0`.
                        "smallcaps": True or False, # Whether the text is in small caps. This feature is not supported yet.
                        "strikeout": True or False, # Whether the text is strikethrough. This feature is not supported yet.
                        "subscript": True or False, # Whether the text is a subscript. This feature is not supported yet.
                        "superscript": True or False, # Whether the text is a superscript. This feature is not supported yet.
                        "textColor": { # Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ... # Color of the text.
                          "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0).
                          "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                          "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                          "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                        },
                        "underlined": True or False, # Whether the text is underlined.
                      },
                    },
                  ],
                  "transforms": [ # Transformation matrices that were applied to the original document image to produce Page.image.
                    { # Representation for transformation matrix, intended to be compatible and used with OpenCV format for image manipulation.
                      "cols": 42, # Number of columns in the matrix.
                      "data": "A String", # The matrix data.
                      "rows": 42, # Number of rows in the matrix.
                      "type": 42, # This encodes information about what data type the matrix uses. For example, 0 (CV_8U) is an unsigned 8-bit image. For the full list of OpenCV primitive data types, please refer to https://docs.opencv.org/4.3.0/d1/d1b/group__core__hal__interface.html
                    },
                  ],
                  "visualElements": [ # A list of detected non-text visual elements e.g. checkbox, signature etc. on the page.
                    { # Detected non-text visual elements e.g. checkbox, signature etc. on the page.
                      "detectedLanguages": [ # A list of detected languages together with confidence.
                        { # Detected language for a structural component.
                          "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
                          "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
                        },
                      ],
                      "layout": { # Visual element describing a layout unit on a page. # Layout for VisualElement.
                        "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
                          "normalizedVertices": [ # The bounding polygon normalized vertices.
                            { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
                              "x": 3.14, # X coordinate.
                              "y": 3.14, # Y coordinate (starts from the top of the image).
                            },
                          ],
                          "vertices": [ # The bounding polygon vertices.
                            { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
                              "x": 42, # X coordinate.
                              "y": 42, # Y coordinate (starts from the top of the image).
                            },
                          ],
                        },
                        "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
                        "orientation": "A String", # Detected orientation for the Layout.
                        "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                          "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                          "textSegments": [ # The text segments from the Document.text.
                            { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                              "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                              "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                            },
                          ],
                        },
                      },
                      "type": "A String", # Type of the VisualElement.
                    },
                  ],
                },
              ],
              "revisions": [ # Placeholder. Revision history of this document.
                { # Contains past or forward revisions of this document.
                  "agent": "A String", # If the change was made by a person specify the name or id of that person.
                  "createTime": "A String", # The time that the revision was created, internally generated by doc proto storage at the time of create.
                  "humanReview": { # Human Review information of the document. # Human Review information of this revision.
                    "state": "A String", # Human review state. e.g. `requested`, `succeeded`, `rejected`.
                    "stateMessage": "A String", # A message providing more details about the current state of processing. For example, the rejection reason when the state is `rejected`.
                  },
                  "id": "A String", # Id of the revision, internally generated by doc proto storage. Unique within the context of the document.
                  "parent": [ # The revisions that this revision is based on. This can include one or more parent (when documents are merged.) This field represents the index into the `revisions` field.
                    42,
                  ],
                  "parentIds": [ # The revisions that this revision is based on. Must include all the ids that have anything to do with this revision - eg. there are `provenance.parent.revision` fields that index into this field.
                    "A String",
                  ],
                  "processor": "A String", # If the annotation was made by processor identify the processor by its resource name.
                },
              ],
              "shardInfo": { # For a large document, sharding may be performed to produce several document shards. Each document shard contains this field to detail which shard it is. # Information about the sharding if this document is sharded part of a larger document. If the document is not sharded, this message is not specified.
                "shardCount": "A String", # Total number of shards.
                "shardIndex": "A String", # The 0-based index of this shard.
                "textOffset": "A String", # The index of the first character in Document.text in the overall document global text.
              },
              "text": "A String", # Optional. UTF-8 encoded text in reading order from the document.
              "textChanges": [ # Placeholder. A list of text corrections made to Document.text. This is usually used for annotating corrections to OCR mistakes. Text changes for a given revision may not overlap with each other.
                { # This message is used for text changes aka. OCR corrections.
                  "changedText": "A String", # The text that replaces the text identified in the `text_anchor`.
                  "provenance": [ # The history of this annotation.
                    { # Structure to identify provenance relationships between annotations in different revisions.
                      "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
                      "parents": [ # References to the original elements that are replaced.
                        { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
                          "id": 42, # The id of the parent provenance.
                          "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
                          "revision": 42, # The index of the index into current revision's parent_ids list.
                        },
                      ],
                      "revision": 42, # The index of the revision that produced this element.
                      "type": "A String", # The type of provenance operation.
                    },
                  ],
                  "textAnchor": { # Text reference indexing into the Document.text. # Provenance of the correction. Text anchor indexing into the Document.text. There can only be a single `TextAnchor.text_segments` element. If the start and end index of the text segment are the same, the text change is inserted before that index.
                    "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                    "textSegments": [ # The text segments from the Document.text.
                      { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                        "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                        "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                      },
                    ],
                  },
                },
              ],
              "textStyles": [ # Styles for the Document.text.
                { # Annotation for common text style attributes. This adheres to CSS conventions as much as possible.
                  "backgroundColor": { # Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ... # Text background color.
                    "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0).
                    "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                    "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                    "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                  },
                  "color": { # Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ... # Text color.
                    "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0).
                    "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
                    "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
                    "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
                  },
                  "fontFamily": "A String", # Font family such as `Arial`, `Times New Roman`. https://www.w3schools.com/cssref/pr_font_font-family.asp
                  "fontSize": { # Font size with unit. # Font size.
                    "size": 3.14, # Font size for the text.
                    "unit": "A String", # Unit for the font size. Follows CSS naming (such as `in`, `px`, and `pt`).
                  },
                  "fontWeight": "A String", # [Font weight](https://www.w3schools.com/cssref/pr_font_weight.asp). Possible values are `normal`, `bold`, `bolder`, and `lighter`.
                  "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
                    "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
                    "textSegments": [ # The text segments from the Document.text.
                      { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
                        "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
                        "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
                      },
                    ],
                  },
                  "textDecoration": "A String", # [Text decoration](https://www.w3schools.com/cssref/pr_text_text-decoration.asp). Follows CSS standard.
                  "textStyle": "A String", # [Text style](https://www.w3schools.com/cssref/pr_font_font-style.asp). Possible values are `normal`, `italic`, and `oblique`.
                },
              ],
              "uri": "A String", # Optional. Currently supports Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. For more information, refer to [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-uris).
            },
            "contentCategory": "A String", # Indicates the category (image, audio, video etc.) of the original content.
            "createTime": "A String", # Output only. The time when the document is created.
            "creator": "A String", # The user who creates the document.
            "displayName": "A String", # Required. Display name of the document given by the user. This name will be displayed in the UI. Customer can populate this field with the name of the document. This differs from the 'title' field as 'title' is optional and stores the top heading in the document.
            "displayUri": "A String", # Uri to display the document, for example, in the UI.
            "dispositionTime": "A String", # Output only. If linked to a Collection with RetentionPolicy, the date when the document becomes mutable.
            "documentSchemaName": "A String", # The Document schema name. Format: projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}.
            "inlineRawDocument": "A String", # Raw document content.
            "legalHold": True or False, # Output only. Indicates if the document has a legal hold on it.
            "name": "A String", # The resource name of the document. Format: projects/{project_number}/locations/{location}/documents/{document_id}. The name is ignored when creating a document.
            "plainText": "A String", # Other document format, such as PPTX, XLXS
            "properties": [ # List of values that are user supplied metadata.
              { # Property of a document.
                "dateTimeValues": { # DateTime values. # Date time property values. It is not supported by CMEK compliant deployment.
                  "values": [ # List of datetime values. Both OffsetDateTime and ZonedDateTime are supported.
                    { # Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations.
                      "day": 42, # Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day.
                      "hours": 42, # Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults to 0 (midnight). An API may choose to allow the value "24:00:00" for scenarios like business closing time.
                      "minutes": 42, # Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.
                      "month": 42, # Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month.
                      "nanos": 42, # Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0.
                      "seconds": 42, # Optional. Seconds of minutes of the time. Must normally be from 0 to 59, defaults to 0. An API may allow the value 60 if it allows leap-seconds.
                      "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Time zone.
                        "id": "A String", # IANA Time Zone Database time zone. For example "America/New_York".
                        "version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a".
                      },
                      "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.
                      "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.
                    },
                  ],
                },
                "enumValues": { # Enum values. # Enum property values.
                  "values": [ # List of enum values.
                    "A String",
                  ],
                },
                "floatValues": { # Float values. # Float property values.
                  "values": [ # List of float values.
                    3.14,
                  ],
                },
                "integerValues": { # Integer values. # Integer property values.
                  "values": [ # List of integer values.
                    42,
                  ],
                },
                "mapProperty": { # Map property value. Represents a structured entries of key value pairs, consisting of field names which map to dynamically typed values. # Map property values.
                  "fields": { # Unordered map of dynamically typed values.
                    "a_key": { # `Value` represents a dynamically typed value which can be either be a float, a integer, a string, or a datetime value. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.
                      "booleanValue": True or False, # Represents a boolean value.
                      "datetimeValue": { # Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations. # Represents a datetime value.
                        "day": 42, # Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day.
                        "hours": 42, # Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults to 0 (midnight). An API may choose to allow the value "24:00:00" for scenarios like business closing time.
                        "minutes": 42, # Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.
                        "month": 42, # Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month.
                        "nanos": 42, # Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0.
                        "seconds": 42, # Optional. Seconds of minutes of the time. Must normally be from 0 to 59, defaults to 0. An API may allow the value 60 if it allows leap-seconds.
                        "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Time zone.
                          "id": "A String", # IANA Time Zone Database time zone. For example "America/New_York".
                          "version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a".
                        },
                        "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.
                        "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.
                      },
                      "enumValue": { # Represents the string value of the enum field. # Represents an enum value.
                        "value": "A String", # String value of the enum field. This must match defined set of enums in document schema using EnumTypeOptions.
                      },
                      "floatValue": 3.14, # Represents a float value.
                      "intValue": 42, # Represents a integer value.
                      "stringValue": "A String", # Represents a string value.
                      "timestampValue": { # Timestamp value type. # Represents a timestamp value.
                        "textValue": "A String", # The string must represent a valid instant in UTC and is parsed using java.time.format.DateTimeFormatter.ISO_INSTANT. e.g. "2013-09-29T18:46:19Z"
                        "timestampValue": "A String", # Timestamp value
                      },
                    },
                  },
                },
                "name": "A String", # Required. Must match the name of a PropertyDefinition in the DocumentSchema.
                "propertyValues": { # Property values. # Nested structured data property values.
                  "properties": [ # List of property values.
                    # Object with schema name: GoogleCloudContentwarehouseV1Property
                  ],
                },
                "textValues": { # String/text values. # String/text property values.
                  "values": [ # List of text values.
                    "A String",
                  ],
                },
                "timestampValues": { # Timestamp values. # Timestamp property values. It is not supported by CMEK compliant deployment.
                  "values": [ # List of timestamp values.
                    { # Timestamp value type.
                      "textValue": "A String", # The string must represent a valid instant in UTC and is parsed using java.time.format.DateTimeFormatter.ISO_INSTANT. e.g. "2013-09-29T18:46:19Z"
                      "timestampValue": "A String", # Timestamp value
                    },
                  ],
                },
              },
            ],
            "rawDocumentFileType": "A String", # This is used when DocAI was not used to load the document and parsing/ extracting is needed for the inline_raw_document. For example, if inline_raw_document is the byte representation of a PDF file, then this should be set to: RAW_DOCUMENT_FILE_TYPE_PDF.
            "rawDocumentPath": "A String", # Raw document file in Cloud Storage path.
            "referenceId": "A String", # The reference ID set by customers. Must be unique per project and location.
            "textExtractionDisabled": True or False, # If true, text extraction will not be performed.
            "textExtractionEnabled": True or False, # If true, text extraction will be performed.
            "title": "A String", # Title that describes the document. This can be the top heading or text that describes the document.
            "updateTime": "A String", # Output only. The time when the document is last updated.
            "updater": "A String", # The user who lastly updates the document.
          },
          "matchedTokenPageIndices": [ # Return the 1-based page indices where those pages have one or more matched tokens.
            "A String",
          ],
          "qaResult": { # Additional result info for the question-answering feature. # Experimental. Additional result info if the question-answering feature is enabled.
            "confidenceScore": 3.14, # The calibrated confidence score for this document, in the range [0., 1.]. This represents the confidence level for whether the returned document and snippet answers the user's query.
            "highlights": [ # Highlighted sections in the snippet.
              { # A text span in the search text snippet that represents a highlighted section (answer context, highly relevant sentence, etc.).
                "endIndex": 42, # End index of the highlight, exclusive.
                "startIndex": 42, # Start index of the highlight.
              },
            ],
          },
          "searchTextSnippet": "A String", # Contains snippets of text from the document full raw text that most closely match a search query's keywords, if available. All HTML tags in the original fields are stripped when returned in this field, and matching query keywords are enclosed in HTML bold tags. If the question-answering feature is enabled, this field will instead contain a snippet that answers the user's natural-language query. No HTML bold tags will be present, and highlights in the answer snippet can be found in QAResult.highlights.
        },
      ],
      "metadata": { # Additional information returned to client, such as debugging information. # Additional information for the API invocation, such as the request tracking id.
        "requestId": "A String", # A unique id associated with this call. This id is logged for tracking purpose.
      },
      "nextPageToken": "A String", # The token that specifies the starting position of the next page of results. This field is empty if there are no more results.
      "questionAnswer": "A String", # Experimental. Question answer from the query against the document.
      "totalSize": 42, # The total number of matched documents which is available only if the client set SearchDocumentsRequest.require_total_size to `true` or set SearchDocumentsRequest.total_result_size to `ESTIMATED_SIZE` or `ACTUAL_SIZE`. Otherwise, the value will be `-1`. Typically a UI would handle this condition by displaying "of many", for example: "Displaying 10 of many".
    }

`search_next()`

    Retrieves the next page of results.

            Args:
              previous_request: The request for the previous page. (required)
              previous_response: The response from the request for the previous page. (required)

            Returns:
              A request object that you can call 'execute()' on to request the next
              page. Returns None if there are no more items in the collection.

`setAcl(resource, body=None, x__xgafv=None)`

    Sets the access control policy for a resource. Replaces any existing policy.

    Args:
      resource: string, Required. REQUIRED: The resource for which the policy is being requested. Format for document: projects/{project_number}/locations/{location}/documents/{document_id}. Format for collection: projects/{project_number}/locations/{location}/collections/{collection_id}. Format for project: projects/{project_number}. (required)
      body: object, The request body.
        The object takes the form of:

    { # Request message for DocumentService.SetAcl.
      "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # Required. REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. This refers to an Identity and Access (IAM) policy, which specifies access controls for the Document. You can set ACL with condition for projects only. Supported operators are: `=`, `!=`, `<`, `<=`, `>`, and `>=` where the left of the operator is `DocumentSchemaId` or property name and the right of the operator is a number or a quoted string. You must escape backslash (\\) and quote (\") characters. Boolean expressions (AND/OR) are supported up to 3 levels of nesting (for example, "((A AND B AND C) OR D) AND E"), a maximum of 10 comparisons are allowed in the expression. The expression must be < 6000 bytes in length. Sample condition: `"DocumentSchemaId = \"some schema id\" OR SchemaId.floatPropertyName >= 10"`
        "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
          { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
            "auditLogConfigs": [ # The configuration for logging of each type of permission.
              { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
                "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
                  "A String",
                ],
                "logType": "A String", # The log type that this config enables.
              },
            ],
            "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
          },
        ],
        "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
          { # Associates `members`, or principals, with a `role`.
            "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
              "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
              "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
              "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
              "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
            },
            "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
              "A String",
            ],
            "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
          },
        ],
        "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
        "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
      },
      "projectOwner": True or False, # For Set Project ACL only. Authorization check for end user will be ignored when project_owner=true.
      "requestMetadata": { # Meta information is used to improve the performance of the service. # The meta information collected about the end user, used to enforce access control for the service.
        "userInfo": { # The user information. # Provides user unique identification and groups information.
          "groupIds": [ # The unique group identifications which the user is belong to. The format is "group:yyyy@example.com";
            "A String",
          ],
          "id": "A String", # A unique user identification string, as determined by the client. The maximum number of allowed characters is 255. Allowed characters include numbers 0 to 9, uppercase and lowercase letters, and restricted special symbols (:, @, +, -, _, ~) The format is "user:xxxx@example.com";
        },
      },
    }

      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # Response message for DocumentService.SetAcl.
      "metadata": { # Additional information returned to client, such as debugging information. # Additional information for the API invocation, such as the request tracking id.
        "requestId": "A String", # A unique id associated with this call. This id is logged for tracking purpose.
      },
      "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # The policy will be attached to a resource (e.g. projecct, document).
        "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
          { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.
            "auditLogConfigs": [ # The configuration for logging of each type of permission.
              { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
                "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
                  "A String",
                ],
                "logType": "A String", # The log type that this config enables.
              },
            ],
            "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
          },
        ],
        "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
          { # Associates `members`, or principals, with a `role`.
            "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
              "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
              "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
              "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
              "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
            },
            "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
              "A String",
            ],
            "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
          },
        ],
        "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
        "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
      },
    }