--- title: "POST /v1/{+parent}/documents" method: POST path: "/v1/{+parent}/documents" tags: ["projects"] --- # POST /v1/{+parent}/documents `POST /v1/{+parent}/documents` Creates a document. ## Path parameters - `parent` string, required ## Request body - GoogleCloudContentwarehouseV1CreateDocumentRequest — Request message for DocumentService.CreateDocument. - `requestMetadata` GoogleCloudContentwarehouseV1RequestMetadata — Meta information is used to improve the performance of the service. - `userInfo` GoogleCloudContentwarehouseV1UserInfo — The user information. - `id` 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"; - `groupIds` string[] — The unique group identifications which the user is belong to. The format is "group:yyyy@example.com"; - `cloudAiDocumentOption` GoogleCloudContentwarehouseV1CloudAIDocumentOption — Request Option for processing Cloud AI Document in CW Document. - `customizedEntitiesPropertiesConversions` object — If set, only selected entities will be converted to properties. - `enableEntitiesConversions` boolean — Whether to convert all the entities to properties. - `createMask` string, google-fieldmask — 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` GoogleCloudContentwarehouseV1Document — Defines the structure for content warehouse document proto. - `rawDocumentFileType` 'RAW_DOCUMENT_FILE_TYPE_UNSPECIFIED' | 'RAW_DOCUMENT_FILE_TYPE_PDF' | 'RAW_DOCUMENT_FILE_TYPE_DOCX' | 'RAW_DOCUMENT_FILE_TYPE_XLSX' | 'RAW_DOCUMENT_FILE_TYPE_PPTX' | 'RAW_DOCUMENT_FILE_TYPE_TEXT' | 'RAW_DOCUMENT_FILE_TYPE_TIFF' — 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. - `dispositionTime` string, google-datetime — Output only. If linked to a Collection with RetentionPolicy, the date when the document becomes mutable. - `updater` string — The user who lastly updates the document. - `textExtractionDisabled` boolean — If true, text extraction will not be performed. - `contentCategory` 'CONTENT_CATEGORY_UNSPECIFIED' | 'CONTENT_CATEGORY_IMAGE' | 'CONTENT_CATEGORY_AUDIO' | 'CONTENT_CATEGORY_VIDEO' — Indicates the category (image, audio, video etc.) of the original content. - `inlineRawDocument` string, byte — Raw document content. - `creator` string — The user who creates the document. - `name` string — The resource name of the document. Format: projects/{project_number}/locations/{location}/documents/{document_id}. The name is ignored when creating a document. - `referenceId` string — The reference ID set by customers. Must be unique per project and location. - `legalHold` boolean — Output only. Indicates if the document has a legal hold on it. - `createTime` string, google-datetime — Output only. The time when the document is created. - `updateTime` string, google-datetime — Output only. The time when the document is last updated. - `textExtractionEnabled` boolean — If true, text extraction will be performed. - `cloudAiDocument` GoogleCloudDocumentaiV1Document — 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. - `entities` GoogleCloudDocumentaiV1DocumentEntity[] — A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries. - `type` string — Required. Entity type from a schema e.g. `Address`. - `mentionId` string — Optional. Deprecated. Use `id` field instead. - `properties` GoogleCloudDocumentaiV1DocumentEntity[] — Optional. Entities can be nested to form a hierarchical data structure representing the content in the document. - `redacted` boolean — Optional. Whether the entity will be redacted for de-identification purposes. - `normalizedValue` GoogleCloudDocumentaiV1DocumentEntityNormalizedValue — Parsed and normalized entity value. - `datetimeValue` GoogleTypeDateTime — 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. - `minutes` integer — Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0. - `utcOffset` string, google-duration — 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 }. - `day` integer — 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. - `nanos` integer — Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0. - `timeZone` GoogleTypeTimeZone — Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). - … - `year` integer — Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year. - `seconds` integer — 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. - `month` integer — Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month. - `hours` integer — 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. - `dateValue` GoogleTypeDate — 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 - `month` integer — Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. - `year` integer — Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. - `day` integer — 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. - `text` 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. - `floatValue` number, float — Float value. - `booleanValue` boolean — Boolean value. Can be used for entities with binary values, or for checkboxes. - `addressValue` GoogleTypePostalAddress — 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 - `sublocality` string — Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts. - `revision` integer — 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. - `postalCode` 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.). - `sortingCode` 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). - `organization` string — Optional. The name of the organization at the address. - `administrativeArea` 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. - `locality` 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. - `recipients` string[] — Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information. - `languageCode` 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". - `addressLines` string[] — 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). - `regionCode` 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. - `integerValue` integer — Integer value. - `moneyValue` GoogleTypeMoney — Represents an amount of money with its currency type. - `units` string, int64 — The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. - `currencyCode` string — The three-letter currency code defined in ISO 4217. - `nanos` integer — 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. - `confidence` number, float — Optional. Confidence of detected Schema entity. Range `[0, 1]`. - `id` string — Optional. Canonical id. This will be a unique value in the entity list for this document. - `provenance` GoogleCloudDocumentaiV1DocumentProvenance — Structure to identify provenance relationships between annotations in different revisions. - `parents` GoogleCloudDocumentaiV1DocumentProvenanceParent[] — References to the original elements that are replaced. - `index` integer — The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. - `id` integer — The id of the parent provenance. - `revision` integer — The index of the index into current revision's parent_ids list. - `revision` integer — The index of the revision that produced this element. - `id` integer — The Id of this operation. Needs to be unique within the scope of the revision. - `type` 'OPERATION_TYPE_UNSPECIFIED' | 'ADD' | 'REMOVE' | 'UPDATE' | 'REPLACE' | 'EVAL_REQUESTED' | 'EVAL_APPROVED' | 'EVAL_SKIPPED' — The type of provenance operation. - `textAnchor` GoogleCloudDocumentaiV1DocumentTextAnchor — Text reference indexing into the Document.text. - `textSegments` GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment[] — The text segments from the Document.text. - `startIndex` string, int64 — TextSegment start UTF-8 char index in the Document.text. - `endIndex` string, int64 — TextSegment half open end UTF-8 char index in the Document.text. - `content` 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. - `mentionText` string — Optional. Text value of the entity e.g. `1600 Amphitheatre Pkwy`. - `pageAnchor` GoogleCloudDocumentaiV1DocumentPageAnchor — 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. - `pageRefs` GoogleCloudDocumentaiV1DocumentPageAnchorPageRef[] — One or more references to visual page elements - `confidence` number, float — Optional. Confidence of detected page element, if applicable. Range `[0, 1]`. - `layoutId` string — Optional. Deprecated. Use PageRef.bounding_poly instead. - `layoutType` 'LAYOUT_TYPE_UNSPECIFIED' | 'BLOCK' | 'PARAGRAPH' | 'LINE' | 'TOKEN' | 'VISUAL_ELEMENT' | 'TABLE' | 'FORM_FIELD' — Optional. The type of the layout element that is being referenced if any. - `page` string, int64 — 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. - `boundingPoly` GoogleCloudDocumentaiV1BoundingPoly — A bounding polygon for the detected image annotation. - … - `textChanges` GoogleCloudDocumentaiV1DocumentTextChange[] — 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. - `changedText` string — The text that replaces the text identified in the `text_anchor`. - `textAnchor` GoogleCloudDocumentaiV1DocumentTextAnchor — Text reference indexing into the Document.text. - `textSegments` GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment[] — The text segments from the Document.text. - `startIndex` string, int64 — TextSegment start UTF-8 char index in the Document.text. - `endIndex` string, int64 — TextSegment half open end UTF-8 char index in the Document.text. - `content` 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. - `provenance` GoogleCloudDocumentaiV1DocumentProvenance[] — The history of this annotation. - `parents` GoogleCloudDocumentaiV1DocumentProvenanceParent[] — References to the original elements that are replaced. - `index` integer — The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. - `id` integer — The id of the parent provenance. - `revision` integer — The index of the index into current revision's parent_ids list. - `revision` integer — The index of the revision that produced this element. - `id` integer — The Id of this operation. Needs to be unique within the scope of the revision. - `type` 'OPERATION_TYPE_UNSPECIFIED' | 'ADD' | 'REMOVE' | 'UPDATE' | 'REPLACE' | 'EVAL_REQUESTED' | 'EVAL_APPROVED' | 'EVAL_SKIPPED' — The type of provenance operation. - `content` string, byte — 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. - `mimeType` string — An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml). - `error` GoogleRpcStatus — 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). - `details` object[] — A list of messages that carry the error details. There is a common set of message types for APIs to use. - `code` integer — The status code, which should be an enum value of google.rpc.Code. - `message` 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. - `entityRelations` GoogleCloudDocumentaiV1DocumentEntityRelation[] — Placeholder. Relationship among Document.entities. - `subjectId` string — Subject entity id. - `objectId` string — Object entity id. - `relation` string — Relationship description. - `revisions` GoogleCloudDocumentaiV1DocumentRevision[] — Placeholder. Revision history of this document. - `processor` string — If the annotation was made by processor identify the processor by its resource name. - `id` string — Id of the revision, internally generated by doc proto storage. Unique within the context of the document. - `parent` integer[] — 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. - `parentIds` string[] — 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. - `createTime` string, google-datetime — The time that the revision was created, internally generated by doc proto storage at the time of create. - `agent` string — If the change was made by a person specify the name or id of that person. - `humanReview` GoogleCloudDocumentaiV1DocumentRevisionHumanReview — Human Review information of the document. - `stateMessage` string — A message providing more details about the current state of processing. For example, the rejection reason when the state is `rejected`. - `state` string — Human review state. e.g. `requested`, `succeeded`, `rejected`. - `textStyles` GoogleCloudDocumentaiV1DocumentStyle[] — Styles for the Document.text. - `fontSize` GoogleCloudDocumentaiV1DocumentStyleFontSize — Font size with unit. - `size` number, float — Font size for the text. - `unit` string — Unit for the font size. Follows CSS naming (such as `in`, `px`, and `pt`). - `backgroundColor` GoogleTypeColor — 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(''); }; // ... - `blue` number, float — The amount of blue in the color as a value in the interval [0, 1]. - `green` number, float — The amount of green in the color as a value in the interval [0, 1]. - `red` number, float — The amount of red in the color as a value in the interval [0, 1]. - `alpha` number, float — 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). - `textStyle` string — [Text style](https://www.w3schools.com/cssref/pr_font_font-style.asp). Possible values are `normal`, `italic`, and `oblique`. - `fontFamily` string — Font family such as `Arial`, `Times New Roman`. https://www.w3schools.com/cssref/pr_font_font-family.asp - `fontWeight` string — [Font weight](https://www.w3schools.com/cssref/pr_font_weight.asp). Possible values are `normal`, `bold`, `bolder`, and `lighter`. - `color` GoogleTypeColor — 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(''); }; // ... - `blue` number, float — The amount of blue in the color as a value in the interval [0, 1]. - `green` number, float — The amount of green in the color as a value in the interval [0, 1]. - `red` number, float — The amount of red in the color as a value in the interval [0, 1]. - `alpha` number, float — 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). - `textDecoration` string — [Text decoration](https://www.w3schools.com/cssref/pr_text_text-decoration.asp). Follows CSS standard. - `textAnchor` GoogleCloudDocumentaiV1DocumentTextAnchor — Text reference indexing into the Document.text. - `textSegments` GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment[] — The text segments from the Document.text. - `startIndex` string, int64 — TextSegment start UTF-8 char index in the Document.text. - `endIndex` string, int64 — TextSegment half open end UTF-8 char index in the Document.text. - `content` 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. - `chunkedDocument` GoogleCloudDocumentaiV1DocumentChunkedDocument — Represents the chunks that the document is divided into. - `chunks` GoogleCloudDocumentaiV1DocumentChunkedDocumentChunk[] — List of chunks. - `pageSpan` GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan — Represents where the chunk starts and ends in the document. - `pageStart` integer — Page where chunk starts in the document. - `pageEnd` integer — Page where chunk ends in the document. - `content` string — Text content of the chunk. - `sourceBlockIds` string[] — Unused. - `chunkId` string — ID of the chunk. - `pageHeaders` GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageHeader[] — Page headers associated with the chunk. - `text` string — Header in text format. - `pageSpan` GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan — Represents where the chunk starts and ends in the document. - … - `pageFooters` GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageFooter[] — Page footers associated with the chunk. - `pageSpan` GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan — Represents where the chunk starts and ends in the document. - … - `text` string — Footer in text format. - `text` string — Optional. UTF-8 encoded text in reading order from the document. - `pages` GoogleCloudDocumentaiV1DocumentPage[] — Visual page layout for the Document. - `paragraphs` GoogleCloudDocumentaiV1DocumentPageParagraph[] — A list of visually detected text paragraphs on the page. A collection of lines that a human would perceive as a paragraph. - `provenance` GoogleCloudDocumentaiV1DocumentProvenance — Structure to identify provenance relationships between annotations in different revisions. - `parents` GoogleCloudDocumentaiV1DocumentProvenanceParent[] — References to the original elements that are replaced. - … - `revision` integer — The index of the revision that produced this element. - `id` integer — The Id of this operation. Needs to be unique within the scope of the revision. - `type` 'OPERATION_TYPE_UNSPECIFIED' | 'ADD' | 'REMOVE' | 'UPDATE' | 'REPLACE' | 'EVAL_REQUESTED' | 'EVAL_APPROVED' | 'EVAL_SKIPPED' — The type of provenance operation. - `layout` GoogleCloudDocumentaiV1DocumentPageLayout — Visual element describing a layout unit on a page. - `orientation` 'ORIENTATION_UNSPECIFIED' | 'PAGE_UP' | 'PAGE_RIGHT' | 'PAGE_DOWN' | 'PAGE_LEFT' — Detected orientation for the Layout. - `confidence` number, float — 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]`. - `boundingPoly` GoogleCloudDocumentaiV1BoundingPoly — A bounding polygon for the detected image annotation. - … - `textAnchor` GoogleCloudDocumentaiV1DocumentTextAnchor — Text reference indexing into the Document.text. - … - `detectedLanguages` GoogleCloudDocumentaiV1DocumentPageDetectedLanguage[] — A list of detected languages together with confidence. - `languageCode` string — The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`. - `confidence` number, float — Confidence of detected language. Range `[0, 1]`. - `tokens` GoogleCloudDocumentaiV1DocumentPageToken[] — A list of visually detected tokens on the page. - `provenance` GoogleCloudDocumentaiV1DocumentProvenance — Structure to identify provenance relationships between annotations in different revisions. - `parents` GoogleCloudDocumentaiV1DocumentProvenanceParent[] — References to the original elements that are replaced. - … - `revision` integer — The index of the revision that produced this element. - `id` integer — The Id of this operation. Needs to be unique within the scope of the revision. - `type` 'OPERATION_TYPE_UNSPECIFIED' | 'ADD' | 'REMOVE' | 'UPDATE' | 'REPLACE' | 'EVAL_REQUESTED' | 'EVAL_APPROVED' | 'EVAL_SKIPPED' — The type of provenance operation. - `styleInfo` GoogleCloudDocumentaiV1DocumentPageTokenStyleInfo — Font and other text style attributes. - `fontType` string — Name or style of the font. - `fontSize` integer — Font size in points (`1` point is `¹⁄₇₂` inches). - `superscript` boolean — Whether the text is a superscript. This feature is not supported yet. - `backgroundColor` GoogleTypeColor — 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(''); }; // ... - … - `smallcaps` boolean — Whether the text is in small caps. This feature is not supported yet. - `fontWeight` integer — TrueType weight on a scale `100` (thin) to `1000` (ultra-heavy). Normal is `400`, bold is `700`. - `bold` boolean — Whether the text is bold (equivalent to font_weight is at least `700`). - `textColor` GoogleTypeColor — 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(''); }; // ... - … - `subscript` boolean — Whether the text is a subscript. This feature is not supported yet. - `underlined` boolean — Whether the text is underlined. - `strikeout` boolean — Whether the text is strikethrough. This feature is not supported yet. - `letterSpacing` number, double — Letter spacing in points. - `handwritten` boolean — Whether the text is handwritten. - `italic` boolean — Whether the text is italic. - `pixelFontSize` number, double — Font size in pixels, equal to _unrounded font_size_ * _resolution_ ÷ `72.0`. - `layout` GoogleCloudDocumentaiV1DocumentPageLayout — Visual element describing a layout unit on a page. - `orientation` 'ORIENTATION_UNSPECIFIED' | 'PAGE_UP' | 'PAGE_RIGHT' | 'PAGE_DOWN' | 'PAGE_LEFT' — Detected orientation for the Layout. - `confidence` number, float — 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]`. - `boundingPoly` GoogleCloudDocumentaiV1BoundingPoly — A bounding polygon for the detected image annotation. - … - `textAnchor` GoogleCloudDocumentaiV1DocumentTextAnchor — Text reference indexing into the Document.text. - … - `detectedLanguages` GoogleCloudDocumentaiV1DocumentPageDetectedLanguage[] — A list of detected languages together with confidence. - `languageCode` string — The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`. - `confidence` number, float — Confidence of detected language. Range `[0, 1]`. - `detectedBreak` GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreak — Detected break at the end of a Token. - `type` 'TYPE_UNSPECIFIED' | 'SPACE' | 'WIDE_SPACE' | 'HYPHEN' — Detected break type. - `formFields` GoogleCloudDocumentaiV1DocumentPageFormField[] — A list of visually detected form fields on the page. - `fieldValue` GoogleCloudDocumentaiV1DocumentPageLayout — Visual element describing a layout unit on a page. - `orientation` 'ORIENTATION_UNSPECIFIED' | 'PAGE_UP' | 'PAGE_RIGHT' | 'PAGE_DOWN' | 'PAGE_LEFT' — Detected orientation for the Layout. - `confidence` number, float — 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]`. - `boundingPoly` GoogleCloudDocumentaiV1BoundingPoly — A bounding polygon for the detected image annotation. - … - `textAnchor` GoogleCloudDocumentaiV1DocumentTextAnchor — Text reference indexing into the Document.text. - … - `fieldName` GoogleCloudDocumentaiV1DocumentPageLayout — Visual element describing a layout unit on a page. - `orientation` 'ORIENTATION_UNSPECIFIED' | 'PAGE_UP' | 'PAGE_RIGHT' | 'PAGE_DOWN' | 'PAGE_LEFT' — Detected orientation for the Layout. - `confidence` number, float — 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]`. - `boundingPoly` GoogleCloudDocumentaiV1BoundingPoly — A bounding polygon for the detected image annotation. - … - `textAnchor` GoogleCloudDocumentaiV1DocumentTextAnchor — Text reference indexing into the Document.text. - … - `correctedKeyText` 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. - `nameDetectedLanguages` GoogleCloudDocumentaiV1DocumentPageDetectedLanguage[] — A list of detected languages for name together with confidence. - `languageCode` string — The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`. - `confidence` number, float — Confidence of detected language. Range `[0, 1]`. - `valueType` 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` - `correctedValueText` 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. - `valueDetectedLanguages` GoogleCloudDocumentaiV1DocumentPageDetectedLanguage[] — A list of detected languages for value together with confidence. - `languageCode` string — The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`. - `confidence` number, float — Confidence of detected language. Range `[0, 1]`. - `provenance` GoogleCloudDocumentaiV1DocumentProvenance — Structure to identify provenance relationships between annotations in different revisions. - `parents` GoogleCloudDocumentaiV1DocumentProvenanceParent[] — References to the original elements that are replaced. - … - `revision` integer — The index of the revision that produced this element. - `id` integer — The Id of this operation. Needs to be unique within the scope of the revision. - `type` 'OPERATION_TYPE_UNSPECIFIED' | 'ADD' | 'REMOVE' | 'UPDATE' | 'REPLACE' | 'EVAL_REQUESTED' | 'EVAL_APPROVED' | 'EVAL_SKIPPED' — The type of provenance operation. - `blocks` GoogleCloudDocumentaiV1DocumentPageBlock[] — 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. - `layout` GoogleCloudDocumentaiV1DocumentPageLayout — Visual element describing a layout unit on a page. - `orientation` 'ORIENTATION_UNSPECIFIED' | 'PAGE_UP' | 'PAGE_RIGHT' | 'PAGE_DOWN' | 'PAGE_LEFT' — Detected orientation for the Layout. - `confidence` number, float — 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]`. - `boundingPoly` GoogleCloudDocumentaiV1BoundingPoly — A bounding polygon for the detected image annotation. - … - `textAnchor` GoogleCloudDocumentaiV1DocumentTextAnchor — Text reference indexing into the Document.text. - … - `detectedLanguages` GoogleCloudDocumentaiV1DocumentPageDetectedLanguage[] — A list of detected languages together with confidence. - `languageCode` string — The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`. - `confidence` number, float — Confidence of detected language. Range `[0, 1]`. - `provenance` GoogleCloudDocumentaiV1DocumentProvenance — Structure to identify provenance relationships between annotations in different revisions. - `parents` GoogleCloudDocumentaiV1DocumentProvenanceParent[] — References to the original elements that are replaced. - … - `revision` integer — The index of the revision that produced this element. - `id` integer — The Id of this operation. Needs to be unique within the scope of the revision. - `type` 'OPERATION_TYPE_UNSPECIFIED' | 'ADD' | 'REMOVE' | 'UPDATE' | 'REPLACE' | 'EVAL_REQUESTED' | 'EVAL_APPROVED' | 'EVAL_SKIPPED' — The type of provenance operation. - `provenance` GoogleCloudDocumentaiV1DocumentProvenance — Structure to identify provenance relationships between annotations in different revisions. - `parents` GoogleCloudDocumentaiV1DocumentProvenanceParent[] — References to the original elements that are replaced. - `index` integer — The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. - `id` integer — The id of the parent provenance. - `revision` integer — The index of the index into current revision's parent_ids list. - `revision` integer — The index of the revision that produced this element. - `id` integer — The Id of this operation. Needs to be unique within the scope of the revision. - `type` 'OPERATION_TYPE_UNSPECIFIED' | 'ADD' | 'REMOVE' | 'UPDATE' | 'REPLACE' | 'EVAL_REQUESTED' | 'EVAL_APPROVED' | 'EVAL_SKIPPED' — The type of provenance operation. - `image` GoogleCloudDocumentaiV1DocumentPageImage — Rendered image contents for this page. - `width` integer — Width of the image in pixels. - `height` integer — Height of the image in pixels. - `mimeType` string — Encoding [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml) for the image. - `content` string, byte — Raw byte content of the image. - `symbols` GoogleCloudDocumentaiV1DocumentPageSymbol[] — A list of visually detected symbols on the page. - `layout` GoogleCloudDocumentaiV1DocumentPageLayout — Visual element describing a layout unit on a page. - `orientation` 'ORIENTATION_UNSPECIFIED' | 'PAGE_UP' | 'PAGE_RIGHT' | 'PAGE_DOWN' | 'PAGE_LEFT' — Detected orientation for the Layout. - `confidence` number, float — 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]`. - `boundingPoly` GoogleCloudDocumentaiV1BoundingPoly — A bounding polygon for the detected image annotation. - … - `textAnchor` GoogleCloudDocumentaiV1DocumentTextAnchor — Text reference indexing into the Document.text. - … - `detectedLanguages` GoogleCloudDocumentaiV1DocumentPageDetectedLanguage[] — A list of detected languages together with confidence. - `languageCode` string — The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`. - `confidence` number, float — Confidence of detected language. Range `[0, 1]`. - `tables` GoogleCloudDocumentaiV1DocumentPageTable[] — A list of visually detected tables on the page. - `provenance` GoogleCloudDocumentaiV1DocumentProvenance — Structure to identify provenance relationships between annotations in different revisions. - `parents` GoogleCloudDocumentaiV1DocumentProvenanceParent[] — References to the original elements that are replaced. - … - `revision` integer — The index of the revision that produced this element. - `id` integer — The Id of this operation. Needs to be unique within the scope of the revision. - `type` 'OPERATION_TYPE_UNSPECIFIED' | 'ADD' | 'REMOVE' | 'UPDATE' | 'REPLACE' | 'EVAL_REQUESTED' | 'EVAL_APPROVED' | 'EVAL_SKIPPED' — The type of provenance operation. - `headerRows` GoogleCloudDocumentaiV1DocumentPageTableTableRow[] — Header rows of the table. - `cells` GoogleCloudDocumentaiV1DocumentPageTableTableCell[] — Cells that make up this row. - … - `detectedLanguages` GoogleCloudDocumentaiV1DocumentPageDetectedLanguage[] — A list of detected languages together with confidence. - `languageCode` string — The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`. - `confidence` number, float — Confidence of detected language. Range `[0, 1]`. - `bodyRows` GoogleCloudDocumentaiV1DocumentPageTableTableRow[] — Body rows of the table. - `cells` GoogleCloudDocumentaiV1DocumentPageTableTableCell[] — Cells that make up this row. - … - `layout` GoogleCloudDocumentaiV1DocumentPageLayout — Visual element describing a layout unit on a page. - `orientation` 'ORIENTATION_UNSPECIFIED' | 'PAGE_UP' | 'PAGE_RIGHT' | 'PAGE_DOWN' | 'PAGE_LEFT' — Detected orientation for the Layout. - `confidence` number, float — 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]`. - `boundingPoly` GoogleCloudDocumentaiV1BoundingPoly — A bounding polygon for the detected image annotation. - … - `textAnchor` GoogleCloudDocumentaiV1DocumentTextAnchor — Text reference indexing into the Document.text. - … - `detectedBarcodes` GoogleCloudDocumentaiV1DocumentPageDetectedBarcode[] — A list of detected barcodes. - `barcode` GoogleCloudDocumentaiV1Barcode — Encodes the detailed information of a barcode. - `valueFormat` 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. - `rawValue` string — Raw value encoded in the barcode. For example: `'MEBKM:TITLE:Google;URL:https://www.google.com;;'`. - `format` string — Format of a barcode. The supported formats are: - `CODE_128`: Code 128 type. - `CODE_39`: Code 39 type. - `CODE_93`: Code 93 type. - `CODABAR`: Codabar type. - `DATA_MATRIX`: 2D Data Matrix type. - `ITF`: ITF type. - `EAN_13`: EAN-13 type. - `EAN_8`: EAN-8 type. - `QR_CODE`: 2D QR code type. - `UPC_A`: UPC-A type. - `UPC_E`: UPC-E type. - `PDF417`: PDF417 type. - `AZTEC`: 2D Aztec code type. - `DATABAR`: GS1 DataBar code type. - `layout` GoogleCloudDocumentaiV1DocumentPageLayout — Visual element describing a layout unit on a page. - `orientation` 'ORIENTATION_UNSPECIFIED' | 'PAGE_UP' | 'PAGE_RIGHT' | 'PAGE_DOWN' | 'PAGE_LEFT' — Detected orientation for the Layout. - `confidence` number, float — 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]`. - `boundingPoly` GoogleCloudDocumentaiV1BoundingPoly — A bounding polygon for the detected image annotation. - … - `textAnchor` GoogleCloudDocumentaiV1DocumentTextAnchor — Text reference indexing into the Document.text. - … - `dimension` GoogleCloudDocumentaiV1DocumentPageDimension — Dimension for the page. - `unit` string — Dimension unit. - `width` number, float — Page width. - `height` number, float — Page height. - `imageQualityScores` GoogleCloudDocumentaiV1DocumentPageImageQualityScores — Image quality scores for the page image. - `detectedDefects` GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefect[] — A list of detected defects. - `type` 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` - `confidence` number, float — Confidence of detected defect. Range `[0, 1]` where `1` indicates strong confidence that the defect exists. - `qualityScore` number, float — The overall quality score. Range `[0, 1]` where `1` is perfect quality. - `transforms` GoogleCloudDocumentaiV1DocumentPageMatrix[] — Transformation matrices that were applied to the original document image to produce Page.image. - `cols` integer — Number of columns in the matrix. - `data` string, byte — The matrix data. - `rows` integer — Number of rows in the matrix. - `type` integer — 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 - `lines` GoogleCloudDocumentaiV1DocumentPageLine[] — A list of visually detected text lines on the page. A collection of tokens that a human would perceive as a line. - `detectedLanguages` GoogleCloudDocumentaiV1DocumentPageDetectedLanguage[] — A list of detected languages together with confidence. - `languageCode` string — The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`. - `confidence` number, float — Confidence of detected language. Range `[0, 1]`. - `provenance` GoogleCloudDocumentaiV1DocumentProvenance — Structure to identify provenance relationships between annotations in different revisions. - `parents` GoogleCloudDocumentaiV1DocumentProvenanceParent[] — References to the original elements that are replaced. - … - `revision` integer — The index of the revision that produced this element. - `id` integer — The Id of this operation. Needs to be unique within the scope of the revision. - `type` 'OPERATION_TYPE_UNSPECIFIED' | 'ADD' | 'REMOVE' | 'UPDATE' | 'REPLACE' | 'EVAL_REQUESTED' | 'EVAL_APPROVED' | 'EVAL_SKIPPED' — The type of provenance operation. - `layout` GoogleCloudDocumentaiV1DocumentPageLayout — Visual element describing a layout unit on a page. - `orientation` 'ORIENTATION_UNSPECIFIED' | 'PAGE_UP' | 'PAGE_RIGHT' | 'PAGE_DOWN' | 'PAGE_LEFT' — Detected orientation for the Layout. - `confidence` number, float — 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]`. - `boundingPoly` GoogleCloudDocumentaiV1BoundingPoly — A bounding polygon for the detected image annotation. - … - `textAnchor` GoogleCloudDocumentaiV1DocumentTextAnchor — Text reference indexing into the Document.text. - … - `detectedLanguages` GoogleCloudDocumentaiV1DocumentPageDetectedLanguage[] — A list of detected languages together with confidence. - `languageCode` string — The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`. - `confidence` number, float — Confidence of detected language. Range `[0, 1]`. - `visualElements` GoogleCloudDocumentaiV1DocumentPageVisualElement[] — A list of detected non-text visual elements e.g. checkbox, signature etc. on the page. - `layout` GoogleCloudDocumentaiV1DocumentPageLayout — Visual element describing a layout unit on a page. - `orientation` 'ORIENTATION_UNSPECIFIED' | 'PAGE_UP' | 'PAGE_RIGHT' | 'PAGE_DOWN' | 'PAGE_LEFT' — Detected orientation for the Layout. - `confidence` number, float — 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]`. - `boundingPoly` GoogleCloudDocumentaiV1BoundingPoly — A bounding polygon for the detected image annotation. - … - `textAnchor` GoogleCloudDocumentaiV1DocumentTextAnchor — Text reference indexing into the Document.text. - … - `type` string — Type of the VisualElement. - `detectedLanguages` GoogleCloudDocumentaiV1DocumentPageDetectedLanguage[] — A list of detected languages together with confidence. - `languageCode` string — The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`. - `confidence` number, float — Confidence of detected language. Range `[0, 1]`. - `layout` GoogleCloudDocumentaiV1DocumentPageLayout — Visual element describing a layout unit on a page. - `orientation` 'ORIENTATION_UNSPECIFIED' | 'PAGE_UP' | 'PAGE_RIGHT' | 'PAGE_DOWN' | 'PAGE_LEFT' — Detected orientation for the Layout. - `confidence` number, float — 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]`. - `boundingPoly` GoogleCloudDocumentaiV1BoundingPoly — A bounding polygon for the detected image annotation. - `vertices` GoogleCloudDocumentaiV1Vertex[] — The bounding polygon vertices. - … - `normalizedVertices` GoogleCloudDocumentaiV1NormalizedVertex[] — The bounding polygon normalized vertices. - … - `textAnchor` GoogleCloudDocumentaiV1DocumentTextAnchor — Text reference indexing into the Document.text. - `textSegments` GoogleCloudDocumentaiV1DocumentTextAnchorTextSegment[] — The text segments from the Document.text. - … - `content` 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. - `pageNumber` integer — 1-based index for current Page in a parent Document. Useful when a page is taken out of a Document for individual processing. - `shardInfo` GoogleCloudDocumentaiV1DocumentShardInfo — 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. - `shardIndex` string, int64 — The 0-based index of this shard. - `shardCount` string, int64 — Total number of shards. - `textOffset` string, int64 — The index of the first character in Document.text in the overall document global text. - `documentLayout` GoogleCloudDocumentaiV1DocumentDocumentLayout — Represents the parsed layout of a document as a collection of blocks that the document is divided into. - `blocks` GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock[] — List of blocks in the document. - `pageSpan` GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan — Represents where the block starts and ends in the document. - `pageEnd` integer — Page where block ends in the document. - `pageStart` integer — Page where block starts in the document. - `blockId` string — ID of the block. - `listBlock` GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock — Represents a list type block. - `listEntries` GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry[] — List entries that constitute a list block. - … - `type` string — Type of the list_entries (if exist). Available options are `ordered` and `unordered`. - `textBlock` GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock — Represents a text type block. - `type` 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`. - `blocks` GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock[] — A text block could further have child blocks. Repeated blocks support further hierarchies and nested blocks. - `text` string — Text content stored in the block. - `tableBlock` GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock — Represents a table type block. - `bodyRows` GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow[] — Body rows containing main table content. - … - `caption` string — Table caption/title. - `headerRows` GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow[] — Header rows at the top of the table. - … - `uri` 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). - `displayUri` string — Uri to display the document, for example, in the UI. - `rawDocumentPath` string — Raw document file in Cloud Storage path. - `properties` GoogleCloudContentwarehouseV1Property[] — List of values that are user supplied metadata. - `timestampValues` GoogleCloudContentwarehouseV1TimestampArray — Timestamp values. - `values` GoogleCloudContentwarehouseV1TimestampValue[] — List of timestamp values. - `timestampValue` string, google-datetime — Timestamp value - `textValue` 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" - `enumValues` GoogleCloudContentwarehouseV1EnumArray — Enum values. - `values` string[] — List of enum values. - `integerValues` GoogleCloudContentwarehouseV1IntegerArray — Integer values. - `values` integer[] — List of integer values. - `floatValues` GoogleCloudContentwarehouseV1FloatArray — Float values. - `values` number[] — List of float values. - `dateTimeValues` GoogleCloudContentwarehouseV1DateTimeArray — DateTime values. - `values` GoogleTypeDateTime[] — List of datetime values. Both OffsetDateTime and ZonedDateTime are supported. - `minutes` integer — Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0. - `utcOffset` string, google-duration — 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 }. - `day` integer — 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. - `nanos` integer — Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0. - `timeZone` GoogleTypeTimeZone — Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). - `id` string — IANA Time Zone Database time zone. For example "America/New_York". - `version` string — Optional. IANA Time Zone Database version number. For example "2019a". - `year` integer — Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year. - `seconds` integer — 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. - `month` integer — Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month. - `hours` integer — 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. - `name` string — Required. Must match the name of a PropertyDefinition in the DocumentSchema. - `textValues` GoogleCloudContentwarehouseV1TextArray — String/text values. - `values` string[] — List of text values. - `propertyValues` GoogleCloudContentwarehouseV1PropertyArray — Property values. - `properties` GoogleCloudContentwarehouseV1Property[] — List of property values. - `mapProperty` GoogleCloudContentwarehouseV1MapProperty — Map property value. Represents a structured entries of key value pairs, consisting of field names which map to dynamically typed values. - `fields` object — Unordered map of dynamically typed values. - `documentSchemaName` string — The Document schema name. Format: projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. - `plainText` string — Other document format, such as PPTX, XLXS - `title` string — Title that describes the document. This can be the top heading or text that describes the document. - `displayName` 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. - `policy` GoogleIamV1Policy — 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/). - `etag` string, byte — `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. - `bindings` GoogleIamV1Binding[] — 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`. - `condition` GoogleTypeExpr — 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. - `description` 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` string — Textual representation of an expression in Common Expression Language syntax. - `title` 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. - `location` string — Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. - `members` string[] — 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`. - `role` 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). - `auditConfigs` GoogleIamV1AuditConfig[] — Specifies cloud audit logging configuration for this policy. - `auditLogConfigs` GoogleIamV1AuditLogConfig[] — The configuration for logging of each type of permission. - `logType` 'LOG_TYPE_UNSPECIFIED' | 'ADMIN_READ' | 'DATA_WRITE' | 'DATA_READ' — The log type that this config enables. - `exemptedMembers` string[] — Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. - `service` 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. - `version` integer — 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). ## Response `200` Successful response --- [API](https://skmtc.net/google/apis/contentwarehouse.md) · [All operations](https://skmtc.net/google/apis/contentwarehouse/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/google/contentwarehouse/versions/7a5c5ed93884/schema)