Google Cloud Document Ai V1 Client - Class DocumentSchema (2.3.0)

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

The schema defines the output of the processed document by a processor.

Generated from protobuf message google.cloud.documentai.v1.DocumentSchema

Namespace

Google \ Cloud \ DocumentAI \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

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

Display name to show to users.
↳ description string

Description of the schema.
↳ entity_types array<DocumentSchema\EntityType>

Entity types of the schema.
↳ metadata DocumentSchema\Metadata

Metadata of the schema.

getDisplayName

Display name to show to users.

Returns
Type Description
string

setDisplayName

Display name to show to users.

Parameter
Name Description
var string
Returns
Type Description
$this

getDescription

Description of the schema.

Returns
Type Description
string

setDescription

Description of the schema.

Parameter
Name Description
var string
Returns
Type Description
$this

getEntityTypes

Entity types of the schema.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setEntityTypes

Entity types of the schema.

Parameter
Name Description
var array<DocumentSchema\EntityType>
Returns
Type Description
$this

getMetadata

Metadata of the schema.

Returns
Type Description
DocumentSchema\Metadata|null

hasMetadata

clearMetadata

setMetadata

Metadata of the schema.

Parameter
Name Description
var DocumentSchema\Metadata
Returns
Type Description
$this