Google Cloud Document Ai V1 Client - Class Property (2.0.0)

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

Defines properties that can be part of the entity type.

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

Namespace

Google \ Cloud \ DocumentAI \ V1 \ DocumentSchema \ EntityType

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

The name of the property. Follows the same guidelines as the EntityType name.

↳ display_name string

User defined name for the property.

↳ value_type string

A reference to the value type of the property. This type is subject to the same conventions as the Entity.base_types field.

↳ occurrence_type int

Occurrence type limits the number of instances an entity type appears in the document.

getName

The name of the property. Follows the same guidelines as the EntityType name.

Returns
Type Description
string

setName

The name of the property. Follows the same guidelines as the EntityType name.

Parameter
Name Description
var string
Returns
Type Description
$this

getDisplayName

User defined name for the property.

Returns
Type Description
string

setDisplayName

User defined name for the property.

Parameter
Name Description
var string
Returns
Type Description
$this

getValueType

A reference to the value type of the property. This type is subject to the same conventions as the Entity.base_types field.

Returns
Type Description
string

setValueType

A reference to the value type of the property. This type is subject to the same conventions as the Entity.base_types field.

Parameter
Name Description
var string
Returns
Type Description
$this

getOccurrenceType

Occurrence type limits the number of instances an entity type appears in the document.

Returns
Type Description
int

setOccurrenceType

Occurrence type limits the number of instances an entity type appears in the document.

Parameter
Name Description
var int
Returns
Type Description
$this