google-cloud-storage-control-v2 1.5.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a9959738837fd27a31ce7d256955428feaa7931de71daf7c9f2bcf7145dcd81
-  data.tar.gz: a9f34b0af109bb5b46e615495e9ca0e308e33c8cea4cd545c3d0c9836b460868
+  metadata.gz: 9fd2a4ec080d2fede49098084b30b604b713ad0ad98dff8aeeb9f99fb9c2e74d
+  data.tar.gz: e428228da9e78cba36ceb7c255f520681620d0e69b970a9463d687cb9efdb4fb
 SHA512:
-  metadata.gz: c4e2df44a11295a4f314eccaa50aa65a6df18c37e3617eee90d3ac89d8efa63e6e106156a628c1788bcc71b5e53bf2b8715fa06fabd9500e720fae74e368e6c5
-  data.tar.gz: e0e082fcf90d48b2082d1ba0a9120ba48b23d76e72de8ec2d41a191791806af0625cf500a6285c9e99f2dbf24ad374293a5c15e1f1050775069ab18b7e0ad4ac
+  metadata.gz: f9f99fd1f287b09e4f333a80e02bc6dd1971bfa6c5f8968f6fe37d8ecf33a2a2511009c97f69f035a3cd351915c03b5bd971638698d833f16c478e8e147839f2
+  data.tar.gz: 37e01f162364b5d1c995803a8c3e36473b4b54113f92d9cd1c9edd502104759a5cd352917af63c374de926fe2ccbd5818eba2ccc2eb60904eaa6f29c86613669

data/AUTHENTICATION.md

@@ -54,9 +54,9 @@ whenever possible.
 To configure a credentials file for an individual client initialization:
 
 ```ruby
-require "google/cloud/storage/control/v2"
+require "google/iam/v1"
 
-client = ::Google::Cloud::Storage::Control::V2::StorageControl::Client.new do |config|
+client = ::Google::Iam::V1::IAMPolicy::Client.new do |config|
   config.credentials = "path/to/credentialfile.json"
 end
 ```
@@ -64,13 +64,13 @@ end
 To configure a credentials file globally for all clients:
 
 ```ruby
-require "google/cloud/storage/control/v2"
+require "google/iam/v1"
 
-::Google::Cloud::Storage::Control::V2::StorageControl::Client.configure do |config|
+::Google::Iam::V1::IAMPolicy::Client.configure do |config|
   config.credentials = "path/to/credentialfile.json"
 end
 
-client = ::Google::Cloud::Storage::Control::V2::StorageControl::Client.new
+client = ::Google::Iam::V1::IAMPolicy::Client.new
 ```
 
 ### Environment Variables
@@ -96,11 +96,11 @@ checks for credentials are:
 * `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
 
 ```ruby
-require "google/cloud/storage/control/v2"
+require "google/iam/v1"
 
 ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
 
-client = ::Google::Cloud::Storage::Control::V2::StorageControl::Client.new
+client = ::Google::Iam::V1::IAMPolicy::Client.new
 ```
 
 ### Local ADC file

data/README.md

@@ -30,11 +30,11 @@ In order to use this library, you first need to go through the following steps:
 ## Quick Start
 
 ```ruby
-require "google/cloud/storage/control/v2"
+require "google/iam/v1"
 
-client = ::Google::Cloud::Storage::Control::V2::StorageControl::Client.new
-request = ::Google::Cloud::Storage::Control::V2::CreateFolderRequest.new # (request fields as keyword arguments...)
-response = client.create_folder request
+client = ::Google::Iam::V1::IAMPolicy::Client.new
+request = ::Google::Iam::V1::SetIamPolicyRequest.new # (request fields as keyword arguments...)
+response = client.set_iam_policy request
 ```
 
 View the [Client Library Documentation](https://cloud.google.com/ruby/docs/reference/google-cloud-storage-control-v2/latest)
@@ -72,10 +72,10 @@ You can customize logging by modifying the `logger` configuration when
 constructing a client object. For example:
 
 ```ruby
-require "google/cloud/storage/control/v2"
+require "google/iam/v1"
 require "logger"
 
-client = ::Google::Cloud::Storage::Control::V2::StorageControl::Client.new do |config|
+client = ::Google::Iam::V1::IAMPolicy::Client.new do |config|
   config.logger = Logger.new "my-app.log"
 end
 ```

data/lib/google/cloud/storage/control/v2/storage_control/client.rb

@@ -2561,6 +2561,321 @@ module Google
                 raise ::Google::Cloud::Error.from_error(e)
               end
 
+              ##
+              # Gets the IAM policy for a specified bucket.
+              # The `resource` field in the request should be
+              # `projects/_/buckets/{bucket}` for a bucket, or
+              # `projects/_/buckets/{bucket}/managedFolders/{managedFolder}`
+              # for a managed folder.
+              #
+              # @overload get_iam_policy(request, options = nil)
+              #   Pass arguments to `get_iam_policy` via a request object, either of type
+              #   {::Google::Iam::V1::GetIamPolicyRequest} or an equivalent Hash.
+              #
+              #   @param request [::Google::Iam::V1::GetIamPolicyRequest, ::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 get_iam_policy(resource: nil, options: nil)
+              #   Pass arguments to `get_iam_policy` 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 resource [::String]
+              #     REQUIRED: The resource for which the policy is being requested.
+              #     See the operation documentation for the appropriate value for this field.
+              #   @param options [::Google::Iam::V1::GetPolicyOptions, ::Hash]
+              #     OPTIONAL: A `GetPolicyOptions` object for specifying options to
+              #     `GetIamPolicy`.
+              #
+              # @yield [response, operation] Access the result along with the RPC operation
+              # @yieldparam response [::Google::Iam::V1::Policy]
+              # @yieldparam operation [::GRPC::ActiveCall::Operation]
+              #
+              # @return [::Google::Iam::V1::Policy]
+              #
+              # @raise [::Google::Cloud::Error] if the RPC is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/storage/control/v2"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Storage::Control::V2::StorageControl::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Iam::V1::GetIamPolicyRequest.new
+              #
+              #   # Call the get_iam_policy method.
+              #   result = client.get_iam_policy request
+              #
+              #   # The returned object is of type Google::Iam::V1::Policy.
+              #   p result
+              #
+              def get_iam_policy request, options = nil
+                raise ::ArgumentError, "request must be provided" if request.nil?
+
+                request = ::Gapic::Protobuf.coerce request, to: ::Google::Iam::V1::GetIamPolicyRequest
+
+                # 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.get_iam_policy.metadata.to_h
+
+                # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::Storage::Control::V2::VERSION
+                metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
+                metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+                header_params = {}
+                if request.resource && !request.resource.empty?
+                  header_params["bucket"] = request.resource
+                end
+                if request.resource
+                  regex_match = %r{^(?<bucket>projects/[^/]+/buckets/[^/]+)(?:/.*)?$}.match request.resource
+                  if regex_match
+                    header_params["bucket"] = regex_match["bucket".to_s]
+                  end
+                end
+
+                request_params_header = URI.encode_www_form header_params
+                metadata[:"x-goog-request-params"] ||= request_params_header
+
+                options.apply_defaults timeout:      @config.rpcs.get_iam_policy.timeout,
+                                       metadata:     metadata,
+                                       retry_policy: @config.rpcs.get_iam_policy.retry_policy
+
+                options.apply_defaults timeout:      @config.timeout,
+                                       metadata:     @config.metadata,
+                                       retry_policy: @config.retry_policy
+
+                @storage_control_stub.call_rpc :get_iam_policy, request, options: options do |response, operation|
+                  yield response, operation if block_given?
+                end
+              rescue ::GRPC::BadStatus => e
+                raise ::Google::Cloud::Error.from_error(e)
+              end
+
+              ##
+              # Updates an IAM policy for the specified bucket.
+              # The `resource` field in the request should be
+              # `projects/_/buckets/{bucket}` for a bucket, or
+              # `projects/_/buckets/{bucket}/managedFolders/{managedFolder}`
+              # for a managed folder.
+              #
+              # @overload set_iam_policy(request, options = nil)
+              #   Pass arguments to `set_iam_policy` via a request object, either of type
+              #   {::Google::Iam::V1::SetIamPolicyRequest} or an equivalent Hash.
+              #
+              #   @param request [::Google::Iam::V1::SetIamPolicyRequest, ::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 set_iam_policy(resource: nil, policy: nil, update_mask: nil)
+              #   Pass arguments to `set_iam_policy` 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 resource [::String]
+              #     REQUIRED: The resource for which the policy is being specified.
+              #     See the operation documentation for the appropriate value for this field.
+              #   @param policy [::Google::Iam::V1::Policy, ::Hash]
+              #     REQUIRED: The complete policy to be applied to the `resource`. The size of
+              #     the policy is limited to a few 10s of KB. An empty policy is a
+              #     valid policy but certain Cloud Platform services (such as Projects)
+              #     might reject them.
+              #   @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
+              #     OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only
+              #     the fields in the mask will be modified. If no mask is provided, the
+              #     following default mask is used:
+              #
+              #     `paths: "bindings, etag"`
+              #
+              # @yield [response, operation] Access the result along with the RPC operation
+              # @yieldparam response [::Google::Iam::V1::Policy]
+              # @yieldparam operation [::GRPC::ActiveCall::Operation]
+              #
+              # @return [::Google::Iam::V1::Policy]
+              #
+              # @raise [::Google::Cloud::Error] if the RPC is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/storage/control/v2"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Storage::Control::V2::StorageControl::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Iam::V1::SetIamPolicyRequest.new
+              #
+              #   # Call the set_iam_policy method.
+              #   result = client.set_iam_policy request
+              #
+              #   # The returned object is of type Google::Iam::V1::Policy.
+              #   p result
+              #
+              def set_iam_policy request, options = nil
+                raise ::ArgumentError, "request must be provided" if request.nil?
+
+                request = ::Gapic::Protobuf.coerce request, to: ::Google::Iam::V1::SetIamPolicyRequest
+
+                # 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.set_iam_policy.metadata.to_h
+
+                # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::Storage::Control::V2::VERSION
+                metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
+                metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+                header_params = {}
+                if request.resource && !request.resource.empty?
+                  header_params["bucket"] = request.resource
+                end
+                if request.resource
+                  regex_match = %r{^(?<bucket>projects/[^/]+/buckets/[^/]+)(?:/.*)?$}.match request.resource
+                  if regex_match
+                    header_params["bucket"] = regex_match["bucket".to_s]
+                  end
+                end
+
+                request_params_header = URI.encode_www_form header_params
+                metadata[:"x-goog-request-params"] ||= request_params_header
+
+                options.apply_defaults timeout:      @config.rpcs.set_iam_policy.timeout,
+                                       metadata:     metadata,
+                                       retry_policy: @config.rpcs.set_iam_policy.retry_policy
+
+                options.apply_defaults timeout:      @config.timeout,
+                                       metadata:     @config.metadata,
+                                       retry_policy: @config.retry_policy
+
+                @storage_control_stub.call_rpc :set_iam_policy, request, options: options do |response, operation|
+                  yield response, operation if block_given?
+                end
+              rescue ::GRPC::BadStatus => e
+                raise ::Google::Cloud::Error.from_error(e)
+              end
+
+              ##
+              # Tests a set of permissions on the given bucket, object, or managed folder
+              # to see which, if any, are held by the caller.
+              # The `resource` field in the request should be
+              # `projects/_/buckets/{bucket}` for a bucket,
+              # `projects/_/buckets/{bucket}/objects/{object}` for an object, or
+              # `projects/_/buckets/{bucket}/managedFolders/{managedFolder}`
+              # for a managed folder.
+              #
+              # @overload test_iam_permissions(request, options = nil)
+              #   Pass arguments to `test_iam_permissions` via a request object, either of type
+              #   {::Google::Iam::V1::TestIamPermissionsRequest} or an equivalent Hash.
+              #
+              #   @param request [::Google::Iam::V1::TestIamPermissionsRequest, ::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 test_iam_permissions(resource: nil, permissions: nil)
+              #   Pass arguments to `test_iam_permissions` 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 resource [::String]
+              #     REQUIRED: The resource for which the policy detail is being requested.
+              #     See the operation documentation for the appropriate value for this field.
+              #   @param permissions [::Array<::String>]
+              #     The set of permissions to check for the `resource`. Permissions with
+              #     wildcards (such as '*' or 'storage.*') are not allowed. For more
+              #     information see
+              #     [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
+              #
+              # @yield [response, operation] Access the result along with the RPC operation
+              # @yieldparam response [::Google::Iam::V1::TestIamPermissionsResponse]
+              # @yieldparam operation [::GRPC::ActiveCall::Operation]
+              #
+              # @return [::Google::Iam::V1::TestIamPermissionsResponse]
+              #
+              # @raise [::Google::Cloud::Error] if the RPC is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/storage/control/v2"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Storage::Control::V2::StorageControl::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Iam::V1::TestIamPermissionsRequest.new
+              #
+              #   # Call the test_iam_permissions method.
+              #   result = client.test_iam_permissions request
+              #
+              #   # The returned object is of type Google::Iam::V1::TestIamPermissionsResponse.
+              #   p result
+              #
+              def test_iam_permissions request, options = nil
+                raise ::ArgumentError, "request must be provided" if request.nil?
+
+                request = ::Gapic::Protobuf.coerce request, to: ::Google::Iam::V1::TestIamPermissionsRequest
+
+                # 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.test_iam_permissions.metadata.to_h
+
+                # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::Storage::Control::V2::VERSION
+                metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
+                metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+                header_params = {}
+                if request.resource && !request.resource.empty?
+                  header_params["bucket"] = request.resource
+                end
+                if request.resource
+                  regex_match = %r{^(?<bucket>projects/[^/]+/buckets/[^/]+)/objects(?:/.*)?$}.match request.resource
+                  if regex_match
+                    header_params["bucket"] = regex_match["bucket".to_s]
+                  end
+                end
+                if request.resource
+                  regex_match = %r{^(?<bucket>projects/[^/]+/buckets/[^/]+)/managedFolders(?:/.*)?$}.match request.resource
+                  if regex_match
+                    header_params["bucket"] = regex_match["bucket".to_s]
+                  end
+                end
+
+                request_params_header = URI.encode_www_form header_params
+                metadata[:"x-goog-request-params"] ||= request_params_header
+
+                options.apply_defaults timeout:      @config.rpcs.test_iam_permissions.timeout,
+                                       metadata:     metadata,
+                                       retry_policy: @config.rpcs.test_iam_permissions.retry_policy
+
+                options.apply_defaults timeout:      @config.timeout,
+                                       metadata:     @config.metadata,
+                                       retry_policy: @config.retry_policy
+
+                @storage_control_stub.call_rpc :test_iam_permissions, request, options: options do |response, operation|
+                  yield response, operation if block_given?
+                end
+              rescue ::GRPC::BadStatus => e
+                raise ::Google::Cloud::Error.from_error(e)
+              end
+
               ##
               # Configuration class for the StorageControl API.
               #
@@ -2842,6 +3157,21 @@ module Google
                   # @return [::Gapic::Config::Method]
                   #
                   attr_reader :update_organization_intelligence_config
+                  ##
+                  # RPC-specific configuration for `get_iam_policy`
+                  # @return [::Gapic::Config::Method]
+                  #
+                  attr_reader :get_iam_policy
+                  ##
+                  # RPC-specific configuration for `set_iam_policy`
+                  # @return [::Gapic::Config::Method]
+                  #
+                  attr_reader :set_iam_policy
+                  ##
+                  # RPC-specific configuration for `test_iam_permissions`
+                  # @return [::Gapic::Config::Method]
+                  #
+                  attr_reader :test_iam_permissions
 
                   # @private
                   def initialize parent_rpcs = nil
@@ -2891,6 +3221,12 @@ module Google
                     @get_organization_intelligence_config = ::Gapic::Config::Method.new get_organization_intelligence_config_config
                     update_organization_intelligence_config_config = parent_rpcs.update_organization_intelligence_config if parent_rpcs.respond_to? :update_organization_intelligence_config
                     @update_organization_intelligence_config = ::Gapic::Config::Method.new update_organization_intelligence_config_config
+                    get_iam_policy_config = parent_rpcs.get_iam_policy if parent_rpcs.respond_to? :get_iam_policy
+                    @get_iam_policy = ::Gapic::Config::Method.new get_iam_policy_config
+                    set_iam_policy_config = parent_rpcs.set_iam_policy if parent_rpcs.respond_to? :set_iam_policy
+                    @set_iam_policy = ::Gapic::Config::Method.new set_iam_policy_config
+                    test_iam_permissions_config = parent_rpcs.test_iam_permissions if parent_rpcs.respond_to? :test_iam_permissions
+                    @test_iam_permissions = ::Gapic::Config::Method.new test_iam_permissions_config
 
                     yield self if block_given?
                   end

data/lib/google/cloud/storage/control/v2/version.rb

@@ -22,7 +22,7 @@ module Google
     module Storage
       module Control
         module V2
-          VERSION = "1.5.0"
+          VERSION = "1.7.0"
         end
       end
     end