google-cloud-spanner-admin-database-v1 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1536ce544d325f282526a4e7a4f70d77e1d073372d1bc82d0cae4d12de5d1917
-  data.tar.gz: 66ee74760e3fff07df238a2c06ad18777f77770d29eba5e3a2f84e71ea76134e
+  metadata.gz: 6929ebcdea92158c0fad9c88ab18ca86cb421e901e4ba3a99f06e6985c0606f8
+  data.tar.gz: 1afdec85fdeaadf2e9b34261a223c69143ea3bf3d62b446e4d3c65e6d0f193f7
 SHA512:
-  metadata.gz: 6c632de0881e5b7e06b9e90c3a031ae425771dedbb4bc451dbc380b4cb0eec0ddff0929dd96bd368b7ad3a01cfa8d0cfcce2776cc788bc304eb1bb7919f7d557
-  data.tar.gz: 07d1c5592f9f7efaa0b3c0495b5cbfd825c900e363c3be9fde0465081bf8bbb70fb7449ae16e5309e1204a2b3d7daf0f438b0a56fefc8c66009864c5296f622c
+  metadata.gz: 46a4bdf68256441bbe8baf778177e5a5dbe8b9596c89befdefcc22a272bd437aa0a2dc34efe0b95155bff3d0577e5f96c1f6d77f9ac598a2a138323e31fca43c
+  data.tar.gz: e916351643479cb10eb263e5b55c780bdad6699eed851d405e52b24fb2cf351fd3197ad35ad714defa3368ef153a2561804cb00707230f2317084d745419487f

data/lib/google/cloud/spanner/admin/database/v1/database_admin/client.rb

@@ -144,6 +144,11 @@ module Google
                       initial_delay: 1.0, max_delay: 32.0, multiplier: 1.3, retry_codes: [14, 4]
                     }
 
+                    default_config.rpcs.list_database_roles.timeout = 3600.0
+                    default_config.rpcs.list_database_roles.retry_policy = {
+                      initial_delay: 1.0, max_delay: 32.0, multiplier: 1.3, retry_codes: [14, 4]
+                    }
+
                     default_config
                   end
                   yield @configure if block_given?
@@ -2253,6 +2258,107 @@ module Google
                   raise ::Google::Cloud::Error.from_error(e)
                 end
 
+                ##
+                # Lists Cloud Spanner database roles.
+                #
+                # @overload list_database_roles(request, options = nil)
+                #   Pass arguments to `list_database_roles` via a request object, either of type
+                #   {::Google::Cloud::Spanner::Admin::Database::V1::ListDatabaseRolesRequest} or an equivalent Hash.
+                #
+                #   @param request [::Google::Cloud::Spanner::Admin::Database::V1::ListDatabaseRolesRequest, ::Hash]
+                #     A request object representing the call parameters. Required. To specify no
+                #     parameters, or to keep all the default parameter values, pass an empty Hash.
+                #   @param options [::Gapic::CallOptions, ::Hash]
+                #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
+                #
+                # @overload list_database_roles(parent: nil, page_size: nil, page_token: nil)
+                #   Pass arguments to `list_database_roles` via keyword arguments. Note that at
+                #   least one keyword argument is required. To specify no parameters, or to keep all
+                #   the default parameter values, pass an empty Hash as a request object (see above).
+                #
+                #   @param parent [::String]
+                #     Required. The database whose roles should be listed.
+                #     Values are of the form
+                #     `projects/<project>/instances/<instance>/databases/<database>/databaseRoles`.
+                #   @param page_size [::Integer]
+                #     Number of database roles to be returned in the response. If 0 or less,
+                #     defaults to the server's maximum allowed page size.
+                #   @param page_token [::String]
+                #     If non-empty, `page_token` should contain a
+                #     {::Google::Cloud::Spanner::Admin::Database::V1::ListDatabaseRolesResponse#next_page_token next_page_token} from a
+                #     previous {::Google::Cloud::Spanner::Admin::Database::V1::ListDatabaseRolesResponse ListDatabaseRolesResponse}.
+                #
+                # @yield [response, operation] Access the result along with the RPC operation
+                # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Spanner::Admin::Database::V1::DatabaseRole>]
+                # @yieldparam operation [::GRPC::ActiveCall::Operation]
+                #
+                # @return [::Gapic::PagedEnumerable<::Google::Cloud::Spanner::Admin::Database::V1::DatabaseRole>]
+                #
+                # @raise [::Google::Cloud::Error] if the RPC is aborted.
+                #
+                # @example Basic example
+                #   require "google/cloud/spanner/admin/database/v1"
+                #
+                #   # Create a client object. The client can be reused for multiple calls.
+                #   client = Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client.new
+                #
+                #   # Create a request. To set request fields, pass in keyword arguments.
+                #   request = Google::Cloud::Spanner::Admin::Database::V1::ListDatabaseRolesRequest.new
+                #
+                #   # Call the list_database_roles method.
+                #   result = client.list_database_roles 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::Spanner::Admin::Database::V1::DatabaseRole.
+                #     p response
+                #   end
+                #
+                def list_database_roles request, options = nil
+                  raise ::ArgumentError, "request must be provided" if request.nil?
+
+                  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Spanner::Admin::Database::V1::ListDatabaseRolesRequest
+
+                  # Converts hash and nil to an options object
+                  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
+
+                  # Customize the options with defaults
+                  metadata = @config.rpcs.list_database_roles.metadata.to_h
+
+                  # Set x-goog-api-client and x-goog-user-project headers
+                  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
+                    lib_name: @config.lib_name, lib_version: @config.lib_version,
+                    gapic_version: ::Google::Cloud::Spanner::Admin::Database::V1::VERSION
+                  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+                  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_database_roles.timeout,
+                                         metadata:     metadata,
+                                         retry_policy: @config.rpcs.list_database_roles.retry_policy
+
+                  options.apply_defaults timeout:      @config.timeout,
+                                         metadata:     @config.metadata,
+                                         retry_policy: @config.retry_policy
+
+                  @database_admin_stub.call_rpc :list_database_roles, request, options: options do |response, operation|
+                    response = ::Gapic::PagedEnumerable.new @database_admin_stub, :list_database_roles, request, response, operation, options
+                    yield response, operation if block_given?
+                    return response
+                  end
+                rescue ::GRPC::BadStatus => e
+                  raise ::Google::Cloud::Error.from_error(e)
+                end
+
                 ##
                 # Configuration class for the DatabaseAdmin API.
                 #
@@ -2478,6 +2584,11 @@ module Google
                     # @return [::Gapic::Config::Method]
                     #
                     attr_reader :list_backup_operations
+                    ##
+                    # RPC-specific configuration for `list_database_roles`
+                    # @return [::Gapic::Config::Method]
+                    #
+                    attr_reader :list_database_roles
 
                     # @private
                     def initialize parent_rpcs = nil
@@ -2517,6 +2628,8 @@ module Google
                       @list_database_operations = ::Gapic::Config::Method.new list_database_operations_config
                       list_backup_operations_config = parent_rpcs.list_backup_operations if parent_rpcs.respond_to? :list_backup_operations
                       @list_backup_operations = ::Gapic::Config::Method.new list_backup_operations_config
+                      list_database_roles_config = parent_rpcs.list_database_roles if parent_rpcs.respond_to? :list_database_roles
+                      @list_database_roles = ::Gapic::Config::Method.new list_database_roles_config
 
                       yield self if block_given?
                     end

data/lib/google/cloud/spanner/admin/database/v1/version.rb

@@ -23,7 +23,7 @@ module Google
       module Admin
         module Database
           module V1
-            VERSION = "0.10.0"
+            VERSION = "0.11.0"
           end
         end
       end

data/lib/google/spanner/admin/database/v1/spanner_database_admin_pb.rb

@@ -126,6 +126,18 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :name, :string, 1
       optional :progress, :message, 2, "google.spanner.admin.database.v1.OperationProgress"
     end
+    add_message "google.spanner.admin.database.v1.DatabaseRole" do
+      optional :name, :string, 1
+    end
+    add_message "google.spanner.admin.database.v1.ListDatabaseRolesRequest" do
+      optional :parent, :string, 1
+      optional :page_size, :int32, 2
+      optional :page_token, :string, 3
+    end
+    add_message "google.spanner.admin.database.v1.ListDatabaseRolesResponse" do
+      repeated :database_roles, :message, 1, "google.spanner.admin.database.v1.DatabaseRole"
+      optional :next_page_token, :string, 2
+    end
     add_enum "google.spanner.admin.database.v1.RestoreSourceType" do
       value :TYPE_UNSPECIFIED, 0
       value :BACKUP, 1
@@ -159,6 +171,9 @@ module Google
             RestoreDatabaseEncryptionConfig::EncryptionType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.spanner.admin.database.v1.RestoreDatabaseEncryptionConfig.EncryptionType").enummodule
             RestoreDatabaseMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.spanner.admin.database.v1.RestoreDatabaseMetadata").msgclass
             OptimizeRestoredDatabaseMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.spanner.admin.database.v1.OptimizeRestoredDatabaseMetadata").msgclass
+            DatabaseRole = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.spanner.admin.database.v1.DatabaseRole").msgclass
+            ListDatabaseRolesRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.spanner.admin.database.v1.ListDatabaseRolesRequest").msgclass
+            ListDatabaseRolesResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.spanner.admin.database.v1.ListDatabaseRolesResponse").msgclass
             RestoreSourceType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.spanner.admin.database.v1.RestoreSourceType").enummodule
           end
         end

data/lib/google/spanner/admin/database/v1/spanner_database_admin_services_pb.rb

@@ -174,6 +174,8 @@ module Google
                 # `operation.metadata.value.progress.start_time` in descending order starting
                 # from the most recently started operation.
                 rpc :ListBackupOperations, ::Google::Cloud::Spanner::Admin::Database::V1::ListBackupOperationsRequest, ::Google::Cloud::Spanner::Admin::Database::V1::ListBackupOperationsResponse
+                # Lists Cloud Spanner database roles.
+                rpc :ListDatabaseRoles, ::Google::Cloud::Spanner::Admin::Database::V1::ListDatabaseRolesRequest, ::Google::Cloud::Spanner::Admin::Database::V1::ListDatabaseRolesResponse
               end
 
               Stub = Service.rpc_stub_class

data/proto_docs/google/spanner/admin/database/v1/spanner_database_admin.rb

@@ -531,6 +531,53 @@ module Google
               extend ::Google::Protobuf::MessageExts::ClassMethods
             end
 
+            # A Cloud Spanner database role.
+            # @!attribute [rw] name
+            #   @return [::String]
+            #     Required. The name of the database role. Values are of the form
+            #     `projects/<project>/instances/<instance>/databases/<database>/databaseRoles/
+            #     \\{role}`, where `<role>` is as specified in the `CREATE ROLE`
+            #     DDL statement. This name can be passed to Get/Set IAMPolicy methods to
+            #     identify the database role.
+            class DatabaseRole
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
+            # The request for {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#list_database_roles ListDatabaseRoles}.
+            # @!attribute [rw] parent
+            #   @return [::String]
+            #     Required. The database whose roles should be listed.
+            #     Values are of the form
+            #     `projects/<project>/instances/<instance>/databases/<database>/databaseRoles`.
+            # @!attribute [rw] page_size
+            #   @return [::Integer]
+            #     Number of database roles to be returned in the response. If 0 or less,
+            #     defaults to the server's maximum allowed page size.
+            # @!attribute [rw] page_token
+            #   @return [::String]
+            #     If non-empty, `page_token` should contain a
+            #     {::Google::Cloud::Spanner::Admin::Database::V1::ListDatabaseRolesResponse#next_page_token next_page_token} from a
+            #     previous {::Google::Cloud::Spanner::Admin::Database::V1::ListDatabaseRolesResponse ListDatabaseRolesResponse}.
+            class ListDatabaseRolesRequest
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
+            # The response for {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#list_database_roles ListDatabaseRoles}.
+            # @!attribute [rw] database_roles
+            #   @return [::Array<::Google::Cloud::Spanner::Admin::Database::V1::DatabaseRole>]
+            #     Database roles that matched the request.
+            # @!attribute [rw] next_page_token
+            #   @return [::String]
+            #     `next_page_token` can be sent in a subsequent
+            #     {::Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client#list_database_roles ListDatabaseRoles}
+            #     call to fetch more of the matching roles.
+            class ListDatabaseRolesResponse
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
             # Indicates the type of the restore source.
             module RestoreSourceType
               # No restore associated.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-spanner-admin-database-v1
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-08 00:00:00.000000000 Z
+date: 2022-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common