Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: add missing doc comments #27574

Merged
merged 2 commits into from
Nov 9, 2024
Merged

docs: add missing doc comments #27574

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f2f1036
docs: add missing doc comments
gcf-owl-bot[bot] Nov 7, 2024
13addac
🦉 Updates from OwlBot post-processor
gcf-owl-bot[bot] Nov 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions google-cloud-service_health-v1/lib/google/cloud/service_health/v1/service_health/client.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -251,7 +251,8 @@ def initialize
# response. The expression takes the following forms: <br>
# * field=value for `category` and `state`<br>
# * field &lt;, >, &lt;=, or >= value for `update_time` <br>
# 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"`
# <br>
#
# Multiple filter queries are separated by spaces. Example:
Expand All @@ -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.
#
Expand Down Expand Up @@ -477,7 +478,7 @@ def get_event request, options = nil
# * field=value for `category` and `state`
# * field &lt;, >, &lt;=, 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`.
Expand Down
7 changes: 4 additions & 3 deletions ...-cloud-service_health-v1/lib/google/cloud/service_health/v1/service_health/rest/client.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -245,7 +245,8 @@ def initialize
# response. The expression takes the following forms: <br>
# * field=value for `category` and `state`<br>
# * field &lt;, >, &lt;=, or >= value for `update_time` <br>
# 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"`
# <br>
#
# Multiple filter queries are separated by spaces. Example:
Expand All @@ -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
Expand Down Expand Up @@ -456,7 +457,7 @@ def get_event request, options = nil
# * field=value for `category` and `state`
# * field &lt;, >, &lt;=, 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`.
Expand Down
6 changes: 6 additions & 0 deletions google-cloud-service_health-v1/proto_docs/google/api/client.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
18 changes: 13 additions & 5 deletions google-cloud-service_health-v1/proto_docs/google/cloud/servicehealth/v1/event_resources.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -445,7 +446,8 @@ class Asset
# response. The expression takes the following forms: <br>
# * field=value for `category` and `state`<br>
# * field &lt;, >, &lt;=, or >= value for `update_time` <br>
# 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"`
# <br>
#
# Multiple filter queries are separated by spaces. Example:
Expand All @@ -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.
Expand All @@ -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.
Expand All @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -533,7 +537,7 @@ class GetEventRequest
# * field=value for `category` and `state`
# * field &lt;, >, &lt;=, 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`.
Expand All @@ -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.
Expand All @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand Down