google-cloud-monitoring 0.29.1 → 0.29.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +5 -5
- data/lib/google/cloud/monitoring.rb +4 -4
- data/lib/google/cloud/monitoring/v3.rb +4 -4
- data/lib/google/cloud/monitoring/v3/alert_policy_service_client.rb +19 -19
- data/lib/google/cloud/monitoring/v3/doc/google/api/distribution.rb +18 -18
- data/lib/google/cloud/monitoring/v3/doc/google/api/metric.rb +69 -48
- data/lib/google/cloud/monitoring/v3/doc/google/api/monitored_resource.rb +20 -21
- data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/alert.rb +42 -42
- data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/alert_service.rb +24 -24
- data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/common.rb +21 -21
- data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/group.rb +9 -9
- data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/group_service.rb +24 -24
- data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/metric.rb +7 -7
- data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/metric_service.rb +41 -41
- data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/notification.rb +15 -15
- data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/notification_service.rb +30 -30
- data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/uptime.rb +8 -8
- data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/uptime_service.rb +21 -21
- data/lib/google/cloud/monitoring/v3/doc/google/protobuf/any.rb +8 -8
- data/lib/google/cloud/monitoring/v3/doc/google/protobuf/duration.rb +3 -3
- data/lib/google/cloud/monitoring/v3/doc/google/protobuf/empty.rb +1 -1
- data/lib/google/cloud/monitoring/v3/doc/google/protobuf/field_mask.rb +7 -7
- data/lib/google/cloud/monitoring/v3/doc/google/protobuf/struct.rb +11 -11
- data/lib/google/cloud/monitoring/v3/doc/google/protobuf/timestamp.rb +7 -7
- data/lib/google/cloud/monitoring/v3/doc/google/protobuf/wrappers.rb +18 -18
- data/lib/google/cloud/monitoring/v3/doc/google/rpc/status.rb +11 -11
- data/lib/google/cloud/monitoring/v3/group_service_client.rb +15 -15
- data/lib/google/cloud/monitoring/v3/metric_service_client.rb +20 -20
- data/lib/google/cloud/monitoring/v3/notification_channel_service_client.rb +11 -11
- data/lib/google/cloud/monitoring/v3/uptime_check_service_client.rb +14 -14
- metadata +3 -4
- data/lib/google/cloud/monitoring/v3/doc/overview.rb +0 -104
@@ -19,7 +19,7 @@ module Google
|
|
19
19
|
# A single strongly-typed value.
|
20
20
|
# @!attribute [rw] bool_value
|
21
21
|
# @return [true, false]
|
22
|
-
# A Boolean value:
|
22
|
+
# A Boolean value: `true` or `false`.
|
23
23
|
# @!attribute [rw] int64_value
|
24
24
|
# @return [Integer]
|
25
25
|
# A 64-bit integer. Its range is approximately ±9.2x10<sup>18</sup>.
|
@@ -51,19 +51,19 @@ module Google
|
|
51
51
|
|
52
52
|
# Describes how to combine multiple time series to provide different views of
|
53
53
|
# the data. Aggregation consists of an alignment step on individual time
|
54
|
-
# series (
|
54
|
+
# series (`alignment_period` and `per_series_aligner`) followed by an optional
|
55
55
|
# reduction step of the data across the aligned time series
|
56
|
-
# (
|
56
|
+
# (`cross_series_reducer` and `group_by_fields`). For more details, see
|
57
57
|
# [Aggregation](https://cloud.google.com/monitoring/api/learn_more#aggregation).
|
58
58
|
# @!attribute [rw] alignment_period
|
59
59
|
# @return [Google::Protobuf::Duration]
|
60
60
|
# The alignment period for per-{Google::Monitoring::V3::TimeSeries time series}
|
61
|
-
# alignment. If present,
|
61
|
+
# alignment. If present, `alignmentPeriod` must be at least 60
|
62
62
|
# seconds. After per-time series alignment, each time series will
|
63
63
|
# contain data points only on the period boundaries. If
|
64
|
-
#
|
65
|
-
# this field is ignored. If
|
66
|
-
# does not equal
|
64
|
+
# `perSeriesAligner` is not specified or equals `ALIGN_NONE`, then
|
65
|
+
# this field is ignored. If `perSeriesAligner` is specified and
|
66
|
+
# does not equal `ALIGN_NONE`, then this field must be defined;
|
67
67
|
# otherwise an error is returned.
|
68
68
|
# @!attribute [rw] per_series_aligner
|
69
69
|
# @return [Google::Monitoring::V3::Aggregation::Aligner]
|
@@ -74,9 +74,9 @@ module Google
|
|
74
74
|
# the time series.
|
75
75
|
#
|
76
76
|
# Time series data must be aligned in order to perform cross-time
|
77
|
-
# series reduction. If
|
78
|
-
#
|
79
|
-
# and
|
77
|
+
# series reduction. If `crossSeriesReducer` is specified, then
|
78
|
+
# `perSeriesAligner` must be specified and not equal `ALIGN_NONE`
|
79
|
+
# and `alignmentPeriod` must be specified; otherwise, an error is
|
80
80
|
# returned.
|
81
81
|
# @!attribute [rw] cross_series_reducer
|
82
82
|
# @return [Google::Monitoring::V3::Aggregation::Reducer]
|
@@ -87,25 +87,25 @@ module Google
|
|
87
87
|
# time series.
|
88
88
|
#
|
89
89
|
# Time series data must be aligned in order to perform cross-time
|
90
|
-
# series reduction. If
|
91
|
-
#
|
92
|
-
# and
|
90
|
+
# series reduction. If `crossSeriesReducer` is specified, then
|
91
|
+
# `perSeriesAligner` must be specified and not equal `ALIGN_NONE`
|
92
|
+
# and `alignmentPeriod` must be specified; otherwise, an error is
|
93
93
|
# returned.
|
94
94
|
# @!attribute [rw] group_by_fields
|
95
95
|
# @return [Array<String>]
|
96
|
-
# The set of fields to preserve when
|
97
|
-
# specified. The
|
96
|
+
# The set of fields to preserve when `crossSeriesReducer` is
|
97
|
+
# specified. The `groupByFields` determine how the time series are
|
98
98
|
# partitioned into subsets prior to applying the aggregation
|
99
99
|
# function. Each subset contains time series that have the same
|
100
100
|
# value for each of the grouping fields. Each individual time
|
101
101
|
# series is a member of exactly one subset. The
|
102
|
-
#
|
102
|
+
# `crossSeriesReducer` is applied to each subset of time series.
|
103
103
|
# It is not possible to reduce across different resource types, so
|
104
|
-
# this field implicitly contains
|
105
|
-
# specified in
|
106
|
-
#
|
104
|
+
# this field implicitly contains `resource.type`. Fields not
|
105
|
+
# specified in `groupByFields` are aggregated away. If
|
106
|
+
# `groupByFields` is not specified and all the time series have
|
107
107
|
# the same resource type, then the time series are aggregated into
|
108
|
-
# a single output time series. If
|
108
|
+
# a single output time series. If `crossSeriesReducer` is not
|
109
109
|
# defined, this field is ignored.
|
110
110
|
class Aggregation
|
111
111
|
# The Aligner describes how to bring the data points in a single
|
@@ -137,7 +137,7 @@ module Google
|
|
137
137
|
# and the output unit is one that has a "/time" dimension.
|
138
138
|
#
|
139
139
|
# If, by rate, you are looking for percentage change, see the
|
140
|
-
#
|
140
|
+
# `ALIGN_PERCENT_CHANGE` aligner option.
|
141
141
|
ALIGN_RATE = 2
|
142
142
|
|
143
143
|
# Align by interpolating between adjacent points around the
|
@@ -23,7 +23,7 @@ module Google
|
|
23
23
|
# monitored resources, and each monitored resource can be a member of any
|
24
24
|
# number of groups.
|
25
25
|
#
|
26
|
-
# Groups can be nested in parent-child hierarchies. The
|
26
|
+
# Groups can be nested in parent-child hierarchies. The `parentName` field
|
27
27
|
# identifies an optional parent for each group. If a group has a parent, then
|
28
28
|
# the only monitored resources available to be matched by the group's filter
|
29
29
|
# are the resources contained in the parent group. In other words, a group
|
@@ -32,9 +32,9 @@ module Google
|
|
32
32
|
# resource.
|
33
33
|
#
|
34
34
|
# For example, consider an infrastructure running a set of instances with two
|
35
|
-
# user-defined tags:
|
36
|
-
#
|
37
|
-
#
|
35
|
+
# user-defined tags: `"environment"` and `"role"`. A parent group has a filter,
|
36
|
+
# `environment="production"`. A child of that parent group has a filter,
|
37
|
+
# `role="transcoder"`. The parent group contains all instances in the
|
38
38
|
# production environment, regardless of their roles. The child group contains
|
39
39
|
# instances that have the transcoder role *and* are in the production
|
40
40
|
# environment.
|
@@ -45,18 +45,18 @@ module Google
|
|
45
45
|
# @!attribute [rw] name
|
46
46
|
# @return [String]
|
47
47
|
# Output only. The name of this group. The format is
|
48
|
-
#
|
48
|
+
# `"projects/{project_id_or_number}/groups/{group_id}"`.
|
49
49
|
# When creating a group, this field is ignored and a new name is created
|
50
|
-
# consisting of the project specified in the call to
|
51
|
-
# and a unique
|
50
|
+
# consisting of the project specified in the call to `CreateGroup`
|
51
|
+
# and a unique `{group_id}` that is generated automatically.
|
52
52
|
# @!attribute [rw] display_name
|
53
53
|
# @return [String]
|
54
54
|
# A user-assigned name for this group, used only for display purposes.
|
55
55
|
# @!attribute [rw] parent_name
|
56
56
|
# @return [String]
|
57
57
|
# The name of the group's parent, if it has one.
|
58
|
-
# The format is
|
59
|
-
# For groups with no parent,
|
58
|
+
# The format is `"projects/{project_id_or_number}/groups/{group_id}"`.
|
59
|
+
# For groups with no parent, `parentName` is the empty string, `""`.
|
60
60
|
# @!attribute [rw] filter
|
61
61
|
# @return [String]
|
62
62
|
# The filter used to determine which monitored resources belong to this group.
|
@@ -16,40 +16,40 @@
|
|
16
16
|
module Google
|
17
17
|
module Monitoring
|
18
18
|
module V3
|
19
|
-
# The
|
19
|
+
# The `ListGroup` request.
|
20
20
|
# @!attribute [rw] name
|
21
21
|
# @return [String]
|
22
22
|
# The project whose groups are to be listed. The format is
|
23
|
-
#
|
23
|
+
# `"projects/{project_id_or_number}"`.
|
24
24
|
# @!attribute [rw] children_of_group
|
25
25
|
# @return [String]
|
26
|
-
# A group name:
|
27
|
-
# Returns groups whose
|
26
|
+
# A group name: `"projects/{project_id_or_number}/groups/{group_id}"`.
|
27
|
+
# Returns groups whose `parentName` field contains the group
|
28
28
|
# name. If no groups have this parent, the results are empty.
|
29
29
|
# @!attribute [rw] ancestors_of_group
|
30
30
|
# @return [String]
|
31
|
-
# A group name:
|
31
|
+
# A group name: `"projects/{project_id_or_number}/groups/{group_id}"`.
|
32
32
|
# Returns groups that are ancestors of the specified group.
|
33
33
|
# The groups are returned in order, starting with the immediate parent and
|
34
34
|
# ending with the most distant ancestor. If the specified group has no
|
35
35
|
# immediate parent, the results are empty.
|
36
36
|
# @!attribute [rw] descendants_of_group
|
37
37
|
# @return [String]
|
38
|
-
# A group name:
|
38
|
+
# A group name: `"projects/{project_id_or_number}/groups/{group_id}"`.
|
39
39
|
# Returns the descendants of the specified group. This is a superset of
|
40
|
-
# the results returned by the
|
40
|
+
# the results returned by the `childrenOfGroup` filter, and includes
|
41
41
|
# children-of-children, and so forth.
|
42
42
|
# @!attribute [rw] page_size
|
43
43
|
# @return [Integer]
|
44
44
|
# A positive number that is the maximum number of results to return.
|
45
45
|
# @!attribute [rw] page_token
|
46
46
|
# @return [String]
|
47
|
-
# If this field is not empty then it must contain the
|
47
|
+
# If this field is not empty then it must contain the `nextPageToken` value
|
48
48
|
# returned by a previous call to this method. Using this field causes the
|
49
49
|
# method to return additional results from the previous method call.
|
50
50
|
class ListGroupsRequest; end
|
51
51
|
|
52
|
-
# The
|
52
|
+
# The `ListGroups` response.
|
53
53
|
# @!attribute [rw] group
|
54
54
|
# @return [Array<Google::Monitoring::V3::Group>]
|
55
55
|
# The groups that match the specified filters.
|
@@ -57,58 +57,58 @@ module Google
|
|
57
57
|
# @return [String]
|
58
58
|
# If there are more results than have been returned, then this field is set
|
59
59
|
# to a non-empty value. To see the additional results,
|
60
|
-
# use that value as
|
60
|
+
# use that value as `pageToken` in the next call to this method.
|
61
61
|
class ListGroupsResponse; end
|
62
62
|
|
63
|
-
# The
|
63
|
+
# The `GetGroup` request.
|
64
64
|
# @!attribute [rw] name
|
65
65
|
# @return [String]
|
66
66
|
# The group to retrieve. The format is
|
67
|
-
#
|
67
|
+
# `"projects/{project_id_or_number}/groups/{group_id}"`.
|
68
68
|
class GetGroupRequest; end
|
69
69
|
|
70
|
-
# The
|
70
|
+
# The `CreateGroup` request.
|
71
71
|
# @!attribute [rw] name
|
72
72
|
# @return [String]
|
73
73
|
# The project in which to create the group. The format is
|
74
|
-
#
|
74
|
+
# `"projects/{project_id_or_number}"`.
|
75
75
|
# @!attribute [rw] group
|
76
76
|
# @return [Google::Monitoring::V3::Group]
|
77
|
-
# A group definition. It is an error to define the
|
77
|
+
# A group definition. It is an error to define the `name` field because
|
78
78
|
# the system assigns the name.
|
79
79
|
# @!attribute [rw] validate_only
|
80
80
|
# @return [true, false]
|
81
81
|
# If true, validate this request but do not create the group.
|
82
82
|
class CreateGroupRequest; end
|
83
83
|
|
84
|
-
# The
|
84
|
+
# The `UpdateGroup` request.
|
85
85
|
# @!attribute [rw] group
|
86
86
|
# @return [Google::Monitoring::V3::Group]
|
87
87
|
# The new definition of the group. All fields of the existing group,
|
88
|
-
# excepting
|
88
|
+
# excepting `name`, are replaced with the corresponding fields of this group.
|
89
89
|
# @!attribute [rw] validate_only
|
90
90
|
# @return [true, false]
|
91
91
|
# If true, validate this request but do not update the existing group.
|
92
92
|
class UpdateGroupRequest; end
|
93
93
|
|
94
|
-
# The
|
94
|
+
# The `DeleteGroup` request. You can only delete a group if it has no children.
|
95
95
|
# @!attribute [rw] name
|
96
96
|
# @return [String]
|
97
97
|
# The group to delete. The format is
|
98
|
-
#
|
98
|
+
# `"projects/{project_id_or_number}/groups/{group_id}"`.
|
99
99
|
class DeleteGroupRequest; end
|
100
100
|
|
101
|
-
# The
|
101
|
+
# The `ListGroupMembers` request.
|
102
102
|
# @!attribute [rw] name
|
103
103
|
# @return [String]
|
104
104
|
# The group whose members are listed. The format is
|
105
|
-
#
|
105
|
+
# `"projects/{project_id_or_number}/groups/{group_id}"`.
|
106
106
|
# @!attribute [rw] page_size
|
107
107
|
# @return [Integer]
|
108
108
|
# A positive number that is the maximum number of results to return.
|
109
109
|
# @!attribute [rw] page_token
|
110
110
|
# @return [String]
|
111
|
-
# If this field is not empty then it must contain the
|
111
|
+
# If this field is not empty then it must contain the `nextPageToken` value
|
112
112
|
# returned by a previous call to this method. Using this field causes the
|
113
113
|
# method to return additional results from the previous method call.
|
114
114
|
# @!attribute [rw] filter
|
@@ -128,7 +128,7 @@ module Google
|
|
128
128
|
# membership over the last minute is returned.
|
129
129
|
class ListGroupMembersRequest; end
|
130
130
|
|
131
|
-
# The
|
131
|
+
# The `ListGroupMembers` response.
|
132
132
|
# @!attribute [rw] members
|
133
133
|
# @return [Array<Google::Api::MonitoredResource>]
|
134
134
|
# A set of monitored resources in the group.
|
@@ -136,7 +136,7 @@ module Google
|
|
136
136
|
# @return [String]
|
137
137
|
# If there are more results than have been returned, then this field is
|
138
138
|
# set to a non-empty value. To see the additional results, use that value as
|
139
|
-
#
|
139
|
+
# `pageToken` in the next call to this method.
|
140
140
|
# @!attribute [rw] total_size
|
141
141
|
# @return [Integer]
|
142
142
|
# The total number of elements matching this request.
|
@@ -19,10 +19,10 @@ module Google
|
|
19
19
|
# A single data point in a time series.
|
20
20
|
# @!attribute [rw] interval
|
21
21
|
# @return [Google::Monitoring::V3::TimeInterval]
|
22
|
-
# The time interval to which the data point applies. For
|
23
|
-
# only the end time of the interval is used. For
|
22
|
+
# The time interval to which the data point applies. For `GAUGE` metrics,
|
23
|
+
# only the end time of the interval is used. For `DELTA` metrics, the start
|
24
24
|
# and end time should specify a non-zero interval, with subsequent points
|
25
|
-
# specifying contiguous and non-overlapping intervals. For
|
25
|
+
# specifying contiguous and non-overlapping intervals. For `CUMULATIVE`
|
26
26
|
# metrics, the start and end time should specify a non-zero interval, with
|
27
27
|
# subsequent points specifying the same start time and increasing end times,
|
28
28
|
# until an event resets the cumulative value to zero and sets a new start
|
@@ -58,8 +58,8 @@ module Google
|
|
58
58
|
# When creating a time series, this field is optional. If present, it must be
|
59
59
|
# the same as the metric kind of the associated metric. If the associated
|
60
60
|
# metric's descriptor must be auto-created, then this field specifies the
|
61
|
-
# metric kind of the new descriptor and must be either
|
62
|
-
# or
|
61
|
+
# metric kind of the new descriptor and must be either `GAUGE` (the default)
|
62
|
+
# or `CUMULATIVE`.
|
63
63
|
# @!attribute [rw] value_type
|
64
64
|
# @return [Google::Api::MetricDescriptor::ValueType]
|
65
65
|
# The value type of the time series. When listing time series, this value
|
@@ -67,7 +67,7 @@ module Google
|
|
67
67
|
# this time series is an alignment or reduction of other time series.
|
68
68
|
#
|
69
69
|
# When creating a time series, this field is optional. If present, it must be
|
70
|
-
# the same as the type of the data in the
|
70
|
+
# the same as the type of the data in the `points` field.
|
71
71
|
# @!attribute [rw] points
|
72
72
|
# @return [Array<Google::Monitoring::V3::Point>]
|
73
73
|
# The data points of this time series. When listing time series, points are
|
@@ -77,7 +77,7 @@ module Google
|
|
77
77
|
# the point's type must be the same as the value type of the associated
|
78
78
|
# metric. If the associated metric's descriptor must be auto-created, then
|
79
79
|
# the value type of the descriptor is determined by the point's type, which
|
80
|
-
# must be
|
80
|
+
# must be `BOOL`, `INT64`, `DOUBLE`, or `DISTRIBUTION`.
|
81
81
|
class TimeSeries; end
|
82
82
|
end
|
83
83
|
end
|
@@ -16,18 +16,18 @@
|
|
16
16
|
module Google
|
17
17
|
module Monitoring
|
18
18
|
module V3
|
19
|
-
# The
|
19
|
+
# The `ListMonitoredResourceDescriptors` request.
|
20
20
|
# @!attribute [rw] name
|
21
21
|
# @return [String]
|
22
22
|
# The project on which to execute the request. The format is
|
23
|
-
#
|
23
|
+
# `"projects/{project_id_or_number}"`.
|
24
24
|
# @!attribute [rw] filter
|
25
25
|
# @return [String]
|
26
26
|
# An optional [filter](https://cloud.google.com/monitoring/api/v3/filters) describing
|
27
27
|
# the descriptors to be returned. The filter can reference
|
28
28
|
# the descriptor's type and labels. For example, the
|
29
29
|
# following filter returns only Google Compute Engine descriptors
|
30
|
-
# that have an
|
30
|
+
# that have an `id` label:
|
31
31
|
#
|
32
32
|
# resource.type = starts_with("gce_") AND resource.label:id
|
33
33
|
# @!attribute [rw] page_size
|
@@ -35,37 +35,37 @@ module Google
|
|
35
35
|
# A positive number that is the maximum number of results to return.
|
36
36
|
# @!attribute [rw] page_token
|
37
37
|
# @return [String]
|
38
|
-
# If this field is not empty then it must contain the
|
38
|
+
# If this field is not empty then it must contain the `nextPageToken` value
|
39
39
|
# returned by a previous call to this method. Using this field causes the
|
40
40
|
# method to return additional results from the previous method call.
|
41
41
|
class ListMonitoredResourceDescriptorsRequest; end
|
42
42
|
|
43
|
-
# The
|
43
|
+
# The `ListMonitoredResourceDescriptors` response.
|
44
44
|
# @!attribute [rw] resource_descriptors
|
45
45
|
# @return [Array<Google::Api::MonitoredResourceDescriptor>]
|
46
46
|
# The monitored resource descriptors that are available to this project
|
47
|
-
# and that match
|
47
|
+
# and that match `filter`, if present.
|
48
48
|
# @!attribute [rw] next_page_token
|
49
49
|
# @return [String]
|
50
50
|
# If there are more results than have been returned, then this field is set
|
51
51
|
# to a non-empty value. To see the additional results,
|
52
|
-
# use that value as
|
52
|
+
# use that value as `pageToken` in the next call to this method.
|
53
53
|
class ListMonitoredResourceDescriptorsResponse; end
|
54
54
|
|
55
|
-
# The
|
55
|
+
# The `GetMonitoredResourceDescriptor` request.
|
56
56
|
# @!attribute [rw] name
|
57
57
|
# @return [String]
|
58
58
|
# The monitored resource descriptor to get. The format is
|
59
|
-
#
|
60
|
-
# The
|
61
|
-
#
|
59
|
+
# `"projects/{project_id_or_number}/monitoredResourceDescriptors/{resource_type}"`.
|
60
|
+
# The `{resource_type}` is a predefined type, such as
|
61
|
+
# `cloudsql_database`.
|
62
62
|
class GetMonitoredResourceDescriptorRequest; end
|
63
63
|
|
64
|
-
# The
|
64
|
+
# The `ListMetricDescriptors` request.
|
65
65
|
# @!attribute [rw] name
|
66
66
|
# @return [String]
|
67
67
|
# The project on which to execute the request. The format is
|
68
|
-
#
|
68
|
+
# `"projects/{project_id_or_number}"`.
|
69
69
|
# @!attribute [rw] filter
|
70
70
|
# @return [String]
|
71
71
|
# If this field is empty, all custom and
|
@@ -81,53 +81,53 @@ module Google
|
|
81
81
|
# A positive number that is the maximum number of results to return.
|
82
82
|
# @!attribute [rw] page_token
|
83
83
|
# @return [String]
|
84
|
-
# If this field is not empty then it must contain the
|
84
|
+
# If this field is not empty then it must contain the `nextPageToken` value
|
85
85
|
# returned by a previous call to this method. Using this field causes the
|
86
86
|
# method to return additional results from the previous method call.
|
87
87
|
class ListMetricDescriptorsRequest; end
|
88
88
|
|
89
|
-
# The
|
89
|
+
# The `ListMetricDescriptors` response.
|
90
90
|
# @!attribute [rw] metric_descriptors
|
91
91
|
# @return [Array<Google::Api::MetricDescriptor>]
|
92
92
|
# The metric descriptors that are available to the project
|
93
|
-
# and that match the value of
|
93
|
+
# and that match the value of `filter`, if present.
|
94
94
|
# @!attribute [rw] next_page_token
|
95
95
|
# @return [String]
|
96
96
|
# If there are more results than have been returned, then this field is set
|
97
97
|
# to a non-empty value. To see the additional results,
|
98
|
-
# use that value as
|
98
|
+
# use that value as `pageToken` in the next call to this method.
|
99
99
|
class ListMetricDescriptorsResponse; end
|
100
100
|
|
101
|
-
# The
|
101
|
+
# The `GetMetricDescriptor` request.
|
102
102
|
# @!attribute [rw] name
|
103
103
|
# @return [String]
|
104
104
|
# The metric descriptor on which to execute the request. The format is
|
105
|
-
#
|
106
|
-
# An example value of
|
107
|
-
#
|
105
|
+
# `"projects/{project_id_or_number}/metricDescriptors/{metric_id}"`.
|
106
|
+
# An example value of `{metric_id}` is
|
107
|
+
# `"compute.googleapis.com/instance/disk/read_bytes_count"`.
|
108
108
|
class GetMetricDescriptorRequest; end
|
109
109
|
|
110
|
-
# The
|
110
|
+
# The `CreateMetricDescriptor` request.
|
111
111
|
# @!attribute [rw] name
|
112
112
|
# @return [String]
|
113
113
|
# The project on which to execute the request. The format is
|
114
|
-
#
|
114
|
+
# `"projects/{project_id_or_number}"`.
|
115
115
|
# @!attribute [rw] metric_descriptor
|
116
116
|
# @return [Google::Api::MetricDescriptor]
|
117
117
|
# The new [custom metric](https://cloud.google.com/monitoring/custom-metrics)
|
118
118
|
# descriptor.
|
119
119
|
class CreateMetricDescriptorRequest; end
|
120
120
|
|
121
|
-
# The
|
121
|
+
# The `DeleteMetricDescriptor` request.
|
122
122
|
# @!attribute [rw] name
|
123
123
|
# @return [String]
|
124
124
|
# The metric descriptor on which to execute the request. The format is
|
125
|
-
#
|
126
|
-
# An example of
|
127
|
-
#
|
125
|
+
# `"projects/{project_id_or_number}/metricDescriptors/{metric_id}"`.
|
126
|
+
# An example of `{metric_id}` is:
|
127
|
+
# `"custom.googleapis.com/my_test_metric"`.
|
128
128
|
class DeleteMetricDescriptorRequest; end
|
129
129
|
|
130
|
-
# The
|
130
|
+
# The `ListTimeSeries` request.
|
131
131
|
# @!attribute [rw] name
|
132
132
|
# @return [String]
|
133
133
|
# The project on which to execute the request. The format is
|
@@ -161,17 +161,17 @@ module Google
|
|
161
161
|
# @!attribute [rw] page_size
|
162
162
|
# @return [Integer]
|
163
163
|
# A positive number that is the maximum number of results to return. If
|
164
|
-
#
|
165
|
-
#
|
166
|
-
# maximum number of
|
167
|
-
# the maximum number of
|
164
|
+
# `page_size` is empty or more than 100,000 results, the effective
|
165
|
+
# `page_size` is 100,000 results. If `view` is set to `FULL`, this is the
|
166
|
+
# maximum number of `Points` returned. If `view` is set to `HEADERS`, this is
|
167
|
+
# the maximum number of `TimeSeries` returned.
|
168
168
|
# @!attribute [rw] page_token
|
169
169
|
# @return [String]
|
170
|
-
# If this field is not empty then it must contain the
|
170
|
+
# If this field is not empty then it must contain the `nextPageToken` value
|
171
171
|
# returned by a previous call to this method. Using this field causes the
|
172
172
|
# method to return additional results from the previous method call.
|
173
173
|
class ListTimeSeriesRequest
|
174
|
-
# Controls which fields are returned by
|
174
|
+
# Controls which fields are returned by `ListTimeSeries`.
|
175
175
|
module TimeSeriesView
|
176
176
|
# Returns the identity of the metric(s), the time series,
|
177
177
|
# and the time series data.
|
@@ -183,7 +183,7 @@ module Google
|
|
183
183
|
end
|
184
184
|
end
|
185
185
|
|
186
|
-
# The
|
186
|
+
# The `ListTimeSeries` response.
|
187
187
|
# @!attribute [rw] time_series
|
188
188
|
# @return [Array<Google::Monitoring::V3::TimeSeries>]
|
189
189
|
# One or more time series that match the filter included in the request.
|
@@ -191,32 +191,32 @@ module Google
|
|
191
191
|
# @return [String]
|
192
192
|
# If there are more results than have been returned, then this field is set
|
193
193
|
# to a non-empty value. To see the additional results,
|
194
|
-
# use that value as
|
194
|
+
# use that value as `pageToken` in the next call to this method.
|
195
195
|
# @!attribute [rw] execution_errors
|
196
196
|
# @return [Array<Google::Rpc::Status>]
|
197
197
|
# Query execution errors that may have caused the time series data returned
|
198
198
|
# to be incomplete.
|
199
199
|
class ListTimeSeriesResponse; end
|
200
200
|
|
201
|
-
# The
|
201
|
+
# The `CreateTimeSeries` request.
|
202
202
|
# @!attribute [rw] name
|
203
203
|
# @return [String]
|
204
204
|
# The project on which to execute the request. The format is
|
205
|
-
#
|
205
|
+
# `"projects/{project_id_or_number}"`.
|
206
206
|
# @!attribute [rw] time_series
|
207
207
|
# @return [Array<Google::Monitoring::V3::TimeSeries>]
|
208
208
|
# The new data to be added to a list of time series.
|
209
209
|
# Adds at most one data point to each of several time series. The new data
|
210
210
|
# point must be more recent than any other point in its time series. Each
|
211
|
-
#
|
211
|
+
# `TimeSeries` value must fully specify a unique time series by supplying
|
212
212
|
# all label values for the metric and the monitored resource.
|
213
213
|
class CreateTimeSeriesRequest; end
|
214
214
|
|
215
215
|
# Describes the result of a failed request to write data to a time series.
|
216
216
|
# @!attribute [rw] time_series
|
217
217
|
# @return [Google::Monitoring::V3::TimeSeries]
|
218
|
-
# The time series, including the
|
219
|
-
# and
|
218
|
+
# The time series, including the `Metric`, `MonitoredResource`,
|
219
|
+
# and `Point`s (including timestamp and value) that resulted
|
220
220
|
# in the error. This field provides all of the context that
|
221
221
|
# would be needed to retry the operation.
|
222
222
|
# @!attribute [rw] status
|