Google Cloud Document Ai V1 Client - Class GcsOutputConfig (1.13.1)

Reference documentation and code samples for the Google Cloud Document Ai V1 Client class GcsOutputConfig.

The configuration used when outputting documents.

Generated from protobuf message google.cloud.documentai.v1.DocumentOutputConfig.GcsOutputConfig

Namespace

Google \ Cloud \ DocumentAI \ V1 \ DocumentOutputConfig

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ gcs_uri string

The Cloud Storage uri (a directory) of the output.
↳ field_mask Google\Protobuf\FieldMask

Specifies which fields to include in the output documents. Only supports top level document and pages field so it must be in the form of {document_field_name} or pages.{page_field_name}.
↳ sharding_config Google\Cloud\DocumentAI\V1\DocumentOutputConfig\GcsOutputConfig\ShardingConfig

Specifies the sharding config for the output document.

getGcsUri

The Cloud Storage uri (a directory) of the output.

Returns
Type Description
string

setGcsUri

The Cloud Storage uri (a directory) of the output.

Parameter
Name Description
var string
Returns
Type Description
$this

getFieldMask

Specifies which fields to include in the output documents.

Only supports top level document and pages field so it must be in the form of {document_field_name} or pages.{page_field_name}.

Returns
Type Description
Google\Protobuf\FieldMask|null

hasFieldMask

clearFieldMask

setFieldMask

Specifies which fields to include in the output documents.

Only supports top level document and pages field so it must be in the form of {document_field_name} or pages.{page_field_name}.

Parameter
Name Description
var Google\Protobuf\FieldMask
Returns
Type Description
$this

getShardingConfig

Specifies the sharding config for the output document.

Returns
Type Description
Google\Cloud\DocumentAI\V1\DocumentOutputConfig\GcsOutputConfig\ShardingConfig|null

hasShardingConfig

clearShardingConfig

setShardingConfig

Specifies the sharding config for the output document.

Parameter
Name Description
var Google\Cloud\DocumentAI\V1\DocumentOutputConfig\GcsOutputConfig\ShardingConfig
Returns
Type Description
$this