From e2cee2d72b86ed4c4e55ffa27be692eed19ab02f Mon Sep 17 00:00:00 2001
From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com>
Date: Wed, 15 May 2024 12:29:12 -0700
Subject: [PATCH] docs: clarify the unavailability of some features (#7312)
chore: field behavior annotations in processor.proto
PiperOrigin-RevId: 633834640
Source-Link: https://github.com/googleapis/googleapis/commit/ca6e6eb9631c42cd2eb51358af4afa7883d4b69b
Source-Link: https://github.com/googleapis/googleapis-gen/commit/017e306f0dcd7936f87e2d7b2a9339da87910e92
Copy-Tag: eyJwIjoiRG9jdW1lbnRBaS8uT3dsQm90LnlhbWwiLCJoIjoiMDE3ZTMwNmYwZGNkNzkzNmY4N2UyZDdiMmE5MzM5ZGE4NzkxMGU5MiJ9
---
DocumentAi/metadata/V1/Processor.php | Bin 3214 -> 3224 bytes
.../src/V1/Document/Page/Token/StyleInfo.php | 32 +++++++++---------
DocumentAi/src/V1/ProcessorVersion.php | 28 +++++++--------
3 files changed, 30 insertions(+), 30 deletions(-)
diff --git a/DocumentAi/metadata/V1/Processor.php b/DocumentAi/metadata/V1/Processor.php
index 91dba5bd5dd402f2a07246cba8c4618011d71316..a6db10d83a8e0e4c192f36464bf043082f57c9ce 100644
GIT binary patch
delta 84
zcmeB^oFTbEiJ4`M5SP|OZ>`Az%sbRyb8ra+6y+zU78mCig{2l1XXfV#339RICFZ6|
mFe)%=a5^zRaO9Y*#S+8lHo2X}krl*eo@~iwwD}jy6m|eIZ5Yx3
delta 73
zcmbOs*(bR{iJ4`Q5SP|OZ>`Az%sZ4Ga&QR*6y+zU78mCig{2l1XXfV#@o=%^CFZ6|
dFe)%=a8A}|iD7h{+{5BH*_q2|GYjh!b^tIJ6!HK7
diff --git a/DocumentAi/src/V1/Document/Page/Token/StyleInfo.php b/DocumentAi/src/V1/Document/Page/Token/StyleInfo.php
index c86a19f223c..64987a93044 100644
--- a/DocumentAi/src/V1/Document/Page/Token/StyleInfo.php
+++ b/DocumentAi/src/V1/Document/Page/Token/StyleInfo.php
@@ -62,25 +62,25 @@ class StyleInfo extends \Google\Protobuf\Internal\Message
*/
private $underlined = false;
/**
- * Whether the text is strikethrough.
+ * Whether the text is strikethrough. This feature is not supported yet.
*
* Generated from protobuf field bool strikeout = 8;
*/
private $strikeout = false;
/**
- * Whether the text is a subscript.
+ * Whether the text is a subscript. This feature is not supported yet.
*
* Generated from protobuf field bool subscript = 9;
*/
private $subscript = false;
/**
- * Whether the text is a superscript.
+ * Whether the text is a superscript. This feature is not supported yet.
*
* Generated from protobuf field bool superscript = 10;
*/
private $superscript = false;
/**
- * Whether the text is in small caps.
+ * Whether the text is in small caps. This feature is not supported yet.
*
* Generated from protobuf field bool smallcaps = 11;
*/
@@ -136,13 +136,13 @@ class StyleInfo extends \Google\Protobuf\Internal\Message
* @type bool $underlined
* Whether the text is underlined.
* @type bool $strikeout
- * Whether the text is strikethrough.
+ * Whether the text is strikethrough. This feature is not supported yet.
* @type bool $subscript
- * Whether the text is a subscript.
+ * Whether the text is a subscript. This feature is not supported yet.
* @type bool $superscript
- * Whether the text is a superscript.
+ * Whether the text is a superscript. This feature is not supported yet.
* @type bool $smallcaps
- * Whether the text is in small caps.
+ * Whether the text is in small caps. This feature is not supported yet.
* @type int $font_weight
* TrueType weight on a scale `100` (thin) to `1000` (ultra-heavy).
* Normal is `400`, bold is `700`.
@@ -350,7 +350,7 @@ public function setUnderlined($var)
}
/**
- * Whether the text is strikethrough.
+ * Whether the text is strikethrough. This feature is not supported yet.
*
* Generated from protobuf field bool strikeout = 8;
* @return bool
@@ -361,7 +361,7 @@ public function getStrikeout()
}
/**
- * Whether the text is strikethrough.
+ * Whether the text is strikethrough. This feature is not supported yet.
*
* Generated from protobuf field bool strikeout = 8;
* @param bool $var
@@ -376,7 +376,7 @@ public function setStrikeout($var)
}
/**
- * Whether the text is a subscript.
+ * Whether the text is a subscript. This feature is not supported yet.
*
* Generated from protobuf field bool subscript = 9;
* @return bool
@@ -387,7 +387,7 @@ public function getSubscript()
}
/**
- * Whether the text is a subscript.
+ * Whether the text is a subscript. This feature is not supported yet.
*
* Generated from protobuf field bool subscript = 9;
* @param bool $var
@@ -402,7 +402,7 @@ public function setSubscript($var)
}
/**
- * Whether the text is a superscript.
+ * Whether the text is a superscript. This feature is not supported yet.
*
* Generated from protobuf field bool superscript = 10;
* @return bool
@@ -413,7 +413,7 @@ public function getSuperscript()
}
/**
- * Whether the text is a superscript.
+ * Whether the text is a superscript. This feature is not supported yet.
*
* Generated from protobuf field bool superscript = 10;
* @param bool $var
@@ -428,7 +428,7 @@ public function setSuperscript($var)
}
/**
- * Whether the text is in small caps.
+ * Whether the text is in small caps. This feature is not supported yet.
*
* Generated from protobuf field bool smallcaps = 11;
* @return bool
@@ -439,7 +439,7 @@ public function getSmallcaps()
}
/**
- * Whether the text is in small caps.
+ * Whether the text is in small caps. This feature is not supported yet.
*
* Generated from protobuf field bool smallcaps = 11;
* @param bool $var
diff --git a/DocumentAi/src/V1/ProcessorVersion.php b/DocumentAi/src/V1/ProcessorVersion.php
index f743ace094d..224507b3f28 100644
--- a/DocumentAi/src/V1/ProcessorVersion.php
+++ b/DocumentAi/src/V1/ProcessorVersion.php
@@ -19,11 +19,11 @@
class ProcessorVersion extends \Google\Protobuf\Internal\Message
{
/**
- * The resource name of the processor version.
+ * Identifier. The resource name of the processor version.
* Format:
* `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}`
*
- * Generated from protobuf field string name = 1;
+ * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
*/
private $name = '';
/**
@@ -39,9 +39,9 @@ class ProcessorVersion extends \Google\Protobuf\Internal\Message
*/
private $document_schema = null;
/**
- * The state of the processor version.
+ * Output only. The state of the processor version.
*
- * Generated from protobuf field .google.cloud.documentai.v1.ProcessorVersion.State state = 6;
+ * Generated from protobuf field .google.cloud.documentai.v1.ProcessorVersion.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
*/
private $state = 0;
/**
@@ -94,7 +94,7 @@ class ProcessorVersion extends \Google\Protobuf\Internal\Message
* Optional. Data for populating the Message object.
*
* @type string $name
- * The resource name of the processor version.
+ * Identifier. The resource name of the processor version.
* Format:
* `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}`
* @type string $display_name
@@ -102,7 +102,7 @@ class ProcessorVersion extends \Google\Protobuf\Internal\Message
* @type \Google\Cloud\DocumentAI\V1\DocumentSchema $document_schema
* The schema of the processor version. Describes the output.
* @type int $state
- * The state of the processor version.
+ * Output only. The state of the processor version.
* @type \Google\Protobuf\Timestamp $create_time
* The time the processor version was created.
* @type \Google\Cloud\DocumentAI\V1\EvaluationReference $latest_evaluation
@@ -125,11 +125,11 @@ public function __construct($data = NULL) {
}
/**
- * The resource name of the processor version.
+ * Identifier. The resource name of the processor version.
* Format:
* `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}`
*
- * Generated from protobuf field string name = 1;
+ * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
* @return string
*/
public function getName()
@@ -138,11 +138,11 @@ public function getName()
}
/**
- * The resource name of the processor version.
+ * Identifier. The resource name of the processor version.
* Format:
* `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}`
*
- * Generated from protobuf field string name = 1;
+ * Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
* @param string $var
* @return $this
*/
@@ -217,9 +217,9 @@ public function setDocumentSchema($var)
}
/**
- * The state of the processor version.
+ * Output only. The state of the processor version.
*
- * Generated from protobuf field .google.cloud.documentai.v1.ProcessorVersion.State state = 6;
+ * Generated from protobuf field .google.cloud.documentai.v1.ProcessorVersion.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @return int
*/
public function getState()
@@ -228,9 +228,9 @@ public function getState()
}
/**
- * The state of the processor version.
+ * Output only. The state of the processor version.
*
- * Generated from protobuf field .google.cloud.documentai.v1.ProcessorVersion.State state = 6;
+ * Generated from protobuf field .google.cloud.documentai.v1.ProcessorVersion.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
* @param int $var
* @return $this
*/