google-cloud-resource_settings-v1 0.1.0 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d4a8cf4f0019a54f850ff4d416598467f5f9f8eb19d2824c8ba354b71154c16a
-  data.tar.gz: 2fcffd1aeeb5352ba8b37b8f0eead5489ae20f4269634300d55b457e7041b463
+  metadata.gz: 0a45502cd027564b1abc9a4277f7f771be7f2bd1856c6795ebf7c07b4391af7f
+  data.tar.gz: d1e53914b690e500f0159d093490ffa6365c7a3dd27c5b9731ae78f03a9463f5
 SHA512:
-  metadata.gz: 79da9601c3f3bd638526d05804aefabaec678db3258ab6df5e2a3acdd7b69879fb64f416112d325febd63346f245c23b44e331f0a5b816ce9b9e799759255260
-  data.tar.gz: 23f8b7219e6f6da52205f42f8418f25a48c7fe21b9ced1015bbe41047abd8dde2b784fce4c65e4710b006ab9daab95793741d149e6a005ab6c8f923be526de50
+  metadata.gz: 93d1929fb1b0c1d61dd9cb12948c4a75a6c29832f41ae324fc378f8f80b94db3b24b7cba5bad05ad3eb15bd17c16c06afa9755e1347a8a8920c372d0d938e330
+  data.tar.gz: fa6af759eb6701e72662ee40e7e84653e7f31b5af62fe8c41e57ca62efc201324ed59ada2cf7920b2409ffdd4e16ab9c5196bb2766d592f0262838e967392fc7

data/AUTHENTICATION.md

@@ -66,11 +66,11 @@ The environment variables that google-cloud-resource_settings-v1
 checks for credentials are configured on the service Credentials class (such as
 {::Google::Cloud::ResourceSettings::V1::ResourceSettingsService::Credentials}):
 
-1. `RESOURCE_SETTINGS_CREDENTIALS` - Path to JSON file, or JSON contents
-2. `RESOURCE_SETTINGS_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
+* `RESOURCE_SETTINGS_CREDENTIALS` - Path to JSON file, or JSON contents
+* `RESOURCE_SETTINGS_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/resource_settings/v1"
@@ -82,8 +82,8 @@ client = ::Google::Cloud::ResourceSettings::V1::ResourceSettingsService::Client.
 
 ### 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/resource_settings/v1"
@@ -93,7 +93,7 @@ client = ::Google::Cloud::ResourceSettings::V1::ResourceSettingsService::Client.
 end
 ```
 
-Or configured globally for all clients:
+Or globally for all clients:
 
 ```ruby
 require "google/cloud/resource_settings/v1"

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/resource_settings/v1"
 
 client = ::Google::Cloud::ResourceSettings::V1::ResourceSettingsService::Client.new
-request = my_create_request
+request = ::Google::Cloud::ResourceSettings::V1::ListSettingsRequest.new # (request fields as keyword arguments...)
 response = client.list_settings request
 ```
 

data/lib/google/cloud/resource_settings/v1/resource_settings_service/client.rb

@@ -52,13 +52,12 @@ module Google
             # See {::Google::Cloud::ResourceSettings::V1::ResourceSettingsService::Client::Configuration}
             # for a description of the configuration fields.
             #
-            # ## Example
+            # @example
             #
-            # To modify the configuration for all ResourceSettingsService clients:
-            #
-            #     ::Google::Cloud::ResourceSettings::V1::ResourceSettingsService::Client.configure do |config|
-            #       config.timeout = 10.0
-            #     end
+            #   # Modify the configuration for all ResourceSettingsService clients
+            #   ::Google::Cloud::ResourceSettings::V1::ResourceSettingsService::Client.configure do |config|
+            #     config.timeout = 10.0
+            #   end
             #
             # @yield [config] Configure the Client client.
             # @yieldparam config [Client::Configuration]
@@ -78,10 +77,17 @@ module Google
 
                 default_config.rpcs.list_settings.timeout = 60.0
                 default_config.rpcs.list_settings.retry_policy = {
-                  initial_delay: 1.0,
-                  max_delay: 10.0,
-                  multiplier: 1.3,
-                  retry_codes: [14, 4]
+                  initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14, 4]
+                }
+
+                default_config.rpcs.get_setting.timeout = 60.0
+                default_config.rpcs.get_setting.retry_policy = {
+                  initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14, 4]
+                }
+
+                default_config.rpcs.update_setting.timeout = 60.0
+                default_config.rpcs.update_setting.retry_policy = {
+                  initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14, 4]
                 }
 
                 default_config
@@ -113,19 +119,15 @@ module Google
             ##
             # Create a new ResourceSettingsService client object.
             #
-            # ## Examples
+            # @example
             #
-            # To create a new ResourceSettingsService client with the default
-            # configuration:
+            #   # Create a client using the default configuration
+            #   client = ::Google::Cloud::ResourceSettings::V1::ResourceSettingsService::Client.new
             #
-            #     client = ::Google::Cloud::ResourceSettings::V1::ResourceSettingsService::Client.new
-            #
-            # To create a new ResourceSettingsService client with a custom
-            # configuration:
-            #
-            #     client = ::Google::Cloud::ResourceSettings::V1::ResourceSettingsService::Client.new do |config|
-            #       config.timeout = 10.0
-            #     end
+            #   # Create a client using a custom configuration
+            #   client = ::Google::Cloud::ResourceSettings::V1::ResourceSettingsService::Client.new do |config|
+            #     config.timeout = 10.0
+            #   end
             #
             # @yield [config] Configure the ResourceSettingsService client.
             # @yieldparam config [Client::Configuration]
@@ -145,14 +147,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
@@ -210,6 +211,27 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/resource_settings/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::ResourceSettings::V1::ResourceSettingsService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::ResourceSettings::V1::ListSettingsRequest.new
+            #
+            #   # Call the list_settings method.
+            #   result = client.list_settings 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::ResourceSettings::V1::Setting.
+            #     p response
+            #   end
+            #
             def list_settings request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -227,16 +249,20 @@ module Google
                 gapic_version: ::Google::Cloud::ResourceSettings::V1::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "parent" => request.parent
-              }
+              header_params = {}
+              if request.parent
+                header_params["parent"] = request.parent
+              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_settings.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.list_settings.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @resource_settings_service_stub.call_rpc :list_settings, request, options: options do |response, operation|
@@ -283,6 +309,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/resource_settings/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::ResourceSettings::V1::ResourceSettingsService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::ResourceSettings::V1::GetSettingRequest.new
+            #
+            #   # Call the get_setting method.
+            #   result = client.get_setting request
+            #
+            #   # The returned object is of type Google::Cloud::ResourceSettings::V1::Setting.
+            #   p result
+            #
             def get_setting request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -300,16 +341,20 @@ module Google
                 gapic_version: ::Google::Cloud::ResourceSettings::V1::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_setting.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.get_setting.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @resource_settings_service_stub.call_rpc :get_setting, request, options: options do |response, operation|
@@ -364,6 +409,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/resource_settings/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::ResourceSettings::V1::ResourceSettingsService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::ResourceSettings::V1::UpdateSettingRequest.new
+            #
+            #   # Call the update_setting method.
+            #   result = client.update_setting request
+            #
+            #   # The returned object is of type Google::Cloud::ResourceSettings::V1::Setting.
+            #   p result
+            #
             def update_setting request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -381,16 +441,20 @@ module Google
                 gapic_version: ::Google::Cloud::ResourceSettings::V1::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "setting.name" => request.setting.name
-              }
+              header_params = {}
+              if request.setting&.name
+                header_params["setting.name"] = request.setting.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_setting.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.update_setting.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @resource_settings_service_stub.call_rpc :update_setting, request, options: options do |response, operation|
@@ -414,22 +478,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_settings
-            # to 20 seconds, and all remaining timeouts to 10 seconds:
-            #
-            #     ::Google::Cloud::ResourceSettings::V1::ResourceSettingsService::Client.configure do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.list_settings.timeout = 20.0
-            #     end
-            #
-            # To apply the above configuration only to a new client:
-            #
-            #     client = ::Google::Cloud::ResourceSettings::V1::ResourceSettingsService::Client.new do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.list_settings.timeout = 20.0
-            #     end
+            # @example
+            #
+            #   # Modify the global config, setting the timeout for
+            #   # list_settings to 20 seconds,
+            #   # and all remaining timeouts to 10 seconds.
+            #   ::Google::Cloud::ResourceSettings::V1::ResourceSettingsService::Client.configure do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.list_settings.timeout = 20.0
+            #   end
+            #
+            #   # Apply the above configuration only to a new client.
+            #   client = ::Google::Cloud::ResourceSettings::V1::ResourceSettingsService::Client.new do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.list_settings.timeout = 20.0
+            #   end
             #
             # @!attribute [rw] endpoint
             #   The hostname or hostname:port of the service endpoint.

data/lib/google/cloud/resource_settings/v1/version.rb

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module ResourceSettings
       module V1
-        VERSION = "0.1.0"
+        VERSION = "0.1.4"
       end
     end
   end

data/lib/google/cloud/resourcesettings/v1/resource_settings_pb.rb

@@ -1,12 +1,12 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/resourcesettings/v1/resource_settings.proto
 
-require 'google/protobuf'
-
 require 'google/api/annotations_pb'
 require 'google/api/client_pb'
 require 'google/api/field_behavior_pb'
 require 'google/api/resource_pb'
+require 'google/protobuf'
+
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/cloud/resourcesettings/v1/resource_settings.proto", :syntax => :proto3) do
     add_message "google.cloud.resourcesettings.v1.Setting" do

data/lib/google/cloud/resourcesettings/v1/resource_settings_services_pb.rb

@@ -38,7 +38,7 @@ module Google
           # `google.rpc.Code.INVALID_ARGUMENT` if the request is malformed.
           class Service
 
-            include GRPC::GenericService
+            include ::GRPC::GenericService
 
             self.marshal_class_method = :encode
             self.unmarshal_class_method = :decode

data/proto_docs/google/api/field_behavior.rb

@@ -60,6 +60,12 @@ module Google
       # in any arbitrary  order, rather than the order the user originally
       # provided. Additionally, the list's order may or may not be stable.
       UNORDERED_LIST = 6
+
+      # Denotes that this field returns a non-empty default value if not set.
+      # This indicates that if the user provides the empty value in a request,
+      # a non-empty value will be returned. The user will not be aware of what
+      # non-empty value to expect.
+      NON_EMPTY_DEFAULT = 7
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-resource_settings-v1
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.4
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-23 00:00:00.000000000 Z
+date: 2021-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.7'
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.7'
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a