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

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

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

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

↳ 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.

Generated from protobuf field string name = 1;

Returns
TypeDescription
string

setName

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

Generated from protobuf field string name = 1;

Parameter
NameDescription
var string
Returns
TypeDescription
$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.

Generated from protobuf field string value_type = 2;

Returns
TypeDescription
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.

Generated from protobuf field string value_type = 2;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getOccurrenceType

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

Generated from protobuf field .google.cloud.documentai.v1.DocumentSchema.EntityType.Property.OccurrenceType occurrence_type = 3;

Returns
TypeDescription
int

setOccurrenceType

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

Generated from protobuf field .google.cloud.documentai.v1.DocumentSchema.EntityType.Property.OccurrenceType occurrence_type = 3;

Parameter
NameDescription
var int
Returns
TypeDescription
$this