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

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

Methods

__construct

Constructor.

Parameters
NameDescription
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<Google\Cloud\DocumentAI\V1\DocumentSchema\EntityType>

Entity types of the schema.

↳ metadata Google\Cloud\DocumentAI\V1\DocumentSchema\Metadata

Metadata of the schema.

getDisplayName

Display name to show to users.

Generated from protobuf field string display_name = 1;

Returns
TypeDescription
string

setDisplayName

Display name to show to users.

Generated from protobuf field string display_name = 1;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDescription

Description of the schema.

Generated from protobuf field string description = 2;

Returns
TypeDescription
string

setDescription

Description of the schema.

Generated from protobuf field string description = 2;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getEntityTypes

Entity types of the schema.

Generated from protobuf field repeated .google.cloud.documentai.v1.DocumentSchema.EntityType entity_types = 3;

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setEntityTypes

Entity types of the schema.

Generated from protobuf field repeated .google.cloud.documentai.v1.DocumentSchema.EntityType entity_types = 3;

Parameter
NameDescription
var array<Google\Cloud\DocumentAI\V1\DocumentSchema\EntityType>
Returns
TypeDescription
$this

getMetadata

Metadata of the schema.

Generated from protobuf field .google.cloud.documentai.v1.DocumentSchema.Metadata metadata = 4;

Returns
TypeDescription
Google\Cloud\DocumentAI\V1\DocumentSchema\Metadata|null

hasMetadata

clearMetadata

setMetadata

Metadata of the schema.

Generated from protobuf field .google.cloud.documentai.v1.DocumentSchema.Metadata metadata = 4;

Parameter
NameDescription
var Google\Cloud\DocumentAI\V1\DocumentSchema\Metadata
Returns
TypeDescription
$this