google-cloud-monitoring 0.37.1 → 1.0.2

data/lib/google/cloud/monitoring/v3/doc/google/api/monitored_resource.rb

@@ -1,108 +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 Api
-    # An object that describes the schema of a {Google::Api::MonitoredResource MonitoredResource} object using a
-    # type name and a set of labels.  For example, the monitored resource
-    # descriptor for Google Compute Engine VM instances has a type of
-    # `"gce_instance"` and specifies the use of the labels `"instance_id"` and
-    # `"zone"` to identify particular VM instances.
-    #
-    # Different APIs can support different monitored resource types. APIs generally
-    # provide a `list` method that returns the monitored resource descriptors used
-    # by the API.
-    # @!attribute [rw] name
-    #   @return [String]
-    #     Optional. The resource name of the monitored resource descriptor:
-    #     `"projects/{project_id}/monitoredResourceDescriptors/{type}"` where
-    #     \\{type} is the value of the `type` field in this object and
-    #     \\{project_id} is a project ID that provides API-specific context for
-    #     accessing the type.  APIs that do not use project information can use the
-    #     resource name format `"monitoredResourceDescriptors/{type}"`.
-    # @!attribute [rw] type
-    #   @return [String]
-    #     Required. The monitored resource type. For example, the type
-    #     `"cloudsql_database"` represents databases in Google Cloud SQL.
-    #     The maximum length of this value is 256 characters.
-    # @!attribute [rw] display_name
-    #   @return [String]
-    #     Optional. A concise name for the monitored resource type that might be
-    #     displayed in user interfaces. It should be a Title Cased Noun Phrase,
-    #     without any article or other determiners. For example,
-    #     `"Google Cloud SQL Database"`.
-    # @!attribute [rw] description
-    #   @return [String]
-    #     Optional. A detailed description of the monitored resource type that might
-    #     be used in documentation.
-    # @!attribute [rw] labels
-    #   @return [Array<Google::Api::LabelDescriptor>]
-    #     Required. A set of labels used to describe instances of this monitored
-    #     resource type. For example, an individual Google Cloud SQL database is
-    #     identified by values for the labels `"database_id"` and `"zone"`.
-    # @!attribute [rw] launch_stage
-    #   @return [Google::Api::LaunchStage]
-    #     Optional. The launch stage of the monitored resource definition.
-    class MonitoredResourceDescriptor; end
-
-    # An object representing a resource that can be used for monitoring, logging,
-    # billing, or other purposes. Examples include virtual machine instances,
-    # databases, and storage devices such as disks. The `type` field identifies a
-    # {Google::Api::MonitoredResourceDescriptor MonitoredResourceDescriptor} object that describes the resource's
-    # schema. Information in the `labels` field identifies the actual resource and
-    # its attributes according to the schema. For example, a particular Compute
-    # Engine VM instance could be represented by the following object, because the
-    # {Google::Api::MonitoredResourceDescriptor MonitoredResourceDescriptor} for `"gce_instance"` has labels
-    # `"instance_id"` and `"zone"`:
-    #
-    #     { "type": "gce_instance",
-    #       "labels": { "instance_id": "12345678901234",
-    #                   "zone": "us-central1-a" }}
-    # @!attribute [rw] type
-    #   @return [String]
-    #     Required. The monitored resource type. This field must match
-    #     the `type` field of a {Google::Api::MonitoredResourceDescriptor MonitoredResourceDescriptor} object. For
-    #     example, the type of a Compute Engine VM instance is `gce_instance`.
-    # @!attribute [rw] labels
-    #   @return [Hash{String => String}]
-    #     Required. Values for all of the labels listed in the associated monitored
-    #     resource descriptor. For example, Compute Engine VM instances use the
-    #     labels `"project_id"`, `"instance_id"`, and `"zone"`.
-    class MonitoredResource; end
-
-    # Auxiliary metadata for a {Google::Api::MonitoredResource MonitoredResource} object.
-    # {Google::Api::MonitoredResource MonitoredResource} objects contain the minimum set of information to
-    # uniquely identify a monitored resource instance. There is some other useful
-    # auxiliary metadata. Monitoring and Logging use an ingestion
-    # pipeline to extract metadata for cloud resources of all types, and store
-    # the metadata in this message.
-    # @!attribute [rw] system_labels
-    #   @return [Google::Protobuf::Struct]
-    #     Output only. Values for predefined system metadata labels.
-    #     System labels are a kind of metadata extracted by Google, including
-    #     "machine_image", "vpc", "subnet_id",
-    #     "security_group", "name", etc.
-    #     System label values can be only strings, Boolean values, or a list of
-    #     strings. For example:
-    #
-    #         { "name": "my-test-instance",
-    #           "security_group": ["a", "b", "c"],
-    #           "spot_instance": false }
-    # @!attribute [rw] user_labels
-    #   @return [Hash{String => String}]
-    #     Output only. A map of user-defined metadata labels.
-    class MonitoredResourceMetadata; end
-  end
-end

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

@@ -1,345 +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 description of the conditions under which some aspect of your system is
-      # considered to be "unhealthy" and the ways to notify people or services about
-      # this state. For an overview of alert policies, see
-      # [Introduction to Alerting](https://cloud.google.com/monitoring/alerts/).
-      # @!attribute [rw] name
-      #   @return [String]
-      #     Required if the policy exists. The resource name for this policy. The
-      #     format is:
-      #
-      #         projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID]
-      #
-      #     `[ALERT_POLICY_ID]` is assigned by Stackdriver Monitoring when the policy
-      #     is created.  When calling the
-      #     {Google::Monitoring::V3::AlertPolicyService::CreateAlertPolicy alertPolicies::create}
-      #     method, do not include the `name` field in the alerting policy passed as
-      #     part of the request.
-      # @!attribute [rw] display_name
-      #   @return [String]
-      #     A short name or phrase used to identify the policy in dashboards,
-      #     notifications, and incidents. To avoid confusion, don't use the same
-      #     display name for multiple policies in the same project. The name is
-      #     limited to 512 Unicode characters.
-      # @!attribute [rw] documentation
-      #   @return [Google::Monitoring::V3::AlertPolicy::Documentation]
-      #     Documentation that is included with notifications and incidents related to
-      #     this policy. Best practice is for the documentation to include information
-      #     to help responders understand, mitigate, escalate, and correct the
-      #     underlying problems detected by the alerting policy. Notification channels
-      #     that have limited capacity might not show this documentation.
-      # @!attribute [rw] user_labels
-      #   @return [Hash{String => String}]
-      #     User-supplied key/value data to be used for organizing and
-      #     identifying the `AlertPolicy` objects.
-      #
-      #     The field can contain up to 64 entries. Each key and value is limited to
-      #     63 Unicode characters or 128 bytes, whichever is smaller. Labels and
-      #     values can contain only lowercase letters, numerals, underscores, and
-      #     dashes. Keys must begin with a letter.
-      # @!attribute [rw] conditions
-      #   @return [Array<Google::Monitoring::V3::AlertPolicy::Condition>]
-      #     A list of conditions for the policy. The conditions are combined by AND or
-      #     OR according to the `combiner` field. If the combined conditions evaluate
-      #     to true, then an incident is created. A policy can have from one to six
-      #     conditions.
-      #     If `condition_time_series_query_language` is present, it must be the only
-      #     `condition`.
-      # @!attribute [rw] combiner
-      #   @return [Google::Monitoring::V3::AlertPolicy::ConditionCombinerType]
-      #     How to combine the results of multiple conditions to determine if an
-      #     incident should be opened.
-      #     If `condition_time_series_query_language` is present, this must be
-      #     `COMBINE_UNSPECIFIED`.
-      # @!attribute [rw] enabled
-      #   @return [Google::Protobuf::BoolValue]
-      #     Whether or not the policy is enabled. On write, the default interpretation
-      #     if unset is that the policy is enabled. On read, clients should not make
-      #     any assumption about the state if it has not been populated. The
-      #     field should always be populated on List and Get operations, unless
-      #     a field projection has been specified that strips it out.
-      # @!attribute [rw] validity
-      #   @return [Google::Rpc::Status]
-      #     Read-only description of how the alert policy is invalid. OK if the alert
-      #     policy is valid. If not OK, the alert policy will not generate incidents.
-      # @!attribute [rw] notification_channels
-      #   @return [Array<String>]
-      #     Identifies the notification channels to which notifications should be sent
-      #     when incidents are opened or closed or when new violations occur on
-      #     an already opened incident. Each element of this array corresponds to
-      #     the `name` field in each of the
-      #     {Google::Monitoring::V3::NotificationChannel `NotificationChannel`}
-      #     objects that are returned from the [`ListNotificationChannels`]
-      #     [google.monitoring.v3.NotificationChannelService.ListNotificationChannels]
-      #     method. The format of the entries in this field is:
-      #
-      #         projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID]
-      # @!attribute [rw] creation_record
-      #   @return [Google::Monitoring::V3::MutationRecord]
-      #     A read-only record of the creation of the alerting policy. If provided
-      #     in a call to create or update, this field will be ignored.
-      # @!attribute [rw] mutation_record
-      #   @return [Google::Monitoring::V3::MutationRecord]
-      #     A read-only record of the most recent change to the alerting policy. If
-      #     provided in a call to create or update, this field will be ignored.
-      class AlertPolicy
-        # A content string and a MIME type that describes the content string's
-        # format.
-        # @!attribute [rw] content
-        #   @return [String]
-        #     The text of the documentation, interpreted according to `mime_type`.
-        #     The content may not exceed 8,192 Unicode characters and may not exceed
-        #     more than 10,240 bytes when encoded in UTF-8 format, whichever is
-        #     smaller.
-        # @!attribute [rw] mime_type
-        #   @return [String]
-        #     The format of the `content` field. Presently, only the value
-        #     `"text/markdown"` is supported. See
-        #     [Markdown](https://en.wikipedia.org/wiki/Markdown) for more information.
-        class Documentation; end
-
-        # A condition is a true/false test that determines when an alerting policy
-        # should open an incident. If a condition evaluates to true, it signifies
-        # that something is wrong.
-        # @!attribute [rw] name
-        #   @return [String]
-        #     Required if the condition exists. The unique resource name for this
-        #     condition. Its format is:
-        #
-        #         projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[POLICY_ID]/conditions/[CONDITION_ID]
-        #
-        #     `[CONDITION_ID]` is assigned by Stackdriver Monitoring when the
-        #     condition is created as part of a new or updated alerting policy.
-        #
-        #     When calling the
-        #     {Google::Monitoring::V3::AlertPolicyService::CreateAlertPolicy alertPolicies::create}
-        #     method, do not include the `name` field in the conditions of the
-        #     requested alerting policy. Stackdriver Monitoring creates the
-        #     condition identifiers and includes them in the new policy.
-        #
-        #     When calling the
-        #     {Google::Monitoring::V3::AlertPolicyService::UpdateAlertPolicy alertPolicies::update}
-        #     method to update a policy, including a condition `name` causes the
-        #     existing condition to be updated. Conditions without names are added to
-        #     the updated policy. Existing conditions are deleted if they are not
-        #     updated.
-        #
-        #     Best practice is to preserve `[CONDITION_ID]` if you make only small
-        #     changes, such as those to condition thresholds, durations, or trigger
-        #     values.  Otherwise, treat the change as a new condition and let the
-        #     existing condition be deleted.
-        # @!attribute [rw] display_name
-        #   @return [String]
-        #     A short name or phrase used to identify the condition in dashboards,
-        #     notifications, and incidents. To avoid confusion, don't use the same
-        #     display name for multiple conditions in the same policy.
-        # @!attribute [rw] condition_threshold
-        #   @return [Google::Monitoring::V3::AlertPolicy::Condition::MetricThreshold]
-        #     A condition that compares a time series against a threshold.
-        # @!attribute [rw] condition_absent
-        #   @return [Google::Monitoring::V3::AlertPolicy::Condition::MetricAbsence]
-        #     A condition that checks that a time series continues to
-        #     receive new data points.
-        # @!attribute [rw] condition_time_series_query_language
-        #   @return [Google::Monitoring::V3::AlertPolicy::Condition::TimeSeriesQueryLanguageCondition]
-        #     A condition that uses the time series query language format to define
-        #     alerts.
-        #     If set, no other conditions can be present.
-        class Condition
-          # Specifies how many time series must fail a predicate to trigger a
-          # condition. If not specified, then a `{count: 1}` trigger is used.
-          # @!attribute [rw] count
-          #   @return [Integer]
-          #     The absolute number of time series that must fail
-          #     the predicate for the condition to be triggered.
-          # @!attribute [rw] percent
-          #   @return [Float]
-          #     The percentage of time series that must fail the
-          #     predicate for the condition to be triggered.
-          class Trigger; end
-
-          # A condition type that compares a collection of time series
-          # against a threshold.
-          # @!attribute [rw] filter
-          #   @return [String]
-          #     A [filter](https://cloud.google.com/monitoring/api/v3/filters) that
-          #     identifies which time series should be compared with the threshold.
-          #
-          #     The filter is similar to the one that is specified in the
-          #     [`ListTimeSeries`
-          #     request](https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list)
-          #     (that call is useful to verify the time series that will be retrieved /
-          #     processed) and must specify the metric type and optionally may contain
-          #     restrictions on resource type, resource labels, and metric labels.
-          #     This field may not exceed 2048 Unicode characters in length.
-          # @!attribute [rw] aggregations
-          #   @return [Array<Google::Monitoring::V3::Aggregation>]
-          #     Specifies the alignment of data points in individual time series as
-          #     well as how to combine the retrieved time series together (such as
-          #     when aggregating multiple streams on each resource to a single
-          #     stream for each resource or when aggregating streams across all
-          #     members of a group of resrouces). Multiple aggregations
-          #     are applied in the order specified.
-          #
-          #     This field is similar to the one in the [`ListTimeSeries`
-          #     request](https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list).
-          #     It is advisable to use the `ListTimeSeries` method when debugging this
-          #     field.
-          # @!attribute [rw] denominator_filter
-          #   @return [String]
-          #     A [filter](https://cloud.google.com/monitoring/api/v3/filters) that
-          #     identifies a time series that should be used as the denominator of a
-          #     ratio that will be compared with the threshold. If a
-          #     `denominator_filter` is specified, the time series specified by the
-          #     `filter` field will be used as the numerator.
-          #
-          #     The filter must specify the metric type and optionally may contain
-          #     restrictions on resource type, resource labels, and metric labels.
-          #     This field may not exceed 2048 Unicode characters in length.
-          # @!attribute [rw] denominator_aggregations
-          #   @return [Array<Google::Monitoring::V3::Aggregation>]
-          #     Specifies the alignment of data points in individual time series
-          #     selected by `denominatorFilter` as
-          #     well as how to combine the retrieved time series together (such as
-          #     when aggregating multiple streams on each resource to a single
-          #     stream for each resource or when aggregating streams across all
-          #     members of a group of resources).
-          #
-          #     When computing ratios, the `aggregations` and
-          #     `denominator_aggregations` fields must use the same alignment period
-          #     and produce time series that have the same periodicity and labels.
-          # @!attribute [rw] comparison
-          #   @return [Google::Monitoring::V3::ComparisonType]
-          #     The comparison to apply between the time series (indicated by `filter`
-          #     and `aggregation`) and the threshold (indicated by `threshold_value`).
-          #     The comparison is applied on each time series, with the time series
-          #     on the left-hand side and the threshold on the right-hand side.
-          #
-          #     Only `COMPARISON_LT` and `COMPARISON_GT` are supported currently.
-          # @!attribute [rw] threshold_value
-          #   @return [Float]
-          #     A value against which to compare the time series.
-          # @!attribute [rw] duration
-          #   @return [Google::Protobuf::Duration]
-          #     The amount of time that a time series must violate the
-          #     threshold to be considered failing. Currently, only values
-          #     that are a multiple of a minute--e.g., 0, 60, 120, or 300
-          #     seconds--are supported. If an invalid value is given, an
-          #     error will be returned. When choosing a duration, it is useful to
-          #     keep in mind the frequency of the underlying time series data
-          #     (which may also be affected by any alignments specified in the
-          #     `aggregations` field); a good duration is long enough so that a single
-          #     outlier does not generate spurious alerts, but short enough that
-          #     unhealthy states are detected and alerted on quickly.
-          # @!attribute [rw] trigger
-          #   @return [Google::Monitoring::V3::AlertPolicy::Condition::Trigger]
-          #     The number/percent of time series for which the comparison must hold
-          #     in order for the condition to trigger. If unspecified, then the
-          #     condition will trigger if the comparison is true for any of the
-          #     time series that have been identified by `filter` and `aggregations`,
-          #     or by the ratio, if `denominator_filter` and `denominator_aggregations`
-          #     are specified.
-          class MetricThreshold; end
-
-          # A condition type that checks that monitored resources
-          # are reporting data. The configuration defines a metric and
-          # a set of monitored resources. The predicate is considered in violation
-          # when a time series for the specified metric of a monitored
-          # resource does not include any data in the specified `duration`.
-          # @!attribute [rw] filter
-          #   @return [String]
-          #     A [filter](https://cloud.google.com/monitoring/api/v3/filters) that
-          #     identifies which time series should be compared with the threshold.
-          #
-          #     The filter is similar to the one that is specified in the
-          #     [`ListTimeSeries`
-          #     request](https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list)
-          #     (that call is useful to verify the time series that will be retrieved /
-          #     processed) and must specify the metric type and optionally may contain
-          #     restrictions on resource type, resource labels, and metric labels.
-          #     This field may not exceed 2048 Unicode characters in length.
-          # @!attribute [rw] aggregations
-          #   @return [Array<Google::Monitoring::V3::Aggregation>]
-          #     Specifies the alignment of data points in individual time series as
-          #     well as how to combine the retrieved time series together (such as
-          #     when aggregating multiple streams on each resource to a single
-          #     stream for each resource or when aggregating streams across all
-          #     members of a group of resrouces). Multiple aggregations
-          #     are applied in the order specified.
-          #
-          #     This field is similar to the one in the [`ListTimeSeries`
-          #     request](https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list).
-          #     It is advisable to use the `ListTimeSeries` method when debugging this
-          #     field.
-          # @!attribute [rw] duration
-          #   @return [Google::Protobuf::Duration]
-          #     The amount of time that a time series must fail to report new
-          #     data to be considered failing. Currently, only values that
-          #     are a multiple of a minute--e.g.  60, 120, or 300
-          #     seconds--are supported. If an invalid value is given, an
-          #     error will be returned. The `Duration.nanos` field is
-          #     ignored.
-          # @!attribute [rw] trigger
-          #   @return [Google::Monitoring::V3::AlertPolicy::Condition::Trigger]
-          #     The number/percent of time series for which the comparison must hold
-          #     in order for the condition to trigger. If unspecified, then the
-          #     condition will trigger if the comparison is true for any of the
-          #     time series that have been identified by `filter` and `aggregations`.
-          class MetricAbsence; end
-
-          # A condition type that allows alert policies to be defined using the
-          # time series query language.
-          # @!attribute [rw] query
-          #   @return [String]
-          #     A query in the time series query language format that generates time
-          #     series indicating points in time that the condition should be
-          #     considered active.
-          # @!attribute [rw] summary
-          #   @return [String]
-          #     A short explanation of what the query represents. For example:
-          #
-          #       "Error ratio exceeds 15% for >5% of servers in >2 regions"
-          class TimeSeriesQueryLanguageCondition; end
-        end
-
-        # Operators for combining conditions.
-        module ConditionCombinerType
-          # An unspecified combiner.
-          COMBINE_UNSPECIFIED = 0
-
-          # Combine conditions using the logical `AND` operator. An
-          # incident is created only if all the conditions are met
-          # simultaneously. This combiner is satisfied if all conditions are
-          # met, even if they are met on completely different resources.
-          AND = 1
-
-          # Combine conditions using the logical `OR` operator. An incident
-          # is created if any of the listed conditions is met.
-          OR = 2
-
-          # Combine conditions using logical `AND` operator, but unlike the regular
-          # `AND` option, an incident is created only if all conditions are met
-          # simultaneously on at least one resource.
-          AND_WITH_MATCHING_RESOURCE = 3
-        end
-      end
-    end
-  end
-end