google-cloud-secret_manager-v1beta1 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1fff098b35fd90526ec1f24e7b575bcf809223dda60af7fbaa4df743cb15fa9d
-  data.tar.gz: bb27e8d00f919e86875324e8f73a9e9c8769c3f1a657300e075d6556a443eebe
+  metadata.gz: e279fc4f5eaf4d3fac171b9dd5a4aeb7f71b978bb339234ed0a473463a425746
+  data.tar.gz: 7a12addd437e83c4105ab318359248fe8e8d2a2321cc217e182e14d51f5cbaa5
 SHA512:
-  metadata.gz: 7cd2be428551069ef4710cfb877583dc7f6c1fc3e19e746ed09a3b6a86d1f2b5be775d73d1ec281d09ee48afb8d81096443c3bbc6ec3997fbb51a0e0b028291b
-  data.tar.gz: 2b73f091d750c69bbe73b20b6a8d084a48467762ef660337e7d55b683abbb505ac65cfa41e8ea3b58ddb4b78cc83041d944554ad361e0aac5bb0411cac992ecc
+  metadata.gz: 632a144908b5fb8ae785c547f55c042d33e4013407ffb35d3146904a3e1e0e3c5096dde6d1010a47dddf7bdce9985f363cf0984d606f456b2ec15be7f7dc9de5
+  data.tar.gz: 685f96628760baba81e6be82d645530102d4e7a8cdc2e5714dbd1e8253771949c3ba173c583548fb00f441847398466f390358179db3514d7b62a3b12d449cb6

data/lib/google/cloud/secret_manager/v1beta1/secret_manager_service/client.rb

@@ -40,7 +40,18 @@ module Google
             attr_reader :secret_manager_service_stub
 
             ##
-            # Configuration for the SecretManagerService Client API.
+            # Configure the SecretManagerService Client class.
+            #
+            # See {Google::Cloud::SecretManager::V1beta1::SecretManagerService::Client::Configuration}
+            # for a description of the configuration fields.
+            #
+            # ## Example
+            #
+            # To modify the configuration for all SecretManagerService clients:
+            #
+            #     Google::Cloud::SecretManager::V1beta1::SecretManagerService::Client.configure do |config|
+            #       config.timeout = 10_000
+            #     end
             #
             # @yield [config] Configure the Client client.
             # @yieldparam config [Client::Configuration]
@@ -69,6 +80,9 @@ module Google
             # but structural changes (adding new fields, etc.) are not allowed. Structural changes
             # should be made on {Client.configure}.
             #
+            # See {Google::Cloud::SecretManager::V1beta1::SecretManagerService::Client::Configuration}
+            # for a description of the configuration fields.
+            #
             # @yield [config] Configure the Client client.
             # @yieldparam config [Client::Configuration]
             #
@@ -80,9 +94,23 @@ module Google
             end
 
             ##
-            # Create a new Client client object.
+            # Create a new SecretManagerService client object.
             #
-            # @yield [config] Configure the Client client.
+            # ## Examples
+            #
+            # To create a new SecretManagerService client with the default
+            # configuration:
+            #
+            #     client = Google::Cloud::SecretManager::V1beta1::SecretManagerService::Client.new
+            #
+            # To create a new SecretManagerService client with a custom
+            # configuration:
+            #
+            #     client = Google::Cloud::SecretManager::V1beta1::SecretManagerService::Client.new do |config|
+            #       config.timeout = 10_000
+            #     end
+            #
+            # @yield [config] Configure the SecretManagerService client.
             # @yieldparam config [Client::Configuration]
             #
             def initialize
@@ -1100,6 +1128,81 @@ module Google
 
             ##
             # Configuration class for the SecretManagerService API.
+            #
+            # This class represents the configuration for SecretManagerService,
+            # providing control over timeouts, retry behavior, logging, transport
+            # parameters, and other low-level controls. Certain parameters can also be
+            # applied individually to specific RPCs. See
+            # {Google::Cloud::SecretManager::V1beta1::SecretManagerService::Client::Configuration::Rpcs}
+            # for a list of RPCs that can be configured independently.
+            #
+            # 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_secrets
+            # to 20 seconds, and all remaining timeouts to 10 seconds:
+            #
+            #     Google::Cloud::SecretManager::V1beta1::SecretManagerService::Client.configure do |config|
+            #       config.timeout = 10_000
+            #       config.rpcs.list_secrets.timeout = 20_000
+            #     end
+            #
+            # To apply the above configuration only to a new client:
+            #
+            #     client = Google::Cloud::SecretManager::V1beta1::SecretManagerService::Client.new do |config|
+            #       config.timeout = 10_000
+            #       config.rpcs.list_secrets.timeout = 20_000
+            #     end
+            #
+            # @!attribute [rw] endpoint
+            #   The hostname or hostname:port of the service endpoint.
+            #   Defaults to `"secretmanager.googleapis.com"`.
+            #   @return [String]
+            # @!attribute [rw] credentials
+            #   Credentials to send with calls. You may provide any of the following types:
+            #    *  (`String`) The path to a service account key file in JSON format
+            #    *  (`Hash`) A service account key as a Hash
+            #    *  (`Google::Auth::Credentials`) A googleauth credentials object
+            #       (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
+            #    *  (`Signet::OAuth2::Client`) A signet oauth2 client object
+            #       (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
+            #    *  (`GRPC::Core::Channel`) a gRPC channel with included credentials
+            #    *  (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
+            #    *  (`nil`) indicating no credentials
+            #   @return [Object]
+            # @!attribute [rw] scope
+            #   The OAuth scopes
+            #   @return [Array<String>]
+            # @!attribute [rw] lib_name
+            #   The library name as recorded in instrumentation and logging
+            #   @return [String]
+            # @!attribute [rw] lib_version
+            #   The library version as recorded in instrumentation and logging
+            #   @return [String]
+            # @!attribute [rw] channel_args
+            #   Extra parameters passed to the gRPC channel. Note: this is ignored if a
+            #   `GRPC::Core::Channel` object is provided as the credential.
+            #   @return [Hash]
+            # @!attribute [rw] interceptors
+            #   An array of interceptors that are run before calls are executed.
+            #   @return [Array<GRPC::ClientInterceptor>]
+            # @!attribute [rw] timeout
+            #   The call timeout in milliseconds.
+            #   @return [Numeric]
+            # @!attribute [rw] metadata
+            #   Additional gRPC headers to be sent with the call.
+            #   @return [Hash{Symbol=>String}]
+            # @!attribute [rw] retry_policy
+            #   The retry policy. The value is a hash with the following keys:
+            #    *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
+            #    *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
+            #    *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
+            #    *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
+            #       trigger a retry.
+            #   @return [Hash]
+            #
             class Configuration
               extend Gapic::Config
 
@@ -1118,12 +1221,17 @@ module Google
               config_attr :metadata,     nil, Hash, nil
               config_attr :retry_policy, nil, Hash, Proc, nil
 
+              # @private
               def initialize parent_config = nil
                 @parent_config = parent_config unless parent_config.nil?
 
                 yield self if block_given?
               end
 
+              ##
+              # Configurations for individual RPCs
+              # @return [Rpcs]
+              #
               def rpcs
                 @rpcs ||= begin
                   parent_rpcs = nil
@@ -1134,23 +1242,99 @@ module Google
 
               ##
               # Configuration RPC class for the SecretManagerService API.
+              #
+              # Includes fields providing the configuration for each RPC in this service.
+              # Each configuration object is of type `Gapic::Config::Method` and includes
+              # the following configuration fields:
+              #
+              #  *  `timeout` (*type:* `Numeric`) - The call timeout in milliseconds
+              #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
+              #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
+              #     include the following keys:
+              #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
+              #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
+              #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
+              #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
+              #         trigger a retry.
+              #
               class Rpcs
+                ##
+                # RPC-specific configuration for `list_secrets`
+                # @return [Gapic::Config::Method]
+                #
                 attr_reader :list_secrets
+                ##
+                # RPC-specific configuration for `create_secret`
+                # @return [Gapic::Config::Method]
+                #
                 attr_reader :create_secret
+                ##
+                # RPC-specific configuration for `add_secret_version`
+                # @return [Gapic::Config::Method]
+                #
                 attr_reader :add_secret_version
+                ##
+                # RPC-specific configuration for `get_secret`
+                # @return [Gapic::Config::Method]
+                #
                 attr_reader :get_secret
+                ##
+                # RPC-specific configuration for `update_secret`
+                # @return [Gapic::Config::Method]
+                #
                 attr_reader :update_secret
+                ##
+                # RPC-specific configuration for `delete_secret`
+                # @return [Gapic::Config::Method]
+                #
                 attr_reader :delete_secret
+                ##
+                # RPC-specific configuration for `list_secret_versions`
+                # @return [Gapic::Config::Method]
+                #
                 attr_reader :list_secret_versions
+                ##
+                # RPC-specific configuration for `get_secret_version`
+                # @return [Gapic::Config::Method]
+                #
                 attr_reader :get_secret_version
+                ##
+                # RPC-specific configuration for `access_secret_version`
+                # @return [Gapic::Config::Method]
+                #
                 attr_reader :access_secret_version
+                ##
+                # RPC-specific configuration for `disable_secret_version`
+                # @return [Gapic::Config::Method]
+                #
                 attr_reader :disable_secret_version
+                ##
+                # RPC-specific configuration for `enable_secret_version`
+                # @return [Gapic::Config::Method]
+                #
                 attr_reader :enable_secret_version
+                ##
+                # RPC-specific configuration for `destroy_secret_version`
+                # @return [Gapic::Config::Method]
+                #
                 attr_reader :destroy_secret_version
+                ##
+                # RPC-specific configuration for `set_iam_policy`
+                # @return [Gapic::Config::Method]
+                #
                 attr_reader :set_iam_policy
+                ##
+                # RPC-specific configuration for `get_iam_policy`
+                # @return [Gapic::Config::Method]
+                #
                 attr_reader :get_iam_policy
+                ##
+                # RPC-specific configuration for `test_iam_permissions`
+                # @return [Gapic::Config::Method]
+                #
                 attr_reader :test_iam_permissions
 
+                # @private
                 def initialize parent_rpcs = nil
                   list_secrets_config = parent_rpcs&.list_secrets if parent_rpcs&.respond_to? :list_secrets
                   @list_secrets = Gapic::Config::Method.new list_secrets_config

data/lib/google/cloud/secret_manager/v1beta1/version.rb

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module SecretManager
       module V1beta1
-        VERSION = "0.2.2"
+        VERSION = "0.2.3"
       end
     end
   end

data/proto_docs/google/api/resource.rb

@@ -165,7 +165,7 @@ module Google
     #     Optional. The field on the resource that designates the resource name
     #     field. If omitted, this is assumed to be "name".
     # @!attribute [rw] history
-    #   @return [ENUM(History)]
+    #   @return [Google::Api::ResourceDescriptor::History]
     #     Optional. The historical or future-looking state of the resource pattern.
     #
     #     Example:

data/proto_docs/google/cloud/secrets/v1beta1/resources.rb

@@ -81,7 +81,7 @@ module Google
         #     Only present if [state][google.cloud.secrets.v1beta1.SecretVersion.state] is
         #     [DESTROYED][google.cloud.secrets.v1beta1.SecretVersion.State.DESTROYED].
         # @!attribute [r] state
-        #   @return [ENUM(State)]
+        #   @return [Google::Cloud::SecretManager::V1beta1::SecretVersion::State]
         #     Output only. The current state of the [SecretVersion][google.cloud.secrets.v1beta1.SecretVersion].
         class SecretVersion
           include Google::Protobuf::MessageExts

data/proto_docs/google/iam/v1/policy.rb

@@ -122,7 +122,7 @@ module Google
       # One delta entry for Binding. Each individual change (only one member in each
       # entry) to a binding will be a separate entry.
       # @!attribute [rw] action
-      #   @return [ENUM(Action)]
+      #   @return [Google::Iam::V1::BindingDelta::Action]
       #     The action that was performed on a Binding.
       #     Required
       # @!attribute [rw] role

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-secret_manager-v1beta1
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-24 00:00:00.000000000 Z
+date: 2020-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -114,14 +114,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0.18'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0.18'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement