google-cloud-monitoring-v3 0.1.0

data/proto_docs/google/monitoring/v3/dropped_labels.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module Monitoring
+      module V3
+        # A set of (label, value) pairs which were dropped during aggregation, attached
+        # to google.api.Distribution.Exemplars in google.api.Distribution values during
+        # aggregation.
+        #
+        # These values are used in combination with the label values that remain on the
+        # aggregated Distribution timeseries to construct the full label set for the
+        # exemplar values.  The resulting full label set may be used to identify the
+        # specific task/job/instance (for example) which may be contributing to a
+        # long-tail, while allowing the storage savings of only storing aggregated
+        # distribution values for a large group.
+        #
+        # Note that there are no guarantees on ordering of the labels from
+        # exemplar-to-exemplar and from distribution-to-distribution in the same
+        # stream, and there may be duplicates.  It is up to clients to resolve any
+        # ambiguities.
+        # @!attribute [rw] label
+        #   @return [::Google::Protobuf::Map{::String => ::String}]
+        #     Map from label to its value, for all labels dropped in any aggregation.
+        class DroppedLabels
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::String]
+          class LabelEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/monitoring/v3/group.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module Monitoring
+      module V3
+        # The description of a dynamic collection of monitored resources. Each group
+        # has a filter that is matched against monitored resources and their associated
+        # metadata. If a group's filter matches an available monitored resource, then
+        # that resource is a member of that group.  Groups can contain any number of
+        # monitored resources, and each monitored resource can be a member of any
+        # number of groups.
+        #
+        # Groups can be nested in parent-child hierarchies. The `parentName` field
+        # identifies an optional parent for each group.  If a group has a parent, then
+        # the only monitored resources available to be matched by the group's filter
+        # are the resources contained in the parent group.  In other words, a group
+        # contains the monitored resources that match its filter and the filters of all
+        # the group's ancestors.  A group without a parent can contain any monitored
+        # resource.
+        #
+        # For example, consider an infrastructure running a set of instances with two
+        # user-defined tags: `"environment"` and `"role"`. A parent group has a filter,
+        # `environment="production"`.  A child of that parent group has a filter,
+        # `role="transcoder"`.  The parent group contains all instances in the
+        # production environment, regardless of their roles.  The child group contains
+        # instances that have the transcoder role *and* are in the production
+        # environment.
+        #
+        # The monitored resources contained in a group can change at any moment,
+        # depending on what resources exist and what filters are associated with the
+        # group and its ancestors.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Output only. The name of this group. The format is:
+        #
+        #         projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]
+        #
+        #     When creating a group, this field is ignored and a new name is created
+        #     consisting of the project specified in the call to `CreateGroup`
+        #     and a unique `[GROUP_ID]` that is generated automatically.
+        # @!attribute [rw] display_name
+        #   @return [::String]
+        #     A user-assigned name for this group, used only for display purposes.
+        # @!attribute [rw] parent_name
+        #   @return [::String]
+        #     The name of the group's parent, if it has one. The format is:
+        #
+        #         projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]
+        #
+        #     For groups with no parent, `parent_name` is the empty string, `""`.
+        # @!attribute [rw] filter
+        #   @return [::String]
+        #     The filter used to determine which monitored resources belong to this
+        #     group.
+        # @!attribute [rw] is_cluster
+        #   @return [::Boolean]
+        #     If true, the members of this group are considered to be a cluster.
+        #     The system can perform additional analysis on groups that are clusters.
+        class Group
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/monitoring/v3/group_service.rb

@@ -0,0 +1,197 @@
+# frozen_string_literal: true
+
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module Monitoring
+      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]
+        # @!attribute [rw] children_of_group
+        #   @return [::String]
+        #     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. 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. 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 `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 `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
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The `ListGroups` response.
+        # @!attribute [rw] group
+        #   @return [::Array<::Google::Cloud::Monitoring::V3::Group>]
+        #     The groups that match the specified filters.
+        # @!attribute [rw] next_page_token
+        #   @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 `page_token` in the next call to this method.
+        class ListGroupsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        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]
+        class GetGroupRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        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]
+        # @!attribute [rw] group
+        #   @return [::Google::Cloud::Monitoring::V3::Group]
+        #     Required. A group definition. It is an error to define the `name` field because
+        #     the system assigns the name.
+        # @!attribute [rw] validate_only
+        #   @return [::Boolean]
+        #     If true, validate this request but do not create the group.
+        class CreateGroupRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The `UpdateGroup` request.
+        # @!attribute [rw] group
+        #   @return [::Google::Cloud::Monitoring::V3::Group]
+        #     Required. The new definition of the group.  All fields of the existing group,
+        #     excepting `name`, are replaced with the corresponding fields of this group.
+        # @!attribute [rw] validate_only
+        #   @return [::Boolean]
+        #     If true, validate this request but do not update the existing group.
+        class UpdateGroupRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The `DeleteGroup` request. The default behavior is to be able to delete a
+        # 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]
+        # @!attribute [rw] recursive
+        #   @return [::Boolean]
+        #     If this field is true, then the request means to delete a group with all
+        #     its descendants. Otherwise, the request means to delete a group only when
+        #     it has no descendants. The default value is false.
+        class DeleteGroupRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        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]
+        # @!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 `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:
+        #
+        #         `resource.type = "gce_instance"`
+        # @!attribute [rw] interval
+        #   @return [::Google::Cloud::Monitoring::V3::TimeInterval]
+        #     An optional time interval for which results should be returned. Only
+        #     members that were part of the group during the specified interval are
+        #     included in the response.  If no interval is provided then the group
+        #     membership over the last minute is returned.
+        class ListGroupMembersRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The `ListGroupMembers` response.
+        # @!attribute [rw] members
+        #   @return [::Array<::Google::Api::MonitoredResource>]
+        #     A set of monitored resources in the group.
+        # @!attribute [rw] next_page_token
+        #   @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
+        #     `page_token` in the next call to this method.
+        # @!attribute [rw] total_size
+        #   @return [::Integer]
+        #     The total number of elements matching this request.
+        class ListGroupMembersResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/monitoring/v3/metric.rb

@@ -0,0 +1,249 @@
+# frozen_string_literal: true
+
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module Monitoring
+      module V3
+        # A single data point in a time series.
+        # @!attribute [rw] interval
+        #   @return [::Google::Cloud::Monitoring::V3::TimeInterval]
+        #     The time interval to which the data point applies.  For `GAUGE` metrics,
+        #     the start time is optional, but if it is supplied, it must equal the
+        #     end time.  For `DELTA` metrics, the start
+        #     and end time should specify a non-zero interval, with subsequent points
+        #     specifying contiguous and non-overlapping intervals.  For `CUMULATIVE`
+        #     metrics, the start and end time should specify a non-zero interval, with
+        #     subsequent points specifying the same start time and increasing end times,
+        #     until an event resets the cumulative value to zero and sets a new start
+        #     time for the following points.
+        # @!attribute [rw] value
+        #   @return [::Google::Cloud::Monitoring::V3::TypedValue]
+        #     The value of the data point.
+        class Point
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # A collection of data points that describes the time-varying values
+        # of a metric. A time series is identified by a combination of a
+        # fully-specified monitored resource and a fully-specified metric.
+        # This type is used for both listing and creating time series.
+        # @!attribute [rw] metric
+        #   @return [::Google::Api::Metric]
+        #     The associated metric. A fully-specified metric used to identify the time
+        #     series.
+        # @!attribute [rw] resource
+        #   @return [::Google::Api::MonitoredResource]
+        #     The associated monitored resource.  Custom metrics can use only certain
+        #     monitored resource types in their time series data.
+        # @!attribute [rw] metadata
+        #   @return [::Google::Api::MonitoredResourceMetadata]
+        #     Output only. The associated monitored resource metadata. When reading a
+        #     a timeseries, this field will include metadata labels that are explicitly
+        #     named in the reduction. When creating a timeseries, this field is ignored.
+        # @!attribute [rw] metric_kind
+        #   @return [::Google::Api::MetricDescriptor::MetricKind]
+        #     The metric kind of the time series. When listing time series, this metric
+        #     kind might be different from the metric kind of the associated metric if
+        #     this time series is an alignment or reduction of other time series.
+        #
+        #     When creating a time series, this field is optional. If present, it must be
+        #     the same as the metric kind of the associated metric. If the associated
+        #     metric's descriptor must be auto-created, then this field specifies the
+        #     metric kind of the new descriptor and must be either `GAUGE` (the default)
+        #     or `CUMULATIVE`.
+        # @!attribute [rw] value_type
+        #   @return [::Google::Api::MetricDescriptor::ValueType]
+        #     The value type of the time series. When listing time series, this value
+        #     type might be different from the value type of the associated metric if
+        #     this time series is an alignment or reduction of other time series.
+        #
+        #     When creating a time series, this field is optional. If present, it must be
+        #     the same as the type of the data in the `points` field.
+        # @!attribute [rw] points
+        #   @return [::Array<::Google::Cloud::Monitoring::V3::Point>]
+        #     The data points of this time series. When listing time series, points are
+        #     returned in reverse time order.
+        #
+        #     When creating a time series, this field must contain exactly one point and
+        #     the point's type must be the same as the value type of the associated
+        #     metric. If the associated metric's descriptor must be auto-created, then
+        #     the value type of the descriptor is determined by the point's type, which
+        #     must be `BOOL`, `INT64`, `DOUBLE`, or `DISTRIBUTION`.
+        class TimeSeries
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # A descriptor for the labels and points in a timeseries.
+        # @!attribute [rw] label_descriptors
+        #   @return [::Array<::Google::Api::LabelDescriptor>]
+        #     Descriptors for the labels.
+        # @!attribute [rw] point_descriptors
+        #   @return [::Array<::Google::Cloud::Monitoring::V3::TimeSeriesDescriptor::ValueDescriptor>]
+        #     Descriptors for the point data value columns.
+        class TimeSeriesDescriptor
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # A descriptor for the value columns in a data point.
+          # @!attribute [rw] key
+          #   @return [::String]
+          #     The value key.
+          # @!attribute [rw] value_type
+          #   @return [::Google::Api::MetricDescriptor::ValueType]
+          #     The value type.
+          # @!attribute [rw] metric_kind
+          #   @return [::Google::Api::MetricDescriptor::MetricKind]
+          #     The value stream kind.
+          class ValueDescriptor
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # Represents the values of a time series associated with a
+        # TimeSeriesDescriptor.
+        # @!attribute [rw] label_values
+        #   @return [::Array<::Google::Cloud::Monitoring::V3::LabelValue>]
+        #     The values of the labels in the time series identifier, given in the same
+        #     order as the `label_descriptors` field of the TimeSeriesDescriptor
+        #     associated with this object. Each value must have a value of the type
+        #     given in the corresponding entry of `label_descriptors`.
+        # @!attribute [rw] point_data
+        #   @return [::Array<::Google::Cloud::Monitoring::V3::TimeSeriesData::PointData>]
+        #     The points in the time series.
+        class TimeSeriesData
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # A point's value columns and time interval. Each point has one or more
+          # point values corresponding to the entries in `point_descriptors` field in
+          # the TimeSeriesDescriptor associated with this object.
+          # @!attribute [rw] values
+          #   @return [::Array<::Google::Cloud::Monitoring::V3::TypedValue>]
+          #     The values that make up the point.
+          # @!attribute [rw] time_interval
+          #   @return [::Google::Cloud::Monitoring::V3::TimeInterval]
+          #     The time interval associated with the point.
+          class PointData
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # A label value.
+        # @!attribute [rw] bool_value
+        #   @return [::Boolean]
+        #     A bool label value.
+        # @!attribute [rw] int64_value
+        #   @return [::Integer]
+        #     An int64 label value.
+        # @!attribute [rw] string_value
+        #   @return [::String]
+        #     A string label value.
+        class LabelValue
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # An error associated with a query in the time series query language format.
+        # @!attribute [rw] locator
+        #   @return [::Google::Cloud::Monitoring::V3::TextLocator]
+        #     The location of the time series query language text that this error applies
+        #     to.
+        # @!attribute [rw] message
+        #   @return [::String]
+        #     The error message.
+        class QueryError
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # A locator for text. Indicates a particular part of the text of a request or
+        # of an object referenced in the request.
+        #
+        # For example, suppose the request field `text` contains:
+        #
+        #   text: "The quick brown fox jumps over the lazy dog."
+        #
+        # Then the locator:
+        #
+        #   source: "text"
+        #   start_position {
+        #     line: 1
+        #     column: 17
+        #   }
+        #   end_position {
+        #     line: 1
+        #     column: 19
+        #   }
+        #
+        # refers to the part of the text: "fox".
+        # @!attribute [rw] source
+        #   @return [::String]
+        #     The source of the text. The source may be a field in the request, in which
+        #     case its format is the format of the
+        #     google.rpc.BadRequest.FieldViolation.field field in
+        #     https://cloud.google.com/apis/design/errors#error_details. It may also be
+        #     be a source other than the request field (e.g. a macro definition
+        #     referenced in the text of the query), in which case this is the name of
+        #     the source (e.g. the macro name).
+        # @!attribute [rw] start_position
+        #   @return [::Google::Cloud::Monitoring::V3::TextLocator::Position]
+        #     The position of the first byte within the text.
+        # @!attribute [rw] end_position
+        #   @return [::Google::Cloud::Monitoring::V3::TextLocator::Position]
+        #     The position of the last byte within the text.
+        # @!attribute [rw] nested_locator
+        #   @return [::Google::Cloud::Monitoring::V3::TextLocator]
+        #     If `source`, `start_position`, and `end_position` describe a call on
+        #     some object (e.g. a macro in the time series query language text) and a
+        #     location is to be designated in that object's text, `nested_locator`
+        #     identifies the location within that object.
+        # @!attribute [rw] nesting_reason
+        #   @return [::String]
+        #     When `nested_locator` is set, this field gives the reason for the nesting.
+        #     Usually, the reason is a macro invocation. In that case, the macro name
+        #     (including the leading '@') signals the location of the macro call
+        #     in the text and a macro argument name (including the leading '$') signals
+        #     the location of the macro argument inside the macro body that got
+        #     substituted away.
+        class TextLocator
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The position of a byte within the text.
+          # @!attribute [rw] line
+          #   @return [::Integer]
+          #     The line, starting with 1, where the byte is positioned.
+          # @!attribute [rw] column
+          #   @return [::Integer]
+          #     The column within the line, starting with 1, where the byte is
+          #     positioned. This is a byte index even though the text is UTF-8.
+          class Position
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end