google-cloud-monitoring 0.38.0 → 1.0.0

data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/group.rb

@@ -1,75 +0,0 @@
-# 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.
-
-
-module Google
-  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 [true, false]
-      #     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; end
-    end
-  end
-end

data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/group_service.rb

@@ -1,167 +0,0 @@
-# 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.
-
-
-module Google
-  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; end
-
-      # The `ListGroups` response.
-      # @!attribute [rw] group
-      #   @return [Array<Google::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; 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; 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::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 [true, false]
-      #     If true, validate this request but do not create the group.
-      class CreateGroupRequest; end
-
-      # The `UpdateGroup` request.
-      # @!attribute [rw] group
-      #   @return [Google::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 [true, false]
-      #     If true, validate this request but do not update the existing group.
-      class UpdateGroupRequest; 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 [true, false]
-      #     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; 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::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; 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; end
-    end
-  end
-end

data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/metric.rb

@@ -1,85 +0,0 @@
-# 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.
-
-
-module Google
-  module Monitoring
-    module V3
-      # A single data point in a time series.
-      # @!attribute [rw] interval
-      #   @return [Google::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::Monitoring::V3::TypedValue]
-      #     The value of the data point.
-      class Point; 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::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; end
-    end
-  end
-end

data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/metric_service.rb

@@ -1,230 +0,0 @@
-# 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.
-
-
-module Google
-  module Monitoring
-    module V3
-      # The `ListMonitoredResourceDescriptors` request.
-      # @!attribute [rw] name
-      #   @return [String]
-      #     Required. The project on which to execute the request. The format is:
-      #
-      #         projects/[PROJECT_ID_OR_NUMBER]
-      # @!attribute [rw] filter
-      #   @return [String]
-      #     An optional [filter](https://cloud.google.com/monitoring/api/v3/filters)
-      #     describing the descriptors to be returned.  The filter can reference the
-      #     descriptor's type and labels. For example, the following filter returns
-      #     only Google Compute Engine descriptors that have an `id` label:
-      #
-      #         resource.type = starts_with("gce_") AND resource.label:id
-      # @!attribute [rw] page_size
-      #   @return [Integer]
-      #     A positive number that is the maximum number of results to return.
-      # @!attribute [rw] page_token
-      #   @return [String]
-      #     If this field is not empty then it must contain the `nextPageToken` value
-      #     returned by a previous call to this method.  Using this field causes the
-      #     method to return additional results from the previous method call.
-      class ListMonitoredResourceDescriptorsRequest; end
-
-      # The `ListMonitoredResourceDescriptors` response.
-      # @!attribute [rw] resource_descriptors
-      #   @return [Array<Google::Api::MonitoredResourceDescriptor>]
-      #     The monitored resource descriptors that are available to this project
-      #     and that match `filter`, if present.
-      # @!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 ListMonitoredResourceDescriptorsResponse; end
-
-      # The `GetMonitoredResourceDescriptor` request.
-      # @!attribute [rw] name
-      #   @return [String]
-      #     Required. The monitored resource descriptor to get.  The format is:
-      #
-      #         projects/[PROJECT_ID_OR_NUMBER]/monitoredResourceDescriptors/[RESOURCE_TYPE]
-      #
-      #     The `[RESOURCE_TYPE]` is a predefined type, such as
-      #     `cloudsql_database`.
-      class GetMonitoredResourceDescriptorRequest; end
-
-      # The `ListMetricDescriptors` request.
-      # @!attribute [rw] name
-      #   @return [String]
-      #     Required. The project on which to execute the request. The format is:
-      #
-      #         projects/[PROJECT_ID_OR_NUMBER]
-      # @!attribute [rw] filter
-      #   @return [String]
-      #     If this field is empty, all custom and
-      #     system-defined metric descriptors are returned.
-      #     Otherwise, the [filter](https://cloud.google.com/monitoring/api/v3/filters)
-      #     specifies which metric descriptors are to be
-      #     returned. For example, the following filter matches all
-      #     [custom metrics](https://cloud.google.com/monitoring/custom-metrics):
-      #
-      #         metric.type = starts_with("custom.googleapis.com/")
-      # @!attribute [rw] page_size
-      #   @return [Integer]
-      #     A positive number that is the maximum number of results to return.
-      # @!attribute [rw] page_token
-      #   @return [String]
-      #     If this field is not empty then it must contain the `nextPageToken` value
-      #     returned by a previous call to this method.  Using this field causes the
-      #     method to return additional results from the previous method call.
-      class ListMetricDescriptorsRequest; end
-
-      # The `ListMetricDescriptors` response.
-      # @!attribute [rw] metric_descriptors
-      #   @return [Array<Google::Api::MetricDescriptor>]
-      #     The metric descriptors that are available to the project
-      #     and that match the value of `filter`, if present.
-      # @!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 ListMetricDescriptorsResponse; end
-
-      # The `GetMetricDescriptor` request.
-      # @!attribute [rw] name
-      #   @return [String]
-      #     Required. The metric descriptor on which to execute the request. The format is:
-      #
-      #         projects/[PROJECT_ID_OR_NUMBER]/metricDescriptors/[METRIC_ID]
-      #
-      #     An example value of `[METRIC_ID]` is
-      #     `"compute.googleapis.com/instance/disk/read_bytes_count"`.
-      class GetMetricDescriptorRequest; end
-
-      # The `CreateMetricDescriptor` request.
-      # @!attribute [rw] name
-      #   @return [String]
-      #     Required. The project on which to execute the request. The format is:
-      #
-      #         projects/[PROJECT_ID_OR_NUMBER]
-      # @!attribute [rw] metric_descriptor
-      #   @return [Google::Api::MetricDescriptor]
-      #     Required. The new [custom metric](https://cloud.google.com/monitoring/custom-metrics)
-      #     descriptor.
-      class CreateMetricDescriptorRequest; end
-
-      # The `DeleteMetricDescriptor` request.
-      # @!attribute [rw] name
-      #   @return [String]
-      #     Required. The metric descriptor on which to execute the request. The format is:
-      #
-      #         projects/[PROJECT_ID_OR_NUMBER]/metricDescriptors/[METRIC_ID]
-      #
-      #     An example of `[METRIC_ID]` is:
-      #     `"custom.googleapis.com/my_test_metric"`.
-      class DeleteMetricDescriptorRequest; end
-
-      # The `ListTimeSeries` request.
-      # @!attribute [rw] name
-      #   @return [String]
-      #     Required. The project on which to execute the request. The format is:
-      #
-      #         projects/[PROJECT_ID_OR_NUMBER]
-      # @!attribute [rw] filter
-      #   @return [String]
-      #     Required. A [monitoring filter](https://cloud.google.com/monitoring/api/v3/filters)
-      #     that specifies which time series should be returned.  The filter must
-      #     specify a single metric type, and can additionally specify metric labels
-      #     and other information. For example:
-      #
-      #         metric.type = "compute.googleapis.com/instance/cpu/usage_time" AND
-      #             metric.labels.instance_name = "my-instance-name"
-      # @!attribute [rw] interval
-      #   @return [Google::Monitoring::V3::TimeInterval]
-      #     Required. The time interval for which results should be returned. Only time series
-      #     that contain data points in the specified interval are included
-      #     in the response.
-      # @!attribute [rw] aggregation
-      #   @return [Google::Monitoring::V3::Aggregation]
-      #     Specifies the alignment of data points in individual time series as
-      #     well as how to combine the retrieved time series across specified labels.
-      #
-      #     By default (if no `aggregation` is explicitly specified), the raw time
-      #     series data is returned.
-      # @!attribute [rw] order_by
-      #   @return [String]
-      #     Unsupported: must be left blank. The points in each time series are
-      #     currently returned in reverse time order (most recent to oldest).
-      # @!attribute [rw] view
-      #   @return [Google::Monitoring::V3::ListTimeSeriesRequest::TimeSeriesView]
-      #     Required. Specifies which information is returned about the time series.
-      # @!attribute [rw] page_size
-      #   @return [Integer]
-      #     A positive number that is the maximum number of results to return. If
-      #     `page_size` is empty or more than 100,000 results, the effective
-      #     `page_size` is 100,000 results. If `view` is set to `FULL`, this is the
-      #     maximum number of `Points` returned. If `view` is set to `HEADERS`, this is
-      #     the maximum number of `TimeSeries` returned.
-      # @!attribute [rw] page_token
-      #   @return [String]
-      #     If this field is not empty then it must contain the `nextPageToken` 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 ListTimeSeriesRequest
-        # Controls which fields are returned by `ListTimeSeries`.
-        module TimeSeriesView
-          # Returns the identity of the metric(s), the time series,
-          # and the time series data.
-          FULL = 0
-
-          # Returns the identity of the metric and the time series resource,
-          # but not the time series data.
-          HEADERS = 1
-        end
-      end
-
-      # The `ListTimeSeries` response.
-      # @!attribute [rw] time_series
-      #   @return [Array<Google::Monitoring::V3::TimeSeries>]
-      #     One or more time series that match the filter included in the request.
-      # @!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] execution_errors
-      #   @return [Array<Google::Rpc::Status>]
-      #     Query execution errors that may have caused the time series data returned
-      #     to be incomplete.
-      class ListTimeSeriesResponse; end
-
-      # The `CreateTimeSeries` request.
-      # @!attribute [rw] name
-      #   @return [String]
-      #     Required. The project on which to execute the request. The format is:
-      #
-      #         projects/[PROJECT_ID_OR_NUMBER]
-      # @!attribute [rw] time_series
-      #   @return [Array<Google::Monitoring::V3::TimeSeries>]
-      #     Required. The new data to be added to a list of time series.
-      #     Adds at most one data point to each of several time series.  The new data
-      #     point must be more recent than any other point in its time series.  Each
-      #     `TimeSeries` value must fully specify a unique time series by supplying
-      #     all label values for the metric and the monitored resource.
-      #
-      #     The maximum number of `TimeSeries` objects per `Create` request is 200.
-      class CreateTimeSeriesRequest; end
-    end
-  end
-end