From 2bd2f093e7fc2798d6646c2f8627c47a864f3d05 Mon Sep 17 00:00:00 2001 From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com> Date: Fri, 13 Sep 2024 14:36:56 -0600 Subject: [PATCH] docs: [Asset] Comments are clarified for certain fields in messages `QueryAssetsResponse` and `ResourceSearchResult` (#7666) PiperOrigin-RevId: 673500457 Source-Link: https://github.com/googleapis/googleapis/commit/c27097ea636b7b2699f1a1c9c6bf3fb66ff8a789 Source-Link: https://github.com/googleapis/googleapis-gen/commit/dd6d5ed8b59764109b996ba6895dd10be1c8b865 Copy-Tag: eyJwIjoiQXNzZXQvLk93bEJvdC55YW1sIiwiaCI6ImRkNmQ1ZWQ4YjU5NzY0MTA5Yjk5NmJhNjg5NWRkMTBiZTFjOGI4NjUifQ== --- Asset/src/V1/QueryAssetsResponse.php | 31 ++++++++++++++++++--------- Asset/src/V1/ResourceSearchResult.php | 17 +++++++-------- 2 files changed, 29 insertions(+), 19 deletions(-) diff --git a/Asset/src/V1/QueryAssetsResponse.php b/Asset/src/V1/QueryAssetsResponse.php index 83ba9ac9ad0a..cc23eb77115b 100644 --- a/Asset/src/V1/QueryAssetsResponse.php +++ b/Asset/src/V1/QueryAssetsResponse.php @@ -23,10 +23,12 @@ class QueryAssetsResponse extends \Google\Protobuf\Internal\Message protected $job_reference = ''; /** * The query response, which can be either an `error` or a valid `response`. - * If `done` == `false` and the query result is being saved in a output, the + * If `done` == `false` and the query result is being saved in an output, the * output_config field will be set. * If `done` == `true`, exactly one of * `error`, `query_result` or `output_config` will be set. + * [done] is unset unless the [QueryAssetsResponse] contains a + * [QueryAssetsResponse.job_reference]. * * Generated from protobuf field bool done = 2; */ @@ -43,17 +45,20 @@ class QueryAssetsResponse extends \Google\Protobuf\Internal\Message * Reference to a query job. * @type bool $done * The query response, which can be either an `error` or a valid `response`. - * If `done` == `false` and the query result is being saved in a output, the + * If `done` == `false` and the query result is being saved in an output, the * output_config field will be set. * If `done` == `true`, exactly one of * `error`, `query_result` or `output_config` will be set. + * [done] is unset unless the [QueryAssetsResponse] contains a + * [QueryAssetsResponse.job_reference]. * @type \Google\Rpc\Status $error * Error status. * @type \Google\Cloud\Asset\V1\QueryResult $query_result * Result of the query. * @type \Google\Cloud\Asset\V1\QueryAssetsOutputConfig $output_config - * Output configuration which indicates instead of being returned in API - * response on the fly, the query result will be saved in a specific output. + * Output configuration, which indicates that instead of being returned in + * an API response on the fly, the query result will be saved in a specific + * output. * } */ public function __construct($data = NULL) { @@ -89,10 +94,12 @@ public function setJobReference($var) /** * The query response, which can be either an `error` or a valid `response`. - * If `done` == `false` and the query result is being saved in a output, the + * If `done` == `false` and the query result is being saved in an output, the * output_config field will be set. * If `done` == `true`, exactly one of * `error`, `query_result` or `output_config` will be set. + * [done] is unset unless the [QueryAssetsResponse] contains a + * [QueryAssetsResponse.job_reference]. * * Generated from protobuf field bool done = 2; * @return bool @@ -104,10 +111,12 @@ public function getDone() /** * The query response, which can be either an `error` or a valid `response`. - * If `done` == `false` and the query result is being saved in a output, the + * If `done` == `false` and the query result is being saved in an output, the * output_config field will be set. * If `done` == `true`, exactly one of * `error`, `query_result` or `output_config` will be set. + * [done] is unset unless the [QueryAssetsResponse] contains a + * [QueryAssetsResponse.job_reference]. * * Generated from protobuf field bool done = 2; * @param bool $var @@ -184,8 +193,9 @@ public function setQueryResult($var) } /** - * Output configuration which indicates instead of being returned in API - * response on the fly, the query result will be saved in a specific output. + * Output configuration, which indicates that instead of being returned in + * an API response on the fly, the query result will be saved in a specific + * output. * * Generated from protobuf field .google.cloud.asset.v1.QueryAssetsOutputConfig output_config = 5; * @return \Google\Cloud\Asset\V1\QueryAssetsOutputConfig|null @@ -201,8 +211,9 @@ public function hasOutputConfig() } /** - * Output configuration which indicates instead of being returned in API - * response on the fly, the query result will be saved in a specific output. + * Output configuration, which indicates that instead of being returned in + * an API response on the fly, the query result will be saved in a specific + * output. * * Generated from protobuf field .google.cloud.asset.v1.QueryAssetsOutputConfig output_config = 5; * @param \Google\Cloud\Asset\V1\QueryAssetsOutputConfig $var diff --git a/Asset/src/V1/ResourceSearchResult.php b/Asset/src/V1/ResourceSearchResult.php index e6d76c71b73c..1ff1be739f9c 100644 --- a/Asset/src/V1/ResourceSearchResult.php +++ b/Asset/src/V1/ResourceSearchResult.php @@ -10,7 +10,6 @@ /** * A result of Resource Search, containing information of a cloud resource. - * Next ID: 34 * * Generated from protobuf message google.cloud.asset.v1.ResourceSearchResult */ @@ -106,8 +105,8 @@ class ResourceSearchResult extends \Google\Protobuf\Internal\Message */ protected $location = ''; /** - * Labels associated with this resource. See [Labelling and grouping Google - * Cloud + * User labels associated with this resource. See [Labelling and grouping + * Google Cloud * resources](https://cloud.google.com/blog/products/gcp/labelling-and-grouping-your-google-cloud-platform-resources) * for more information. This field is available only when the resource's * Protobuf contains it. @@ -459,8 +458,8 @@ class ResourceSearchResult extends \Google\Protobuf\Internal\Message * * Use a field query. Example: `location:us-west*` * * Use a free text query. Example: `us-west*` * @type array|\Google\Protobuf\Internal\MapField $labels - * Labels associated with this resource. See [Labelling and grouping Google - * Cloud + * User labels associated with this resource. See [Labelling and grouping + * Google Cloud * resources](https://cloud.google.com/blog/products/gcp/labelling-and-grouping-your-google-cloud-platform-resources) * for more information. This field is available only when the resource's * Protobuf contains it. @@ -965,8 +964,8 @@ public function setLocation($var) } /** - * Labels associated with this resource. See [Labelling and grouping Google - * Cloud + * User labels associated with this resource. See [Labelling and grouping + * Google Cloud * resources](https://cloud.google.com/blog/products/gcp/labelling-and-grouping-your-google-cloud-platform-resources) * for more information. This field is available only when the resource's * Protobuf contains it. @@ -986,8 +985,8 @@ public function getLabels() } /** - * Labels associated with this resource. See [Labelling and grouping Google - * Cloud + * User labels associated with this resource. See [Labelling and grouping + * Google Cloud * resources](https://cloud.google.com/blog/products/gcp/labelling-and-grouping-your-google-cloud-platform-resources) * for more information. This field is available only when the resource's * Protobuf contains it.