google-api-client 0.37.0 → 0.38.0

data/generated/google/apis/monitoring_v3/service.rb

@@ -20,14 +20,13 @@ require 'google/apis/errors'
 module Google
   module Apis
     module MonitoringV3
-      # Stackdriver Monitoring API
+      # Cloud Monitoring API
       #
-      # Manages your Stackdriver Monitoring data and configurations. Most projects
-      #  must be associated with a Stackdriver account, with a few exceptions as noted
-      #  on the individual method pages. The table entries below are presented in
-      #  alphabetical order, not in order of common use. For explanations of the
-      #  concepts found in the table entries, read the Stackdriver Monitoring
-      #  documentation.
+      # Manages your Cloud Monitoring data and configurations. Most projects must be
+      #  associated with a Workspace, with a few exceptions as noted on the individual
+      #  method pages. The table entries below are presented in alphabetical order, not
+      #  in order of common use. For explanations of the concepts found in the table
+      #  entries, read the Cloud Monitoring documentation.
       #
       # @example
       #    require 'google/apis/monitoring_v3'
@@ -164,12 +163,13 @@ module Google
         # @param [String] filter
         #   If provided, this field specifies the criteria that must be met by alert
         #   policies to be included in the response.For more details, see sorting and
-        #   filtering.
+        #   filtering (https://cloud.google.com/monitoring/api/v3/sorting-and-filtering).
         # @param [String] order_by
         #   A comma-separated list of fields by which to sort the result. Supports the
         #   same set of field references as the filter field. Entries can be prefixed with
         #   a minus sign to sort by the field in descending order.For more details, see
-        #   sorting and filtering.
+        #   sorting and filtering (https://cloud.google.com/monitoring/api/v3/sorting-and-
+        #   filtering).
         # @param [Fixnum] page_size
         #   The maximum number of results to return in a single response.
         # @param [String] page_token
@@ -511,10 +511,11 @@ module Google
         #   Required. The group whose members are listed. The format is:
         #   projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]
         # @param [String] filter
-        #   An optional list filter 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:
+        #   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"`
         # @param [String] interval_end_time
         #   Required. The end of the time interval.
@@ -560,7 +561,7 @@ module Google
         end
         
         # Creates a new metric descriptor. User-created metric descriptors define custom
-        # metrics.
+        # metrics (https://cloud.google.com/monitoring/custom-metrics).
         # @param [String] name
         #   Required. The project on which to execute the request. The format is:
         #   projects/[PROJECT_ID_OR_NUMBER]
@@ -594,7 +595,8 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # Deletes a metric descriptor. Only user-created custom metrics can be deleted.
+        # Deletes a metric descriptor. Only user-created custom metrics (https://cloud.
+        # google.com/monitoring/custom-metrics) can be deleted.
         # @param [String] name
         #   Required. The metric descriptor on which to execute the request. The format is:
         #   projects/[PROJECT_ID_OR_NUMBER]/metricDescriptors/[METRIC_ID]
@@ -626,8 +628,7 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # Gets a single metric descriptor. This method does not require a Stackdriver
-        # account.
+        # Gets a single metric descriptor. This method does not require a Workspace.
         # @param [String] name
         #   Required. The metric descriptor on which to execute the request. The format is:
         #   projects/[PROJECT_ID_OR_NUMBER]/metricDescriptors/[METRIC_ID]
@@ -661,14 +662,16 @@ module Google
         end
         
         # Lists metric descriptors that match a filter. This method does not require a
-        # Stackdriver account.
+        # Workspace.
         # @param [String] name
         #   Required. The project on which to execute the request. The format is:
         #   projects/[PROJECT_ID_OR_NUMBER]
         # @param [String] filter
         #   If this field is empty, all custom and system-defined metric descriptors are
-        #   returned. Otherwise, the filter specifies which metric descriptors are to be
-        #   returned. For example, the following filter matches all custom metrics:
+        #   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/")
         # @param [Fixnum] page_size
         #   A positive number that is the maximum number of results to return.
@@ -707,7 +710,7 @@ module Google
         end
         
         # Gets a single monitored resource descriptor. This method does not require a
-        # Stackdriver account.
+        # Workspace.
         # @param [String] name
         #   Required. The monitored resource descriptor to get. The format is:
         #   projects/[PROJECT_ID_OR_NUMBER]/monitoredResourceDescriptors/[RESOURCE_TYPE]
@@ -740,14 +743,15 @@ module Google
         end
         
         # Lists monitored resource descriptors that match a filter. This method does not
-        # require a Stackdriver account.
+        # require a Workspace.
         # @param [String] name
         #   Required. The project on which to execute the request. The format is:
         #   projects/[PROJECT_ID_OR_NUMBER]
         # @param [String] filter
-        #   An optional filter 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:
+        #   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
         # @param [Fixnum] page_size
         #   A positive number that is the maximum number of results to return.
@@ -1034,12 +1038,14 @@ module Google
         # @param [String] filter
         #   If provided, this field specifies the criteria that must be met by
         #   notification channels to be included in the response.For more details, see
-        #   sorting and filtering.
+        #   sorting and filtering (https://cloud.google.com/monitoring/api/v3/sorting-and-
+        #   filtering).
         # @param [String] order_by
         #   A comma-separated list of fields by which to sort the result. Supports the
         #   same set of fields as in filter. Entries can be prefixed with a minus sign to
         #   sort in descending rather than ascending order.For more details, see sorting
-        #   and filtering.
+        #   and filtering (https://cloud.google.com/monitoring/api/v3/sorting-and-
+        #   filtering).
         # @param [Fixnum] page_size
         #   The maximum number of results to return in a single response. If not set to a
         #   positive number, a reasonable value will be chosen by the service.
@@ -1221,7 +1227,7 @@ module Google
         end
         
         # Lists time series that match a filter. This method does not require a
-        # Stackdriver account.
+        # Workspace.
         # @param [String] name
         #   Required. The project on which to execute the request. The format is:
         #   projects/[PROJECT_ID_OR_NUMBER]
@@ -1270,9 +1276,10 @@ module Google
         #   per_series_aligner must be specified and not equal to ALIGN_NONE and
         #   alignment_period must be specified; otherwise, an error is returned.
         # @param [String] filter
-        #   Required. A monitoring filter 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:
+        #   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"
         # @param [String] interval_end_time
@@ -1333,6 +1340,41 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Queries time series using the time series query language. This method does not
+        # require a Workspace.
+        # @param [String] name
+        #   Required. The project on which to execute the request. The format is:
+        #   projects/[PROJECT_ID_OR_NUMBER]
+        # @param [Google::Apis::MonitoringV3::QueryTimeSeriesRequest] query_time_series_request_object
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::MonitoringV3::QueryTimeSeriesResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::MonitoringV3::QueryTimeSeriesResponse]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def query_time_series(name, query_time_series_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v3/{+name}/timeSeries:query', options)
+          command.request_representation = Google::Apis::MonitoringV3::QueryTimeSeriesRequest::Representation
+          command.request_object = query_time_series_request_object
+          command.response_representation = Google::Apis::MonitoringV3::QueryTimeSeriesResponse::Representation
+          command.response_class = Google::Apis::MonitoringV3::QueryTimeSeriesResponse
+          command.params['name'] = name unless name.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Creates a new Uptime check configuration.
         # @param [String] parent
         #   Required. The project in which to create the Uptime check. The format is:
@@ -1624,9 +1666,9 @@ module Google
         # List Services for this workspace.
         # @param [String] parent
         #   Required. Resource name of the parent containing the listed services, either a
-        #   project or Stackdriver Account (workspace). The formats are:
+        #   project or a Monitoring Workspace. The formats are:
         #   projects/[PROJECT_ID_OR_NUMBER]
-        #   workspaces/[HOST_PROJECT_ID]
+        #   workspaces/[HOST_PROJECT_ID_OR_NUMBER]
         # @param [String] filter
         #   A filter specifying what Services to return. The filter currently supports the
         #   following fields:
@@ -1681,7 +1723,7 @@ module Google
         # Update this Service.
         # @param [String] name
         #   Resource name for this Service. The format is:
-        #   projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID`
+        #   projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]
         # @param [Google::Apis::MonitoringV3::Service] service_object
         # @param [String] update_mask
         #   A set of field paths defining which fields to use for the update.
@@ -1825,8 +1867,10 @@ module Google
         
         # List the ServiceLevelObjectives for the given Service.
         # @param [String] parent
-        #   Required. Resource name of the parent Service. The format is:
+        #   Required. Resource name of the parent containing the listed SLOs, either a
+        #   project or a Monitoring Workspace. The formats are:
         #   projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]
+        #   workspaces/[HOST_PROJECT_ID_OR_NUMBER]/services/-
         # @param [String] filter
         #   A filter specifying what ServiceLevelObjectives to return.
         # @param [Fixnum] page_size

data/generated/google/apis/monitoring_v3.rb

@@ -18,19 +18,18 @@ require 'google/apis/monitoring_v3/representations.rb'
 
 module Google
   module Apis
-    # Stackdriver Monitoring API
+    # Cloud Monitoring API
     #
-    # Manages your Stackdriver Monitoring data and configurations. Most projects
-    # must be associated with a Stackdriver account, with a few exceptions as noted
-    # on the individual method pages. The table entries below are presented in
-    # alphabetical order, not in order of common use. For explanations of the
-    # concepts found in the table entries, read the Stackdriver Monitoring
-    # documentation.
+    # Manages your Cloud Monitoring data and configurations. Most projects must be
+    # associated with a Workspace, with a few exceptions as noted on the individual
+    # method pages. The table entries below are presented in alphabetical order, not
+    # in order of common use. For explanations of the concepts found in the table
+    # entries, read the Cloud Monitoring documentation.
     #
     # @see https://cloud.google.com/monitoring/api/
     module MonitoringV3
       VERSION = 'V3'
-      REVISION = '20200210'
+      REVISION = '20200329'
 
       # View and manage your data across Google Cloud Platform services
       AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'