From 32a1ceed3f69637b687aa10f1efae9c11ebed1b7 Mon Sep 17 00:00:00 2001
From: "gcf-owl-bot[bot]" <78513119+gcf-owl-bot[bot]@users.noreply.github.com>
Date: Fri, 8 Nov 2024 09:59:29 -0800
Subject: [PATCH] docs: add missing doc comments (#7813)
PiperOrigin-RevId: 694016287
Source-Link: https://github.com/googleapis/googleapis/commit/eb336685e9b6ca6107745bd606f822efe7ae7262
Source-Link: https://github.com/googleapis/googleapis-gen/commit/3a07a7eef3512bfaf4f83fedbabdc42e36a418aa
Copy-Tag: eyJwIjoiU2VydmljZUhlYWx0aC8uT3dsQm90LnlhbWwiLCJoIjoiM2EwN2E3ZWVmMzUxMmJmYWY0ZjgzZmVkYmFiZGM0MmUzNmE0MThhYSJ9
---
ServiceHealth/src/V1/GetEventRequest.php | 2 +-
.../src/V1/GetOrganizationEventRequest.php | 2 ++
.../src/V1/GetOrganizationImpactRequest.php | 2 ++
ServiceHealth/src/V1/ListEventsRequest.php | 22 ++++++++++++-------
ServiceHealth/src/V1/ListEventsResponse.php | 2 ++
.../src/V1/ListOrganizationEventsRequest.php | 10 +++++----
.../src/V1/ListOrganizationEventsResponse.php | 2 ++
.../src/V1/ListOrganizationImpactsRequest.php | 2 +-
.../V1/ListOrganizationImpactsResponse.php | 2 ++
9 files changed, 32 insertions(+), 14 deletions(-)
diff --git a/ServiceHealth/src/V1/GetEventRequest.php b/ServiceHealth/src/V1/GetEventRequest.php
index b5ecac42aa75..004760acc0e2 100644
--- a/ServiceHealth/src/V1/GetEventRequest.php
+++ b/ServiceHealth/src/V1/GetEventRequest.php
@@ -9,7 +9,7 @@
use Google\Protobuf\Internal\GPBUtil;
/**
- * Message for getting an event
+ * Message for getting an event.
*
* Generated from protobuf message google.cloud.servicehealth.v1.GetEventRequest
*/
diff --git a/ServiceHealth/src/V1/GetOrganizationEventRequest.php b/ServiceHealth/src/V1/GetOrganizationEventRequest.php
index 82ae68a3cc45..a37764823ddc 100644
--- a/ServiceHealth/src/V1/GetOrganizationEventRequest.php
+++ b/ServiceHealth/src/V1/GetOrganizationEventRequest.php
@@ -9,6 +9,8 @@
use Google\Protobuf\Internal\GPBUtil;
/**
+ * Message for getting an organization event.
+ *
* Generated from protobuf message google.cloud.servicehealth.v1.GetOrganizationEventRequest
*/
class GetOrganizationEventRequest extends \Google\Protobuf\Internal\Message
diff --git a/ServiceHealth/src/V1/GetOrganizationImpactRequest.php b/ServiceHealth/src/V1/GetOrganizationImpactRequest.php
index 88296a2e0f13..b59d14adad8d 100644
--- a/ServiceHealth/src/V1/GetOrganizationImpactRequest.php
+++ b/ServiceHealth/src/V1/GetOrganizationImpactRequest.php
@@ -9,6 +9,8 @@
use Google\Protobuf\Internal\GPBUtil;
/**
+ * Message for getting an organization impact.
+ *
* Generated from protobuf message google.cloud.servicehealth.v1.GetOrganizationImpactRequest
*/
class GetOrganizationImpactRequest extends \Google\Protobuf\Internal\Message
diff --git a/ServiceHealth/src/V1/ListEventsRequest.php b/ServiceHealth/src/V1/ListEventsRequest.php
index bf67cf80eabc..e472c6fa7e9a 100644
--- a/ServiceHealth/src/V1/ListEventsRequest.php
+++ b/ServiceHealth/src/V1/ListEventsRequest.php
@@ -9,6 +9,8 @@
use Google\Protobuf\Internal\GPBUtil;
/**
+ * Message for requesting list of events.
+ *
* Generated from protobuf message google.cloud.servicehealth.v1.ListEventsRequest
*/
class ListEventsRequest extends \Google\Protobuf\Internal\Message
@@ -49,14 +51,15 @@ class ListEventsRequest extends \Google\Protobuf\Internal\Message
* response. The expression takes the following forms:
* * field=value for `category` and `state`
* * field <, >, <=, or >= value for `update_time`
- * Examples: `category=INCIDENT`, `update_time>=2000-01-01T11:30:00-04:00`
+ * Examples: `category=INCIDENT`, `update_time>="2000-01-01T11:30:00-04:00"`,
+ * `event_impacts.product.product_name:"Eventarc"`
*
* Multiple filter queries are separated by spaces. Example:
* `category=INCIDENT state=ACTIVE`.
* By default, each expression is an AND expression. However, you can include
* AND and OR expressions explicitly.
* Filter is supported for the following fields: `category`, `state`,
- * `update_time`
+ * `update_time`, `event_impacts.product.product_name`
*
* Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
*/
@@ -119,14 +122,15 @@ public static function build(string $parent): self
* response. The expression takes the following forms:
* * field=value for `category` and `state`
* * field <, >, <=, or >= value for `update_time`
- * Examples: `category=INCIDENT`, `update_time>=2000-01-01T11:30:00-04:00`
+ * Examples: `category=INCIDENT`, `update_time>="2000-01-01T11:30:00-04:00"`,
+ * `event_impacts.product.product_name:"Eventarc"`
*
* Multiple filter queries are separated by spaces. Example:
* `category=INCIDENT state=ACTIVE`.
* By default, each expression is an AND expression. However, you can include
* AND and OR expressions explicitly.
* Filter is supported for the following fields: `category`, `state`,
- * `update_time`
+ * `update_time`, `event_impacts.product.product_name`
* @type int $view
* Optional. Event fields to include in response.
* }
@@ -245,14 +249,15 @@ public function setPageToken($var)
* response. The expression takes the following forms:
* * field=value for `category` and `state`
* * field <, >, <=, or >= value for `update_time`
- * Examples: `category=INCIDENT`, `update_time>=2000-01-01T11:30:00-04:00`
+ * Examples: `category=INCIDENT`, `update_time>="2000-01-01T11:30:00-04:00"`,
+ * `event_impacts.product.product_name:"Eventarc"`
*
* Multiple filter queries are separated by spaces. Example:
* `category=INCIDENT state=ACTIVE`.
* By default, each expression is an AND expression. However, you can include
* AND and OR expressions explicitly.
* Filter is supported for the following fields: `category`, `state`,
- * `update_time`
+ * `update_time`, `event_impacts.product.product_name`
*
* Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
* @return string
@@ -267,14 +272,15 @@ public function getFilter()
* response. The expression takes the following forms:
* * field=value for `category` and `state`
* * field <, >, <=, or >= value for `update_time`
- * Examples: `category=INCIDENT`, `update_time>=2000-01-01T11:30:00-04:00`
+ * Examples: `category=INCIDENT`, `update_time>="2000-01-01T11:30:00-04:00"`,
+ * `event_impacts.product.product_name:"Eventarc"`
*
* Multiple filter queries are separated by spaces. Example:
* `category=INCIDENT state=ACTIVE`.
* By default, each expression is an AND expression. However, you can include
* AND and OR expressions explicitly.
* Filter is supported for the following fields: `category`, `state`,
- * `update_time`
+ * `update_time`, `event_impacts.product.product_name`
*
* Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
* @param string $var
diff --git a/ServiceHealth/src/V1/ListEventsResponse.php b/ServiceHealth/src/V1/ListEventsResponse.php
index d08be4ba84e3..789e8058ce9b 100644
--- a/ServiceHealth/src/V1/ListEventsResponse.php
+++ b/ServiceHealth/src/V1/ListEventsResponse.php
@@ -9,6 +9,8 @@
use Google\Protobuf\Internal\GPBUtil;
/**
+ * Message for response to listing events.
+ *
* Generated from protobuf message google.cloud.servicehealth.v1.ListEventsResponse
*/
class ListEventsResponse extends \Google\Protobuf\Internal\Message
diff --git a/ServiceHealth/src/V1/ListOrganizationEventsRequest.php b/ServiceHealth/src/V1/ListOrganizationEventsRequest.php
index ff2ded5a3686..4030fc692bf3 100644
--- a/ServiceHealth/src/V1/ListOrganizationEventsRequest.php
+++ b/ServiceHealth/src/V1/ListOrganizationEventsRequest.php
@@ -9,6 +9,8 @@
use Google\Protobuf\Internal\GPBUtil;
/**
+ * Message for requesting list of organization events.
+ *
* Generated from protobuf message google.cloud.servicehealth.v1.ListOrganizationEventsRequest
*/
class ListOrganizationEventsRequest extends \Google\Protobuf\Internal\Message
@@ -52,7 +54,7 @@ class ListOrganizationEventsRequest extends \Google\Protobuf\Internal\Message
* response. The expression takes the following forms:
* * field=value for `category` and `state`
* * field <, >, <=, or >= value for `update_time`
- * Examples: `category=INCIDENT`, `update_time>=2000-01-01T11:30:00-04:00`
+ * Examples: `category=INCIDENT`, `update_time>="2000-01-01T11:30:00-04:00"`
* Multiple filter queries are space-separated. Example:
* `category=INCIDENT state=ACTIVE`.
* By default, each expression is an AND expression. However, you can include
@@ -126,7 +128,7 @@ public static function build(string $parent): self
* response. The expression takes the following forms:
* * field=value for `category` and `state`
* * field <, >, <=, or >= value for `update_time`
- * Examples: `category=INCIDENT`, `update_time>=2000-01-01T11:30:00-04:00`
+ * Examples: `category=INCIDENT`, `update_time>="2000-01-01T11:30:00-04:00"`
* Multiple filter queries are space-separated. Example:
* `category=INCIDENT state=ACTIVE`.
* By default, each expression is an AND expression. However, you can include
@@ -257,7 +259,7 @@ public function setPageToken($var)
* response. The expression takes the following forms:
* * field=value for `category` and `state`
* * field <, >, <=, or >= value for `update_time`
- * Examples: `category=INCIDENT`, `update_time>=2000-01-01T11:30:00-04:00`
+ * Examples: `category=INCIDENT`, `update_time>="2000-01-01T11:30:00-04:00"`
* Multiple filter queries are space-separated. Example:
* `category=INCIDENT state=ACTIVE`.
* By default, each expression is an AND expression. However, you can include
@@ -278,7 +280,7 @@ public function getFilter()
* response. The expression takes the following forms:
* * field=value for `category` and `state`
* * field <, >, <=, or >= value for `update_time`
- * Examples: `category=INCIDENT`, `update_time>=2000-01-01T11:30:00-04:00`
+ * Examples: `category=INCIDENT`, `update_time>="2000-01-01T11:30:00-04:00"`
* Multiple filter queries are space-separated. Example:
* `category=INCIDENT state=ACTIVE`.
* By default, each expression is an AND expression. However, you can include
diff --git a/ServiceHealth/src/V1/ListOrganizationEventsResponse.php b/ServiceHealth/src/V1/ListOrganizationEventsResponse.php
index 42cf762ec82b..59d09784b595 100644
--- a/ServiceHealth/src/V1/ListOrganizationEventsResponse.php
+++ b/ServiceHealth/src/V1/ListOrganizationEventsResponse.php
@@ -9,6 +9,8 @@
use Google\Protobuf\Internal\GPBUtil;
/**
+ * Message for response to listing organization events.
+ *
* Generated from protobuf message google.cloud.servicehealth.v1.ListOrganizationEventsResponse
*/
class ListOrganizationEventsResponse extends \Google\Protobuf\Internal\Message
diff --git a/ServiceHealth/src/V1/ListOrganizationImpactsRequest.php b/ServiceHealth/src/V1/ListOrganizationImpactsRequest.php
index cbd2ee6ef404..17794a7c3733 100644
--- a/ServiceHealth/src/V1/ListOrganizationImpactsRequest.php
+++ b/ServiceHealth/src/V1/ListOrganizationImpactsRequest.php
@@ -9,7 +9,7 @@
use Google\Protobuf\Internal\GPBUtil;
/**
- * Message for requesting list of OrganizationImpacts
+ * Message for requesting list of organization impacts.
*
* Generated from protobuf message google.cloud.servicehealth.v1.ListOrganizationImpactsRequest
*/
diff --git a/ServiceHealth/src/V1/ListOrganizationImpactsResponse.php b/ServiceHealth/src/V1/ListOrganizationImpactsResponse.php
index 077d67bdcc75..d63cff8ba58a 100644
--- a/ServiceHealth/src/V1/ListOrganizationImpactsResponse.php
+++ b/ServiceHealth/src/V1/ListOrganizationImpactsResponse.php
@@ -9,6 +9,8 @@
use Google\Protobuf\Internal\GPBUtil;
/**
+ * Message for response to listing organization impacts.
+ *
* Generated from protobuf message google.cloud.servicehealth.v1.ListOrganizationImpactsResponse
*/
class ListOrganizationImpactsResponse extends \Google\Protobuf\Internal\Message