From 8ff9b65d479d5edf2a5f625ba879a5d348eccb9e 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 16:53:19 -0800
Subject: [PATCH] docs: add missing doc comments (#27574)
---
.../service_health/v1/service_health/client.rb | 7 ++++---
.../v1/service_health/rest/client.rb | 7 ++++---
.../proto_docs/google/api/client.rb | 6 ++++++
.../cloud/servicehealth/v1/event_resources.rb | 18 +++++++++++++-----
4 files changed, 27 insertions(+), 11 deletions(-)
diff --git a/google-cloud-service_health-v1/lib/google/cloud/service_health/v1/service_health/client.rb b/google-cloud-service_health-v1/lib/google/cloud/service_health/v1/service_health/client.rb
index 5869fde2e0d5..61dd6c331933 100644
--- a/google-cloud-service_health-v1/lib/google/cloud/service_health/v1/service_health/client.rb
+++ b/google-cloud-service_health-v1/lib/google/cloud/service_health/v1/service_health/client.rb
@@ -251,7 +251,8 @@ def initialize
# 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:
@@ -261,7 +262,7 @@ def initialize
# AND and OR expressions explicitly.
#
# Filter is supported for the following fields: `category`, `state`,
- # `update_time`
+ # `update_time`, `event_impacts.product.product_name`
# @param view [::Google::Cloud::ServiceHealth::V1::EventView]
# Optional. Event fields to include in response.
#
@@ -477,7 +478,7 @@ def get_event request, options = nil
# * 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`.
diff --git a/google-cloud-service_health-v1/lib/google/cloud/service_health/v1/service_health/rest/client.rb b/google-cloud-service_health-v1/lib/google/cloud/service_health/v1/service_health/rest/client.rb
index e9e88169467c..6acdfabcb3c9 100644
--- a/google-cloud-service_health-v1/lib/google/cloud/service_health/v1/service_health/rest/client.rb
+++ b/google-cloud-service_health-v1/lib/google/cloud/service_health/v1/service_health/rest/client.rb
@@ -245,7 +245,8 @@ def initialize
# 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:
@@ -255,7 +256,7 @@ def initialize
# AND and OR expressions explicitly.
#
# Filter is supported for the following fields: `category`, `state`,
- # `update_time`
+ # `update_time`, `event_impacts.product.product_name`
# @param view [::Google::Cloud::ServiceHealth::V1::EventView]
# Optional. Event fields to include in response.
# @yield [result, operation] Access the result along with the TransportOperation object
@@ -456,7 +457,7 @@ def get_event request, options = nil
# * 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`.
diff --git a/google-cloud-service_health-v1/proto_docs/google/api/client.rb b/google-cloud-service_health-v1/proto_docs/google/api/client.rb
index c3b5c18e4f9b..588d2e1d708d 100644
--- a/google-cloud-service_health-v1/proto_docs/google/api/client.rb
+++ b/google-cloud-service_health-v1/proto_docs/google/api/client.rb
@@ -215,6 +215,12 @@ class PythonSettings
# enabled. By default, asynchronous REST clients will not be generated.
# This feature will be enabled by default 1 month after launching the
# feature in preview packages.
+ # @!attribute [rw] protobuf_pythonic_types_enabled
+ # @return [::Boolean]
+ # Enables generation of protobuf code using new types that are more
+ # Pythonic which are included in `protobuf>=5.29.x`. This feature will be
+ # enabled by default 1 month after launching the feature in preview
+ # packages.
class ExperimentalFeatures
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
diff --git a/google-cloud-service_health-v1/proto_docs/google/cloud/servicehealth/v1/event_resources.rb b/google-cloud-service_health-v1/proto_docs/google/cloud/servicehealth/v1/event_resources.rb
index 36fe92efdacf..c5c6b78d8ef2 100644
--- a/google-cloud-service_health-v1/proto_docs/google/cloud/servicehealth/v1/event_resources.rb
+++ b/google-cloud-service_health-v1/proto_docs/google/cloud/servicehealth/v1/event_resources.rb
@@ -416,6 +416,7 @@ class Asset
extend ::Google::Protobuf::MessageExts::ClassMethods
end
+ # Message for requesting list of events.
# @!attribute [rw] parent
# @return [::String]
# Required. Parent value using the form
@@ -445,7 +446,8 @@ class Asset
# 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:
@@ -455,7 +457,7 @@ class Asset
# AND and OR expressions explicitly.
#
# Filter is supported for the following fields: `category`, `state`,
- # `update_time`
+ # `update_time`, `event_impacts.product.product_name`
# @!attribute [rw] view
# @return [::Google::Cloud::ServiceHealth::V1::EventView]
# Optional. Event fields to include in response.
@@ -464,6 +466,7 @@ class ListEventsRequest
extend ::Google::Protobuf::MessageExts::ClassMethods
end
+ # Message for response to listing events.
# @!attribute [r] events
# @return [::Array<::Google::Cloud::ServiceHealth::V1::Event>]
# Output only. List of events.
@@ -482,7 +485,7 @@ class ListEventsResponse
extend ::Google::Protobuf::MessageExts::ClassMethods
end
- # Message for getting an event
+ # Message for getting an event.
# @!attribute [rw] name
# @return [::String]
# Required. Unique name of the event in this scope including project
@@ -497,6 +500,7 @@ class GetEventRequest
extend ::Google::Protobuf::MessageExts::ClassMethods
end
+ # Message for requesting list of organization events.
# @!attribute [rw] parent
# @return [::String]
# Required. Parent value using the form
@@ -533,7 +537,7 @@ class GetEventRequest
# * 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`.
@@ -551,6 +555,7 @@ class ListOrganizationEventsRequest
extend ::Google::Protobuf::MessageExts::ClassMethods
end
+ # Message for response to listing organization events.
# @!attribute [r] organization_events
# @return [::Array<::Google::Cloud::ServiceHealth::V1::OrganizationEvent>]
# Output only. List of organization events affecting an organization.
@@ -569,6 +574,7 @@ class ListOrganizationEventsResponse
extend ::Google::Protobuf::MessageExts::ClassMethods
end
+ # Message for getting an organization event.
# @!attribute [rw] name
# @return [::String]
# Required. Unique name of the event in this scope including organization and
@@ -585,7 +591,7 @@ class GetOrganizationEventRequest
extend ::Google::Protobuf::MessageExts::ClassMethods
end
- # Message for requesting list of OrganizationImpacts
+ # Message for requesting list of organization impacts.
# @!attribute [rw] parent
# @return [::String]
# Required. Parent value using the form
@@ -637,6 +643,7 @@ class ListOrganizationImpactsRequest
extend ::Google::Protobuf::MessageExts::ClassMethods
end
+ # Message for response to listing organization impacts.
# @!attribute [r] organization_impacts
# @return [::Array<::Google::Cloud::ServiceHealth::V1::OrganizationImpact>]
# Output only. List of
@@ -657,6 +664,7 @@ class ListOrganizationImpactsResponse
extend ::Google::Protobuf::MessageExts::ClassMethods
end
+ # Message for getting an organization impact.
# @!attribute [rw] name
# @return [::String]
# Required. Name of the resource using the form