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

[CHANGE ME] Re-generated google-cloud-monitoring to pick up changes in the API or client library generator. #4827

Merged
merged 1 commit into from Feb 17, 2020
Merged

[CHANGE ME] Re-generated google-cloud-monitoring to pick up changes in the API or client library generator. #4827

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
24 changes: 13 additions & 11 deletions google-cloud-monitoring/lib/google/cloud/monitoring/v3/alert_policy_service_client.rb
View file
Open in desktop
Expand Up @@ -286,9 +286,9 @@ def initialize \
# Lists the existing alerting policies for the project.
#
# @param name [String]
# Required. The project whose alert policies are to be listed. The format is
# Required. The project whose alert policies are to be listed. The format is:
#
# projects/[PROJECT_ID]
# projects/[PROJECT_ID_OR_NUMBER]
#
# Note that this field names the parent container in which the alerting
# policies to be listed are stored. To retrieve a single alerting policy
Expand All @@ -300,14 +300,14 @@ def initialize \
# alert policies to be included in the response.
#
# For more details, see [sorting and
# filtering](/monitoring/api/v3/sorting-and-filtering).
# filtering](https://cloud.google.com/monitoring/api/v3/sorting-and-filtering).
# @param order_by [String]
# A comma-separated list of fields by which to sort the result. Supports
# the same set of field references as the `filter` field. Entries can be
# prefixed with a minus sign to sort by the field in descending order.
#
# For more details, see [sorting and
# filtering](/monitoring/api/v3/sorting-and-filtering).
# filtering](https://cloud.google.com/monitoring/api/v3/sorting-and-filtering).
# @param page_size [Integer]
# The maximum number of resources contained in the underlying API
# response. If page streaming is performed per-resource, this
Expand Down Expand Up @@ -365,9 +365,9 @@ def list_alert_policies \
# Gets a single alerting policy.
#
# @param name [String]
# Required. The alerting policy to retrieve. The format is
# Required. The alerting policy to retrieve. The format is:
#
# projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID]
# projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID]
# @param options [Google::Gax::CallOptions]
# Overrides the default settings for this call, e.g, timeout,
# retries, etc.
Expand Down Expand Up @@ -397,18 +397,20 @@ def get_alert_policy \
# Creates a new alerting policy.
#
# @param name [String]
# Required. The project in which to create the alerting policy. The format is
# `projects/[PROJECT_ID]`.
# Required. The project in which to create the alerting policy. The format is:
#
# projects/[PROJECT_ID_OR_NUMBER]
#
# Note that this field names the parent container in which the alerting
# policy will be written, not the name of the created policy. The alerting
# policy that is returned will have a name that contains a normalized
# representation of this name as a prefix but adds a suffix of the form
# `/alertPolicies/[POLICY_ID]`, identifying the policy in the container.
# `/alertPolicies/[ALERT_POLICY_ID]`, identifying the policy in the
# container.
# @param alert_policy [Google::Monitoring::V3::AlertPolicy | Hash]
# Required. The requested alerting policy. You should omit the `name` field in this
# policy. The name will be returned in the new policy, including
# a new [ALERT_POLICY_ID] value.
# a new `[ALERT_POLICY_ID]` value.
# A hash of the same form as `Google::Monitoring::V3::AlertPolicy`
# can also be provided.
# @param options [Google::Gax::CallOptions]
Expand Down Expand Up @@ -447,7 +449,7 @@ def create_alert_policy \
# @param name [String]
# Required. The alerting policy to delete. The format is:
#
# projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID]
# projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID]
#
# For more information, see {Google::Monitoring::V3::AlertPolicy AlertPolicy}.
# @param options [Google::Gax::CallOptions]
Expand Down
32 changes: 16 additions & 16 deletions google-cloud-monitoring/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/alert.rb
View file
Open in desktop
Expand Up @@ -23,9 +23,9 @@ module V3
# @!attribute [rw] name
# @return [String]
# Required if the policy exists. The resource name for this policy. The
# syntax is:
# format is:
#
# projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID]
# projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID]
#
# `[ALERT_POLICY_ID]` is assigned by Stackdriver Monitoring when the policy
# is created. When calling the
Expand Down Expand Up @@ -60,14 +60,14 @@ module V3
# OR according to the `combiner` field. If the combined conditions evaluate
# to true, then an incident is created. A policy can have from one to six
# conditions.
# If |condition_time_series_uery_language| is present, it must be the only
# |condition|.
# If `condition_time_series_query_language` is present, it must be the only
# `condition`.
# @!attribute [rw] combiner
# @return [Google::Monitoring::V3::AlertPolicy::ConditionCombinerType]
# How to combine the results of multiple conditions to determine if an
# incident should be opened.
# If condition_time_series_query_language is present, this must be
# COMBINE_UNSPECIFIED.
# If `condition_time_series_query_language` is present, this must be
# `COMBINE_UNSPECIFIED`.
# @!attribute [rw] enabled
# @return [Google::Protobuf::BoolValue]
# Whether or not the policy is enabled. On write, the default interpretation
Expand All @@ -88,9 +88,9 @@ module V3
# {Google::Monitoring::V3::NotificationChannel `NotificationChannel`}
# objects that are returned from the [`ListNotificationChannels`]
# [google.monitoring.v3.NotificationChannelService.ListNotificationChannels]
# method. The syntax of the entries in this field is:
# method. The format of the entries in this field is:
#
# projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID]
# projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID]
# @!attribute [rw] creation_record
# @return [Google::Monitoring::V3::MutationRecord]
# A read-only record of the creation of the alerting policy. If provided
Expand Down Expand Up @@ -121,9 +121,9 @@ class Documentation; end
# @!attribute [rw] name
# @return [String]
# Required if the condition exists. The unique resource name for this
# condition. Its syntax is:
# condition. Its format is:
#
# projects/[PROJECT_ID]/alertPolicies/[POLICY_ID]/conditions/[CONDITION_ID]
# projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[POLICY_ID]/conditions/[CONDITION_ID]
#
# `[CONDITION_ID]` is assigned by Stackdriver Monitoring when the
# condition is created as part of a new or updated alerting policy.
Expand Down Expand Up @@ -199,11 +199,11 @@ class Trigger; end
# field.
# @!attribute [rw] denominator_filter
# @return [String]
# A [filter](https://cloud.google.com/monitoring/api/v3/filters) that identifies a time
# series that should be used as the denominator of a ratio that will be
# compared with the threshold. If a `denominator_filter` is specified,
# the time series specified by the `filter` field will be used as the
# numerator.
# A [filter](https://cloud.google.com/monitoring/api/v3/filters) that
# identifies a time series that should be used as the denominator of a
# ratio that will be compared with the threshold. If a
# `denominator_filter` is specified, the time series specified by the
# `filter` field will be used as the numerator.
#
# The filter must specify the metric type and optionally may contain
# restrictions on resource type, resource labels, and metric labels.
Expand Down Expand Up @@ -306,7 +306,7 @@ module ConditionCombinerType
COMBINE_UNSPECIFIED = 0

# Combine conditions using the logical `AND` operator. An
# incident is created only if all conditions are met
# incident is created only if all the conditions are met
# simultaneously. This combiner is satisfied if all conditions are
# met, even if they are met on completely different resources.
AND = 1
Expand Down
26 changes: 14 additions & 12 deletions ...cloud-monitoring/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/alert_service.rb
View file
Open in desktop
Expand Up @@ -19,35 +19,37 @@ module V3
# The protocol for the `CreateAlertPolicy` request.
# @!attribute [rw] name
# @return [String]
# Required. The project in which to create the alerting policy. The format is
# `projects/[PROJECT_ID]`.
# Required. The project in which to create the alerting policy. The format is:
#
# projects/[PROJECT_ID_OR_NUMBER]
#
# Note that this field names the parent container in which the alerting
# policy will be written, not the name of the created policy. The alerting
# policy that is returned will have a name that contains a normalized
# representation of this name as a prefix but adds a suffix of the form
# `/alertPolicies/[POLICY_ID]`, identifying the policy in the container.
# `/alertPolicies/[ALERT_POLICY_ID]`, identifying the policy in the
# container.
# @!attribute [rw] alert_policy
# @return [Google::Monitoring::V3::AlertPolicy]
# Required. The requested alerting policy. You should omit the `name` field in this
# policy. The name will be returned in the new policy, including
# a new [ALERT_POLICY_ID] value.
# a new `[ALERT_POLICY_ID]` value.
class CreateAlertPolicyRequest; end

# The protocol for the `GetAlertPolicy` request.
# @!attribute [rw] name
# @return [String]
# Required. The alerting policy to retrieve. The format is
# Required. The alerting policy to retrieve. The format is:
#
# projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID]
# projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID]
class GetAlertPolicyRequest; end

# The protocol for the `ListAlertPolicies` request.
# @!attribute [rw] name
# @return [String]
# Required. The project whose alert policies are to be listed. The format is
# Required. The project whose alert policies are to be listed. The format is:
#
# projects/[PROJECT_ID]
# projects/[PROJECT_ID_OR_NUMBER]
#
# Note that this field names the parent container in which the alerting
# policies to be listed are stored. To retrieve a single alerting policy
Expand All @@ -60,15 +62,15 @@ class GetAlertPolicyRequest; end
# alert policies to be included in the response.
#
# For more details, see [sorting and
# filtering](/monitoring/api/v3/sorting-and-filtering).
# filtering](https://cloud.google.com/monitoring/api/v3/sorting-and-filtering).
# @!attribute [rw] order_by
# @return [String]
# A comma-separated list of fields by which to sort the result. Supports
# the same set of field references as the `filter` field. Entries can be
# prefixed with a minus sign to sort by the field in descending order.
#
# For more details, see [sorting and
# filtering](/monitoring/api/v3/sorting-and-filtering).
# filtering](https://cloud.google.com/monitoring/api/v3/sorting-and-filtering).
# @!attribute [rw] page_size
# @return [Integer]
# The maximum number of results to return in a single response.
Expand All @@ -87,7 +89,7 @@ class ListAlertPoliciesRequest; end
# @return [String]
# If there might be more results than were returned, then this field is set
# to a non-empty value. To see the additional results,
# use that value as `pageToken` in the next call to this method.
# use that value as `page_token` in the next call to this method.
class ListAlertPoliciesResponse; end

# The protocol for the `UpdateAlertPolicy` request.
Expand Down Expand Up @@ -127,7 +129,7 @@ class UpdateAlertPolicyRequest; end
# @return [String]
# Required. The alerting policy to delete. The format is:
#
# projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID]
# projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID]
#
# For more information, see {Google::Monitoring::V3::AlertPolicy AlertPolicy}.
class DeleteAlertPolicyRequest; end
Expand Down
65 changes: 40 additions & 25 deletions ...cloud-monitoring/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/group_service.rb
View file
Open in desktop
Expand Up @@ -19,32 +19,42 @@ module V3
# The `ListGroup` request.
# @!attribute [rw] name
# @return [String]
# Required. The project whose groups are to be listed. The format is
# `"projects/{project_id_or_number}"`.
# Required. The project whose groups are to be listed. The format is:
#
# projects/[PROJECT_ID_OR_NUMBER]
# @!attribute [rw] children_of_group
# @return [String]
# A group name: `"projects/{project_id_or_number}/groups/{group_id}"`.
# Returns groups whose `parentName` field contains the group
# A group name. The format is:
#
# projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]
#
# Returns groups whose `parent_name` field contains the group
# name. If no groups have this parent, the results are empty.
# @!attribute [rw] ancestors_of_group
# @return [String]
# A group name: `"projects/{project_id_or_number}/groups/{group_id}"`.
# A group name. The format is:
#
# projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]
#
# Returns groups that are ancestors of the specified group.
# The groups are returned in order, starting with the immediate parent and
# ending with the most distant ancestor. If the specified group has no
# immediate parent, the results are empty.
# @!attribute [rw] descendants_of_group
# @return [String]
# A group name: `"projects/{project_id_or_number}/groups/{group_id}"`.
# A group name. The format is:
#
# projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]
#
# Returns the descendants of the specified group. This is a superset of
# the results returned by the `childrenOfGroup` filter, and includes
# the results returned by the `children_of_group` filter, and includes
# children-of-children, and so forth.
# @!attribute [rw] page_size
# @return [Integer]
# A positive number that is the maximum number of results to return.
# @!attribute [rw] page_token
# @return [String]
# If this field is not empty then it must contain the `nextPageToken` value
# If this field is not empty then it must contain the `next_page_token` value
# returned by a previous call to this method. Using this field causes the
# method to return additional results from the previous method call.
class ListGroupsRequest; end
Expand All @@ -57,21 +67,23 @@ class ListGroupsRequest; end
# @return [String]
# If there are more results than have been returned, then this field is set
# to a non-empty value. To see the additional results,
# use that value as `pageToken` in the next call to this method.
# use that value as `page_token` in the next call to this method.
class ListGroupsResponse; end

# The `GetGroup` request.
# @!attribute [rw] name
# @return [String]
# Required. The group to retrieve. The format is
# `"projects/{project_id_or_number}/groups/{group_id}"`.
# Required. The group to retrieve. The format is:
#
# projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]
class GetGroupRequest; end

# The `CreateGroup` request.
# @!attribute [rw] name
# @return [String]
# Required. The project in which to create the group. The format is
# `"projects/{project_id_or_number}"`.
# Required. The project in which to create the group. The format is:
#
# projects/[PROJECT_ID_OR_NUMBER]
# @!attribute [rw] group
# @return [Google::Monitoring::V3::Group]
# Required. A group definition. It is an error to define the `name` field because
Expand All @@ -95,8 +107,9 @@ class UpdateGroupRequest; end
# single group without any descendants.
# @!attribute [rw] name
# @return [String]
# Required. The group to delete. The format is
# `"projects/{project_id_or_number}/groups/{group_id}"`.
# Required. The group to delete. The format is:
#
# projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]
# @!attribute [rw] recursive
# @return [true, false]
# If this field is true, then the request means to delete a group with all
Expand All @@ -107,25 +120,27 @@ class DeleteGroupRequest; end
# The `ListGroupMembers` request.
# @!attribute [rw] name
# @return [String]
# Required. The group whose members are listed. The format is
# `"projects/{project_id_or_number}/groups/{group_id}"`.
# Required. The group whose members are listed. The format is:
#
# projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]
# @!attribute [rw] page_size
# @return [Integer]
# A positive number that is the maximum number of results to return.
# @!attribute [rw] page_token
# @return [String]
# If this field is not empty then it must contain the `nextPageToken` value
# If this field is not empty then it must contain the `next_page_token` value
# returned by a previous call to this method. Using this field causes the
# method to return additional results from the previous method call.
# @!attribute [rw] filter
# @return [String]
# An optional [list filter](https://cloud.google.com/monitoring/api/learn_more#filtering) describing
# the members to be returned. The filter may reference the type, labels, and
# metadata of monitored resources that comprise the group.
# For example, to return only resources representing Compute Engine VM
# instances, use this filter:
# An optional [list
# filter](https://cloud.google.com/monitoring/api/learn_more#filtering)
# describing the members to be returned. The filter may reference the type,
# labels, and metadata of monitored resources that comprise the group. For
# example, to return only resources representing Compute Engine VM instances,
# use this filter:
#
# resource.type = "gce_instance"
# `resource.type = "gce_instance"`
# @!attribute [rw] interval
# @return [Google::Monitoring::V3::TimeInterval]
# An optional time interval for which results should be returned. Only
Expand All @@ -142,7 +157,7 @@ class ListGroupMembersRequest; end
# @return [String]
# If there are more results than have been returned, then this field is
# set to a non-empty value. To see the additional results, use that value as
# `pageToken` in the next call to this method.
# `page_token` in the next call to this method.
# @!attribute [rw] total_size
# @return [Integer]
# The total number of elements matching this request.
Expand Down