google-cloud-monitoring-v3 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7dde825c6bd5681f684e54850a39ab1605ad97a9cab57c95f8a5f2ed7a1b2f0f
-  data.tar.gz: 23ee04f8d2788c456cf9db967c894c8282f04d9c4b68ea0fa5f39c1f13c32090
+  metadata.gz: 5c4a4b754aa2a207389ae00d3da7aa82d1e54e649ddfa4d352993b3e1e4c55c5
+  data.tar.gz: edb8e5a5d6a9f9a8d2eca79d702615fc181d93c830a7013c815d10577d9356da
 SHA512:
-  metadata.gz: '029fcf7c8b30890bc1f7338f75c32bc5f7cfe3ba7ceb371dba5b62b7a1b2e6ce149ee6f7749daddf89dddae006a2744c047b0b5ba3d34a1fde8f19837bfd8a97'
-  data.tar.gz: 5c1d9ef62f8b18cf57d0bb9a587f30d1dacda859b2a7fbca89f0fcd455141f24a39626eee514e5fac860e482407bdf210b48e7de7d41c7d2f83202e3dda9bfef
+  metadata.gz: 204e30228200cc150bb96602586058e541e59865432b5c671710931d9c88b0dd45bd9e47ff0f52c6aa04265e7a4a019b8c6de79e50000ff71be93cd172f33438
+  data.tar.gz: 6d0eea897a6f29e661d1a02c59700fe303501e50c88638069b16ec53fdd0f96ef0594474aa277a668bea55fcfbc2e9bd01149c793f5fdb42358d556d5364df84

data/AUTHENTICATION.md

@@ -66,11 +66,11 @@ The environment variables that google-cloud-monitoring-v3
 checks for credentials are configured on the service Credentials class (such as
 {::Google::Cloud::Monitoring::V3::AlertPolicyService::Credentials}):
 
-1. `MONITORING_CREDENTIALS` - Path to JSON file, or JSON contents
-2. `MONITORING_KEYFILE` - Path to JSON file, or JSON contents
-3. `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
-4. `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
-5. `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
+* `MONITORING_CREDENTIALS` - Path to JSON file, or JSON contents
+* `MONITORING_KEYFILE` - Path to JSON file, or JSON contents
+* `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
+* `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
+* `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
 
 ```ruby
 require "google/cloud/monitoring/v3"
@@ -82,8 +82,8 @@ client = ::Google::Cloud::Monitoring::V3::AlertPolicyService::Client.new
 
 ### Configuration
 
-The **Credentials JSON** can be configured instead of placing them in
-environment variables. Either on an individual client initialization:
+The path to the **Credentials JSON** file can be configured instead of storing
+it in an environment variable. Either on an individual client initialization:
 
 ```ruby
 require "google/cloud/monitoring/v3"
@@ -93,7 +93,7 @@ client = ::Google::Cloud::Monitoring::V3::AlertPolicyService::Client.new do |con
 end
 ```
 
-Or configured globally for all clients:
+Or globally for all clients:
 
 ```ruby
 require "google/cloud/monitoring/v3"

data/README.md

@@ -33,7 +33,7 @@ In order to use this library, you first need to go through the following steps:
 require "google/cloud/monitoring/v3"
 
 client = ::Google::Cloud::Monitoring::V3::AlertPolicyService::Client.new
-request = my_create_request
+request = ::Google::Cloud::Monitoring::V3::ListAlertPoliciesRequest.new # (request fields as keyword arguments...)
 response = client.list_alert_policies request
 ```
 

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,28 +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
@@ -130,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]
@@ -162,14 +148,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
@@ -205,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]
             #
@@ -268,7 +254,9 @@ module Google
               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|
@@ -337,7 +325,9 @@ module Google
               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|
@@ -367,7 +357,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]
             #
@@ -417,7 +408,9 @@ module Google
               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|
@@ -487,7 +480,9 @@ module Google
               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|
@@ -581,7 +576,9 @@ module Google
               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|
@@ -605,22 +602,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.

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

@@ -162,6 +162,20 @@ module Google
               "organizations/#{organization}"
             end
 
+            ##
+            # Create a fully-qualified Project resource string.
+            #
+            # The resource will be in the following format:
+            #
+            # `projects/{project}`
+            #
+            # @param project [String]
+            #
+            # @return [::String]
+            def project_path project:
+              "projects/#{project}"
+            end
+
             ##
             # Create a fully-qualified Workspace resource string.
             #

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

@@ -52,13 +52,12 @@ module Google
             # See {::Google::Cloud::Monitoring::V3::GroupService::Client::Configuration}
             # for a description of the configuration fields.
             #
-            # ## Example
+            # @example
             #
-            # To modify the configuration for all GroupService clients:
-            #
-            #     ::Google::Cloud::Monitoring::V3::GroupService::Client.configure do |config|
-            #       config.timeout = 10.0
-            #     end
+            #   # Modify the configuration for all GroupService clients
+            #   ::Google::Cloud::Monitoring::V3::GroupService::Client.configure do |config|
+            #     config.timeout = 10.0
+            #   end
             #
             # @yield [config] Configure the Client client.
             # @yieldparam config [Client::Configuration]
@@ -78,44 +77,29 @@ module Google
 
                 default_config.rpcs.list_groups.timeout = 30.0
                 default_config.rpcs.list_groups.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_group.timeout = 30.0
                 default_config.rpcs.get_group.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_group.timeout = 30.0
 
-                default_config.rpcs.update_group.timeout = 30.0
+                default_config.rpcs.update_group.timeout = 180.0
                 default_config.rpcs.update_group.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.delete_group.timeout = 30.0
                 default_config.rpcs.delete_group.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_group_members.timeout = 30.0
                 default_config.rpcs.list_group_members.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
@@ -147,19 +131,15 @@ module Google
             ##
             # Create a new GroupService client object.
             #
-            # ## Examples
-            #
-            # To create a new GroupService client with the default
-            # configuration:
+            # @example
             #
-            #     client = ::Google::Cloud::Monitoring::V3::GroupService::Client.new
+            #   # Create a client using the default configuration
+            #   client = ::Google::Cloud::Monitoring::V3::GroupService::Client.new
             #
-            # To create a new GroupService client with a custom
-            # configuration:
-            #
-            #     client = ::Google::Cloud::Monitoring::V3::GroupService::Client.new do |config|
-            #       config.timeout = 10.0
-            #     end
+            #   # Create a client using a custom configuration
+            #   client = ::Google::Cloud::Monitoring::V3::GroupService::Client.new do |config|
+            #     config.timeout = 10.0
+            #   end
             #
             # @yield [config] Configure the GroupService client.
             # @yieldparam config [Client::Configuration]
@@ -179,14 +159,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 +201,8 @@ module Google
             #   the default parameter values, pass an empty Hash as a request object (see above).
             #
             #   @param name [::String]
-            #     Required. The project whose groups are to be listed. The format is:
+            #     Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name)
+            #     whose groups are to be listed. The format is:
             #
             #         projects/[PROJECT_ID_OR_NUMBER]
             #   @param children_of_group [::String]
@@ -290,7 +270,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.list_groups.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.list_groups.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @group_service_stub.call_rpc :list_groups, request, options: options do |response, operation|
@@ -359,7 +341,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.get_group.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.get_group.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @group_service_stub.call_rpc :get_group, request, options: options do |response, operation|
@@ -389,7 +373,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 group. The format is:
+            #     Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) in
+            #     which to create the group. The format is:
             #
             #         projects/[PROJECT_ID_OR_NUMBER]
             #   @param group [::Google::Cloud::Monitoring::V3::Group, ::Hash]
@@ -432,7 +417,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.create_group.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.create_group.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @group_service_stub.call_rpc :create_group, request, options: options do |response, operation|
@@ -502,7 +489,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.update_group.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.update_group.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @group_service_stub.call_rpc :update_group, request, options: options do |response, operation|
@@ -574,7 +563,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.delete_group.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.delete_group.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @group_service_stub.call_rpc :delete_group, request, options: options do |response, operation|
@@ -662,7 +653,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.list_group_members.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.list_group_members.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @group_service_stub.call_rpc :list_group_members, request, options: options do |response, operation|
@@ -687,22 +680,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_groups
-            # to 20 seconds, and all remaining timeouts to 10 seconds:
-            #
-            #     ::Google::Cloud::Monitoring::V3::GroupService::Client.configure do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.list_groups.timeout = 20.0
-            #     end
-            #
-            # To apply the above configuration only to a new client:
-            #
-            #     client = ::Google::Cloud::Monitoring::V3::GroupService::Client.new do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.list_groups.timeout = 20.0
-            #     end
+            # @example
+            #
+            #   # Modify the global config, setting the timeout for
+            #   # list_groups to 20 seconds,
+            #   # and all remaining timeouts to 10 seconds.
+            #   ::Google::Cloud::Monitoring::V3::GroupService::Client.configure do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.list_groups.timeout = 20.0
+            #   end
+            #
+            #   # Apply the above configuration only to a new client.
+            #   client = ::Google::Cloud::Monitoring::V3::GroupService::Client.new do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.list_groups.timeout = 20.0
+            #   end
             #
             # @!attribute [rw] endpoint
             #   The hostname or hostname:port of the service endpoint.