google-cloud-monitoring-v3 0.4.2 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7dec6d95d8bd4486aa11ae3ec9dff1d78bec82ab8e9a3cf05f9b46ad5d64dba2
-  data.tar.gz: 1dbef9169213f4c1f5c359eed7303ea8c1bb7c28415be568dfde9b7a2f2ca817
+  metadata.gz: 135c4d1afadbf4c699971b07032372bd90c61c0848ab176ff5efdd5f294a1d01
+  data.tar.gz: 1a162a3e4b27d3d843b9348568ce58dcadb76a201af38fd419ecbae73c4d88e4
 SHA512:
-  metadata.gz: 6bd4ed90760607805d6156f95224fd7552d3817826095f45fb252af63990417baa6f64f9dd82969d043093c08a70c1cdcc169f7e0c65145ab30ed869d6a885b9
-  data.tar.gz: 0c2a694792313db4ed25401ff15c914e61ce1ea8f153b932741e57bc3c96381e40b8c522635c192fa069172d80975af2f071d74086064c5907851d5028ae2887
+  metadata.gz: 21d9c448175505c545653338caa4b45bf09b0bb572b353b8b1a6b450bc603475991c750d284b0ffa17bd7b2fee219c8bbf67179bfa3795e36b8e1df4ba4300cb
+  data.tar.gz: '087d61b21d791ffdd7e21739a4160825d80eaa642ee2b60e714963283c2e67f9a9916724c7753de98ea4f8c28ed2bf40c1f22bc7a1940987c4938275e9b2b49d'

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

@@ -49,13 +49,12 @@ module Google
             # See {::Google::Cloud::Monitoring::V3::AlertPolicyService::Client::Configuration}
             # for a description of the configuration fields.
             #
-            # ## Example
+            # @example
             #
-            # To modify the configuration for all AlertPolicyService clients:
-            #
-            #     ::Google::Cloud::Monitoring::V3::AlertPolicyService::Client.configure do |config|
-            #       config.timeout = 10.0
-            #     end
+            #   # Modify the configuration for all AlertPolicyService clients
+            #   ::Google::Cloud::Monitoring::V3::AlertPolicyService::Client.configure do |config|
+            #     config.timeout = 10.0
+            #   end
             #
             # @yield [config] Configure the Client client.
             # @yieldparam config [Client::Configuration]
@@ -75,19 +74,19 @@ module Google
 
                 default_config.rpcs.list_alert_policies.timeout = 30.0
                 default_config.rpcs.list_alert_policies.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_alert_policy.timeout = 30.0
                 default_config.rpcs.get_alert_policy.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_alert_policy.timeout = 30.0
 
                 default_config.rpcs.delete_alert_policy.timeout = 30.0
                 default_config.rpcs.delete_alert_policy.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.update_alert_policy.timeout = 30.0
@@ -121,19 +120,15 @@ module Google
             ##
             # Create a new AlertPolicyService client object.
             #
-            # ## Examples
-            #
-            # To create a new AlertPolicyService client with the default
-            # configuration:
-            #
-            #     client = ::Google::Cloud::Monitoring::V3::AlertPolicyService::Client.new
+            # @example
             #
-            # To create a new AlertPolicyService client with a custom
-            # configuration:
+            #   # Create a client using the default configuration
+            #   client = ::Google::Cloud::Monitoring::V3::AlertPolicyService::Client.new
             #
-            #     client = ::Google::Cloud::Monitoring::V3::AlertPolicyService::Client.new do |config|
-            #       config.timeout = 10.0
-            #     end
+            #   # Create a client using a custom configuration
+            #   client = ::Google::Cloud::Monitoring::V3::AlertPolicyService::Client.new do |config|
+            #     config.timeout = 10.0
+            #   end
             #
             # @yield [config] Configure the AlertPolicyService client.
             # @yieldparam config [Client::Configuration]
@@ -153,10 +148,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
@@ -196,7 +190,8 @@ module Google
             #   the default parameter values, pass an empty Hash as a request object (see above).
             #
             #   @param name [::String]
-            #     Required. The project whose alert policies are to be listed. The format is:
+            #     Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name)
+            #     whose alert policies are to be listed. The format is:
             #
             #         projects/[PROJECT_ID_OR_NUMBER]
             #
@@ -233,6 +228,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::AlertPolicyService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Monitoring::V3::ListAlertPoliciesRequest.new
+            #
+            #   # Call the list_alert_policies method.
+            #   result = client.list_alert_policies 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::AlertPolicy.
+            #     p response
+            #   end
+            #
             def list_alert_policies request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -250,16 +266,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.list_alert_policies.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.list_alert_policies.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @alert_policy_service_stub.call_rpc :list_alert_policies, request, options: options do |response, operation|
@@ -302,6 +322,21 @@ 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::AlertPolicyService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Monitoring::V3::GetAlertPolicyRequest.new
+            #
+            #   # Call the get_alert_policy method.
+            #   result = client.get_alert_policy request
+            #
+            #   # The returned object is of type Google::Cloud::Monitoring::V3::AlertPolicy.
+            #   p result
+            #
             def get_alert_policy request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -319,16 +354,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.get_alert_policy.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.get_alert_policy.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @alert_policy_service_stub.call_rpc :get_alert_policy, request, options: options do |response, operation|
@@ -358,7 +397,8 @@ module Google
             #   the default parameter values, pass an empty Hash as a request object (see above).
             #
             #   @param name [::String]
-            #     Required. The project in which to create the alerting policy. The format is:
+            #     Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) in
+            #     which to create the alerting policy. The format is:
             #
             #         projects/[PROJECT_ID_OR_NUMBER]
             #
@@ -382,6 +422,21 @@ 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::AlertPolicyService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Monitoring::V3::CreateAlertPolicyRequest.new
+            #
+            #   # Call the create_alert_policy method.
+            #   result = client.create_alert_policy request
+            #
+            #   # The returned object is of type Google::Cloud::Monitoring::V3::AlertPolicy.
+            #   p result
+            #
             def create_alert_policy request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -399,16 +454,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.create_alert_policy.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.create_alert_policy.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @alert_policy_service_stub.call_rpc :create_alert_policy, request, options: options do |response, operation|
@@ -452,6 +511,21 @@ 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::AlertPolicyService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Monitoring::V3::DeleteAlertPolicyRequest.new
+            #
+            #   # Call the delete_alert_policy method.
+            #   result = client.delete_alert_policy request
+            #
+            #   # The returned object is of type Google::Protobuf::Empty.
+            #   p result
+            #
             def delete_alert_policy request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -469,16 +543,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.delete_alert_policy.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.delete_alert_policy.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @alert_policy_service_stub.call_rpc :delete_alert_policy, request, options: options do |response, operation|
@@ -546,6 +624,21 @@ 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::AlertPolicyService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Monitoring::V3::UpdateAlertPolicyRequest.new
+            #
+            #   # Call the update_alert_policy method.
+            #   result = client.update_alert_policy request
+            #
+            #   # The returned object is of type Google::Cloud::Monitoring::V3::AlertPolicy.
+            #   p result
+            #
             def update_alert_policy request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -563,16 +656,20 @@ module Google
                 gapic_version: ::Google::Cloud::Monitoring::V3::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "alert_policy.name" => request.alert_policy.name
-              }
+              header_params = {}
+              if request.alert_policy&.name
+                header_params["alert_policy.name"] = request.alert_policy.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.update_alert_policy.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.update_alert_policy.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @alert_policy_service_stub.call_rpc :update_alert_policy, request, options: options do |response, operation|
@@ -596,22 +693,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 list_alert_policies
-            # to 20 seconds, and all remaining timeouts to 10 seconds:
-            #
-            #     ::Google::Cloud::Monitoring::V3::AlertPolicyService::Client.configure do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.list_alert_policies.timeout = 20.0
-            #     end
-            #
-            # To apply the above configuration only to a new client:
-            #
-            #     client = ::Google::Cloud::Monitoring::V3::AlertPolicyService::Client.new do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.list_alert_policies.timeout = 20.0
-            #     end
+            # @example
+            #
+            #   # Modify the global config, setting the timeout for
+            #   # list_alert_policies to 20 seconds,
+            #   # and all remaining timeouts to 10 seconds.
+            #   ::Google::Cloud::Monitoring::V3::AlertPolicyService::Client.configure do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.list_alert_policies.timeout = 20.0
+            #   end
+            #
+            #   # Apply the above configuration only to a new client.
+            #   client = ::Google::Cloud::Monitoring::V3::AlertPolicyService::Client.new do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.list_alert_policies.timeout = 20.0
+            #   end
             #
             # @!attribute [rw] endpoint
             #   The hostname or hostname:port of the service endpoint.