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
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
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 |
↳ 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 |
↳ 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 | |
|---|---|
| Type | Description |
string | |
hasAgent
setAgent
If the change was made by a person specify the name or id of that person.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getProcessor
If the annotation was made by processor identify the processor by its resource name.
| Returns | |
|---|---|
| Type | Description |
string | |
hasProcessor
setProcessor
If the annotation was made by processor identify the processor by its resource name.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getId
Id of the revision, internally generated by doc proto storage.
Unique within the context of the document.
| Returns | |
|---|---|
| Type | Description |
string | |
setId
Id of the revision, internally generated by doc proto storage.
Unique within the context of the document.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
int[]
|
| Returns | |
|---|---|
| Type | Description |
$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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCreateTime
The time that the revision was created, internally generated by doc proto storage at the time of create.
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getHumanReview
Human Review information of this revision.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\DocumentAI\V1\Document\Revision\HumanReview|null | |
hasHumanReview
clearHumanReview
setHumanReview
Human Review information of this revision.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\DocumentAI\V1\Document\Revision\HumanReview
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSource
| Returns | |
|---|---|
| Type | Description |
string | |