google-cloud-monitoring-v3 0.4.1 → 0.6.0

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

@@ -42,13 +42,12 @@ module Google
             # See {::Google::Cloud::Monitoring::V3::MetricService::Client::Configuration}
             # for a description of the configuration fields.
             #
-            # ## Example
+            # @example
             #
-            # To modify the configuration for all MetricService clients:
-            #
-            #     ::Google::Cloud::Monitoring::V3::MetricService::Client.configure do |config|
-            #       config.timeout = 10.0
-            #     end
+            #   # Modify the configuration for all MetricService clients
+            #   ::Google::Cloud::Monitoring::V3::MetricService::Client.configure do |config|
+            #     config.timeout = 10.0
+            #   end
             #
             # @yield [config] Configure the Client client.
             # @yieldparam config [Client::Configuration]
@@ -68,52 +67,34 @@ module Google
 
                 default_config.rpcs.list_monitored_resource_descriptors.timeout = 30.0
                 default_config.rpcs.list_monitored_resource_descriptors.retry_policy = {
-                  initial_delay: 0.1,
-              max_delay: 30.0,
-              multiplier: 1.3,
-              retry_codes: [4, 14]
+                  initial_delay: 0.1, max_delay: 30.0, multiplier: 1.3, retry_codes: [14]
                 }
 
                 default_config.rpcs.get_monitored_resource_descriptor.timeout = 30.0
                 default_config.rpcs.get_monitored_resource_descriptor.retry_policy = {
-                  initial_delay: 0.1,
-              max_delay: 30.0,
-              multiplier: 1.3,
-              retry_codes: [4, 14]
+                  initial_delay: 0.1, max_delay: 30.0, multiplier: 1.3, retry_codes: [14]
                 }
 
                 default_config.rpcs.list_metric_descriptors.timeout = 30.0
                 default_config.rpcs.list_metric_descriptors.retry_policy = {
-                  initial_delay: 0.1,
-              max_delay: 30.0,
-              multiplier: 1.3,
-              retry_codes: [4, 14]
+                  initial_delay: 0.1, max_delay: 30.0, multiplier: 1.3, retry_codes: [14]
                 }
 
                 default_config.rpcs.get_metric_descriptor.timeout = 30.0
                 default_config.rpcs.get_metric_descriptor.retry_policy = {
-                  initial_delay: 0.1,
-              max_delay: 30.0,
-              multiplier: 1.3,
-              retry_codes: [4, 14]
+                  initial_delay: 0.1, max_delay: 30.0, multiplier: 1.3, retry_codes: [14]
                 }
 
                 default_config.rpcs.create_metric_descriptor.timeout = 12.0
 
                 default_config.rpcs.delete_metric_descriptor.timeout = 30.0
                 default_config.rpcs.delete_metric_descriptor.retry_policy = {
-                  initial_delay: 0.1,
-              max_delay: 30.0,
-              multiplier: 1.3,
-              retry_codes: [4, 14]
+                  initial_delay: 0.1, max_delay: 30.0, multiplier: 1.3, retry_codes: [14]
                 }
 
-                default_config.rpcs.list_time_series.timeout = 30.0
+                default_config.rpcs.list_time_series.timeout = 90.0
                 default_config.rpcs.list_time_series.retry_policy = {
-                  initial_delay: 0.1,
-              max_delay: 30.0,
-              multiplier: 1.3,
-              retry_codes: [4, 14]
+                  initial_delay: 0.1, max_delay: 30.0, multiplier: 1.3, retry_codes: [14]
                 }
 
                 default_config.rpcs.create_time_series.timeout = 12.0
@@ -147,19 +128,15 @@ module Google
             ##
             # Create a new MetricService client object.
             #
-            # ## Examples
-            #
-            # To create a new MetricService client with the default
-            # configuration:
-            #
-            #     client = ::Google::Cloud::Monitoring::V3::MetricService::Client.new
+            # @example
             #
-            # To create a new MetricService client with a custom
-            # configuration:
+            #   # Create a client using the default configuration
+            #   client = ::Google::Cloud::Monitoring::V3::MetricService::Client.new
             #
-            #     client = ::Google::Cloud::Monitoring::V3::MetricService::Client.new do |config|
-            #       config.timeout = 10.0
-            #     end
+            #   # Create a client using a custom configuration
+            #   client = ::Google::Cloud::Monitoring::V3::MetricService::Client.new do |config|
+            #     config.timeout = 10.0
+            #   end
             #
             # @yield [config] Configure the MetricService client.
             # @yieldparam config [Client::Configuration]
@@ -179,14 +156,13 @@ module Google
 
               # Create credentials
               credentials = @config.credentials
-              # Use self-signed JWT if the scope and endpoint are unchanged from default,
+              # Use self-signed JWT if the endpoint is unchanged from default,
               # but only if the default endpoint does not have a region prefix.
-              enable_self_signed_jwt = @config.scope == Client.configure.scope &&
-                                       @config.endpoint == Client.configure.endpoint &&
+              enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
                                        !@config.endpoint.split(".").first.include?("-")
               credentials ||= Credentials.default scope: @config.scope,
                                                   enable_self_signed_jwt: enable_self_signed_jwt
-              if credentials.is_a?(String) || credentials.is_a?(Hash)
+              if credentials.is_a?(::String) || credentials.is_a?(::Hash)
                 credentials = Credentials.new credentials, scope: @config.scope
               end
               @quota_project_id = @config.quota_project
@@ -222,7 +198,8 @@ module Google
             #   the default parameter values, pass an empty Hash as a request object (see above).
             #
             #   @param name [::String]
-            #     Required. The project on which to execute the request. The format is:
+            #     Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) on
+            #     which to execute the request. The format is:
             #
             #         projects/[PROJECT_ID_OR_NUMBER]
             #   @param filter [::String]
@@ -273,7 +250,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.list_monitored_resource_descriptors.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.list_monitored_resource_descriptors.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @metric_service_stub.call_rpc :list_monitored_resource_descriptors, request, options: options do |response, operation|
@@ -345,7 +324,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.get_monitored_resource_descriptor.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.get_monitored_resource_descriptor.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @metric_service_stub.call_rpc :get_monitored_resource_descriptor, request, options: options do |response, operation|
@@ -375,7 +356,8 @@ module Google
             #   the default parameter values, pass an empty Hash as a request object (see above).
             #
             #   @param name [::String]
-            #     Required. The project on which to execute the request. The format is:
+            #     Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) on
+            #     which to execute the request. The format is:
             #
             #         projects/[PROJECT_ID_OR_NUMBER]
             #   @param filter [::String]
@@ -428,7 +410,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.list_metric_descriptors.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.list_metric_descriptors.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @metric_service_stub.call_rpc :list_metric_descriptors, request, options: options do |response, operation|
@@ -500,7 +484,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.get_metric_descriptor.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.get_metric_descriptor.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @metric_service_stub.call_rpc :get_metric_descriptor, request, options: options do |response, operation|
@@ -513,6 +499,8 @@ module Google
 
             ##
             # Creates a new metric descriptor.
+            # The creation is executed asynchronously and callers may check the returned
+            # operation to track its progress.
             # User-created metric descriptors define
             # [custom metrics](https://cloud.google.com/monitoring/custom-metrics).
             #
@@ -532,8 +520,9 @@ module Google
             #   the default parameter values, pass an empty Hash as a request object (see above).
             #
             #   @param name [::String]
-            #     Required. The project on which to execute the request. The format is:
-            #
+            #     Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) on
+            #     which to execute the request. The format is:
+            #     4
             #         projects/[PROJECT_ID_OR_NUMBER]
             #   @param metric_descriptor [::Google::Api::MetricDescriptor, ::Hash]
             #     Required. The new [custom metric](https://cloud.google.com/monitoring/custom-metrics)
@@ -573,7 +562,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.create_metric_descriptor.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.create_metric_descriptor.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @metric_service_stub.call_rpc :create_metric_descriptor, request, options: options do |response, operation|
@@ -646,7 +637,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.delete_metric_descriptor.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.delete_metric_descriptor.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @metric_service_stub.call_rpc :delete_metric_descriptor, request, options: options do |response, operation|
@@ -676,8 +669,8 @@ module Google
             #   the default parameter values, pass an empty Hash as a request object (see above).
             #
             #   @param name [::String]
-            #     Required. The project, organization or folder on which to execute the request. The
-            #     format is:
+            #     Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name),
+            #     organization or folder on which to execute the request. The format is:
             #
             #         projects/[PROJECT_ID_OR_NUMBER]
             #         organizations/[ORGANIZATION_ID]
@@ -753,7 +746,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.list_time_series.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.list_time_series.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @metric_service_stub.call_rpc :list_time_series, request, options: options do |response, operation|
@@ -787,7 +782,8 @@ module Google
             #   the default parameter values, pass an empty Hash as a request object (see above).
             #
             #   @param name [::String]
-            #     Required. The project on which to execute the request. The format is:
+            #     Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) on
+            #     which to execute the request. The format is:
             #
             #         projects/[PROJECT_ID_OR_NUMBER]
             #   @param time_series [::Array<::Google::Cloud::Monitoring::V3::TimeSeries, ::Hash>]
@@ -833,7 +829,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.create_time_series.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.create_time_series.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @metric_service_stub.call_rpc :create_time_series, request, options: options do |response, operation|
@@ -844,6 +842,93 @@ module Google
               raise ::Google::Cloud::Error.from_error(e)
             end
 
+            ##
+            # Creates or adds data to one or more service time series. A service time
+            # series is a time series for a metric from a Google Cloud service. The
+            # response is empty if all time series in the request were written. If any
+            # time series could not be written, a corresponding failure message is
+            # included in the error response. This endpoint rejects writes to
+            # user-defined metrics.
+            # This method is only for use by Google Cloud services. Use
+            # {::Google::Cloud::Monitoring::V3::MetricService::Client#create_time_series projects.timeSeries.create}
+            # instead.
+            #
+            # @overload create_service_time_series(request, options = nil)
+            #   Pass arguments to `create_service_time_series` via a request object, either of type
+            #   {::Google::Cloud::Monitoring::V3::CreateTimeSeriesRequest} or an equivalent Hash.
+            #
+            #   @param request [::Google::Cloud::Monitoring::V3::CreateTimeSeriesRequest, ::Hash]
+            #     A request object representing the call parameters. Required. To specify no
+            #     parameters, or to keep all the default parameter values, pass an empty Hash.
+            #   @param options [::Gapic::CallOptions, ::Hash]
+            #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
+            #
+            # @overload create_service_time_series(name: nil, time_series: nil)
+            #   Pass arguments to `create_service_time_series` via keyword arguments. Note that at
+            #   least one keyword argument is required. To specify no parameters, or to keep all
+            #   the default parameter values, pass an empty Hash as a request object (see above).
+            #
+            #   @param name [::String]
+            #     Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) on
+            #     which to execute the request. The format is:
+            #
+            #         projects/[PROJECT_ID_OR_NUMBER]
+            #   @param time_series [::Array<::Google::Cloud::Monitoring::V3::TimeSeries, ::Hash>]
+            #     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.
+            #
+            # @yield [response, operation] Access the result along with the RPC operation
+            # @yieldparam response [::Google::Protobuf::Empty]
+            # @yieldparam operation [::GRPC::ActiveCall::Operation]
+            #
+            # @return [::Google::Protobuf::Empty]
+            #
+            # @raise [::Google::Cloud::Error] if the RPC is aborted.
+            #
+            def create_service_time_series request, options = nil
+              raise ::ArgumentError, "request must be provided" if request.nil?
+
+              request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Monitoring::V3::CreateTimeSeriesRequest
+
+              # Converts hash and nil to an options object
+              options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
+
+              # Customize the options with defaults
+              metadata = @config.rpcs.create_service_time_series.metadata.to_h
+
+              # Set x-goog-api-client and x-goog-user-project headers
+              metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
+                lib_name: @config.lib_name, lib_version: @config.lib_version,
+                gapic_version: ::Google::Cloud::Monitoring::V3::VERSION
+              metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+              header_params = {
+                "name" => request.name
+              }
+              request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
+              metadata[:"x-goog-request-params"] ||= request_params_header
+
+              options.apply_defaults timeout:      @config.rpcs.create_service_time_series.timeout,
+                                     metadata:     metadata,
+                                     retry_policy: @config.rpcs.create_service_time_series.retry_policy
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
+                                     retry_policy: @config.retry_policy
+
+              @metric_service_stub.call_rpc :create_service_time_series, request, options: options do |response, operation|
+                yield response, operation if block_given?
+                return response
+              end
+            rescue ::GRPC::BadStatus => e
+              raise ::Google::Cloud::Error.from_error(e)
+            end
+
             ##
             # Configuration class for the MetricService API.
             #
@@ -857,22 +942,21 @@ module Google
             # Configuration can be applied globally to all clients, or to a single client
             # on construction.
             #
-            # # Examples
+            # @example
             #
-            # To modify the global config, setting the timeout for list_monitored_resource_descriptors
-            # to 20 seconds, and all remaining timeouts to 10 seconds:
+            #   # Modify the global config, setting the timeout for
+            #   # list_monitored_resource_descriptors to 20 seconds,
+            #   # and all remaining timeouts to 10 seconds.
+            #   ::Google::Cloud::Monitoring::V3::MetricService::Client.configure do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.list_monitored_resource_descriptors.timeout = 20.0
+            #   end
             #
-            #     ::Google::Cloud::Monitoring::V3::MetricService::Client.configure do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.list_monitored_resource_descriptors.timeout = 20.0
-            #     end
-            #
-            # To apply the above configuration only to a new client:
-            #
-            #     client = ::Google::Cloud::Monitoring::V3::MetricService::Client.new do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.list_monitored_resource_descriptors.timeout = 20.0
-            #     end
+            #   # Apply the above configuration only to a new client.
+            #   client = ::Google::Cloud::Monitoring::V3::MetricService::Client.new do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.list_monitored_resource_descriptors.timeout = 20.0
+            #   end
             #
             # @!attribute [rw] endpoint
             #   The hostname or hostname:port of the service endpoint.
@@ -1020,6 +1104,11 @@ module Google
                 # @return [::Gapic::Config::Method]
                 #
                 attr_reader :create_time_series
+                ##
+                # RPC-specific configuration for `create_service_time_series`
+                # @return [::Gapic::Config::Method]
+                #
+                attr_reader :create_service_time_series
 
                 # @private
                 def initialize parent_rpcs = nil
@@ -1039,6 +1128,8 @@ module Google
                   @list_time_series = ::Gapic::Config::Method.new list_time_series_config
                   create_time_series_config = parent_rpcs.create_time_series if parent_rpcs.respond_to? :create_time_series
                   @create_time_series = ::Gapic::Config::Method.new create_time_series_config
+                  create_service_time_series_config = parent_rpcs.create_service_time_series if parent_rpcs.respond_to? :create_service_time_series
+                  @create_service_time_series = ::Gapic::Config::Method.new create_service_time_series_config
 
                   yield self if block_given?
                 end