google-cloud-monitoring-v3 0.4.2 → 0.6.1

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

@@ -41,13 +41,12 @@ module Google
             # See {::Google::Cloud::Monitoring::V3::QueryService::Client::Configuration}
             # for a description of the configuration fields.
             #
-            # ## Example
+            # @example
             #
-            # To modify the configuration for all QueryService clients:
-            #
-            #     ::Google::Cloud::Monitoring::V3::QueryService::Client.configure do |config|
-            #       config.timeout = 10.0
-            #     end
+            #   # Modify the configuration for all QueryService clients
+            #   ::Google::Cloud::Monitoring::V3::QueryService::Client.configure do |config|
+            #     config.timeout = 10.0
+            #   end
             #
             # @yield [config] Configure the Client client.
             # @yieldparam config [Client::Configuration]
@@ -94,19 +93,15 @@ module Google
             ##
             # Create a new QueryService client object.
             #
-            # ## Examples
-            #
-            # To create a new QueryService client with the default
-            # configuration:
+            # @example
             #
-            #     client = ::Google::Cloud::Monitoring::V3::QueryService::Client.new
+            #   # Create a client using the default configuration
+            #   client = ::Google::Cloud::Monitoring::V3::QueryService::Client.new
             #
-            # To create a new QueryService client with a custom
-            # configuration:
-            #
-            #     client = ::Google::Cloud::Monitoring::V3::QueryService::Client.new do |config|
-            #       config.timeout = 10.0
-            #     end
+            #   # Create a client using a custom configuration
+            #   client = ::Google::Cloud::Monitoring::V3::QueryService::Client.new do |config|
+            #     config.timeout = 10.0
+            #   end
             #
             # @yield [config] Configure the QueryService client.
             # @yieldparam config [Client::Configuration]
@@ -126,10 +121,9 @@ 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
@@ -169,7 +163,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 query [::String]
@@ -191,6 +186,27 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/monitoring/v3"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Monitoring::V3::QueryService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Monitoring::V3::QueryTimeSeriesRequest.new
+            #
+            #   # Call the query_time_series method.
+            #   result = client.query_time_series request
+            #
+            #   # The returned object is of type Gapic::PagedEnumerable. You can
+            #   # iterate over all elements by calling #each, and the enumerable
+            #   # will lazily make API calls to fetch subsequent pages. Other
+            #   # methods are also available for managing paging directly.
+            #   result.each do |response|
+            #     # Each element is of type ::Google::Cloud::Monitoring::V3::TimeSeriesData.
+            #     p response
+            #   end
+            #
             def query_time_series request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -208,16 +224,20 @@ module Google
                 gapic_version: ::Google::Cloud::Monitoring::V3::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "name" => request.name
-              }
+              header_params = {}
+              if request.name
+                header_params["name"] = request.name
+              end
+
               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.query_time_series.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.query_time_series.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @query_service_stub.call_rpc :query_time_series, request, options: options do |response, operation|
@@ -242,22 +262,21 @@ module Google
             # Configuration can be applied globally to all clients, or to a single client
             # on construction.
             #
-            # # Examples
-            #
-            # To modify the global config, setting the timeout for query_time_series
-            # to 20 seconds, and all remaining timeouts to 10 seconds:
-            #
-            #     ::Google::Cloud::Monitoring::V3::QueryService::Client.configure do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.query_time_series.timeout = 20.0
-            #     end
-            #
-            # To apply the above configuration only to a new client:
-            #
-            #     client = ::Google::Cloud::Monitoring::V3::QueryService::Client.new do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.query_time_series.timeout = 20.0
-            #     end
+            # @example
+            #
+            #   # Modify the global config, setting the timeout for
+            #   # query_time_series to 20 seconds,
+            #   # and all remaining timeouts to 10 seconds.
+            #   ::Google::Cloud::Monitoring::V3::QueryService::Client.configure do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.query_time_series.timeout = 20.0
+            #   end
+            #
+            #   # Apply the above configuration only to a new client.
+            #   client = ::Google::Cloud::Monitoring::V3::QueryService::Client.new do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.query_time_series.timeout = 20.0
+            #   end
             #
             # @!attribute [rw] endpoint
             #   The hostname or hostname:port of the service endpoint.