google-cloud-monitoring 0.38.0 → 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.yardopts +2 -1
- data/AUTHENTICATION.md +51 -54
- data/LICENSE.md +203 -0
- data/MIGRATING.md +361 -0
- data/README.md +34 -50
- data/lib/google-cloud-monitoring.rb +6 -5
- data/lib/google/cloud/monitoring.rb +255 -443
- data/lib/google/cloud/monitoring/dashboard.rb +88 -117
- data/lib/google/cloud/monitoring/{v3/doc/google/protobuf/wrappers.rb → dashboard/version.rb} +12 -9
- data/lib/google/cloud/monitoring/version.rb +6 -2
- metadata +71 -128
- data/LICENSE +0 -201
- data/lib/google/cloud/monitoring/dashboard/v1.rb +0 -148
- data/lib/google/cloud/monitoring/dashboard/v1/credentials.rb +0 -46
- data/lib/google/cloud/monitoring/dashboard/v1/dashboards_service_client.rb +0 -457
- data/lib/google/cloud/monitoring/dashboard/v1/dashboards_service_client_config.json +0 -51
- data/lib/google/cloud/monitoring/dashboard/v1/doc/google/monitoring/dashboard/v1/common.rb +0 -394
- data/lib/google/cloud/monitoring/dashboard/v1/doc/google/monitoring/dashboard/v1/dashboard.rb +0 -53
- data/lib/google/cloud/monitoring/dashboard/v1/doc/google/monitoring/dashboard/v1/dashboards_service.rb +0 -82
- data/lib/google/cloud/monitoring/dashboard/v1/doc/google/monitoring/dashboard/v1/layouts.rb +0 -71
- data/lib/google/cloud/monitoring/dashboard/v1/doc/google/monitoring/dashboard/v1/metrics.rb +0 -151
- data/lib/google/cloud/monitoring/dashboard/v1/doc/google/monitoring/dashboard/v1/scorecard.rb +0 -102
- data/lib/google/cloud/monitoring/dashboard/v1/doc/google/monitoring/dashboard/v1/text.rb +0 -43
- data/lib/google/cloud/monitoring/dashboard/v1/doc/google/monitoring/dashboard/v1/widget.rb +0 -41
- data/lib/google/cloud/monitoring/dashboard/v1/doc/google/monitoring/dashboard/v1/xychart.rb +0 -141
- data/lib/google/cloud/monitoring/dashboard/v1/doc/google/protobuf/duration.rb +0 -91
- data/lib/google/cloud/monitoring/dashboard/v1/doc/google/protobuf/empty.rb +0 -29
- data/lib/google/cloud/monitoring/v3.rb +0 -532
- data/lib/google/cloud/monitoring/v3/alert_policy_service_client.rb +0 -553
- data/lib/google/cloud/monitoring/v3/alert_policy_service_client_config.json +0 -51
- data/lib/google/cloud/monitoring/v3/credentials.rb +0 -44
- data/lib/google/cloud/monitoring/v3/doc/google/api/distribution.rb +0 -200
- data/lib/google/cloud/monitoring/v3/doc/google/api/label.rb +0 -42
- data/lib/google/cloud/monitoring/v3/doc/google/api/metric.rb +0 -245
- data/lib/google/cloud/monitoring/v3/doc/google/api/monitored_resource.rb +0 -108
- data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/alert.rb +0 -344
- data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/alert_service.rb +0 -138
- data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/common.rb +0 -449
- data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/group.rb +0 -75
- data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/group_service.rb +0 -167
- data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/metric.rb +0 -85
- data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/metric_service.rb +0 -230
- data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/mutation_record.rb +0 -29
- data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/notification.rb +0 -156
- data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/notification_service.rb +0 -221
- data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/service.rb +0 -361
- data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/service_service.rb +0 -197
- data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/uptime.rb +0 -364
- data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/uptime_service.rb +0 -136
- data/lib/google/cloud/monitoring/v3/doc/google/protobuf/any.rb +0 -131
- data/lib/google/cloud/monitoring/v3/doc/google/protobuf/duration.rb +0 -91
- data/lib/google/cloud/monitoring/v3/doc/google/protobuf/empty.rb +0 -29
- data/lib/google/cloud/monitoring/v3/doc/google/protobuf/field_mask.rb +0 -222
- data/lib/google/cloud/monitoring/v3/doc/google/protobuf/struct.rb +0 -74
- data/lib/google/cloud/monitoring/v3/doc/google/protobuf/timestamp.rb +0 -113
- data/lib/google/cloud/monitoring/v3/doc/google/rpc/status.rb +0 -39
- data/lib/google/cloud/monitoring/v3/group_service_client.rb +0 -606
- data/lib/google/cloud/monitoring/v3/group_service_client_config.json +0 -56
- data/lib/google/cloud/monitoring/v3/metric_service_client.rb +0 -750
- data/lib/google/cloud/monitoring/v3/metric_service_client_config.json +0 -66
- data/lib/google/cloud/monitoring/v3/notification_channel_service_client.rb +0 -811
- data/lib/google/cloud/monitoring/v3/notification_channel_service_client_config.json +0 -76
- data/lib/google/cloud/monitoring/v3/service_monitoring_service_client.rb +0 -788
- data/lib/google/cloud/monitoring/v3/service_monitoring_service_client_config.json +0 -76
- data/lib/google/cloud/monitoring/v3/uptime_check_service_client.rb +0 -550
- data/lib/google/cloud/monitoring/v3/uptime_check_service_client_config.json +0 -56
- data/lib/google/monitoring/dashboard/v1/common_pb.rb +0 -95
- data/lib/google/monitoring/dashboard/v1/dashboard_pb.rb +0 -29
- data/lib/google/monitoring/dashboard/v1/dashboards_service_pb.rb +0 -51
- data/lib/google/monitoring/dashboard/v1/dashboards_service_services_pb.rb +0 -76
- data/lib/google/monitoring/dashboard/v1/drilldowns_pb.rb +0 -17
- data/lib/google/monitoring/dashboard/v1/layouts_pb.rb +0 -41
- data/lib/google/monitoring/dashboard/v1/metrics_pb.rb +0 -76
- data/lib/google/monitoring/dashboard/v1/scorecard_pb.rb +0 -38
- data/lib/google/monitoring/dashboard/v1/service_pb.rb +0 -17
- data/lib/google/monitoring/dashboard/v1/text_pb.rb +0 -28
- data/lib/google/monitoring/dashboard/v1/widget_pb.rb +0 -32
- data/lib/google/monitoring/dashboard/v1/xychart_pb.rb +0 -66
- data/lib/google/monitoring/v3/alert_pb.rb +0 -87
- data/lib/google/monitoring/v3/alert_service_pb.rb +0 -53
- data/lib/google/monitoring/v3/alert_service_services_pb.rb +0 -63
- data/lib/google/monitoring/v3/common_pb.rb +0 -95
- data/lib/google/monitoring/v3/dropped_labels_pb.rb +0 -19
- data/lib/google/monitoring/v3/group_pb.rb +0 -24
- data/lib/google/monitoring/v3/group_service_pb.rb +0 -73
- data/lib/google/monitoring/v3/group_service_services_pb.rb +0 -66
- data/lib/google/monitoring/v3/metric_pb.rb +0 -82
- data/lib/google/monitoring/v3/metric_service_pb.rb +0 -130
- data/lib/google/monitoring/v3/metric_service_services_pb.rb +0 -66
- data/lib/google/monitoring/v3/mutation_record_pb.rb +0 -21
- data/lib/google/monitoring/v3/notification_pb.rb +0 -47
- data/lib/google/monitoring/v3/notification_service_pb.rb +0 -90
- data/lib/google/monitoring/v3/notification_service_services_pb.rb +0 -94
- data/lib/google/monitoring/v3/service_pb.rb +0 -149
- data/lib/google/monitoring/v3/service_service_pb.rb +0 -86
- data/lib/google/monitoring/v3/service_service_services_pb.rb +0 -65
- data/lib/google/monitoring/v3/span_context_pb.rb +0 -19
- data/lib/google/monitoring/v3/uptime_pb.rb +0 -123
- data/lib/google/monitoring/v3/uptime_service_pb.rb +0 -63
- data/lib/google/monitoring/v3/uptime_service_services_pb.rb +0 -67
@@ -1,29 +0,0 @@
|
|
1
|
-
# Copyright 2020 Google LLC
|
2
|
-
#
|
3
|
-
# Licensed under the Apache License, Version 2.0 (the "License");
|
4
|
-
# you may not use this file except in compliance with the License.
|
5
|
-
# You may obtain a copy of the License at
|
6
|
-
#
|
7
|
-
# https://www.apache.org/licenses/LICENSE-2.0
|
8
|
-
#
|
9
|
-
# Unless required by applicable law or agreed to in writing, software
|
10
|
-
# distributed under the License is distributed on an "AS IS" BASIS,
|
11
|
-
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
12
|
-
# See the License for the specific language governing permissions and
|
13
|
-
# limitations under the License.
|
14
|
-
|
15
|
-
|
16
|
-
module Google
|
17
|
-
module Monitoring
|
18
|
-
module V3
|
19
|
-
# Describes a change made to a configuration.
|
20
|
-
# @!attribute [rw] mutate_time
|
21
|
-
# @return [Google::Protobuf::Timestamp]
|
22
|
-
# When the change occurred.
|
23
|
-
# @!attribute [rw] mutated_by
|
24
|
-
# @return [String]
|
25
|
-
# The email address of the user making the change.
|
26
|
-
class MutationRecord; end
|
27
|
-
end
|
28
|
-
end
|
29
|
-
end
|
@@ -1,156 +0,0 @@
|
|
1
|
-
# Copyright 2020 Google LLC
|
2
|
-
#
|
3
|
-
# Licensed under the Apache License, Version 2.0 (the "License");
|
4
|
-
# you may not use this file except in compliance with the License.
|
5
|
-
# You may obtain a copy of the License at
|
6
|
-
#
|
7
|
-
# https://www.apache.org/licenses/LICENSE-2.0
|
8
|
-
#
|
9
|
-
# Unless required by applicable law or agreed to in writing, software
|
10
|
-
# distributed under the License is distributed on an "AS IS" BASIS,
|
11
|
-
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
12
|
-
# See the License for the specific language governing permissions and
|
13
|
-
# limitations under the License.
|
14
|
-
|
15
|
-
|
16
|
-
module Google
|
17
|
-
module Monitoring
|
18
|
-
module V3
|
19
|
-
# A description of a notification channel. The descriptor includes
|
20
|
-
# the properties of the channel and the set of labels or fields that
|
21
|
-
# must be specified to configure channels of a given type.
|
22
|
-
# @!attribute [rw] name
|
23
|
-
# @return [String]
|
24
|
-
# The full REST resource name for this descriptor. The format is:
|
25
|
-
#
|
26
|
-
# projects/[PROJECT_ID_OR_NUMBER]/notificationChannelDescriptors/[TYPE]
|
27
|
-
#
|
28
|
-
# In the above, `[TYPE]` is the value of the `type` field.
|
29
|
-
# @!attribute [rw] type
|
30
|
-
# @return [String]
|
31
|
-
# The type of notification channel, such as "email", "sms", etc.
|
32
|
-
# Notification channel types are globally unique.
|
33
|
-
# @!attribute [rw] display_name
|
34
|
-
# @return [String]
|
35
|
-
# A human-readable name for the notification channel type. This
|
36
|
-
# form of the name is suitable for a user interface.
|
37
|
-
# @!attribute [rw] description
|
38
|
-
# @return [String]
|
39
|
-
# A human-readable description of the notification channel
|
40
|
-
# type. The description may include a description of the properties
|
41
|
-
# of the channel and pointers to external documentation.
|
42
|
-
# @!attribute [rw] labels
|
43
|
-
# @return [Array<Google::Api::LabelDescriptor>]
|
44
|
-
# The set of labels that must be defined to identify a particular
|
45
|
-
# channel of the corresponding type. Each label includes a
|
46
|
-
# description for how that field should be populated.
|
47
|
-
# @!attribute [rw] supported_tiers
|
48
|
-
# @return [Array<Google::Monitoring::V3::ServiceTier>]
|
49
|
-
# The tiers that support this notification channel; the project service tier
|
50
|
-
# must be one of the supported_tiers.
|
51
|
-
# @!attribute [rw] launch_stage
|
52
|
-
# @return [Google::Api::LaunchStage]
|
53
|
-
# The product launch stage for channels of this type.
|
54
|
-
class NotificationChannelDescriptor; end
|
55
|
-
|
56
|
-
# A `NotificationChannel` is a medium through which an alert is
|
57
|
-
# delivered when a policy violation is detected. Examples of channels
|
58
|
-
# include email, SMS, and third-party messaging applications. Fields
|
59
|
-
# containing sensitive information like authentication tokens or
|
60
|
-
# contact info are only partially populated on retrieval.
|
61
|
-
# @!attribute [rw] type
|
62
|
-
# @return [String]
|
63
|
-
# The type of the notification channel. This field matches the
|
64
|
-
# value of the {Google::Monitoring::V3::NotificationChannelDescriptor#type NotificationChannelDescriptor#type} field.
|
65
|
-
# @!attribute [rw] name
|
66
|
-
# @return [String]
|
67
|
-
# The full REST resource name for this channel. The format is:
|
68
|
-
#
|
69
|
-
# projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID]
|
70
|
-
#
|
71
|
-
# The `[CHANNEL_ID]` is automatically assigned by the server on creation.
|
72
|
-
# @!attribute [rw] display_name
|
73
|
-
# @return [String]
|
74
|
-
# An optional human-readable name for this notification channel. It is
|
75
|
-
# recommended that you specify a non-empty and unique name in order to
|
76
|
-
# make it easier to identify the channels in your project, though this is
|
77
|
-
# not enforced. The display name is limited to 512 Unicode characters.
|
78
|
-
# @!attribute [rw] description
|
79
|
-
# @return [String]
|
80
|
-
# An optional human-readable description of this notification channel. This
|
81
|
-
# description may provide additional details, beyond the display
|
82
|
-
# name, for the channel. This may not exceed 1024 Unicode characters.
|
83
|
-
# @!attribute [rw] labels
|
84
|
-
# @return [Hash{String => String}]
|
85
|
-
# Configuration fields that define the channel and its behavior. The
|
86
|
-
# permissible and required labels are specified in the
|
87
|
-
# {Google::Monitoring::V3::NotificationChannelDescriptor#labels NotificationChannelDescriptor#labels} of the
|
88
|
-
# `NotificationChannelDescriptor` corresponding to the `type` field.
|
89
|
-
# @!attribute [rw] user_labels
|
90
|
-
# @return [Hash{String => String}]
|
91
|
-
# User-supplied key/value data that does not need to conform to
|
92
|
-
# the corresponding `NotificationChannelDescriptor`'s schema, unlike
|
93
|
-
# the `labels` field. This field is intended to be used for organizing
|
94
|
-
# and identifying the `NotificationChannel` objects.
|
95
|
-
#
|
96
|
-
# The field can contain up to 64 entries. Each key and value is limited to
|
97
|
-
# 63 Unicode characters or 128 bytes, whichever is smaller. Labels and
|
98
|
-
# values can contain only lowercase letters, numerals, underscores, and
|
99
|
-
# dashes. Keys must begin with a letter.
|
100
|
-
# @!attribute [rw] verification_status
|
101
|
-
# @return [Google::Monitoring::V3::NotificationChannel::VerificationStatus]
|
102
|
-
# Indicates whether this channel has been verified or not. On a
|
103
|
-
# {Google::Monitoring::V3::NotificationChannelService::ListNotificationChannels `ListNotificationChannels`}
|
104
|
-
# or
|
105
|
-
# {Google::Monitoring::V3::NotificationChannelService::GetNotificationChannel `GetNotificationChannel`}
|
106
|
-
# operation, this field is expected to be populated.
|
107
|
-
#
|
108
|
-
# If the value is `UNVERIFIED`, then it indicates that the channel is
|
109
|
-
# non-functioning (it both requires verification and lacks verification);
|
110
|
-
# otherwise, it is assumed that the channel works.
|
111
|
-
#
|
112
|
-
# If the channel is neither `VERIFIED` nor `UNVERIFIED`, it implies that
|
113
|
-
# the channel is of a type that does not require verification or that
|
114
|
-
# this specific channel has been exempted from verification because it was
|
115
|
-
# created prior to verification being required for channels of this type.
|
116
|
-
#
|
117
|
-
# This field cannot be modified using a standard
|
118
|
-
# {Google::Monitoring::V3::NotificationChannelService::UpdateNotificationChannel `UpdateNotificationChannel`}
|
119
|
-
# operation. To change the value of this field, you must call
|
120
|
-
# {Google::Monitoring::V3::NotificationChannelService::VerifyNotificationChannel `VerifyNotificationChannel`}.
|
121
|
-
# @!attribute [rw] enabled
|
122
|
-
# @return [Google::Protobuf::BoolValue]
|
123
|
-
# Whether notifications are forwarded to the described channel. This makes
|
124
|
-
# it possible to disable delivery of notifications to a particular channel
|
125
|
-
# without removing the channel from all alerting policies that reference
|
126
|
-
# the channel. This is a more convenient approach when the change is
|
127
|
-
# temporary and you want to receive notifications from the same set
|
128
|
-
# of alerting policies on the channel at some point in the future.
|
129
|
-
class NotificationChannel
|
130
|
-
# Indicates whether the channel has been verified or not. It is illegal
|
131
|
-
# to specify this field in a
|
132
|
-
# {Google::Monitoring::V3::NotificationChannelService::CreateNotificationChannel `CreateNotificationChannel`}
|
133
|
-
# or an
|
134
|
-
# {Google::Monitoring::V3::NotificationChannelService::UpdateNotificationChannel `UpdateNotificationChannel`}
|
135
|
-
# operation.
|
136
|
-
module VerificationStatus
|
137
|
-
# Sentinel value used to indicate that the state is unknown, omitted, or
|
138
|
-
# is not applicable (as in the case of channels that neither support
|
139
|
-
# nor require verification in order to function).
|
140
|
-
VERIFICATION_STATUS_UNSPECIFIED = 0
|
141
|
-
|
142
|
-
# The channel has yet to be verified and requires verification to function.
|
143
|
-
# Note that this state also applies to the case where the verification
|
144
|
-
# process has been initiated by sending a verification code but where
|
145
|
-
# the verification code has not been submitted to complete the process.
|
146
|
-
UNVERIFIED = 1
|
147
|
-
|
148
|
-
# It has been proven that notifications can be received on this
|
149
|
-
# notification channel and that someone on the project has access
|
150
|
-
# to messages that are delivered to that channel.
|
151
|
-
VERIFIED = 2
|
152
|
-
end
|
153
|
-
end
|
154
|
-
end
|
155
|
-
end
|
156
|
-
end
|
@@ -1,221 +0,0 @@
|
|
1
|
-
# Copyright 2020 Google LLC
|
2
|
-
#
|
3
|
-
# Licensed under the Apache License, Version 2.0 (the "License");
|
4
|
-
# you may not use this file except in compliance with the License.
|
5
|
-
# You may obtain a copy of the License at
|
6
|
-
#
|
7
|
-
# https://www.apache.org/licenses/LICENSE-2.0
|
8
|
-
#
|
9
|
-
# Unless required by applicable law or agreed to in writing, software
|
10
|
-
# distributed under the License is distributed on an "AS IS" BASIS,
|
11
|
-
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
12
|
-
# See the License for the specific language governing permissions and
|
13
|
-
# limitations under the License.
|
14
|
-
|
15
|
-
|
16
|
-
module Google
|
17
|
-
module Monitoring
|
18
|
-
module V3
|
19
|
-
# The `ListNotificationChannelDescriptors` request.
|
20
|
-
# @!attribute [rw] name
|
21
|
-
# @return [String]
|
22
|
-
# Required. The REST resource name of the parent from which to retrieve
|
23
|
-
# the notification channel descriptors. The expected syntax is:
|
24
|
-
#
|
25
|
-
# projects/[PROJECT_ID_OR_NUMBER]
|
26
|
-
#
|
27
|
-
# Note that this names the parent container in which to look for the
|
28
|
-
# descriptors; to retrieve a single descriptor by name, use the
|
29
|
-
# {Google::Monitoring::V3::NotificationChannelService::GetNotificationChannelDescriptor GetNotificationChannelDescriptor}
|
30
|
-
# operation, instead.
|
31
|
-
# @!attribute [rw] page_size
|
32
|
-
# @return [Integer]
|
33
|
-
# The maximum number of results to return in a single response. If
|
34
|
-
# not set to a positive number, a reasonable value will be chosen by the
|
35
|
-
# service.
|
36
|
-
# @!attribute [rw] page_token
|
37
|
-
# @return [String]
|
38
|
-
# If non-empty, `page_token` must contain a value returned as the
|
39
|
-
# `next_page_token` in a previous response to request the next set
|
40
|
-
# of results.
|
41
|
-
class ListNotificationChannelDescriptorsRequest; end
|
42
|
-
|
43
|
-
# The `ListNotificationChannelDescriptors` response.
|
44
|
-
# @!attribute [rw] channel_descriptors
|
45
|
-
# @return [Array<Google::Monitoring::V3::NotificationChannelDescriptor>]
|
46
|
-
# The monitored resource descriptors supported for the specified
|
47
|
-
# project, optionally filtered.
|
48
|
-
# @!attribute [rw] next_page_token
|
49
|
-
# @return [String]
|
50
|
-
# If not empty, indicates that there may be more results that match
|
51
|
-
# the request. Use the value in the `page_token` field in a
|
52
|
-
# subsequent request to fetch the next set of results. If empty,
|
53
|
-
# all results have been returned.
|
54
|
-
class ListNotificationChannelDescriptorsResponse; end
|
55
|
-
|
56
|
-
# The `GetNotificationChannelDescriptor` response.
|
57
|
-
# @!attribute [rw] name
|
58
|
-
# @return [String]
|
59
|
-
# Required. The channel type for which to execute the request. The format is:
|
60
|
-
#
|
61
|
-
# projects/[PROJECT_ID_OR_NUMBER]/notificationChannelDescriptors/[CHANNEL_TYPE]
|
62
|
-
class GetNotificationChannelDescriptorRequest; end
|
63
|
-
|
64
|
-
# The `CreateNotificationChannel` request.
|
65
|
-
# @!attribute [rw] name
|
66
|
-
# @return [String]
|
67
|
-
# Required. The project on which to execute the request. The format is:
|
68
|
-
#
|
69
|
-
# projects/[PROJECT_ID_OR_NUMBER]
|
70
|
-
#
|
71
|
-
# This names the container into which the channel will be
|
72
|
-
# written, this does not name the newly created channel. The resulting
|
73
|
-
# channel's name will have a normalized version of this field as a prefix,
|
74
|
-
# but will add `/notificationChannels/[CHANNEL_ID]` to identify the channel.
|
75
|
-
# @!attribute [rw] notification_channel
|
76
|
-
# @return [Google::Monitoring::V3::NotificationChannel]
|
77
|
-
# Required. The definition of the `NotificationChannel` to create.
|
78
|
-
class CreateNotificationChannelRequest; end
|
79
|
-
|
80
|
-
# The `ListNotificationChannels` request.
|
81
|
-
# @!attribute [rw] name
|
82
|
-
# @return [String]
|
83
|
-
# Required. The project on which to execute the request. The format is:
|
84
|
-
#
|
85
|
-
# projects/[PROJECT_ID_OR_NUMBER]
|
86
|
-
#
|
87
|
-
# This names the container
|
88
|
-
# in which to look for the notification channels; it does not name a
|
89
|
-
# specific channel. To query a specific channel by REST resource name, use
|
90
|
-
# the
|
91
|
-
# {Google::Monitoring::V3::NotificationChannelService::GetNotificationChannel `GetNotificationChannel`}
|
92
|
-
# operation.
|
93
|
-
# @!attribute [rw] filter
|
94
|
-
# @return [String]
|
95
|
-
# If provided, this field specifies the criteria that must be met by
|
96
|
-
# notification channels to be included in the response.
|
97
|
-
#
|
98
|
-
# For more details, see [sorting and
|
99
|
-
# filtering](https://cloud.google.com/monitoring/api/v3/sorting-and-filtering).
|
100
|
-
# @!attribute [rw] order_by
|
101
|
-
# @return [String]
|
102
|
-
# A comma-separated list of fields by which to sort the result. Supports
|
103
|
-
# the same set of fields as in `filter`. Entries can be prefixed with
|
104
|
-
# a minus sign to sort in descending rather than ascending order.
|
105
|
-
#
|
106
|
-
# For more details, see [sorting and
|
107
|
-
# filtering](https://cloud.google.com/monitoring/api/v3/sorting-and-filtering).
|
108
|
-
# @!attribute [rw] page_size
|
109
|
-
# @return [Integer]
|
110
|
-
# The maximum number of results to return in a single response. If
|
111
|
-
# not set to a positive number, a reasonable value will be chosen by the
|
112
|
-
# service.
|
113
|
-
# @!attribute [rw] page_token
|
114
|
-
# @return [String]
|
115
|
-
# If non-empty, `page_token` must contain a value returned as the
|
116
|
-
# `next_page_token` in a previous response to request the next set
|
117
|
-
# of results.
|
118
|
-
class ListNotificationChannelsRequest; end
|
119
|
-
|
120
|
-
# The `ListNotificationChannels` response.
|
121
|
-
# @!attribute [rw] notification_channels
|
122
|
-
# @return [Array<Google::Monitoring::V3::NotificationChannel>]
|
123
|
-
# The notification channels defined for the specified project.
|
124
|
-
# @!attribute [rw] next_page_token
|
125
|
-
# @return [String]
|
126
|
-
# If not empty, indicates that there may be more results that match
|
127
|
-
# the request. Use the value in the `page_token` field in a
|
128
|
-
# subsequent request to fetch the next set of results. If empty,
|
129
|
-
# all results have been returned.
|
130
|
-
class ListNotificationChannelsResponse; end
|
131
|
-
|
132
|
-
# The `GetNotificationChannel` request.
|
133
|
-
# @!attribute [rw] name
|
134
|
-
# @return [String]
|
135
|
-
# Required. The channel for which to execute the request. The format is:
|
136
|
-
#
|
137
|
-
# projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID]
|
138
|
-
class GetNotificationChannelRequest; end
|
139
|
-
|
140
|
-
# The `UpdateNotificationChannel` request.
|
141
|
-
# @!attribute [rw] update_mask
|
142
|
-
# @return [Google::Protobuf::FieldMask]
|
143
|
-
# The fields to update.
|
144
|
-
# @!attribute [rw] notification_channel
|
145
|
-
# @return [Google::Monitoring::V3::NotificationChannel]
|
146
|
-
# Required. A description of the changes to be applied to the specified
|
147
|
-
# notification channel. The description must provide a definition for
|
148
|
-
# fields to be updated; the names of these fields should also be
|
149
|
-
# included in the `update_mask`.
|
150
|
-
class UpdateNotificationChannelRequest; end
|
151
|
-
|
152
|
-
# The `DeleteNotificationChannel` request.
|
153
|
-
# @!attribute [rw] name
|
154
|
-
# @return [String]
|
155
|
-
# Required. The channel for which to execute the request. The format is:
|
156
|
-
#
|
157
|
-
# projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID]
|
158
|
-
# @!attribute [rw] force
|
159
|
-
# @return [true, false]
|
160
|
-
# If true, the notification channel will be deleted regardless of its
|
161
|
-
# use in alert policies (the policies will be updated to remove the
|
162
|
-
# channel). If false, channels that are still referenced by an existing
|
163
|
-
# alerting policy will fail to be deleted in a delete operation.
|
164
|
-
class DeleteNotificationChannelRequest; end
|
165
|
-
|
166
|
-
# The `SendNotificationChannelVerificationCode` request.
|
167
|
-
# @!attribute [rw] name
|
168
|
-
# @return [String]
|
169
|
-
# Required. The notification channel to which to send a verification code.
|
170
|
-
class SendNotificationChannelVerificationCodeRequest; end
|
171
|
-
|
172
|
-
# The `GetNotificationChannelVerificationCode` request.
|
173
|
-
# @!attribute [rw] name
|
174
|
-
# @return [String]
|
175
|
-
# Required. The notification channel for which a verification code is to be generated
|
176
|
-
# and retrieved. This must name a channel that is already verified; if
|
177
|
-
# the specified channel is not verified, the request will fail.
|
178
|
-
# @!attribute [rw] expire_time
|
179
|
-
# @return [Google::Protobuf::Timestamp]
|
180
|
-
# The desired expiration time. If specified, the API will guarantee that
|
181
|
-
# the returned code will not be valid after the specified timestamp;
|
182
|
-
# however, the API cannot guarantee that the returned code will be
|
183
|
-
# valid for at least as long as the requested time (the API puts an upper
|
184
|
-
# bound on the amount of time for which a code may be valid). If omitted,
|
185
|
-
# a default expiration will be used, which may be less than the max
|
186
|
-
# permissible expiration (so specifying an expiration may extend the
|
187
|
-
# code's lifetime over omitting an expiration, even though the API does
|
188
|
-
# impose an upper limit on the maximum expiration that is permitted).
|
189
|
-
class GetNotificationChannelVerificationCodeRequest; end
|
190
|
-
|
191
|
-
# The `GetNotificationChannelVerificationCode` request.
|
192
|
-
# @!attribute [rw] code
|
193
|
-
# @return [String]
|
194
|
-
# The verification code, which may be used to verify other channels
|
195
|
-
# that have an equivalent identity (i.e. other channels of the same
|
196
|
-
# type with the same fingerprint such as other email channels with
|
197
|
-
# the same email address or other sms channels with the same number).
|
198
|
-
# @!attribute [rw] expire_time
|
199
|
-
# @return [Google::Protobuf::Timestamp]
|
200
|
-
# The expiration time associated with the code that was returned. If
|
201
|
-
# an expiration was provided in the request, this is the minimum of the
|
202
|
-
# requested expiration in the request and the max permitted expiration.
|
203
|
-
class GetNotificationChannelVerificationCodeResponse; end
|
204
|
-
|
205
|
-
# The `VerifyNotificationChannel` request.
|
206
|
-
# @!attribute [rw] name
|
207
|
-
# @return [String]
|
208
|
-
# Required. The notification channel to verify.
|
209
|
-
# @!attribute [rw] code
|
210
|
-
# @return [String]
|
211
|
-
# Required. The verification code that was delivered to the channel as
|
212
|
-
# a result of invoking the `SendNotificationChannelVerificationCode` API
|
213
|
-
# method or that was retrieved from a verified channel via
|
214
|
-
# `GetNotificationChannelVerificationCode`. For example, one might have
|
215
|
-
# "G-123456" or "TKNZGhhd2EyN3I1MnRnMjRv" (in general, one is only
|
216
|
-
# guaranteed that the code is valid UTF-8; one should not
|
217
|
-
# make any assumptions regarding the structure or format of the code).
|
218
|
-
class VerifyNotificationChannelRequest; end
|
219
|
-
end
|
220
|
-
end
|
221
|
-
end
|
@@ -1,361 +0,0 @@
|
|
1
|
-
# Copyright 2020 Google LLC
|
2
|
-
#
|
3
|
-
# Licensed under the Apache License, Version 2.0 (the "License");
|
4
|
-
# you may not use this file except in compliance with the License.
|
5
|
-
# You may obtain a copy of the License at
|
6
|
-
#
|
7
|
-
# https://www.apache.org/licenses/LICENSE-2.0
|
8
|
-
#
|
9
|
-
# Unless required by applicable law or agreed to in writing, software
|
10
|
-
# distributed under the License is distributed on an "AS IS" BASIS,
|
11
|
-
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
12
|
-
# See the License for the specific language governing permissions and
|
13
|
-
# limitations under the License.
|
14
|
-
|
15
|
-
|
16
|
-
module Google
|
17
|
-
module Monitoring
|
18
|
-
module V3
|
19
|
-
# A `Service` is a discrete, autonomous, and network-accessible unit, designed
|
20
|
-
# to solve an individual concern
|
21
|
-
# ([Wikipedia](https://en.wikipedia.org/wiki/Service-orientation)). In
|
22
|
-
# Cloud Monitoring, a `Service` acts as the root resource under which
|
23
|
-
# operational aspects of the service are accessible.
|
24
|
-
# @!attribute [rw] name
|
25
|
-
# @return [String]
|
26
|
-
# Resource name for this Service. The format is:
|
27
|
-
#
|
28
|
-
# projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]
|
29
|
-
# @!attribute [rw] display_name
|
30
|
-
# @return [String]
|
31
|
-
# Name used for UI elements listing this Service.
|
32
|
-
# @!attribute [rw] custom
|
33
|
-
# @return [Google::Monitoring::V3::Service::Custom]
|
34
|
-
# Custom service type.
|
35
|
-
# @!attribute [rw] app_engine
|
36
|
-
# @return [Google::Monitoring::V3::Service::AppEngine]
|
37
|
-
# Type used for App Engine services.
|
38
|
-
# @!attribute [rw] cloud_endpoints
|
39
|
-
# @return [Google::Monitoring::V3::Service::CloudEndpoints]
|
40
|
-
# Type used for Cloud Endpoints services.
|
41
|
-
# @!attribute [rw] cluster_istio
|
42
|
-
# @return [Google::Monitoring::V3::Service::ClusterIstio]
|
43
|
-
# Type used for Istio services that live in a Kubernetes cluster.
|
44
|
-
# @!attribute [rw] mesh_istio
|
45
|
-
# @return [Google::Monitoring::V3::Service::MeshIstio]
|
46
|
-
# Type used for Istio services scoped to an Istio mesh.
|
47
|
-
# @!attribute [rw] telemetry
|
48
|
-
# @return [Google::Monitoring::V3::Service::Telemetry]
|
49
|
-
# Configuration for how to query telemetry on a Service.
|
50
|
-
class Service
|
51
|
-
# Custom view of service telemetry. Currently a place-holder pending final
|
52
|
-
# design.
|
53
|
-
class Custom; end
|
54
|
-
|
55
|
-
# App Engine service. Learn more at https://cloud.google.com/appengine.
|
56
|
-
# @!attribute [rw] module_id
|
57
|
-
# @return [String]
|
58
|
-
# The ID of the App Engine module underlying this service. Corresponds to
|
59
|
-
# the `module_id` resource label in the `gae_app` monitored resource:
|
60
|
-
# https://cloud.google.com/monitoring/api/resources#tag_gae_app
|
61
|
-
class AppEngine; end
|
62
|
-
|
63
|
-
# Cloud Endpoints service. Learn more at https://cloud.google.com/endpoints.
|
64
|
-
# @!attribute [rw] service
|
65
|
-
# @return [String]
|
66
|
-
# The name of the Cloud Endpoints service underlying this service.
|
67
|
-
# Corresponds to the `service` resource label in the `api` monitored
|
68
|
-
# resource: https://cloud.google.com/monitoring/api/resources#tag_api
|
69
|
-
class CloudEndpoints; end
|
70
|
-
|
71
|
-
# Istio service scoped to a single Kubernetes cluster. Learn more at
|
72
|
-
# http://istio.io.
|
73
|
-
# @!attribute [rw] location
|
74
|
-
# @return [String]
|
75
|
-
# The location of the Kubernetes cluster in which this Istio service is
|
76
|
-
# defined. Corresponds to the `location` resource label in `k8s_cluster`
|
77
|
-
# resources.
|
78
|
-
# @!attribute [rw] cluster_name
|
79
|
-
# @return [String]
|
80
|
-
# The name of the Kubernetes cluster in which this Istio service is
|
81
|
-
# defined. Corresponds to the `cluster_name` resource label in
|
82
|
-
# `k8s_cluster` resources.
|
83
|
-
# @!attribute [rw] service_namespace
|
84
|
-
# @return [String]
|
85
|
-
# The namespace of the Istio service underlying this service. Corresponds
|
86
|
-
# to the `destination_service_namespace` metric label in Istio metrics.
|
87
|
-
# @!attribute [rw] service_name
|
88
|
-
# @return [String]
|
89
|
-
# The name of the Istio service underlying this service. Corresponds to the
|
90
|
-
# `destination_service_name` metric label in Istio metrics.
|
91
|
-
class ClusterIstio; end
|
92
|
-
|
93
|
-
# Istio service scoped to an Istio mesh
|
94
|
-
# @!attribute [rw] mesh_uid
|
95
|
-
# @return [String]
|
96
|
-
# Identifier for the mesh in which this Istio service is defined.
|
97
|
-
# Corresponds to the `mesh_uid` metric label in Istio metrics.
|
98
|
-
# @!attribute [rw] service_namespace
|
99
|
-
# @return [String]
|
100
|
-
# The namespace of the Istio service underlying this service. Corresponds
|
101
|
-
# to the `destination_service_namespace` metric label in Istio metrics.
|
102
|
-
# @!attribute [rw] service_name
|
103
|
-
# @return [String]
|
104
|
-
# The name of the Istio service underlying this service. Corresponds to the
|
105
|
-
# `destination_service_name` metric label in Istio metrics.
|
106
|
-
class MeshIstio; end
|
107
|
-
|
108
|
-
# Configuration for how to query telemetry on a Service.
|
109
|
-
# @!attribute [rw] resource_name
|
110
|
-
# @return [String]
|
111
|
-
# The full name of the resource that defines this service. Formatted as
|
112
|
-
# described in https://cloud.google.com/apis/design/resource_names.
|
113
|
-
class Telemetry; end
|
114
|
-
end
|
115
|
-
|
116
|
-
# A Service-Level Objective (SLO) describes a level of desired good service. It
|
117
|
-
# consists of a service-level indicator (SLI), a performance goal, and a period
|
118
|
-
# over which the objective is to be evaluated against that goal. The SLO can
|
119
|
-
# use SLIs defined in a number of different manners. Typical SLOs might include
|
120
|
-
# "99% of requests in each rolling week have latency below 200 milliseconds" or
|
121
|
-
# "99.5% of requests in each calendar month return successfully."
|
122
|
-
# @!attribute [rw] name
|
123
|
-
# @return [String]
|
124
|
-
# Resource name for this `ServiceLevelObjective`. The format is:
|
125
|
-
#
|
126
|
-
# projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME]
|
127
|
-
# @!attribute [rw] display_name
|
128
|
-
# @return [String]
|
129
|
-
# Name used for UI elements listing this SLO.
|
130
|
-
# @!attribute [rw] service_level_indicator
|
131
|
-
# @return [Google::Monitoring::V3::ServiceLevelIndicator]
|
132
|
-
# The definition of good service, used to measure and calculate the quality
|
133
|
-
# of the `Service`'s performance with respect to a single aspect of service
|
134
|
-
# quality.
|
135
|
-
# @!attribute [rw] goal
|
136
|
-
# @return [Float]
|
137
|
-
# The fraction of service that must be good in order for this objective to be
|
138
|
-
# met. `0 < goal <= 0.999`.
|
139
|
-
# @!attribute [rw] rolling_period
|
140
|
-
# @return [Google::Protobuf::Duration]
|
141
|
-
# A rolling time period, semantically "in the past `<rolling_period>`".
|
142
|
-
# Must be an integer multiple of 1 day no larger than 30 days.
|
143
|
-
# @!attribute [rw] calendar_period
|
144
|
-
# @return [Google::Type::CalendarPeriod]
|
145
|
-
# A calendar period, semantically "since the start of the current
|
146
|
-
# `<calendar_period>`". At this time, only `DAY`, `WEEK`, `FORTNIGHT`, and
|
147
|
-
# `MONTH` are supported.
|
148
|
-
class ServiceLevelObjective
|
149
|
-
# `ServiceLevelObjective.View` determines what form of
|
150
|
-
# `ServiceLevelObjective` is returned from `GetServiceLevelObjective`,
|
151
|
-
# `ListServiceLevelObjectives`, and `ListServiceLevelObjectiveVersions` RPCs.
|
152
|
-
module View
|
153
|
-
# Same as FULL.
|
154
|
-
VIEW_UNSPECIFIED = 0
|
155
|
-
|
156
|
-
# Return the embedded `ServiceLevelIndicator` in the form in which it was
|
157
|
-
# defined. If it was defined using a `BasicSli`, return that `BasicSli`.
|
158
|
-
FULL = 2
|
159
|
-
|
160
|
-
# For `ServiceLevelIndicator`s using `BasicSli` articulation, instead
|
161
|
-
# return the `ServiceLevelIndicator` with its mode of computation fully
|
162
|
-
# spelled out as a `RequestBasedSli`. For `ServiceLevelIndicator`s using
|
163
|
-
# `RequestBasedSli` or `WindowsBasedSli`, return the
|
164
|
-
# `ServiceLevelIndicator` as it was provided.
|
165
|
-
EXPLICIT = 1
|
166
|
-
end
|
167
|
-
end
|
168
|
-
|
169
|
-
# A Service-Level Indicator (SLI) describes the "performance" of a service. For
|
170
|
-
# some services, the SLI is well-defined. In such cases, the SLI can be
|
171
|
-
# described easily by referencing the well-known SLI and providing the needed
|
172
|
-
# parameters. Alternatively, a "custom" SLI can be defined with a query to the
|
173
|
-
# underlying metric store. An SLI is defined to be `good_service /
|
174
|
-
# total_service` over any queried time interval. The value of performance
|
175
|
-
# always falls into the range `0 <= performance <= 1`. A custom SLI describes
|
176
|
-
# how to compute this ratio, whether this is by dividing values from a pair of
|
177
|
-
# time series, cutting a `Distribution` into good and bad counts, or counting
|
178
|
-
# time windows in which the service complies with a criterion. For separation
|
179
|
-
# of concerns, a single Service-Level Indicator measures performance for only
|
180
|
-
# one aspect of service quality, such as fraction of successful queries or
|
181
|
-
# fast-enough queries.
|
182
|
-
# @!attribute [rw] basic_sli
|
183
|
-
# @return [Google::Monitoring::V3::BasicSli]
|
184
|
-
# Basic SLI on a well-known service type.
|
185
|
-
# @!attribute [rw] request_based
|
186
|
-
# @return [Google::Monitoring::V3::RequestBasedSli]
|
187
|
-
# Request-based SLIs
|
188
|
-
# @!attribute [rw] windows_based
|
189
|
-
# @return [Google::Monitoring::V3::WindowsBasedSli]
|
190
|
-
# Windows-based SLIs
|
191
|
-
class ServiceLevelIndicator; end
|
192
|
-
|
193
|
-
# An SLI measuring performance on a well-known service type. Performance will
|
194
|
-
# be computed on the basis of pre-defined metrics. The type of the
|
195
|
-
# `service_resource` determines the metrics to use and the
|
196
|
-
# `service_resource.labels` and `metric_labels` are used to construct a
|
197
|
-
# monitoring filter to filter that metric down to just the data relevant to
|
198
|
-
# this service.
|
199
|
-
# @!attribute [rw] method
|
200
|
-
# @return [Array<String>]
|
201
|
-
# OPTIONAL: The set of RPCs to which this SLI is relevant. Telemetry from
|
202
|
-
# other methods will not be used to calculate performance for this SLI. If
|
203
|
-
# omitted, this SLI applies to all the Service's methods. For service types
|
204
|
-
# that don't support breaking down by method, setting this field will result
|
205
|
-
# in an error.
|
206
|
-
# @!attribute [rw] location
|
207
|
-
# @return [Array<String>]
|
208
|
-
# OPTIONAL: The set of locations to which this SLI is relevant. Telemetry
|
209
|
-
# from other locations will not be used to calculate performance for this
|
210
|
-
# SLI. If omitted, this SLI applies to all locations in which the Service has
|
211
|
-
# activity. For service types that don't support breaking down by location,
|
212
|
-
# setting this field will result in an error.
|
213
|
-
# @!attribute [rw] version
|
214
|
-
# @return [Array<String>]
|
215
|
-
# OPTIONAL: The set of API versions to which this SLI is relevant. Telemetry
|
216
|
-
# from other API versions will not be used to calculate performance for this
|
217
|
-
# SLI. If omitted, this SLI applies to all API versions. For service types
|
218
|
-
# that don't support breaking down by version, setting this field will result
|
219
|
-
# in an error.
|
220
|
-
# @!attribute [rw] availability
|
221
|
-
# @return [Google::Monitoring::V3::BasicSli::AvailabilityCriteria]
|
222
|
-
# Good service is defined to be the count of requests made to this service
|
223
|
-
# that return successfully.
|
224
|
-
# @!attribute [rw] latency
|
225
|
-
# @return [Google::Monitoring::V3::BasicSli::LatencyCriteria]
|
226
|
-
# Good service is defined to be the count of requests made to this service
|
227
|
-
# that are fast enough with respect to `latency.threshold`.
|
228
|
-
class BasicSli
|
229
|
-
# Future parameters for the availability SLI.
|
230
|
-
class AvailabilityCriteria; end
|
231
|
-
|
232
|
-
# Parameters for a latency threshold SLI.
|
233
|
-
# @!attribute [rw] threshold
|
234
|
-
# @return [Google::Protobuf::Duration]
|
235
|
-
# Good service is defined to be the count of requests made to this service
|
236
|
-
# that return in no more than `threshold`.
|
237
|
-
class LatencyCriteria; end
|
238
|
-
end
|
239
|
-
|
240
|
-
# Range of numerical values, inclusive of `min` and exclusive of `max`. If the
|
241
|
-
# open range "< range.max" is desired, set `range.min = -infinity`. If the open
|
242
|
-
# range ">= range.min" is desired, set `range.max = infinity`.
|
243
|
-
# @!attribute [rw] min
|
244
|
-
# @return [Float]
|
245
|
-
# Range minimum.
|
246
|
-
# @!attribute [rw] max
|
247
|
-
# @return [Float]
|
248
|
-
# Range maximum.
|
249
|
-
class Range; end
|
250
|
-
|
251
|
-
# Service Level Indicators for which atomic units of service are counted
|
252
|
-
# directly.
|
253
|
-
# @!attribute [rw] good_total_ratio
|
254
|
-
# @return [Google::Monitoring::V3::TimeSeriesRatio]
|
255
|
-
# `good_total_ratio` is used when the ratio of `good_service` to
|
256
|
-
# `total_service` is computed from two `TimeSeries`.
|
257
|
-
# @!attribute [rw] distribution_cut
|
258
|
-
# @return [Google::Monitoring::V3::DistributionCut]
|
259
|
-
# `distribution_cut` is used when `good_service` is a count of values
|
260
|
-
# aggregated in a `Distribution` that fall into a good range. The
|
261
|
-
# `total_service` is the total count of all values aggregated in the
|
262
|
-
# `Distribution`.
|
263
|
-
class RequestBasedSli; end
|
264
|
-
|
265
|
-
# A `TimeSeriesRatio` specifies two `TimeSeries` to use for computing the
|
266
|
-
# `good_service / total_service` ratio. The specified `TimeSeries` must have
|
267
|
-
# `ValueType = DOUBLE` or `ValueType = INT64` and must have `MetricKind =
|
268
|
-
# DELTA` or `MetricKind = CUMULATIVE`. The `TimeSeriesRatio` must specify
|
269
|
-
# exactly two of good, bad, and total, and the relationship `good_service +
|
270
|
-
# bad_service = total_service` will be assumed.
|
271
|
-
# @!attribute [rw] good_service_filter
|
272
|
-
# @return [String]
|
273
|
-
# A [monitoring filter](https://cloud.google.com/monitoring/api/v3/filters)
|
274
|
-
# specifying a `TimeSeries` quantifying good service provided. Must have
|
275
|
-
# `ValueType = DOUBLE` or `ValueType = INT64` and must have `MetricKind =
|
276
|
-
# DELTA` or `MetricKind = CUMULATIVE`.
|
277
|
-
# @!attribute [rw] bad_service_filter
|
278
|
-
# @return [String]
|
279
|
-
# A [monitoring filter](https://cloud.google.com/monitoring/api/v3/filters)
|
280
|
-
# specifying a `TimeSeries` quantifying bad service, either demanded service
|
281
|
-
# that was not provided or demanded service that was of inadequate quality.
|
282
|
-
# Must have `ValueType = DOUBLE` or `ValueType = INT64` and must have
|
283
|
-
# `MetricKind = DELTA` or `MetricKind = CUMULATIVE`.
|
284
|
-
# @!attribute [rw] total_service_filter
|
285
|
-
# @return [String]
|
286
|
-
# A [monitoring filter](https://cloud.google.com/monitoring/api/v3/filters)
|
287
|
-
# specifying a `TimeSeries` quantifying total demanded service. Must have
|
288
|
-
# `ValueType = DOUBLE` or `ValueType = INT64` and must have `MetricKind =
|
289
|
-
# DELTA` or `MetricKind = CUMULATIVE`.
|
290
|
-
class TimeSeriesRatio; end
|
291
|
-
|
292
|
-
# A `DistributionCut` defines a `TimeSeries` and thresholds used for measuring
|
293
|
-
# good service and total service. The `TimeSeries` must have `ValueType =
|
294
|
-
# DISTRIBUTION` and `MetricKind = DELTA` or `MetricKind = CUMULATIVE`. The
|
295
|
-
# computed `good_service` will be the count of values x in the `Distribution`
|
296
|
-
# such that `range.min <= x < range.max`.
|
297
|
-
# @!attribute [rw] distribution_filter
|
298
|
-
# @return [String]
|
299
|
-
# A [monitoring filter](https://cloud.google.com/monitoring/api/v3/filters)
|
300
|
-
# specifying a `TimeSeries` aggregating values. Must have `ValueType =
|
301
|
-
# DISTRIBUTION` and `MetricKind = DELTA` or `MetricKind = CUMULATIVE`.
|
302
|
-
# @!attribute [rw] range
|
303
|
-
# @return [Google::Monitoring::V3::Range]
|
304
|
-
# Range of values considered "good." For a one-sided range, set one bound to
|
305
|
-
# an infinite value.
|
306
|
-
class DistributionCut; end
|
307
|
-
|
308
|
-
# A `WindowsBasedSli` defines `good_service` as the count of time windows for
|
309
|
-
# which the provided service was of good quality. Criteria for determining
|
310
|
-
# if service was good are embedded in the `window_criterion`.
|
311
|
-
# @!attribute [rw] good_bad_metric_filter
|
312
|
-
# @return [String]
|
313
|
-
# A [monitoring filter](https://cloud.google.com/monitoring/api/v3/filters)
|
314
|
-
# specifying a `TimeSeries` with `ValueType = BOOL`. The window is good if
|
315
|
-
# any `true` values appear in the window.
|
316
|
-
# @!attribute [rw] good_total_ratio_threshold
|
317
|
-
# @return [Google::Monitoring::V3::WindowsBasedSli::PerformanceThreshold]
|
318
|
-
# A window is good if its `performance` is high enough.
|
319
|
-
# @!attribute [rw] metric_mean_in_range
|
320
|
-
# @return [Google::Monitoring::V3::WindowsBasedSli::MetricRange]
|
321
|
-
# A window is good if the metric's value is in a good range, averaged
|
322
|
-
# across returned streams.
|
323
|
-
# @!attribute [rw] metric_sum_in_range
|
324
|
-
# @return [Google::Monitoring::V3::WindowsBasedSli::MetricRange]
|
325
|
-
# A window is good if the metric's value is in a good range, summed across
|
326
|
-
# returned streams.
|
327
|
-
# @!attribute [rw] window_period
|
328
|
-
# @return [Google::Protobuf::Duration]
|
329
|
-
# Duration over which window quality is evaluated. Must be an integer
|
330
|
-
# fraction of a day and at least `60s`.
|
331
|
-
class WindowsBasedSli
|
332
|
-
# A `PerformanceThreshold` is used when each window is good when that window
|
333
|
-
# has a sufficiently high `performance`.
|
334
|
-
# @!attribute [rw] performance
|
335
|
-
# @return [Google::Monitoring::V3::RequestBasedSli]
|
336
|
-
# `RequestBasedSli` to evaluate to judge window quality.
|
337
|
-
# @!attribute [rw] basic_sli_performance
|
338
|
-
# @return [Google::Monitoring::V3::BasicSli]
|
339
|
-
# `BasicSli` to evaluate to judge window quality.
|
340
|
-
# @!attribute [rw] threshold
|
341
|
-
# @return [Float]
|
342
|
-
# If window `performance >= threshold`, the window is counted as good.
|
343
|
-
class PerformanceThreshold; end
|
344
|
-
|
345
|
-
# A `MetricRange` is used when each window is good when the value x of a
|
346
|
-
# single `TimeSeries` satisfies `range.min <= x < range.max`. The provided
|
347
|
-
# `TimeSeries` must have `ValueType = INT64` or `ValueType = DOUBLE` and
|
348
|
-
# `MetricKind = GAUGE`.
|
349
|
-
# @!attribute [rw] time_series
|
350
|
-
# @return [String]
|
351
|
-
# A [monitoring filter](https://cloud.google.com/monitoring/api/v3/filters)
|
352
|
-
# specifying the `TimeSeries` to use for evaluating window quality.
|
353
|
-
# @!attribute [rw] range
|
354
|
-
# @return [Google::Monitoring::V3::Range]
|
355
|
-
# Range of values considered "good." For a one-sided range, set one bound
|
356
|
-
# to an infinite value.
|
357
|
-
class MetricRange; end
|
358
|
-
end
|
359
|
-
end
|
360
|
-
end
|
361
|
-
end
|