Google Cloud Document Ai V1 Client - Class Revision (1.7.0)

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

Contains past or forward revisions of this document.

Generated from protobuf message google.cloud.documentai.v1.Document.Revision

Namespace

Google \ Cloud \ DocumentAI \ V1 \ Document

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ agent string

If the change was made by a person specify the name or id of that person.

↳ processor string

If the annotation was made by processor identify the processor by its resource name.

↳ id string

Id of the revision, internally generated by doc proto storage. Unique within the context of the document.

↳ parent array

The revisions that this revision is based on. This can include one or more parent (when documents are merged.) This field represents the index into the revisions field.

↳ parent_ids array

The revisions that this revision is based on. Must include all the ids that have anything to do with this revision - eg. there are provenance.parent.revision fields that index into this field.

↳ create_time Google\Protobuf\Timestamp

The time that the revision was created, internally generated by doc proto storage at the time of create.

↳ human_review Google\Cloud\DocumentAI\V1\Document\Revision\HumanReview

Human Review information of this revision.

getAgent

If the change was made by a person specify the name or id of that person.

Returns
TypeDescription
string

hasAgent

setAgent

If the change was made by a person specify the name or id of that person.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getProcessor

If the annotation was made by processor identify the processor by its resource name.

Returns
TypeDescription
string

hasProcessor

setProcessor

If the annotation was made by processor identify the processor by its resource name.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getId

Id of the revision, internally generated by doc proto storage.

Unique within the context of the document.

Returns
TypeDescription
string

setId

Id of the revision, internally generated by doc proto storage.

Unique within the context of the document.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getParent

The revisions that this revision is based on. This can include one or more parent (when documents are merged.) This field represents the index into the revisions field.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setParent

The revisions that this revision is based on. This can include one or more parent (when documents are merged.) This field represents the index into the revisions field.

Parameter
NameDescription
var int[]
Returns
TypeDescription
$this

getParentIds

The revisions that this revision is based on. Must include all the ids that have anything to do with this revision - eg. there are provenance.parent.revision fields that index into this field.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setParentIds

The revisions that this revision is based on. Must include all the ids that have anything to do with this revision - eg. there are provenance.parent.revision fields that index into this field.

Parameter
NameDescription
var string[]
Returns
TypeDescription
$this

getCreateTime

The time that the revision was created, internally generated by doc proto storage at the time of create.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

The time that the revision was created, internally generated by doc proto storage at the time of create.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getHumanReview

Human Review information of this revision.

Returns
TypeDescription
Google\Cloud\DocumentAI\V1\Document\Revision\HumanReview|null

hasHumanReview

clearHumanReview

setHumanReview

Human Review information of this revision.

Parameter
NameDescription
var Google\Cloud\DocumentAI\V1\Document\Revision\HumanReview
Returns
TypeDescription
$this

getSource

Returns
TypeDescription
string