Class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta1OutputConfig

Inherits:

Object

• Object
• Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta1OutputConfig

Includes:

Core::Hashable, Core::JsonObjectSupport

Defined in:

generated/google/apis/documentai_v1beta3/classes.rb,
generated/google/apis/documentai_v1beta3/representations.rb,
generated/google/apis/documentai_v1beta3/representations.rb

Overview

The desired output location and metadata.

Instance Attribute Summary

• #gcs_destination ⇒ Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta1GcsDestination

  The Google Cloud Storage location where the output file will be written to.

• #pages_per_shard ⇒ Fixnum

  The max number of pages to include into each output Document shard JSON on Google Cloud Storage.

Instance Method Summary

• #initialize(**args) ⇒ GoogleCloudDocumentaiV1beta1OutputConfig constructor

  A new instance of GoogleCloudDocumentaiV1beta1OutputConfig.

• #update!(**args) ⇒ Object

  Update properties of this object.

Constructor Details

#initialize(**args) ⇒ GoogleCloudDocumentaiV1beta1OutputConfig

Returns a new instance of GoogleCloudDocumentaiV1beta1OutputConfig.

# File 'generated/google/apis/documentai_v1beta3/classes.rb', line 1954

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

Instance Attribute Details

#gcs_destination ⇒ Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta1GcsDestination

The Google Cloud Storage location where the output file will be written to. Corresponds to the JSON property gcsDestination

Returns:

• (Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta1GcsDestination)

# File 'generated/google/apis/documentai_v1beta3/classes.rb', line 1939

def gcs_destination
  @gcs_destination
end

#pages_per_shard ⇒ Fixnum

The max number of pages to include into each output Document shard JSON on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 parsed pages will be produced. If pages_per_shard = 20, then 5 Document shard JSON files each containing 20 parsed pages will be written under the prefix OutputConfig.gcs_destination.uri and suffix pages-x-to-y.json where x and y are 1-indexed page numbers. Example GCS outputs with 157 pages and pages_per_shard = 50: pages-001-to-050.json pages-051-to-100.json pages-101-to- 150.json pages-151-to-157.json Corresponds to the JSON property pagesPerShard

Returns:

• (Fixnum)

# File 'generated/google/apis/documentai_v1beta3/classes.rb', line 1952

def pages_per_shard
  @pages_per_shard
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'generated/google/apis/documentai_v1beta3/classes.rb', line 1959

def update!(**args)
  @gcs_destination = args[:gcs_destination] if args.key?(:gcs_destination)
  @pages_per_shard = args[:pages_per_shard] if args.key?(:pages_per_shard)
end