getDocument

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

Using getDocument

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getDocument(args: GetDocumentArgs, opts?: InvokeOptions): Promise<GetDocumentResult>
function getDocumentOutput(args: GetDocumentOutputArgs, opts?: InvokeOptions): Output<GetDocumentResult>
def get_document(document_id: Optional[str] = None,
                 location: Optional[str] = None,
                 project: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetDocumentResult
def get_document_output(document_id: Optional[pulumi.Input[str]] = None,
                 location: Optional[pulumi.Input[str]] = None,
                 project: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetDocumentResult]
func LookupDocument(ctx *Context, args *LookupDocumentArgs, opts ...InvokeOption) (*LookupDocumentResult, error)
func LookupDocumentOutput(ctx *Context, args *LookupDocumentOutputArgs, opts ...InvokeOption) LookupDocumentResultOutput

> Note: This function is named LookupDocument in the Go SDK.

public static class GetDocument 
{
    public static Task<GetDocumentResult> InvokeAsync(GetDocumentArgs args, InvokeOptions? opts = null)
    public static Output<GetDocumentResult> Invoke(GetDocumentInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetDocumentResult> getDocument(GetDocumentArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: google-native:contentwarehouse/v1:getDocument
  arguments:
    # arguments dictionary

The following arguments are supported:

DocumentId string
Location string
Project string
DocumentId string
Location string
Project string
documentId String
location String
project String
documentId string
location string
project string
documentId String
location String
project String

getDocument Result

The following output properties are available:

AsyncEnabled bool

If true, makes the document visible to asynchronous policies and rules.

CloudAiDocument Pulumi.GoogleNative.contentwarehouse.V1.Outputs.GoogleCloudDocumentaiV1DocumentResponse

Document AI format to save the structured content, including OCR.

CreateTime string

The time when the document is created.

Creator string

The user who creates the document.

DisplayName string

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 string

Uri to display the document, for example, in the UI.

DocumentSchemaName string

The Document schema name. Format: projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}.

InlineRawDocument string

Raw document content.

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.

PlainText string

Other document format, such as PPTX, XLXS

Properties List<Pulumi.GoogleNative.contentwarehouse.V1.Outputs.GoogleCloudContentwarehouseV1PropertyResponse>

List of values that are user supplied metadata.

RawDocumentFileType 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 string

Raw document file in Cloud Storage path.

ReferenceId string

The reference ID set by customers. Must be unique per project and location.

StructuredContentUri string

A path linked to structured content file.

TextExtractionDisabled bool

If true, text extraction will not be performed.

Title string

Title that describes the document. This is usually present in the top section of the document, and is a mandatory field for the question-answering feature.

UpdateTime string

The time when the document is last updated.

Updater string

The user who lastly updates the document.

AsyncEnabled bool

If true, makes the document visible to asynchronous policies and rules.

CloudAiDocument GoogleCloudDocumentaiV1DocumentResponse

Document AI format to save the structured content, including OCR.

CreateTime string

The time when the document is created.

Creator string

The user who creates the document.

DisplayName string

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 string

Uri to display the document, for example, in the UI.

DocumentSchemaName string

The Document schema name. Format: projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}.

InlineRawDocument string

Raw document content.

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.

PlainText string

Other document format, such as PPTX, XLXS

Properties []GoogleCloudContentwarehouseV1PropertyResponse

List of values that are user supplied metadata.

RawDocumentFileType 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 string

Raw document file in Cloud Storage path.

ReferenceId string

The reference ID set by customers. Must be unique per project and location.

StructuredContentUri string

A path linked to structured content file.

TextExtractionDisabled bool

If true, text extraction will not be performed.

Title string

Title that describes the document. This is usually present in the top section of the document, and is a mandatory field for the question-answering feature.

UpdateTime string

The time when the document is last updated.

Updater string

The user who lastly updates the document.

asyncEnabled Boolean

If true, makes the document visible to asynchronous policies and rules.

cloudAiDocument GoogleCloudDocumentaiV1DocumentResponse

Document AI format to save the structured content, including OCR.

createTime String

The time when the document is created.

creator String

The user who creates the document.

displayName String

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 String

Uri to display the document, for example, in the UI.

documentSchemaName String

The Document schema name. Format: projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}.

inlineRawDocument String

Raw document content.

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.

plainText String

Other document format, such as PPTX, XLXS

properties List<GoogleCloudContentwarehouseV1PropertyResponse>

List of values that are user supplied metadata.

rawDocumentFileType 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 String

Raw document file in Cloud Storage path.

referenceId String

The reference ID set by customers. Must be unique per project and location.

structuredContentUri String

A path linked to structured content file.

textExtractionDisabled Boolean

If true, text extraction will not be performed.

title String

Title that describes the document. This is usually present in the top section of the document, and is a mandatory field for the question-answering feature.

updateTime String

The time when the document is last updated.

updater String

The user who lastly updates the document.

asyncEnabled boolean

If true, makes the document visible to asynchronous policies and rules.

cloudAiDocument GoogleCloudDocumentaiV1DocumentResponse

Document AI format to save the structured content, including OCR.

createTime string

The time when the document is created.

creator string

The user who creates the document.

displayName string

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 string

Uri to display the document, for example, in the UI.

documentSchemaName string

The Document schema name. Format: projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}.

inlineRawDocument string

Raw document content.

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.

plainText string

Other document format, such as PPTX, XLXS

properties GoogleCloudContentwarehouseV1PropertyResponse[]

List of values that are user supplied metadata.

rawDocumentFileType 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 string

Raw document file in Cloud Storage path.

referenceId string

The reference ID set by customers. Must be unique per project and location.

structuredContentUri string

A path linked to structured content file.

textExtractionDisabled boolean

If true, text extraction will not be performed.

title string

Title that describes the document. This is usually present in the top section of the document, and is a mandatory field for the question-answering feature.

updateTime string

The time when the document is last updated.

updater string

The user who lastly updates the document.

async_enabled bool

If true, makes the document visible to asynchronous policies and rules.

cloud_ai_document GoogleCloudDocumentaiV1DocumentResponse

Document AI format to save the structured content, including OCR.

create_time str

The time when the document is created.

creator str

The user who creates the document.

display_name str

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.

display_uri str

Uri to display the document, for example, in the UI.

document_schema_name str

The Document schema name. Format: projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}.

inline_raw_document str

Raw document content.

name str

The resource name of the document. Format: projects/{project_number}/locations/{location}/documents/{document_id}. The name is ignored when creating a document.

plain_text str

Other document format, such as PPTX, XLXS

properties Sequence[GoogleCloudContentwarehouseV1PropertyResponse]

List of values that are user supplied metadata.

raw_document_file_type str

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.

raw_document_path str

Raw document file in Cloud Storage path.

reference_id str

The reference ID set by customers. Must be unique per project and location.

structured_content_uri str

A path linked to structured content file.

text_extraction_disabled bool

If true, text extraction will not be performed.

title str

Title that describes the document. This is usually present in the top section of the document, and is a mandatory field for the question-answering feature.

update_time str

The time when the document is last updated.

updater str

The user who lastly updates the document.

asyncEnabled Boolean

If true, makes the document visible to asynchronous policies and rules.

cloudAiDocument Property Map

Document AI format to save the structured content, including OCR.

createTime String

The time when the document is created.

creator String

The user who creates the document.

displayName String

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 String

Uri to display the document, for example, in the UI.

documentSchemaName String

The Document schema name. Format: projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}.

inlineRawDocument String

Raw document content.

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.

plainText String

Other document format, such as PPTX, XLXS

properties List<Property Map>

List of values that are user supplied metadata.

rawDocumentFileType 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 String

Raw document file in Cloud Storage path.

referenceId String

The reference ID set by customers. Must be unique per project and location.

structuredContentUri String

A path linked to structured content file.

textExtractionDisabled Boolean

If true, text extraction will not be performed.

title String

Title that describes the document. This is usually present in the top section of the document, and is a mandatory field for the question-answering feature.

updateTime String

The time when the document is last updated.

updater String

The user who lastly updates the document.

Supporting Types

GoogleCloudContentwarehouseV1DateTimeArrayResponse

Values List<Pulumi.GoogleNative.contentwarehouse.V1.Inputs.GoogleTypeDateTimeResponse>

List of datetime values. Both OffsetDateTime and ZonedDateTime are supported.

Values []GoogleTypeDateTimeResponse

List of datetime values. Both OffsetDateTime and ZonedDateTime are supported.

values List<GoogleTypeDateTimeResponse>

List of datetime values. Both OffsetDateTime and ZonedDateTime are supported.

values GoogleTypeDateTimeResponse[]

List of datetime values. Both OffsetDateTime and ZonedDateTime are supported.

values Sequence[GoogleTypeDateTimeResponse]

List of datetime values. Both OffsetDateTime and ZonedDateTime are supported.

values List<Property Map>

List of datetime values. Both OffsetDateTime and ZonedDateTime are supported.

GoogleCloudContentwarehouseV1EnumArrayResponse

Values List<string>

List of enum values.

Values []string

List of enum values.

values List<String>

List of enum values.

values string[]

List of enum values.

values Sequence[str]

List of enum values.

values List<String>

List of enum values.

GoogleCloudContentwarehouseV1FloatArrayResponse

Values List<double>

List of float values.

Values []float64

List of float values.

values List<Double>

List of float values.

values number[]

List of float values.

values Sequence[float]

List of float values.

values List<Number>

List of float values.

GoogleCloudContentwarehouseV1IntegerArrayResponse

Values List<int>

List of integer values.

Values []int

List of integer values.

values List<Integer>

List of integer values.

values number[]

List of integer values.

values Sequence[int]

List of integer values.

values List<Number>

List of integer values.

GoogleCloudContentwarehouseV1MapPropertyResponse

Fields Dictionary<string, string>

Unordered map of dynamically typed values.

Fields map[string]string

Unordered map of dynamically typed values.

fields Map<String,String>

Unordered map of dynamically typed values.

fields {[key: string]: string}

Unordered map of dynamically typed values.

fields Mapping[str, str]

Unordered map of dynamically typed values.

fields Map<String>

Unordered map of dynamically typed values.

GoogleCloudContentwarehouseV1PropertyArrayResponse

properties List<Property Map>

List of property values.

GoogleCloudContentwarehouseV1PropertyResponse

DateTimeValues Pulumi.GoogleNative.contentwarehouse.V1.Inputs.GoogleCloudContentwarehouseV1DateTimeArrayResponse

Date time property values. It is not supported by CMEK compliant deployment.

EnumValues Pulumi.GoogleNative.contentwarehouse.V1.Inputs.GoogleCloudContentwarehouseV1EnumArrayResponse

Enum property values.

FloatValues Pulumi.GoogleNative.contentwarehouse.V1.Inputs.GoogleCloudContentwarehouseV1FloatArrayResponse

Float property values.

IntegerValues Pulumi.GoogleNative.contentwarehouse.V1.Inputs.GoogleCloudContentwarehouseV1IntegerArrayResponse

Integer property values.

MapProperty Pulumi.GoogleNative.contentwarehouse.V1.Inputs.GoogleCloudContentwarehouseV1MapPropertyResponse

Map property values.

Name string

Must match the name of a PropertyDefinition in the DocumentSchema.

PropertyValues Pulumi.GoogleNative.contentwarehouse.V1.Inputs.GoogleCloudContentwarehouseV1PropertyArrayResponse

Nested structured data property values.

TextValues Pulumi.GoogleNative.contentwarehouse.V1.Inputs.GoogleCloudContentwarehouseV1TextArrayResponse

String/text property values.

TimestampValues Pulumi.GoogleNative.contentwarehouse.V1.Inputs.GoogleCloudContentwarehouseV1TimestampArrayResponse

Timestamp property values. It is not supported by CMEK compliant deployment.

DateTimeValues GoogleCloudContentwarehouseV1DateTimeArrayResponse

Date time property values. It is not supported by CMEK compliant deployment.

EnumValues GoogleCloudContentwarehouseV1EnumArrayResponse

Enum property values.

FloatValues GoogleCloudContentwarehouseV1FloatArrayResponse

Float property values.

IntegerValues GoogleCloudContentwarehouseV1IntegerArrayResponse

Integer property values.

MapProperty GoogleCloudContentwarehouseV1MapPropertyResponse

Map property values.

Name string

Must match the name of a PropertyDefinition in the DocumentSchema.

PropertyValues GoogleCloudContentwarehouseV1PropertyArrayResponse

Nested structured data property values.

TextValues GoogleCloudContentwarehouseV1TextArrayResponse

String/text property values.

TimestampValues GoogleCloudContentwarehouseV1TimestampArrayResponse

Timestamp property values. It is not supported by CMEK compliant deployment.

dateTimeValues GoogleCloudContentwarehouseV1DateTimeArrayResponse

Date time property values. It is not supported by CMEK compliant deployment.

enumValues GoogleCloudContentwarehouseV1EnumArrayResponse

Enum property values.

floatValues GoogleCloudContentwarehouseV1FloatArrayResponse

Float property values.

integerValues GoogleCloudContentwarehouseV1IntegerArrayResponse

Integer property values.

mapProperty GoogleCloudContentwarehouseV1MapPropertyResponse

Map property values.

name String

Must match the name of a PropertyDefinition in the DocumentSchema.

propertyValues GoogleCloudContentwarehouseV1PropertyArrayResponse

Nested structured data property values.

textValues GoogleCloudContentwarehouseV1TextArrayResponse

String/text property values.

timestampValues GoogleCloudContentwarehouseV1TimestampArrayResponse

Timestamp property values. It is not supported by CMEK compliant deployment.

dateTimeValues GoogleCloudContentwarehouseV1DateTimeArrayResponse

Date time property values. It is not supported by CMEK compliant deployment.

enumValues GoogleCloudContentwarehouseV1EnumArrayResponse

Enum property values.

floatValues GoogleCloudContentwarehouseV1FloatArrayResponse

Float property values.

integerValues GoogleCloudContentwarehouseV1IntegerArrayResponse

Integer property values.

mapProperty GoogleCloudContentwarehouseV1MapPropertyResponse

Map property values.

name string

Must match the name of a PropertyDefinition in the DocumentSchema.

propertyValues GoogleCloudContentwarehouseV1PropertyArrayResponse

Nested structured data property values.

textValues GoogleCloudContentwarehouseV1TextArrayResponse

String/text property values.

timestampValues GoogleCloudContentwarehouseV1TimestampArrayResponse

Timestamp property values. It is not supported by CMEK compliant deployment.

date_time_values GoogleCloudContentwarehouseV1DateTimeArrayResponse

Date time property values. It is not supported by CMEK compliant deployment.

enum_values GoogleCloudContentwarehouseV1EnumArrayResponse

Enum property values.

float_values GoogleCloudContentwarehouseV1FloatArrayResponse

Float property values.

integer_values GoogleCloudContentwarehouseV1IntegerArrayResponse

Integer property values.

map_property GoogleCloudContentwarehouseV1MapPropertyResponse

Map property values.

name str

Must match the name of a PropertyDefinition in the DocumentSchema.

property_values GoogleCloudContentwarehouseV1PropertyArrayResponse

Nested structured data property values.

text_values GoogleCloudContentwarehouseV1TextArrayResponse

String/text property values.

timestamp_values GoogleCloudContentwarehouseV1TimestampArrayResponse

Timestamp property values. It is not supported by CMEK compliant deployment.

dateTimeValues Property Map

Date time property values. It is not supported by CMEK compliant deployment.

enumValues Property Map

Enum property values.

floatValues Property Map

Float property values.

integerValues Property Map

Integer property values.

mapProperty Property Map

Map property values.

name String

Must match the name of a PropertyDefinition in the DocumentSchema.

propertyValues Property Map

Nested structured data property values.

textValues Property Map

String/text property values.

timestampValues Property Map

Timestamp property values. It is not supported by CMEK compliant deployment.

GoogleCloudContentwarehouseV1TextArrayResponse

Values List<string>

List of text values.

Values []string

List of text values.

values List<String>

List of text values.

values string[]

List of text values.

values Sequence[str]

List of text values.

values List<String>

List of text values.

GoogleCloudContentwarehouseV1TimestampArrayResponse

values List<Property Map>

List of timestamp values.

GoogleCloudContentwarehouseV1TimestampValueResponse

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"

TimestampValue string

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"

TimestampValue string

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"

timestampValue String

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"

timestampValue string

Timestamp value

text_value str

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"

timestamp_value str

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"

timestampValue String

Timestamp value

GoogleCloudDocumentaiV1BarcodeResponse

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.

RawValue string

Raw value encoded in the barcode. For example, 'MEBKM:TITLE:Google;URL:https://www.google.com;;'.

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.

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.

RawValue string

Raw value encoded in the barcode. For example, 'MEBKM:TITLE:Google;URL:https://www.google.com;;'.

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.

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.

rawValue String

Raw value encoded in the barcode. For example, 'MEBKM:TITLE:Google;URL:https://www.google.com;;'.

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.

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.

rawValue string

Raw value encoded in the barcode. For example, 'MEBKM:TITLE:Google;URL:https://www.google.com;;'.

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.

format str

Format of a barcode. The supported formats are: CODE_128: Code 128 type. CODE_39: Code 39 type. CODE_93: Code 93 type. CODABAR: Codabar type. DATA_MATRIX: 2D Data Matrix type. ITF: ITF type. EAN_13: EAN-13 type. EAN_8: EAN-8 type. QR_CODE: 2D QR code type. UPC_A: UPC-A type. UPC_E: UPC-E type. PDF417: PDF417 type. AZTEC: 2D Aztec code type. DATABAR: GS1 DataBar code type.

raw_value str

Raw value encoded in the barcode. For example, 'MEBKM:TITLE:Google;URL:https://www.google.com;;'.

value_format str

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.

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.

rawValue String

Raw value encoded in the barcode. For example, 'MEBKM:TITLE:Google;URL:https://www.google.com;;'.

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.

GoogleCloudDocumentaiV1BoundingPolyResponse

normalizedVertices List<Property Map>

The bounding polygon normalized vertices.

vertices List<Property Map>

The bounding polygon vertices.

GoogleCloudDocumentaiV1DocumentEntityNormalizedValueResponse

AddressValue Pulumi.GoogleNative.contentwarehouse.V1.Inputs.GoogleTypePostalAddressResponse

Postal address. See also: https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto

BooleanValue bool

Boolean value. Can be used for entities with binary values, or for checkboxes.

DateValue Pulumi.GoogleNative.contentwarehouse.V1.Inputs.GoogleTypeDateResponse

Date value. Includes year, month, day. See also: https://github.com/googleapis/googleapis/blob/master/google/type/date.proto

DatetimeValue Pulumi.GoogleNative.contentwarehouse.V1.Inputs.GoogleTypeDateTimeResponse

DateTime value. Includes date, time, and timezone. See also: https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto

FloatValue double

Float value.

IntegerValue int

Integer value.

MoneyValue Pulumi.GoogleNative.contentwarehouse.V1.Inputs.GoogleTypeMoneyResponse

Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto

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 int 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.

AddressValue GoogleTypePostalAddressResponse

Postal address. See also: https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto

BooleanValue bool

Boolean value. Can be used for entities with binary values, or for checkboxes.

DateValue GoogleTypeDateResponse

Date value. Includes year, month, day. See also: https://github.com/googleapis/googleapis/blob/master/google/type/date.proto

DatetimeValue GoogleTypeDateTimeResponse

DateTime value. Includes date, time, and timezone. See also: https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto

FloatValue float64

Float value.

IntegerValue int

Integer value.

MoneyValue GoogleTypeMoneyResponse

Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto

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 int 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.

addressValue GoogleTypePostalAddressResponse

Postal address. See also: https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto

booleanValue Boolean

Boolean value. Can be used for entities with binary values, or for checkboxes.

dateValue GoogleTypeDateResponse

Date value. Includes year, month, day. See also: https://github.com/googleapis/googleapis/blob/master/google/type/date.proto

datetimeValue GoogleTypeDateTimeResponse

DateTime value. Includes date, time, and timezone. See also: https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto

floatValue Double

Float value.

integerValue Integer

Integer value.

moneyValue GoogleTypeMoneyResponse

Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto

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 int 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.

addressValue GoogleTypePostalAddressResponse

Postal address. See also: https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto

booleanValue boolean

Boolean value. Can be used for entities with binary values, or for checkboxes.

dateValue GoogleTypeDateResponse

Date value. Includes year, month, day. See also: https://github.com/googleapis/googleapis/blob/master/google/type/date.proto

datetimeValue GoogleTypeDateTimeResponse

DateTime value. Includes date, time, and timezone. See also: https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto

floatValue number

Float value.

integerValue number

Integer value.

moneyValue GoogleTypeMoneyResponse

Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto

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 int 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.

address_value GoogleTypePostalAddressResponse

Postal address. See also: https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto

boolean_value bool

Boolean value. Can be used for entities with binary values, or for checkboxes.

date_value GoogleTypeDateResponse

Date value. Includes year, month, day. See also: https://github.com/googleapis/googleapis/blob/master/google/type/date.proto

datetime_value GoogleTypeDateTimeResponse

DateTime value. Includes date, time, and timezone. See also: https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto

float_value float

Float value.

integer_value int

Integer value.

money_value GoogleTypeMoneyResponse

Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto

text str

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 int 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.

addressValue Property Map

Postal address. See also: https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto

booleanValue Boolean

Boolean value. Can be used for entities with binary values, or for checkboxes.

dateValue Property Map

Date value. Includes year, month, day. See also: https://github.com/googleapis/googleapis/blob/master/google/type/date.proto

datetimeValue Property Map

DateTime value. Includes date, time, and timezone. See also: https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto

floatValue Number

Float value.

integerValue Number

Integer value.

moneyValue Property Map

Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto

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 int 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.

GoogleCloudDocumentaiV1DocumentEntityRelationResponse

ObjectId string

Object entity id.

Relation string

Relationship description.

SubjectId string

Subject entity id.

ObjectId string

Object entity id.

Relation string

Relationship description.

SubjectId string

Subject entity id.

objectId String

Object entity id.

relation String

Relationship description.

subjectId String

Subject entity id.

objectId string

Object entity id.

relation string

Relationship description.

subjectId string

Subject entity id.

object_id str

Object entity id.

relation str

Relationship description.

subject_id str

Subject entity id.

objectId String

Object entity id.

relation String

Relationship description.

subjectId String

Subject entity id.

GoogleCloudDocumentaiV1DocumentEntityResponse

Confidence double

Optional. Confidence of detected Schema entity. Range [0, 1].

MentionId string

Optional. Deprecated. Use id field instead.

Deprecated:

Optional. Deprecated. Use id field instead.

MentionText string

Optional. Text value of the entity e.g. 1600 Amphitheatre Pkwy.

NormalizedValue Pulumi.GoogleNative.contentwarehouse.V1.Inputs.GoogleCloudDocumentaiV1DocumentEntityNormalizedValueResponse

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.

PageAnchor Pulumi.GoogleNative.contentwarehouse.V1.Inputs.GoogleCloudDocumentaiV1DocumentPageAnchorResponse

Optional. Represents the provenance of this entity wrt. the location on the page where it was found.

Properties List<Pulumi.GoogleNative.contentwarehouse.V1.Inputs.GoogleCloudDocumentaiV1DocumentEntityResponse>

Optional. Entities can be nested to form a hierarchical data structure representing the content in the document.

Provenance Pulumi.GoogleNative.contentwarehouse.V1.Inputs.GoogleCloudDocumentaiV1DocumentProvenanceResponse

Optional. The history of this annotation.

Redacted bool

Optional. Whether the entity will be redacted for de-identification purposes.

TextAnchor Pulumi.GoogleNative.contentwarehouse.V1.Inputs.GoogleCloudDocumentaiV1DocumentTextAnchorResponse

Optional. Provenance of the entity. Text anchor indexing into the Document.text.

Type string

Entity type from a schema e.g. Address.

Confidence float64

Optional. Confidence of detected Schema entity. Range [0, 1].

MentionId string

Optional. Deprecated. Use id field instead.

Deprecated:

Optional. Deprecated. Use id field instead.

MentionText string

Optional. Text value of the entity e.g. 1600 Amphitheatre Pkwy.

NormalizedValue GoogleCloudDocumentaiV1DocumentEntityNormalizedValueResponse

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.

PageAnchor GoogleCloudDocumentaiV1DocumentPageAnchorResponse

Optional. Represents the provenance of this entity wrt. the location on the page where it was found.

Properties []GoogleCloudDocumentaiV1DocumentEntityResponse

Optional. Entities can be nested to form a hierarchical data structure representing the content in the document.

Provenance GoogleCloudDocumentaiV1DocumentProvenanceResponse

Optional. The history of this annotation.

Redacted bool

Optional. Whether the entity will be redacted for de-identification purposes.

TextAnchor GoogleCloudDocumentaiV1DocumentTextAnchorResponse

Optional. Provenance of the entity. Text anchor indexing into the Document.text.

Type string

Entity type from a schema e.g. Address.

confidence Double

Optional. Confidence of detected Schema entity. Range [0, 1].

mentionId String

Optional. Deprecated. Use id field instead.

Deprecated:

Optional. Deprecated. Use id field instead.

mentionText String

Optional. Text value of the entity e.g. 1600 Amphitheatre Pkwy.

normalizedValue GoogleCloudDocumentaiV1DocumentEntityNormalizedValueResponse

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.

pageAnchor GoogleCloudDocumentaiV1DocumentPageAnchorResponse

Optional. Represents the provenance of this entity wrt. the location on the page where it was found.

properties List<GoogleCloudDocumentaiV1DocumentEntityResponse>

Optional. Entities can be nested to form a hierarchical data structure representing the content in the document.

provenance GoogleCloudDocumentaiV1DocumentProvenanceResponse

Optional. The history of this annotation.

redacted Boolean

Optional. Whether the entity will be redacted for de-identification purposes.

textAnchor GoogleCloudDocumentaiV1DocumentTextAnchorResponse

Optional. Provenance of the entity. Text anchor indexing into the Document.text.

type String

Entity type from a schema e.g. Address.

confidence number

Optional. Confidence of detected Schema entity. Range [0, 1].

mentionId string

Optional. Deprecated. Use id field instead.

Deprecated:

Optional. Deprecated. Use id field instead.

mentionText string

Optional. Text value of the entity e.g. 1600 Amphitheatre Pkwy.

normalizedValue GoogleCloudDocumentaiV1DocumentEntityNormalizedValueResponse

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.

pageAnchor GoogleCloudDocumentaiV1DocumentPageAnchorResponse

Optional. Represents the provenance of this entity wrt. the location on the page where it was found.

properties GoogleCloudDocumentaiV1DocumentEntityResponse[]

Optional. Entities can be nested to form a hierarchical data structure representing the content in the document.

provenance GoogleCloudDocumentaiV1DocumentProvenanceResponse

Optional. The history of this annotation.

redacted boolean

Optional. Whether the entity will be redacted for de-identification purposes.

textAnchor GoogleCloudDocumentaiV1DocumentTextAnchorResponse

Optional. Provenance of the entity. Text anchor indexing into the Document.text.

type string

Entity type from a schema e.g. Address.

confidence float

Optional. Confidence of detected Schema entity. Range [0, 1].

mention_id str

Optional. Deprecated. Use id field instead.

Deprecated:

Optional. Deprecated. Use id field instead.

mention_text str

Optional. Text value of the entity e.g. 1600 Amphitheatre Pkwy.

normalized_value GoogleCloudDocumentaiV1DocumentEntityNormalizedValueResponse

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.

page_anchor GoogleCloudDocumentaiV1DocumentPageAnchorResponse

Optional. Represents the provenance of this entity wrt. the location on the page where it was found.

properties Sequence[GoogleCloudDocumentaiV1DocumentEntityResponse]

Optional. Entities can be nested to form a hierarchical data structure representing the content in the document.

provenance GoogleCloudDocumentaiV1DocumentProvenanceResponse

Optional. The history of this annotation.

redacted bool

Optional. Whether the entity will be redacted for de-identification purposes.

text_anchor GoogleCloudDocumentaiV1DocumentTextAnchorResponse

Optional. Provenance of the entity. Text anchor indexing into the Document.text.

type str

Entity type from a schema e.g. Address.

confidence Number

Optional. Confidence of detected Schema entity. Range [0, 1].

mentionId String

Optional. Deprecated. Use id field instead.

Deprecated:

Optional. Deprecated. Use id field instead.

mentionText String

Optional. Text value of the entity e.g. 1600 Amphitheatre Pkwy.

normalizedValue Property Map

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.

pageAnchor Property Map

Optional. Represents the provenance of this entity wrt. the location on the page where it was found.

properties List<Property Map>

Optional. Entities can be nested to form a hierarchical data structure representing the content in the document.

provenance Property Map

Optional. The history of this annotation.

redacted Boolean

Optional. Whether the entity will be redacted for de-identification purposes.

textAnchor Property Map

Optional. Provenance of the entity. Text anchor indexing into the Document.text.

type String

Entity type from a schema e.g. Address.

GoogleCloudDocumentaiV1DocumentPageAnchorPageRefResponse

BoundingPoly Pulumi.GoogleNative.contentwarehouse.V1.Inputs.GoogleCloudDocumentaiV1BoundingPolyResponse

Optional. Identifies the bounding polygon of a layout element on the page.

Confidence double

Optional. Confidence of detected page element, if applicable. Range [0, 1].

LayoutId string

Optional. Deprecated. Use PageRef.bounding_poly instead.

Deprecated:

Optional. Deprecated. Use PageRef.bounding_poly instead.

LayoutType string

Optional. The type of the layout element that is being referenced if any.

Page string

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 GoogleCloudDocumentaiV1BoundingPolyResponse

Optional. Identifies the bounding polygon of a layout element on the page.

Confidence float64

Optional. Confidence of detected page element, if applicable. Range [0, 1].

LayoutId string

Optional. Deprecated. Use PageRef.bounding_poly instead.

Deprecated:

Optional. Deprecated. Use PageRef.bounding_poly instead.

LayoutType string

Optional. The type of the layout element that is being referenced if any.

Page string

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 GoogleCloudDocumentaiV1BoundingPolyResponse

Optional. Identifies the bounding polygon of a layout element on the page.

confidence Double

Optional. Confidence of detected page element, if applicable. Range [0, 1].

layoutId String

Optional. Deprecated. Use PageRef.bounding_poly instead.

Deprecated:

Optional. Deprecated. Use PageRef.bounding_poly instead.

layoutType String

Optional. The type of the layout element that is being referenced if any.

page String

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 GoogleCloudDocumentaiV1BoundingPolyResponse

Optional. Identifies the bounding polygon of a layout element on the page.

confidence number

Optional. Confidence of detected page element, if applicable. Range [0, 1].

layoutId string

Optional. Deprecated. Use PageRef.bounding_poly instead.

Deprecated:

Optional. Deprecated. Use PageRef.bounding_poly instead.

layoutType string

Optional. The type of the layout element that is being referenced if any.

page string

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.

bounding_poly GoogleCloudDocumentaiV1BoundingPolyResponse

Optional. Identifies the bounding polygon of a layout element on the page.

confidence float

Optional. Confidence of detected page element, if applicable. Range [0, 1].

layout_id str

Optional. Deprecated. Use PageRef.bounding_poly instead.

Deprecated:

Optional. Deprecated. Use PageRef.bounding_poly instead.

layout_type str

Optional. The type of the layout element that is being referenced if any.

page str

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 Property Map

Optional. Identifies the bounding polygon of a layout element on the page.

confidence Number

Optional. Confidence of detected page element, if applicable. Range [0, 1].

layoutId String

Optional. Deprecated. Use PageRef.bounding_poly instead.

Deprecated:

Optional. Deprecated. Use PageRef.bounding_poly instead.

layoutType String

Optional. The type of the layout element that is being referenced if any.

page String

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.

GoogleCloudDocumentaiV1DocumentPageAnchorResponse

PageRefs []GoogleCloudDocumentaiV1DocumentPageAnchorPageRefResponse

One or more references to visual page elements

pageRefs List<GoogleCloudDocumentaiV1DocumentPageAnchorPageRefResponse>

One or more references to visual page elements

pageRefs GoogleCloudDocumentaiV1DocumentPageAnchorPageRefResponse[]

One or more references to visual page elements

pageRefs List<Property Map>

One or more references to visual page elements

GoogleCloudDocumentaiV1DocumentPageBlockResponse

detectedLanguages List<Property Map>

A list of detected languages together with confidence.

layout Property Map

Layout for Block.

provenance Property Map

The history of this annotation.

GoogleCloudDocumentaiV1DocumentPageDetectedBarcodeResponse

Barcode GoogleCloudDocumentaiV1BarcodeResponse

Detailed barcode information of the DetectedBarcode.

Layout GoogleCloudDocumentaiV1DocumentPageLayoutResponse

Layout for DetectedBarcode.

barcode GoogleCloudDocumentaiV1BarcodeResponse

Detailed barcode information of the DetectedBarcode.

layout GoogleCloudDocumentaiV1DocumentPageLayoutResponse

Layout for DetectedBarcode.

barcode GoogleCloudDocumentaiV1BarcodeResponse

Detailed barcode information of the DetectedBarcode.

layout GoogleCloudDocumentaiV1DocumentPageLayoutResponse

Layout for DetectedBarcode.

barcode GoogleCloudDocumentaiV1BarcodeResponse

Detailed barcode information of the DetectedBarcode.

layout GoogleCloudDocumentaiV1DocumentPageLayoutResponse

Layout for DetectedBarcode.

barcode Property Map

Detailed barcode information of the DetectedBarcode.

layout Property Map

Layout for DetectedBarcode.

GoogleCloudDocumentaiV1DocumentPageDetectedLanguageResponse

Confidence double

Confidence of detected language. Range [0, 1].

LanguageCode string

The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see https://www.unicode.org/reports/tr35/#Unicode_locale_identifier.

Confidence float64

Confidence of detected language. Range [0, 1].

LanguageCode string

The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see https://www.unicode.org/reports/tr35/#Unicode_locale_identifier.

confidence Double

Confidence of detected language. Range [0, 1].

languageCode String

The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see https://www.unicode.org/reports/tr35/#Unicode_locale_identifier.

confidence number

Confidence of detected language. Range [0, 1].

languageCode string

The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see https://www.unicode.org/reports/tr35/#Unicode_locale_identifier.

confidence float

Confidence of detected language. Range [0, 1].

language_code str

The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see https://www.unicode.org/reports/tr35/#Unicode_locale_identifier.

confidence Number

Confidence of detected language. Range [0, 1].

languageCode String

The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see https://www.unicode.org/reports/tr35/#Unicode_locale_identifier.

GoogleCloudDocumentaiV1DocumentPageDimensionResponse

Height double

Page height.

Unit string

Dimension unit.

Width double

Page width.

Height float64

Page height.

Unit string

Dimension unit.

Width float64

Page width.

height Double

Page height.

unit String

Dimension unit.

width Double

Page width.

height number

Page height.

unit string

Dimension unit.

width number

Page width.

height float

Page height.

unit str

Dimension unit.

width float

Page width.

height Number

Page height.

unit String

Dimension unit.

width Number

Page width.

GoogleCloudDocumentaiV1DocumentPageFormFieldResponse

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.

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.

FieldName Pulumi.GoogleNative.contentwarehouse.V1.Inputs.GoogleCloudDocumentaiV1DocumentPageLayoutResponse

Layout for the FormField name. e.g. Address, Email, Grand total, Phone number, etc.

FieldValue Pulumi.GoogleNative.contentwarehouse.V1.Inputs.GoogleCloudDocumentaiV1DocumentPageLayoutResponse

Layout for the FormField value.

NameDetectedLanguages List<Pulumi.GoogleNative.contentwarehouse.V1.Inputs.GoogleCloudDocumentaiV1DocumentPageDetectedLanguageResponse>

A list of detected languages for name together with confidence.

Provenance Pulumi.GoogleNative.contentwarehouse.V1.Inputs.GoogleCloudDocumentaiV1DocumentProvenanceResponse

The history of this annotation.

ValueDetectedLanguages List<Pulumi.GoogleNative.contentwarehouse.V1.Inputs.GoogleCloudDocumentaiV1DocumentPageDetectedLanguageResponse>

A list of detected languages for value together with confidence.

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"

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.

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.

FieldName GoogleCloudDocumentaiV1DocumentPageLayoutResponse

Layout for the FormField name. e.g. Address, Email, Grand total, Phone number, etc.

FieldValue GoogleCloudDocumentaiV1DocumentPageLayoutResponse

Layout for the FormField value.

NameDetectedLanguages []GoogleCloudDocumentaiV1DocumentPageDetectedLanguageResponse

A list of detected languages for name together with confidence.

Provenance GoogleCloudDocumentaiV1DocumentProvenanceResponse

The history of this annotation.

ValueDetectedLanguages []GoogleCloudDocumentaiV1DocumentPageDetectedLanguageResponse

A list of detected languages for value together with confidence.

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"

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.

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.

fieldName GoogleCloudDocumentaiV1DocumentPageLayoutResponse

Layout for the FormField name. e.g. Address, Email, Grand total, Phone number, etc.

fieldValue GoogleCloudDocumentaiV1DocumentPageLayoutResponse

Layout for the FormField value.

nameDetectedLanguages List<GoogleCloudDocumentaiV1DocumentPageDetectedLanguageResponse>

A list of detected languages for name together with confidence.

provenance GoogleCloudDocumentaiV1DocumentProvenanceResponse

The history of this annotation.

valueDetectedLanguages List<GoogleCloudDocumentaiV1DocumentPageDetectedLanguageResponse>

A list of detected languages for value together with confidence.

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"

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.

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.

fieldName GoogleCloudDocumentaiV1DocumentPageLayoutResponse

Layout for the FormField name. e.g. Address, Email, Grand total, Phone number, etc.

fieldValue GoogleCloudDocumentaiV1DocumentPageLayoutResponse

Layout for the FormField value.

nameDetectedLanguages GoogleCloudDocumentaiV1DocumentPageDetectedLanguageResponse[]

A list of detected languages for name together with confidence.

provenance GoogleCloudDocumentaiV1DocumentProvenanceResponse

The history of this annotation.

valueDetectedLanguages GoogleCloudDocumentaiV1DocumentPageDetectedLanguageResponse[]

A list of detected languages for value together with confidence.

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"

corrected_key_text str

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.

corrected_value_text str

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.

field_name GoogleCloudDocumentaiV1DocumentPageLayoutResponse

Layout for the FormField name. e.g. Address, Email, Grand total, Phone number, etc.

field_value GoogleCloudDocumentaiV1DocumentPageLayoutResponse

Layout for the FormField value.

name_detected_languages Sequence[GoogleCloudDocumentaiV1DocumentPageDetectedLanguageResponse]

A list of detected languages for name together with confidence.

provenance GoogleCloudDocumentaiV1DocumentProvenanceResponse

The history of this annotation.

value_detected_languages Sequence[GoogleCloudDocumentaiV1DocumentPageDetectedLanguageResponse]

A list of detected languages for value together with confidence.

value_type str

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"

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.

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.

fieldName Property Map

Layout for the FormField name. e.g. Address, Email, Grand total, Phone number, etc.

fieldValue Property Map

Layout for the FormField value.

nameDetectedLanguages List<Property Map>

A list of detected languages for name together with confidence.

provenance Property Map

The history of this annotation.

valueDetectedLanguages List<Property Map>

A list of detected languages for value together with confidence.

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"

GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefectResponse

Confidence double

Confidence of detected defect. Range [0, 1] where 1 indicates strong confidence of that the defect exists.

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 float64

Confidence of detected defect. Range [0, 1] where 1 indicates strong confidence of that the defect exists.

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 Double

Confidence of detected defect. Range [0, 1] where 1 indicates strong confidence of that the defect exists.

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

Confidence of detected defect. Range [0, 1] where 1 indicates strong confidence of that the defect exists.

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 float

Confidence of detected defect. Range [0, 1] where 1 indicates strong confidence of that the defect exists.

type str

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

Confidence of detected defect. Range [0, 1] where 1 indicates strong confidence of that the defect exists.

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"

GoogleCloudDocumentaiV1DocumentPageImageQualityScoresResponse

DetectedDefects []GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefectResponse

A list of detected defects.

QualityScore float64

The overall quality score. Range [0, 1] where 1 is perfect quality.

detectedDefects List<GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefectResponse>

A list of detected defects.

qualityScore Double

The overall quality score. Range [0, 1] where 1 is perfect quality.

detectedDefects GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefectResponse[]

A list of detected defects.

qualityScore number

The overall quality score. Range [0, 1] where 1 is perfect quality.

detected_defects Sequence[GoogleCloudDocumentaiV1DocumentPageImageQualityScoresDetectedDefectResponse]

A list of detected defects.

quality_score float

The overall quality score. Range [0, 1] where 1 is perfect quality.

detectedDefects List<Property Map>

A list of detected defects.

qualityScore Number

The overall quality score. Range [0, 1] where 1 is perfect quality.

GoogleCloudDocumentaiV1DocumentPageImageResponse

Content string

Raw byte content of the image.

Height int

Height of the image in pixels.

MimeType string

Encoding mime type for the image.

Width int

Width of the image in pixels.

Content string

Raw byte content of the image.

Height int

Height of the image in pixels.

MimeType string

Encoding mime type for the image.

Width int

Width of the image in pixels.

content String

Raw byte content of the image.

height Integer

Height of the image in pixels.

mimeType String

Encoding mime type for the image.

width Integer

Width of the image in pixels.

content string

Raw byte content of the image.

height number

Height of the image in pixels.

mimeType string

Encoding mime type for the image.

width number

Width of the image in pixels.

content str

Raw byte content of the image.

height int

Height of the image in pixels.

mime_type str

Encoding mime type for the image.

width int

Width of the image in pixels.

content String

Raw byte content of the image.

height Number

Height of the image in pixels.

mimeType String

Encoding mime type for the image.

width Number

Width of the image in pixels.

GoogleCloudDocumentaiV1DocumentPageLayoutResponse

BoundingPoly Pulumi.GoogleNative.contentwarehouse.V1.Inputs.GoogleCloudDocumentaiV1BoundingPolyResponse

The bounding polygon for the Layout.

Confidence double

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 string

Detected orientation for the Layout.

TextAnchor Pulumi.GoogleNative.contentwarehouse.V1.Inputs.GoogleCloudDocumentaiV1DocumentTextAnchorResponse

Text anchor indexing into the Document.text.

BoundingPoly GoogleCloudDocumentaiV1BoundingPolyResponse

The bounding polygon for the Layout.

Confidence float64

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 string

Detected orientation for the Layout.

TextAnchor GoogleCloudDocumentaiV1DocumentTextAnchorResponse

Text anchor indexing into the Document.text.

boundingPoly GoogleCloudDocumentaiV1BoundingPolyResponse

The bounding polygon for the Layout.

confidence Double

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 String

Detected orientation for the Layout.

textAnchor GoogleCloudDocumentaiV1DocumentTextAnchorResponse

Text anchor indexing into the Document.text.

boundingPoly GoogleCloudDocumentaiV1BoundingPolyResponse

The bounding polygon for the Layout.

confidence number

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 string

Detected orientation for the Layout.

textAnchor GoogleCloudDocumentaiV1DocumentTextAnchorResponse

Text anchor indexing into the Document.text.

bounding_poly GoogleCloudDocumentaiV1BoundingPolyResponse

The bounding polygon for the Layout.

confidence 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].

orientation str

Detected orientation for the Layout.

text_anchor GoogleCloudDocumentaiV1DocumentTextAnchorResponse

Text anchor indexing into the Document.text.

boundingPoly Property Map

The bounding polygon for the Layout.

confidence Number

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 String

Detected orientation for the Layout.

textAnchor Property Map

Text anchor indexing into the Document.text.

GoogleCloudDocumentaiV1DocumentPageLineResponse

detectedLanguages List<Property Map>

A list of detected languages together with confidence.

layout Property Map

Layout for Line.

provenance Property Map

The history of this annotation.

GoogleCloudDocumentaiV1DocumentPageMatrixResponse

Cols int

Number of columns in the matrix.

Data string

The matrix data.

Rows int

Number of rows in the matrix.

Type int

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

Cols int

Number of columns in the matrix.

Data string

The matrix data.

Rows int

Number of rows in the matrix.

Type int

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

cols Integer

Number of columns in the matrix.

data String

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

cols number

Number of columns in the matrix.

data string

The matrix data.

rows number

Number of rows in the matrix.

type number

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

cols int

Number of columns in the matrix.

data str

The matrix data.

rows int

Number of rows in the matrix.

type int

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

cols Number

Number of columns in the matrix.

data String

The matrix data.

rows Number

Number of rows in the matrix.

type Number

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

GoogleCloudDocumentaiV1DocumentPageParagraphResponse

detectedLanguages List<Property Map>

A list of detected languages together with confidence.

layout Property Map

Layout for Paragraph.

provenance Property Map

The history of this annotation.

GoogleCloudDocumentaiV1DocumentPageResponse

Blocks List<Pulumi.GoogleNative.contentwarehouse.V1.Inputs.GoogleCloudDocumentaiV1DocumentPageBlockResponse>

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.

DetectedBarcodes List<Pulumi.GoogleNative.contentwarehouse.V1.Inputs.GoogleCloudDocumentaiV1DocumentPageDetectedBarcodeResponse>

A list of detected barcodes.

DetectedLanguages List<Pulumi.GoogleNative.contentwarehouse.V1.Inputs.GoogleCloudDocumentaiV1DocumentPageDetectedLanguageResponse>

A list of detected languages together with confidence.

Dimension Pulumi.GoogleNative.contentwarehouse.V1.Inputs.GoogleCloudDocumentaiV1DocumentPageDimensionResponse

Physical dimension of the page.

FormFields List<Pulumi.GoogleNative.contentwarehouse.V1.Inputs.GoogleCloudDocumentaiV1DocumentPageFormFieldResponse>

A list of visually detected form fields on the page.

Image Pulumi.GoogleNative.contentwarehouse.V1.Inputs.GoogleCloudDocumentaiV1DocumentPageImageResponse

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.

ImageQualityScores Pulumi.GoogleNative.contentwarehouse.V1.Inputs.GoogleCloudDocumentaiV1DocumentPageImageQualityScoresResponse

Image Quality Scores.

Layout Pulumi.GoogleNative.contentwarehouse.V1.Inputs.GoogleCloudDocumentaiV1DocumentPageLayoutResponse

Layout for the page.

Lines List<Pulumi.GoogleNative.contentwarehouse.V1.Inputs.GoogleCloudDocumentaiV1DocumentPageLineResponse>

A list of visually detected text lines on the page. A collection of tokens that a human would perceive as a line.

PageNumber int

1-based index for current Page in a parent Document. Useful when a page is taken out of a Document for individual processing.

Paragraphs List<Pulumi.GoogleNative.contentwarehouse.V1.Inputs.GoogleCloudDocumentaiV1DocumentPageParagraphResponse>

A list of visually detected text paragraphs on the page. A collection of lines that a human would perceive as a paragraph.

Provenance Pulumi.GoogleNative.contentwarehouse.V1.Inputs.GoogleCloudDocumentaiV1DocumentProvenanceResponse

The history of this page.

Symbols List<Pulumi.GoogleNative.contentwarehouse.V1.Inputs.GoogleCloudDocumentaiV1DocumentPageSymbolResponse>

A list of visually detected symbols on the page.

Tables List<Pulumi.GoogleNative.contentwarehouse.V1.Inputs.GoogleCloudDocumentaiV1DocumentPageTableResponse>

A list of visually detected tables on the page.

Tokens List<Pulumi.GoogleNative.contentwarehouse.V1.Inputs.GoogleCloudDocumentaiV1DocumentPageTokenResponse>

A list of visually detected tokens on the page.

Transforms List<Pulumi.GoogleNative.contentwarehouse.V1.Inputs.GoogleCloudDocumentaiV1DocumentPageMatrixResponse>

Transformation matrices that were applied to the original document image to produce Page.image.

VisualElements List<Pulumi.GoogleNative.contentwarehouse.V1.Inputs.GoogleCloudDocumentaiV1DocumentPageVisualElementResponse>

A list of detected non-text visual elements e.g. checkbox, signature etc. on the page.

Blocks []GoogleCloudDocumentaiV1DocumentPageBlockResponse

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.

DetectedBarcodes []GoogleCloudDocumentaiV1DocumentPageDetectedBarcodeResponse

A list of detected barcodes.

DetectedLanguages []GoogleCloudDocumentaiV1DocumentPageDetectedLanguageResponse

A list of detected languages together with confidence.

Dimension GoogleCloudDocumentaiV1DocumentPageDimensionResponse

Physical dimension of the page.

FormFields []GoogleCloudDocumentaiV1DocumentPageFormFieldResponse

A list of visually detected form fields on the page.

Image GoogleCloudDocumentaiV1DocumentPageImageResponse

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.

ImageQualityScores GoogleCloudDocumentaiV1DocumentPageImageQualityScoresResponse

Image Quality Scores.

Layout GoogleCloudDocumentaiV1DocumentPageLayoutResponse

Layout for the page.

Lines []GoogleCloudDocumentaiV1DocumentPageLineResponse

A list of visually detected text lines on the page. A collection of tokens that a human would perceive as a line.

PageNumber int

1-based index for current Page in a parent Document. Useful when a page is taken out of a Document for individual processing.

Paragraphs []GoogleCloudDocumentaiV1DocumentPageParagraphResponse

A list of visually detected text paragraphs on the page. A collection of lines that a human would perceive as a paragraph.

Provenance GoogleCloudDocumentaiV1DocumentProvenanceResponse

The history of this page.

Symbols []GoogleCloudDocumentaiV1DocumentPageSymbolResponse

A list of visually detected symbols on the page.

Tables []GoogleCloudDocumentaiV1DocumentPageTableResponse

A list of visually detected tables on the page.

Tokens []GoogleCloudDocumentaiV1DocumentPageTokenResponse

A list of visually detected tokens on the page.

Transforms []GoogleCloudDocumentaiV1DocumentPageMatrixResponse

Transformation matrices that were applied to the original document image to produce Page.image.

VisualElements []GoogleCloudDocumentaiV1DocumentPageVisualElementResponse

A list of detected non-text visual elements e.g. checkbox, signature etc. on the page.

blocks List<GoogleCloudDocumentaiV1DocumentPageBlockResponse>

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.

detectedBarcodes List<GoogleCloudDocumentaiV1DocumentPageDetectedBarcodeResponse>

A list of detected barcodes.

detectedLanguages List<GoogleCloudDocumentaiV1DocumentPageDetectedLanguageResponse>

A list of detected languages together with confidence.

dimension GoogleCloudDocumentaiV1DocumentPageDimensionResponse

Physical dimension of the page.

formFields List<GoogleCloudDocumentaiV1DocumentPageFormFieldResponse>

A list of visually detected form fields on the page.

image GoogleCloudDocumentaiV1DocumentPageImageResponse

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.

imageQualityScores GoogleCloudDocumentaiV1DocumentPageImageQualityScoresResponse

Image Quality Scores.

layout GoogleCloudDocumentaiV1DocumentPageLayoutResponse

Layout for the page.

lines List<GoogleCloudDocumentaiV1DocumentPageLineResponse>

A list of visually detected text lines on the page. A collection of tokens that a human would perceive as a line.

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.

paragraphs List<GoogleCloudDocumentaiV1DocumentPageParagraphResponse>

A list of visually detected text paragraphs on the page. A collection of lines that a human would perceive as a paragraph.

provenance GoogleCloudDocumentaiV1DocumentProvenanceResponse

The history of this page.

symbols List<GoogleCloudDocumentaiV1DocumentPageSymbolResponse>

A list of visually detected symbols on the page.

tables List<GoogleCloudDocumentaiV1DocumentPageTableResponse>

A list of visually detected tables on the page.

tokens List<GoogleCloudDocumentaiV1DocumentPageTokenResponse>

A list of visually detected tokens on the page.

transforms List<GoogleCloudDocumentaiV1DocumentPageMatrixResponse>

Transformation matrices that were applied to the original document image to produce Page.image.

visualElements List<GoogleCloudDocumentaiV1DocumentPageVisualElementResponse>

A list of detected non-text visual elements e.g. checkbox, signature etc. on the page.

blocks GoogleCloudDocumentaiV1DocumentPageBlockResponse[]

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.

detectedBarcodes GoogleCloudDocumentaiV1DocumentPageDetectedBarcodeResponse[]

A list of detected barcodes.

detectedLanguages GoogleCloudDocumentaiV1DocumentPageDetectedLanguageResponse[]

A list of detected languages together with confidence.

dimension GoogleCloudDocumentaiV1DocumentPageDimensionResponse

Physical dimension of the page.

formFields GoogleCloudDocumentaiV1DocumentPageFormFieldResponse[]

A list of visually detected form fields on the page.

image GoogleCloudDocumentaiV1DocumentPageImageResponse

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.

imageQualityScores GoogleCloudDocumentaiV1DocumentPageImageQualityScoresResponse

Image Quality Scores.

layout GoogleCloudDocumentaiV1DocumentPageLayoutResponse

Layout for the page.

lines GoogleCloudDocumentaiV1DocumentPageLineResponse[]

A list of visually detected text lines on the page. A collection of tokens that a human would perceive as a line.

pageNumber number

1-based index for current Page in a parent Document. Useful when a page is taken out of a Document for individual processing.

paragraphs GoogleCloudDocumentaiV1DocumentPageParagraphResponse[]

A list of visually detected text paragraphs on the page. A collection of lines that a human would perceive as a paragraph.

provenance GoogleCloudDocumentaiV1DocumentProvenanceResponse

The history of this page.

symbols GoogleCloudDocumentaiV1DocumentPageSymbolResponse[]

A list of visually detected symbols on the page.

tables GoogleCloudDocumentaiV1DocumentPageTableResponse[]

A list of visually detected tables on the page.

tokens GoogleCloudDocumentaiV1DocumentPageTokenResponse[]

A list of visually detected tokens on the page.

transforms GoogleCloudDocumentaiV1DocumentPageMatrixResponse[]

Transformation matrices that were applied to the original document image to produce Page.image.

visualElements GoogleCloudDocumentaiV1DocumentPageVisualElementResponse[]

A list of detected non-text visual elements e.g. checkbox, signature etc. on the page.

blocks Sequence[GoogleCloudDocumentaiV1DocumentPageBlockResponse]

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.

detected_barcodes Sequence[GoogleCloudDocumentaiV1DocumentPageDetectedBarcodeResponse]

A list of detected barcodes.

detected_languages Sequence[GoogleCloudDocumentaiV1DocumentPageDetectedLanguageResponse]

A list of detected languages together with confidence.

dimension GoogleCloudDocumentaiV1DocumentPageDimensionResponse

Physical dimension of the page.

form_fields Sequence[GoogleCloudDocumentaiV1DocumentPageFormFieldResponse]

A list of visually detected form fields on the page.

image GoogleCloudDocumentaiV1DocumentPageImageResponse

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.

image_quality_scores GoogleCloudDocumentaiV1DocumentPageImageQualityScoresResponse

Image Quality Scores.

layout GoogleCloudDocumentaiV1DocumentPageLayoutResponse

Layout for the page.

lines Sequence[GoogleCloudDocumentaiV1DocumentPageLineResponse]

A list of visually detected text lines on the page. A collection of tokens that a human would perceive as a line.

page_number int

1-based index for current Page in a parent Document. Useful when a page is taken out of a Document for individual processing.

paragraphs Sequence[GoogleCloudDocumentaiV1DocumentPageParagraphResponse]

A list of visually detected text paragraphs on the page. A collection of lines that a human would perceive as a paragraph.

provenance GoogleCloudDocumentaiV1DocumentProvenanceResponse

The history of this page.

symbols Sequence[GoogleCloudDocumentaiV1DocumentPageSymbolResponse]

A list of visually detected symbols on the page.

tables Sequence[GoogleCloudDocumentaiV1DocumentPageTableResponse]

A list of visually detected tables on the page.

tokens Sequence[GoogleCloudDocumentaiV1DocumentPageTokenResponse]

A list of visually detected tokens on the page.

transforms Sequence[GoogleCloudDocumentaiV1DocumentPageMatrixResponse]

Transformation matrices that were applied to the original document image to produce Page.image.

visual_elements Sequence[GoogleCloudDocumentaiV1DocumentPageVisualElementResponse]

A list of detected non-text visual elements e.g. checkbox, signature etc. on the page.

blocks List<Property Map>

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.

detectedBarcodes List<Property Map>

A list of detected barcodes.

detectedLanguages List<Property Map>

A list of detected languages together with confidence.

dimension Property Map

Physical dimension of the page.

formFields List<Property Map>

A list of visually detected form fields on the page.

image Property Map

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.

imageQualityScores Property Map

Image Quality Scores.

layout Property Map

Layout for the page.

lines List<Property Map>

A list of visually detected text lines on the page. A collection of tokens that a human would perceive as a line.

pageNumber Number

1-based index for current Page in a parent Document. Useful when a page is taken out of a Document for individual processing.

paragraphs List<Property Map>

A list of visually detected text paragraphs on the page. A collection of lines that a human would perceive as a paragraph.

provenance Property Map

The history of this page.

symbols List<Property Map>

A list of visually detected symbols on the page.

tables List<Property Map>

A list of visually detected tables on the page.

tokens List<Property Map>

A list of visually detected tokens on the page.

transforms List<Property Map>

Transformation matrices that were applied to the original document image to produce Page.image.

visualElements List<Property Map>

A list of detected non-text visual elements e.g. checkbox, signature etc. on the page.

GoogleCloudDocumentaiV1DocumentPageSymbolResponse

detectedLanguages List<Property Map>

A list of detected languages together with confidence.

layout Property Map

Layout for Symbol.

GoogleCloudDocumentaiV1DocumentPageTableResponse

bodyRows List<Property Map>

Body rows of the table.

detectedLanguages List<Property Map>

A list of detected languages together with confidence.

headerRows List<Property Map>

Header rows of the table.

layout Property Map

Layout for Table.

provenance Property Map

The history of this table.

GoogleCloudDocumentaiV1DocumentPageTableTableCellResponse

ColSpan int

How many columns this cell spans.

DetectedLanguages []GoogleCloudDocumentaiV1DocumentPageDetectedLanguageResponse

A list of detected languages together with confidence.

Layout GoogleCloudDocumentaiV1DocumentPageLayoutResponse

Layout for TableCell.

RowSpan int

How many rows this cell spans.

colSpan Integer

How many columns this cell spans.

detectedLanguages List<GoogleCloudDocumentaiV1DocumentPageDetectedLanguageResponse>

A list of detected languages together with confidence.

layout GoogleCloudDocumentaiV1DocumentPageLayoutResponse

Layout for TableCell.

rowSpan Integer

How many rows this cell spans.

colSpan number

How many columns this cell spans.

detectedLanguages GoogleCloudDocumentaiV1DocumentPageDetectedLanguageResponse[]

A list of detected languages together with confidence.

layout GoogleCloudDocumentaiV1DocumentPageLayoutResponse

Layout for TableCell.

rowSpan number

How many rows this cell spans.

col_span int

How many columns this cell spans.

detected_languages Sequence[GoogleCloudDocumentaiV1DocumentPageDetectedLanguageResponse]

A list of detected languages together with confidence.

layout GoogleCloudDocumentaiV1DocumentPageLayoutResponse

Layout for TableCell.

row_span int

How many rows this cell spans.

colSpan Number

How many columns this cell spans.

detectedLanguages List<Property Map>

A list of detected languages together with confidence.

layout Property Map

Layout for TableCell.

rowSpan Number

How many rows this cell spans.

GoogleCloudDocumentaiV1DocumentPageTableTableRowResponse

cells List<Property Map>

Cells that make up this row.

GoogleCloudDocumentaiV1DocumentPageTokenDetectedBreakResponse

Type string

Detected break type.

Type string

Detected break type.

type String

Detected break type.

type string

Detected break type.

type str

Detected break type.

type String

Detected break type.

GoogleCloudDocumentaiV1DocumentPageTokenResponse

detectedBreak Property Map

Detected break at the end of a Token.

detectedLanguages List<Property Map>

A list of detected languages together with confidence.

layout Property Map

Layout for Token.

provenance Property Map

The history of this annotation.

GoogleCloudDocumentaiV1DocumentPageVisualElementResponse

DetectedLanguages []GoogleCloudDocumentaiV1DocumentPageDetectedLanguageResponse

A list of detected languages together with confidence.

Layout GoogleCloudDocumentaiV1DocumentPageLayoutResponse

Layout for VisualElement.

Type string

Type of the VisualElement.

detectedLanguages List<GoogleCloudDocumentaiV1DocumentPageDetectedLanguageResponse>

A list of detected languages together with confidence.

layout GoogleCloudDocumentaiV1DocumentPageLayoutResponse

Layout for VisualElement.

type String

Type of the VisualElement.

detectedLanguages GoogleCloudDocumentaiV1DocumentPageDetectedLanguageResponse[]

A list of detected languages together with confidence.

layout GoogleCloudDocumentaiV1DocumentPageLayoutResponse

Layout for VisualElement.

type string

Type of the VisualElement.

detected_languages Sequence[GoogleCloudDocumentaiV1DocumentPageDetectedLanguageResponse]

A list of detected languages together with confidence.

layout GoogleCloudDocumentaiV1DocumentPageLayoutResponse

Layout for VisualElement.

type str

Type of the VisualElement.

detectedLanguages List<Property Map>

A list of detected languages together with confidence.

layout Property Map

Layout for VisualElement.

type String

Type of the VisualElement.

GoogleCloudDocumentaiV1DocumentProvenanceParentResponse

Index int

The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.

Revision int

The index of the index into current revision's parent_ids list.

Index int

The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.

Revision int

The index of the index into current revision's parent_ids list.

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.

revision Integer

The index of the index into current revision's parent_ids list.

index number

The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.

revision number

The index of the index into current revision's parent_ids list.

index int

The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.

revision int

The index of the index into current revision's parent_ids list.

index Number

The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.

revision Number

The index of the index into current revision's parent_ids list.

GoogleCloudDocumentaiV1DocumentProvenanceResponse

Parents List<Pulumi.GoogleNative.contentwarehouse.V1.Inputs.GoogleCloudDocumentaiV1DocumentProvenanceParentResponse>

References to the original elements that are replaced.

Revision int

The index of the revision that produced this element.

Type string

The type of provenance operation.

Parents []GoogleCloudDocumentaiV1DocumentProvenanceParentResponse

References to the original elements that are replaced.

Revision int

The index of the revision that produced this element.

Type string

The type of provenance operation.

parents List<GoogleCloudDocumentaiV1DocumentProvenanceParentResponse>

References to the original elements that are replaced.

revision Integer

The index of the revision that produced this element.

type String

The type of provenance operation.

parents GoogleCloudDocumentaiV1DocumentProvenanceParentResponse[]

References to the original elements that are replaced.

revision number

The index of the revision that produced this element.

type string

The type of provenance operation.

parents Sequence[GoogleCloudDocumentaiV1DocumentProvenanceParentResponse]

References to the original elements that are replaced.

revision int

The index of the revision that produced this element.

type str

The type of provenance operation.

parents List<Property Map>

References to the original elements that are replaced.

revision Number

The index of the revision that produced this element.

type String

The type of provenance operation.

GoogleCloudDocumentaiV1DocumentResponse

Content 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.

Entities List<Pulumi.GoogleNative.contentwarehouse.V1.Inputs.GoogleCloudDocumentaiV1DocumentEntityResponse>

A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries.

EntityRelations List<Pulumi.GoogleNative.contentwarehouse.V1.Inputs.GoogleCloudDocumentaiV1DocumentEntityRelationResponse>

Placeholder. Relationship among Document.entities.

Error Pulumi.GoogleNative.contentwarehouse.V1.Inputs.GoogleRpcStatusResponse

Any error that occurred while processing this document.

MimeType string

An IANA published MIME type (also referred to as media type). For more information, see https://www.iana.org/assignments/media-types/media-types.xhtml.

Pages List<Pulumi.GoogleNative.contentwarehouse.V1.Inputs.GoogleCloudDocumentaiV1DocumentPageResponse>

Visual page layout for the Document.

Revisions List<Pulumi.GoogleNative.contentwarehouse.V1.Inputs.GoogleCloudDocumentaiV1DocumentRevisionResponse>

Placeholder. Revision history of this document.

ShardInfo Pulumi.GoogleNative.contentwarehouse.V1.Inputs.GoogleCloudDocumentaiV1DocumentShardInfoResponse

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.

Text string

Optional. UTF-8 encoded text in reading order from the document.

TextChanges List<Pulumi.GoogleNative.contentwarehouse.V1.Inputs.GoogleCloudDocumentaiV1DocumentTextChangeResponse>

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.

TextStyles List<Pulumi.GoogleNative.contentwarehouse.V1.Inputs.GoogleCloudDocumentaiV1DocumentStyleResponse>

Placeholder. Styles for the Document.text.

Uri string

Optional. Currently supports Google Cloud Storage URI of the form gs://bucket_name/object_name. Object versioning is not supported. See Google Cloud Storage Request URIs for more info.

Content 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.

Entities []GoogleCloudDocumentaiV1DocumentEntityResponse

A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries.

EntityRelations []GoogleCloudDocumentaiV1DocumentEntityRelationResponse

Placeholder. Relationship among Document.entities.

Error GoogleRpcStatusResponse

Any error that occurred while processing this document.

MimeType string

An IANA published MIME type (also referred to as media type). For more information, see https://www.iana.org/assignments/media-types/media-types.xhtml.

Pages []GoogleCloudDocumentaiV1DocumentPageResponse

Visual page layout for the Document.

Revisions []GoogleCloudDocumentaiV1DocumentRevisionResponse

Placeholder. Revision history of this document.

ShardInfo GoogleCloudDocumentaiV1DocumentShardInfoResponse

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.

Text string

Optional. UTF-8 encoded text in reading order from the document.

TextChanges []GoogleCloudDocumentaiV1DocumentTextChangeResponse

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.

TextStyles []GoogleCloudDocumentaiV1DocumentStyleResponse

Placeholder. Styles for the Document.text.

Uri string

Optional. Currently supports Google Cloud Storage URI of the form gs://bucket_name/object_name. Object versioning is not supported. See Google Cloud Storage Request URIs for more info.

content 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.

entities List<GoogleCloudDocumentaiV1DocumentEntityResponse>

A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries.

entityRelations List<GoogleCloudDocumentaiV1DocumentEntityRelationResponse>

Placeholder. Relationship among Document.entities.

error GoogleRpcStatusResponse

Any error that occurred while processing this document.

mimeType String

An IANA published MIME type (also referred to as media type). For more information, see https://www.iana.org/assignments/media-types/media-types.xhtml.

pages List<GoogleCloudDocumentaiV1DocumentPageResponse>

Visual page layout for the Document.

revisions List<GoogleCloudDocumentaiV1DocumentRevisionResponse>

Placeholder. Revision history of this document.

shardInfo GoogleCloudDocumentaiV1DocumentShardInfoResponse

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.

text String

Optional. UTF-8 encoded text in reading order from the document.

textChanges List<GoogleCloudDocumentaiV1DocumentTextChangeResponse>

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.

textStyles List<GoogleCloudDocumentaiV1DocumentStyleResponse>

Placeholder. Styles for the Document.text.

uri String

Optional. Currently supports Google Cloud Storage URI of the form gs://bucket_name/object_name. Object versioning is not supported. See Google Cloud Storage Request URIs for more info.

content 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.

entities GoogleCloudDocumentaiV1DocumentEntityResponse[]

A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries.

entityRelations GoogleCloudDocumentaiV1DocumentEntityRelationResponse[]

Placeholder. Relationship among Document.entities.

error GoogleRpcStatusResponse

Any error that occurred while processing this document.

mimeType string

An IANA published MIME type (also referred to as media type). For more information, see https://www.iana.org/assignments/media-types/media-types.xhtml.

pages GoogleCloudDocumentaiV1DocumentPageResponse[]

Visual page layout for the Document.

revisions GoogleCloudDocumentaiV1DocumentRevisionResponse[]

Placeholder. Revision history of this document.

shardInfo GoogleCloudDocumentaiV1DocumentShardInfoResponse

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.

text string

Optional. UTF-8 encoded text in reading order from the document.

textChanges GoogleCloudDocumentaiV1DocumentTextChangeResponse[]

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.

textStyles GoogleCloudDocumentaiV1DocumentStyleResponse[]

Placeholder. Styles for the Document.text.

uri string

Optional. Currently supports Google Cloud Storage URI of the form gs://bucket_name/object_name. Object versioning is not supported. See Google Cloud Storage Request URIs for more info.

content str

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.

entities Sequence[GoogleCloudDocumentaiV1DocumentEntityResponse]

A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries.

entity_relations Sequence[GoogleCloudDocumentaiV1DocumentEntityRelationResponse]

Placeholder. Relationship among Document.entities.

error GoogleRpcStatusResponse

Any error that occurred while processing this document.

mime_type str

An IANA published MIME type (also referred to as media type). For more information, see https://www.iana.org/assignments/media-types/media-types.xhtml.

pages Sequence[GoogleCloudDocumentaiV1DocumentPageResponse]

Visual page layout for the Document.

revisions Sequence[GoogleCloudDocumentaiV1DocumentRevisionResponse]

Placeholder. Revision history of this document.

shard_info GoogleCloudDocumentaiV1DocumentShardInfoResponse

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.

text str

Optional. UTF-8 encoded text in reading order from the document.

text_changes Sequence[GoogleCloudDocumentaiV1DocumentTextChangeResponse]

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.

text_styles Sequence[GoogleCloudDocumentaiV1DocumentStyleResponse]

Placeholder. Styles for the Document.text.

uri str

Optional. Currently supports Google Cloud Storage URI of the form gs://bucket_name/object_name. Object versioning is not supported. See Google Cloud Storage Request URIs for more info.

content 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.

entities List<Property Map>

A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries.

entityRelations List<Property Map>

Placeholder. Relationship among Document.entities.

error Property Map

Any error that occurred while processing this document.

mimeType String

An IANA published MIME type (also referred to as media type). For more information, see https://www.iana.org/assignments/media-types/media-types.xhtml.

pages List<Property Map>

Visual page layout for the Document.

revisions List<Property Map>

Placeholder. Revision history of this document.

shardInfo Property Map

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.

text String

Optional. UTF-8 encoded text in reading order from the document.

textChanges List<Property Map>

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.

textStyles List<Property Map>

Placeholder. Styles for the Document.text.

uri String

Optional. Currently supports Google Cloud Storage URI of the form gs://bucket_name/object_name. Object versioning is not supported. See Google Cloud Storage Request URIs for more info.

GoogleCloudDocumentaiV1DocumentRevisionHumanReviewResponse

State string

Human review state. e.g. requested, succeeded, rejected.

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.

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.

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.

stateMessage string

A message providing more details about the current state of processing. For example, the rejection reason when the state is rejected.

state str

Human review state. e.g. requested, succeeded, rejected.

state_message str

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.

stateMessage String

A message providing more details about the current state of processing. For example, the rejection reason when the state is rejected.

GoogleCloudDocumentaiV1DocumentRevisionResponse

Agent string

If the change was made by a person specify the name or id of that person.

CreateTime string

The time that the revision was created.

HumanReview Pulumi.GoogleNative.contentwarehouse.V1.Inputs.GoogleCloudDocumentaiV1DocumentRevisionHumanReviewResponse

Human Review information of this revision.

Parent List<int>

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 List<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.

Processor string

If the annotation was made by processor identify the processor by its resource name.

Agent string

If the change was made by a person specify the name or id of that person.

CreateTime string

The time that the revision was created.

HumanReview GoogleCloudDocumentaiV1DocumentRevisionHumanReviewResponse

Human Review information of this revision.

Parent []int

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.

Processor string

If the annotation was made by processor identify the processor by its resource name.

agent String

If the change was made by a person specify the name or id of that person.

createTime String

The time that the revision was created.

humanReview GoogleCloudDocumentaiV1DocumentRevisionHumanReviewResponse

Human Review information of this revision.

parent List<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 List<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.

processor String

If the annotation was made by processor identify the processor by its resource name.

agent string

If the change was made by a person specify the name or id of that person.

createTime string

The time that the revision was created.

humanReview GoogleCloudDocumentaiV1DocumentRevisionHumanReviewResponse

Human Review information of this revision.

parent number[]

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.

processor string

If the annotation was made by processor identify the processor by its resource name.

agent str

If the change was made by a person specify the name or id of that person.

create_time str

The time that the revision was created.

human_review GoogleCloudDocumentaiV1DocumentRevisionHumanReviewResponse

Human Review information of this revision.

parent Sequence[int]

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.

parent_ids Sequence[str]

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.

processor str

If the annotation was made by processor identify the processor by its resource name.

agent String

If the change was made by a person specify the name or id of that person.

createTime String

The time that the revision was created.

humanReview Property Map

Human Review information of this revision.

parent List<Number>

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 List<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.

processor String

If the annotation was made by processor identify the processor by its resource name.

GoogleCloudDocumentaiV1DocumentShardInfoResponse

ShardCount string

Total number of shards.

ShardIndex string

The 0-based index of this shard.

TextOffset string

The index of the first character in Document.text in the overall document global text.

ShardCount string

Total number of shards.

ShardIndex string

The 0-based index of this shard.

TextOffset string

The index of the first character in Document.text in the overall document global text.

shardCount String

Total number of shards.

shardIndex String

The 0-based index of this shard.

textOffset String

The index of the first character in Document.text in the overall document global text.

shardCount string

Total number of shards.

shardIndex string

The 0-based index of this shard.

textOffset string

The index of the first character in Document.text in the overall document global text.

shard_count str

Total number of shards.

shard_index str

The 0-based index of this shard.

text_offset str

The index of the first character in Document.text in the overall document global text.

shardCount String

Total number of shards.

shardIndex String

The 0-based index of this shard.

textOffset String

The index of the first character in Document.text in the overall document global text.

GoogleCloudDocumentaiV1DocumentStyleFontSizeResponse

Size double

Font size for the text.

Unit string

Unit for the font size. Follows CSS naming (in, px, pt, etc.).

Size float64

Font size for the text.

Unit string

Unit for the font size. Follows CSS naming (in, px, pt, etc.).

size Double

Font size for the text.

unit String

Unit for the font size. Follows CSS naming (in, px, pt, etc.).

size number

Font size for the text.

unit string

Unit for the font size. Follows CSS naming (in, px, pt, etc.).

size float

Font size for the text.

unit str

Unit for the font size. Follows CSS naming (in, px, pt, etc.).

size Number

Font size for the text.

unit String

Unit for the font size. Follows CSS naming (in, px, pt, etc.).

GoogleCloudDocumentaiV1DocumentStyleResponse

BackgroundColor Pulumi.GoogleNative.contentwarehouse.V1.Inputs.GoogleTypeColorResponse

Text background color.

Color Pulumi.GoogleNative.contentwarehouse.V1.Inputs.GoogleTypeColorResponse

Text color.

FontFamily string

Font family such as "Arial", "Times New Roman". https://www.w3schools.com/cssref/pr_font_font-family.asp

FontSize Pulumi.GoogleNative.contentwarehouse.V1.Inputs.GoogleCloudDocumentaiV1DocumentStyleFontSizeResponse

Font size.

FontWeight string

Font weight. Possible values are normal, bold, bolder, and lighter. https://www.w3schools.com/cssref/pr_font_weight.asp

TextAnchor Pulumi.GoogleNative.contentwarehouse.V1.Inputs.GoogleCloudDocumentaiV1DocumentTextAnchorResponse

Text anchor indexing into the Document.text.

TextDecoration string

Text decoration. Follows CSS standard. https://www.w3schools.com/cssref/pr_text_text-decoration.asp

TextStyle string

Text style. Possible values are normal, italic, and oblique. https://www.w3schools.com/cssref/pr_font_font-style.asp

BackgroundColor GoogleTypeColorResponse

Text background color.

Color GoogleTypeColorResponse

Text color.

FontFamily string

Font family such as "Arial", "Times New Roman". https://www.w3schools.com/cssref/pr_font_font-family.asp

FontSize GoogleCloudDocumentaiV1DocumentStyleFontSizeResponse

Font size.

FontWeight string

Font weight. Possible values are normal, bold, bolder, and lighter. https://www.w3schools.com/cssref/pr_font_weight.asp

TextAnchor GoogleCloudDocumentaiV1DocumentTextAnchorResponse

Text anchor indexing into the Document.text.

TextDecoration string

Text decoration. Follows CSS standard. https://www.w3schools.com/cssref/pr_text_text-decoration.asp

TextStyle string

Text style. Possible values are normal, italic, and oblique. https://www.w3schools.com/cssref/pr_font_font-style.asp

backgroundColor GoogleTypeColorResponse

Text background color.

color GoogleTypeColorResponse

Text color.

fontFamily String

Font family such as "Arial", "Times New Roman". https://www.w3schools.com/cssref/pr_font_font-family.asp

fontSize GoogleCloudDocumentaiV1DocumentStyleFontSizeResponse

Font size.

fontWeight String

Font weight. Possible values are normal, bold, bolder, and lighter. https://www.w3schools.com/cssref/pr_font_weight.asp

textAnchor GoogleCloudDocumentaiV1DocumentTextAnchorResponse

Text anchor indexing into the Document.text.

textDecoration String

Text decoration. Follows CSS standard. https://www.w3schools.com/cssref/pr_text_text-decoration.asp

textStyle String

Text style. Possible values are normal, italic, and oblique. https://www.w3schools.com/cssref/pr_font_font-style.asp

backgroundColor GoogleTypeColorResponse

Text background color.

color GoogleTypeColorResponse

Text color.

fontFamily string

Font family such as "Arial", "Times New Roman". https://www.w3schools.com/cssref/pr_font_font-family.asp

fontSize GoogleCloudDocumentaiV1DocumentStyleFontSizeResponse

Font size.

fontWeight string

Font weight. Possible values are normal, bold, bolder, and lighter. https://www.w3schools.com/cssref/pr_font_weight.asp

textAnchor GoogleCloudDocumentaiV1DocumentTextAnchorResponse

Text anchor indexing into the Document.text.

textDecoration string

Text decoration. Follows CSS standard. https://www.w3schools.com/cssref/pr_text_text-decoration.asp

textStyle string

Text style. Possible values are normal, italic, and oblique. https://www.w3schools.com/cssref/pr_font_font-style.asp

background_color GoogleTypeColorResponse

Text background color.

color GoogleTypeColorResponse

Text color.

font_family str

Font family such as "Arial", "Times New Roman". https://www.w3schools.com/cssref/pr_font_font-family.asp

font_size GoogleCloudDocumentaiV1DocumentStyleFontSizeResponse

Font size.

font_weight str

Font weight. Possible values are normal, bold, bolder, and lighter. https://www.w3schools.com/cssref/pr_font_weight.asp

text_anchor GoogleCloudDocumentaiV1DocumentTextAnchorResponse

Text anchor indexing into the Document.text.

text_decoration str

Text decoration. Follows CSS standard. https://www.w3schools.com/cssref/pr_text_text-decoration.asp

text_style str

Text style. Possible values are normal, italic, and oblique. https://www.w3schools.com/cssref/pr_font_font-style.asp

backgroundColor Property Map

Text background color.

color Property Map

Text color.

fontFamily String

Font family such as "Arial", "Times New Roman". https://www.w3schools.com/cssref/pr_font_font-family.asp

fontSize Property Map

Font size.

fontWeight String

Font weight. Possible values are normal, bold, bolder, and lighter. https://www.w3schools.com/cssref/pr_font_weight.asp

textAnchor Property Map

Text anchor indexing into the Document.text.

textDecoration String

Text decoration. Follows CSS standard. https://www.w3schools.com/cssref/pr_text_text-decoration.asp

textStyle String

Text style. Possible values are normal, italic, and oblique. https://www.w3schools.com/cssref/pr_font_font-style.asp

GoogleCloudDocumentaiV1DocumentTextAnchorResponse

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.

TextSegments List<Pulumi.GoogleNative.contentwarehouse.V1.Inputs.GoogleCloudDocumentaiV1DocumentTextAnchorTextSegmentResponse>

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.

TextSegments []GoogleCloudDocumentaiV1DocumentTextAnchorTextSegmentResponse

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.

textSegments List<GoogleCloudDocumentaiV1DocumentTextAnchorTextSegmentResponse>

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.

textSegments GoogleCloudDocumentaiV1DocumentTextAnchorTextSegmentResponse[]

The text segments from the Document.text.

content str

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.

text_segments Sequence[GoogleCloudDocumentaiV1DocumentTextAnchorTextSegmentResponse]

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.

textSegments List<Property Map>

The text segments from the Document.text.

GoogleCloudDocumentaiV1DocumentTextAnchorTextSegmentResponse

EndIndex string

TextSegment half open end UTF-8 char index in the Document.text.

StartIndex string

TextSegment start UTF-8 char index in the Document.text.

EndIndex string

TextSegment half open end UTF-8 char index in the Document.text.

StartIndex string

TextSegment start UTF-8 char index in the Document.text.

endIndex String

TextSegment half open end UTF-8 char index in the Document.text.

startIndex String

TextSegment start UTF-8 char index in the Document.text.

endIndex string

TextSegment half open end UTF-8 char index in the Document.text.

startIndex string

TextSegment start UTF-8 char index in the Document.text.

end_index str

TextSegment half open end UTF-8 char index in the Document.text.

start_index str

TextSegment start UTF-8 char index in the Document.text.

endIndex String

TextSegment half open end UTF-8 char index in the Document.text.

startIndex String

TextSegment start UTF-8 char index in the Document.text.

GoogleCloudDocumentaiV1DocumentTextChangeResponse

ChangedText string

The text that replaces the text identified in the text_anchor.

Provenance List<Pulumi.GoogleNative.contentwarehouse.V1.Inputs.GoogleCloudDocumentaiV1DocumentProvenanceResponse>

The history of this annotation.

TextAnchor Pulumi.GoogleNative.contentwarehouse.V1.Inputs.GoogleCloudDocumentaiV1DocumentTextAnchorResponse

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.

ChangedText string

The text that replaces the text identified in the text_anchor.

Provenance []GoogleCloudDocumentaiV1DocumentProvenanceResponse

The history of this annotation.

TextAnchor GoogleCloudDocumentaiV1DocumentTextAnchorResponse

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.

changedText String

The text that replaces the text identified in the text_anchor.

provenance List<GoogleCloudDocumentaiV1DocumentProvenanceResponse>

The history of this annotation.

textAnchor GoogleCloudDocumentaiV1DocumentTextAnchorResponse

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.

changedText string

The text that replaces the text identified in the text_anchor.

provenance GoogleCloudDocumentaiV1DocumentProvenanceResponse[]

The history of this annotation.

textAnchor GoogleCloudDocumentaiV1DocumentTextAnchorResponse

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.

changed_text str

The text that replaces the text identified in the text_anchor.

provenance Sequence[GoogleCloudDocumentaiV1DocumentProvenanceResponse]

The history of this annotation.

text_anchor GoogleCloudDocumentaiV1DocumentTextAnchorResponse

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.

changedText String

The text that replaces the text identified in the text_anchor.

provenance List<Property Map>

The history of this annotation.

textAnchor Property Map

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.

GoogleCloudDocumentaiV1NormalizedVertexResponse

X double

X coordinate.

Y double

Y coordinate (starts from the top of the image).

X float64

X coordinate.

Y float64

Y coordinate (starts from the top of the image).

x Double

X coordinate.

y Double

Y coordinate (starts from the top of the image).

x number

X coordinate.

y number

Y coordinate (starts from the top of the image).

x float

X coordinate.

y float

Y coordinate (starts from the top of the image).

x Number

X coordinate.

y Number

Y coordinate (starts from the top of the image).

GoogleCloudDocumentaiV1VertexResponse

X int

X coordinate.

Y int

Y coordinate (starts from the top of the image).

X int

X coordinate.

Y int

Y coordinate (starts from the top of the image).

x Integer

X coordinate.

y Integer

Y coordinate (starts from the top of the image).

x number

X coordinate.

y number

Y coordinate (starts from the top of the image).

x int

X coordinate.

y int

Y coordinate (starts from the top of the image).

x Number

X coordinate.

y Number

Y coordinate (starts from the top of the image).

GoogleRpcStatusResponse

Code int

The status code, which should be an enum value of google.rpc.Code.

Details List<ImmutableDictionary<string, string>>

A list of messages that carry the error details. There is a common set of message types for APIs to use.

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.

Code int

The status code, which should be an enum value of google.rpc.Code.

Details []map[string]string

A list of messages that carry the error details. There is a common set of message types for APIs to use.

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.

code Integer

The status code, which should be an enum value of google.rpc.Code.

details List<Map<String,String>>

A list of messages that carry the error details. There is a common set of message types for APIs to use.

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.

code number

The status code, which should be an enum value of google.rpc.Code.

details {[key: string]: string}[]

A list of messages that carry the error details. There is a common set of message types for APIs to use.

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.

code int

The status code, which should be an enum value of google.rpc.Code.

details Sequence[Mapping[str, str]]

A list of messages that carry the error details. There is a common set of message types for APIs to use.

message str

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.

code Number

The status code, which should be an enum value of google.rpc.Code.

details List<Map<String>>

A list of messages that carry the error details. There is a common set of message types for APIs to use.

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.

GoogleTypeColorResponse

Alpha double

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 double

The amount of blue in the color as a value in the interval [0, 1].

Green double

The amount of green in the color as a value in the interval [0, 1].

Red double

The amount of red in the color as a value in the interval [0, 1].

Alpha float64

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 float64

The amount of blue in the color as a value in the interval [0, 1].

Green float64

The amount of green in the color as a value in the interval [0, 1].

Red float64

The amount of red in the color as a value in the interval [0, 1].

alpha Double

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 Double

The amount of blue in the color as a value in the interval [0, 1].

green Double

The amount of green in the color as a value in the interval [0, 1].

red Double

The amount of red in the color as a value in the interval [0, 1].

alpha number

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 number

The amount of blue in the color as a value in the interval [0, 1].

green number

The amount of green in the color as a value in the interval [0, 1].

red number

The amount of red in the color as a value in the interval [0, 1].

alpha 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).

blue float

The amount of blue in the color as a value in the interval [0, 1].

green float

The amount of green in the color as a value in the interval [0, 1].

red float

The amount of red in the color as a value in the interval [0, 1].

alpha Number

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 Number

The amount of blue in the color as a value in the interval [0, 1].

green Number

The amount of green in the color as a value in the interval [0, 1].

red Number

The amount of red in the color as a value in the interval [0, 1].

GoogleTypeDateResponse

Day int

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 int

Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

Year int

Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

Day int

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 int

Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

Year int

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.

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 number

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 number

Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

year number

Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

day int

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 int

Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

year int

Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

day Number

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 Number

Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

year Number

Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

GoogleTypeDateTimeResponse

Day int

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 int

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 int

Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.

Month int

Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month.

Nanos int

Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0.

Seconds int

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 Pulumi.GoogleNative.contentwarehouse.V1.Inputs.GoogleTypeTimeZoneResponse

Time zone.

UtcOffset 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 int

Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.

Day int

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 int

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 int

Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.

Month int

Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month.

Nanos int

Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0.

Seconds int

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 GoogleTypeTimeZoneResponse

Time zone.

UtcOffset 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 int

Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.

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.

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.

minutes Integer

Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.

month Integer

Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month.

nanos Integer

Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0.

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.

timeZone GoogleTypeTimeZoneResponse

Time zone.

utcOffset 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 Integer

Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.

day number

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 number

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 number

Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.

month number

Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month.

nanos number

Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0.

seconds number

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 GoogleTypeTimeZoneResponse

Time zone.

utcOffset 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 number

Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.

day int

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 int

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 int

Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.

month int

Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month.

nanos int

Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0.

seconds int

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.

time_zone GoogleTypeTimeZoneResponse

Time zone.

utc_offset str

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 int

Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.

day Number

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 Number

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 Number

Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.

month Number

Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month.

nanos Number

Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0.

seconds Number

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 Property Map

Time zone.

utcOffset 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 Number

Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.

GoogleTypeMoneyResponse

CurrencyCode string

The three-letter currency code defined in ISO 4217.

Nanos int

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 string

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 int

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 string

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.

units String

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 number

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 string

The whole units of the amount. For example if currencyCode is "USD", then 1 unit is one US dollar.

currency_code str

The three-letter currency code defined in ISO 4217.

nanos int

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 str

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 Number

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 String

The whole units of the amount. For example if currencyCode is "USD", then 1 unit is one US dollar.

GoogleTypePostalAddressResponse

AddressLines List<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 (e.g. "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 (e.g. Japan), address_language is used to make it explicit (e.g. "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).

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 (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.

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".

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.

Organization string

Optional. The name of the organization at the address.

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 (e.g. state/zip validation in the U.S.A.).

Recipients List<string>

Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.

RegionCode string

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 int

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 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 (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

Sublocality string

Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.

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 (e.g. "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 (e.g. Japan), address_language is used to make it explicit (e.g. "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).

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 (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.

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".

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.

Organization string

Optional. The name of the organization at the address.

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 (e.g. state/zip validation in the U.S.A.).

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.

RegionCode string

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 int

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 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 (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

Sublocality string

Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.

addressLines List<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 (e.g. "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 (e.g. Japan), address_language is used to make it explicit (e.g. "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).

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 (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.

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".

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.

organization String

Optional. The name of the organization at the address.

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 (e.g. state/zip validation in the U.S.A.).

recipients List<String>

Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.

regionCode String

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 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.

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 (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

sublocality String

Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.

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 (e.g. "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 (e.g. Japan), address_language is used to make it explicit (e.g. "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).

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 (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.

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".

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.

organization string

Optional. The name of the organization at the address.

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 (e.g. state/zip validation in the U.S.A.).

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.

regionCode string

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 number

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 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 (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

sublocality string

Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.

address_lines Sequence[str]

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 (e.g. "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 (e.g. Japan), address_language is used to make it explicit (e.g. "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).

administrative_area str

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 (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.

language_code str

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 str

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 str

Optional. The name of the organization at the address.

postal_code str

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 (e.g. state/zip validation in the U.S.A.).

recipients Sequence[str]

Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.

region_code str

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 int

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.

sorting_code str

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 (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

sublocality str

Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.

addressLines List<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 (e.g. "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 (e.g. Japan), address_language is used to make it explicit (e.g. "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).

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 (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.

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".

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.

organization String

Optional. The name of the organization at the address.

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 (e.g. state/zip validation in the U.S.A.).

recipients List<String>

Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.

regionCode String

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 Number

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 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 (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

sublocality String

Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.

GoogleTypeTimeZoneResponse

Version string

Optional. IANA Time Zone Database version number, e.g. "2019a".

Version string

Optional. IANA Time Zone Database version number, e.g. "2019a".

version String

Optional. IANA Time Zone Database version number, e.g. "2019a".

version string

Optional. IANA Time Zone Database version number, e.g. "2019a".

version str

Optional. IANA Time Zone Database version number, e.g. "2019a".

version String

Optional. IANA Time Zone Database version number, e.g. "2019a".

Package Details

Repository
https://github.com/pulumi/pulumi-google-native
License
Apache-2.0