google-cloud-cloud_controls_partner-v1beta 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b5000680bb6442bdaafd074f7276d26842af4c5f78bbd5fce2efd35a9edf3c55
-  data.tar.gz: 672a6852fa956e9f838134b0dc7a7bd0a791a01afe83335ac89c030a50bfd5ff
+  metadata.gz: d81a5677d3306660124bf1c10835833a227072ef90f01e2e3aa8af63844e5abe
+  data.tar.gz: d65fee438acbf5d756b6c7be91e92477673c54cb15149b645d87c1cc0bf92950
 SHA512:
-  metadata.gz: 65c918cc0351e39975e8e428e9f11ba49b8d897bcbc002872cebc0418451f8a483e02a9461b1dc8c998f9df5b7d2ce9e1dce29cbc1205f20ea3ce3294b3ba6d9
-  data.tar.gz: 73efddd9e7dd433c152e3b1744bb87533e874c637df67e8d04552354fa20c513418ffbdd9948e6a9b12498254db617912e5a25c8cb74f4854c9dbbff2571fca4
+  metadata.gz: 26ecfe3d416a5bc324f082bca933d3d4164be1e28070cc7ca07249f73854e76e375cbe5b397a8eee054dec93dce20098f93d7bf8377cbd8e5a2d8652740c5aa4
+  data.tar.gz: fe8fe3f5cfef46d66091fd50d5bc295fba4080ad07ec8e4c558459cc364c48c987c0262130ada0602e3eb7d68f8569291e1580718dd7e61efdaea767fd8d0cad

data/README.md

@@ -43,40 +43,50 @@ for class and method documentation.
 See also the [Product Documentation](https://cloud.google.com/sovereign-controls-by-partners/docs/sovereign-partners/reference/rest)
 for general usage information.
 
-## Enabling Logging
-
-To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
-The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/current/stdlibs/logger/Logger.html) as shown below,
-or a [`Google::Cloud::Logging::Logger`](https://cloud.google.com/ruby/docs/reference/google-cloud-logging/latest)
-that will write logs to [Cloud Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
-and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
-
-Configuring a Ruby stdlib logger:
+## Debug Logging
+
+This library comes with opt-in Debug Logging that can help you troubleshoot
+your application's integration with the API. When logging is activated, key
+events such as requests and responses, along with data payloads and metadata
+such as headers and client configuration, are logged to the standard error
+stream.
+
+**WARNING:** Client Library Debug Logging includes your data payloads in
+plaintext, which could include sensitive data such as PII for yourself or your
+customers, private keys, or other security data that could be compromising if
+leaked. Always practice good data hygiene with your application logs, and follow
+the principle of least access. Google also recommends that Client Library Debug
+Logging be enabled only temporarily during active debugging, and not used
+permanently in production.
+
+To enable logging, set the environment variable `GOOGLE_SDK_RUBY_LOGGING_GEMS`
+to the value `all`. Alternatively, you can set the value to a comma-delimited
+list of client library gem names. This will select the default logging behavior,
+which writes logs to the standard error stream. On a local workstation, this may
+result in logs appearing on the console. When running on a Google Cloud hosting
+service such as [Google Cloud Run](https://cloud.google.com/run), this generally
+results in logs appearing alongside your application logs in the
+[Google Cloud Logging](https://cloud.google.com/logging/) service.
+
+You can customize logging by modifying the `logger` configuration when
+constructing a client object. For example:
 
 ```ruby
+require "google/cloud/cloud_controls_partner/v1beta"
 require "logger"
 
-module MyLogger
-  LOGGER = Logger.new $stderr, level: Logger::WARN
-  def logger
-    LOGGER
-  end
-end
-
-# Define a gRPC module-level logger method before grpc/logconfig.rb loads.
-module GRPC
-  extend MyLogger
+client = ::Google::Cloud::CloudControlsPartner::V1beta::CloudControlsPartnerCore::Client.new do |config|
+  config.logger = Logger.new "my-app.log"
 end
 ```
 
-
 ## Google Cloud Samples
 
 To browse ready to use code samples check [Google Cloud Samples](https://cloud.google.com/docs/samples).
 
 ## Supported Ruby Versions
 
-This library is supported on Ruby 2.7+.
+This library is supported on Ruby 3.0+.
 
 Google provides official support for Ruby versions that are actively supported
 by Ruby Core—that is, Ruby versions that are either in normal maintenance or

data/lib/google/cloud/cloud_controls_partner/v1beta/cloud_controls_partner_core/client.rb

@@ -192,8 +192,28 @@ module Google
                 universe_domain: @config.universe_domain,
                 channel_args: @config.channel_args,
                 interceptors: @config.interceptors,
-                channel_pool_config: @config.channel_pool
+                channel_pool_config: @config.channel_pool,
+                logger: @config.logger
               )
+
+              @cloud_controls_partner_core_stub.stub_logger&.info do |entry|
+                entry.set_system_name
+                entry.set_service
+                entry.message = "Created client for #{entry.service}"
+                entry.set_credentials_fields credentials
+                entry.set "customEndpoint", @config.endpoint if @config.endpoint
+                entry.set "defaultTimeout", @config.timeout if @config.timeout
+                entry.set "quotaProject", @quota_project_id if @quota_project_id
+              end
+            end
+
+            ##
+            # The logger used for request/response debug logging.
+            #
+            # @return [Logger]
+            #
+            def logger
+              @cloud_controls_partner_core_stub.logger
             end
 
             # Service calls
@@ -279,7 +299,6 @@ module Google
 
               @cloud_controls_partner_core_stub.call_rpc :get_workload, request, options: options do |response, operation|
                 yield response, operation if block_given?
-                return response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -382,7 +401,7 @@ module Google
               @cloud_controls_partner_core_stub.call_rpc :list_workloads, request, options: options do |response, operation|
                 response = ::Gapic::PagedEnumerable.new @cloud_controls_partner_core_stub, :list_workloads, request, response, operation, options
                 yield response, operation if block_given?
-                return response
+                throw :response, response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -469,7 +488,6 @@ module Google
 
               @cloud_controls_partner_core_stub.call_rpc :get_customer, request, options: options do |response, operation|
                 yield response, operation if block_given?
-                return response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -571,7 +589,7 @@ module Google
               @cloud_controls_partner_core_stub.call_rpc :list_customers, request, options: options do |response, operation|
                 response = ::Gapic::PagedEnumerable.new @cloud_controls_partner_core_stub, :list_customers, request, response, operation, options
                 yield response, operation if block_given?
-                return response
+                throw :response, response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -658,7 +676,6 @@ module Google
 
               @cloud_controls_partner_core_stub.call_rpc :get_ekm_connections, request, options: options do |response, operation|
                 yield response, operation if block_given?
-                return response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -745,7 +762,6 @@ module Google
 
               @cloud_controls_partner_core_stub.call_rpc :get_partner_permissions, request, options: options do |response, operation|
                 yield response, operation if block_given?
-                return response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -853,7 +869,7 @@ module Google
               @cloud_controls_partner_core_stub.call_rpc :list_access_approval_requests, request, options: options do |response, operation|
                 response = ::Gapic::PagedEnumerable.new @cloud_controls_partner_core_stub, :list_access_approval_requests, request, response, operation, options
                 yield response, operation if block_given?
-                return response
+                throw :response, response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -940,7 +956,273 @@ module Google
 
               @cloud_controls_partner_core_stub.call_rpc :get_partner, request, options: options do |response, operation|
                 yield response, operation if block_given?
-                return response
+              end
+            rescue ::GRPC::BadStatus => e
+              raise ::Google::Cloud::Error.from_error(e)
+            end
+
+            ##
+            # Creates a new customer.
+            #
+            # @overload create_customer(request, options = nil)
+            #   Pass arguments to `create_customer` via a request object, either of type
+            #   {::Google::Cloud::CloudControlsPartner::V1beta::CreateCustomerRequest} or an equivalent Hash.
+            #
+            #   @param request [::Google::Cloud::CloudControlsPartner::V1beta::CreateCustomerRequest, ::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 create_customer(parent: nil, customer: nil, customer_id: nil)
+            #   Pass arguments to `create_customer` 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. Parent resource
+            #     Format: `organizations/{organization}/locations/{location}`
+            #   @param customer [::Google::Cloud::CloudControlsPartner::V1beta::Customer, ::Hash]
+            #     Required. The customer to create.
+            #   @param customer_id [::String]
+            #     Required. The customer id to use for the customer, which will become the
+            #     final component of the customer's resource name. The specified value must
+            #     be a valid Google cloud organization id.
+            #
+            # @yield [response, operation] Access the result along with the RPC operation
+            # @yieldparam response [::Google::Cloud::CloudControlsPartner::V1beta::Customer]
+            # @yieldparam operation [::GRPC::ActiveCall::Operation]
+            #
+            # @return [::Google::Cloud::CloudControlsPartner::V1beta::Customer]
+            #
+            # @raise [::Google::Cloud::Error] if the RPC is aborted.
+            #
+            # @example Basic example
+            #   require "google/cloud/cloud_controls_partner/v1beta"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::CloudControlsPartner::V1beta::CloudControlsPartnerCore::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::CloudControlsPartner::V1beta::CreateCustomerRequest.new
+            #
+            #   # Call the create_customer method.
+            #   result = client.create_customer request
+            #
+            #   # The returned object is of type Google::Cloud::CloudControlsPartner::V1beta::Customer.
+            #   p result
+            #
+            def create_customer request, options = nil
+              raise ::ArgumentError, "request must be provided" if request.nil?
+
+              request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::CloudControlsPartner::V1beta::CreateCustomerRequest
+
+              # 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.create_customer.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::CloudControlsPartner::V1beta::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.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.create_customer.timeout,
+                                     metadata:     metadata,
+                                     retry_policy: @config.rpcs.create_customer.retry_policy
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
+                                     retry_policy: @config.retry_policy
+
+              @cloud_controls_partner_core_stub.call_rpc :create_customer, 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
+
+            ##
+            # Update details of a single customer
+            #
+            # @overload update_customer(request, options = nil)
+            #   Pass arguments to `update_customer` via a request object, either of type
+            #   {::Google::Cloud::CloudControlsPartner::V1beta::UpdateCustomerRequest} or an equivalent Hash.
+            #
+            #   @param request [::Google::Cloud::CloudControlsPartner::V1beta::UpdateCustomerRequest, ::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 update_customer(customer: nil, update_mask: nil)
+            #   Pass arguments to `update_customer` 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 customer [::Google::Cloud::CloudControlsPartner::V1beta::Customer, ::Hash]
+            #     Required. The customer to update
+            #     Format:
+            #     `organizations/{organization}/locations/{location}/customers/{customer}`
+            #   @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
+            #     Optional. The list of fields to update
+            #
+            # @yield [response, operation] Access the result along with the RPC operation
+            # @yieldparam response [::Google::Cloud::CloudControlsPartner::V1beta::Customer]
+            # @yieldparam operation [::GRPC::ActiveCall::Operation]
+            #
+            # @return [::Google::Cloud::CloudControlsPartner::V1beta::Customer]
+            #
+            # @raise [::Google::Cloud::Error] if the RPC is aborted.
+            #
+            # @example Basic example
+            #   require "google/cloud/cloud_controls_partner/v1beta"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::CloudControlsPartner::V1beta::CloudControlsPartnerCore::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::CloudControlsPartner::V1beta::UpdateCustomerRequest.new
+            #
+            #   # Call the update_customer method.
+            #   result = client.update_customer request
+            #
+            #   # The returned object is of type Google::Cloud::CloudControlsPartner::V1beta::Customer.
+            #   p result
+            #
+            def update_customer request, options = nil
+              raise ::ArgumentError, "request must be provided" if request.nil?
+
+              request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::CloudControlsPartner::V1beta::UpdateCustomerRequest
+
+              # 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.update_customer.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::CloudControlsPartner::V1beta::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.customer&.name
+                header_params["customer.name"] = request.customer.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_customer.timeout,
+                                     metadata:     metadata,
+                                     retry_policy: @config.rpcs.update_customer.retry_policy
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
+                                     retry_policy: @config.retry_policy
+
+              @cloud_controls_partner_core_stub.call_rpc :update_customer, 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
+
+            ##
+            # Delete details of a single customer
+            #
+            # @overload delete_customer(request, options = nil)
+            #   Pass arguments to `delete_customer` via a request object, either of type
+            #   {::Google::Cloud::CloudControlsPartner::V1beta::DeleteCustomerRequest} or an equivalent Hash.
+            #
+            #   @param request [::Google::Cloud::CloudControlsPartner::V1beta::DeleteCustomerRequest, ::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 delete_customer(name: nil)
+            #   Pass arguments to `delete_customer` 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 name [::String]
+            #     Required. name of the resource to be deleted
+            #     format: name=organizations/*/locations/*/customers/*
+            #
+            # @yield [response, operation] Access the result along with the RPC operation
+            # @yieldparam response [::Google::Protobuf::Empty]
+            # @yieldparam operation [::GRPC::ActiveCall::Operation]
+            #
+            # @return [::Google::Protobuf::Empty]
+            #
+            # @raise [::Google::Cloud::Error] if the RPC is aborted.
+            #
+            # @example Basic example
+            #   require "google/cloud/cloud_controls_partner/v1beta"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::CloudControlsPartner::V1beta::CloudControlsPartnerCore::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::CloudControlsPartner::V1beta::DeleteCustomerRequest.new
+            #
+            #   # Call the delete_customer method.
+            #   result = client.delete_customer request
+            #
+            #   # The returned object is of type Google::Protobuf::Empty.
+            #   p result
+            #
+            def delete_customer request, options = nil
+              raise ::ArgumentError, "request must be provided" if request.nil?
+
+              request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::CloudControlsPartner::V1beta::DeleteCustomerRequest
+
+              # 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.delete_customer.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::CloudControlsPartner::V1beta::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.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.delete_customer.timeout,
+                                     metadata:     metadata,
+                                     retry_policy: @config.rpcs.delete_customer.retry_policy
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
+                                     retry_policy: @config.retry_policy
+
+              @cloud_controls_partner_core_stub.call_rpc :delete_customer, request, options: options do |response, operation|
+                yield response, operation if block_given?
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -990,6 +1272,13 @@ module Google
             #    *  (`GRPC::Core::Channel`) a gRPC channel with included credentials
             #    *  (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
             #    *  (`nil`) indicating no credentials
+            #
+            #   Warning: If you accept a credential configuration (JSON file or Hash) from an
+            #   external source for authentication to Google Cloud, you must validate it before
+            #   providing it to a Google API client library. Providing an unvalidated credential
+            #   configuration to Google APIs can compromise the security of your systems and data.
+            #   For more information, refer to [Validate credential configurations from external
+            #   sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials).
             #   @return [::Object]
             # @!attribute [rw] scope
             #   The OAuth scopes
@@ -1029,6 +1318,11 @@ module Google
             #   default endpoint URL. The default value of nil uses the environment
             #   universe (usually the default "googleapis.com" universe).
             #   @return [::String,nil]
+            # @!attribute [rw] logger
+            #   A custom logger to use for request/response debug logging, or the value
+            #   `:default` (the default) to construct a default logger, or `nil` to
+            #   explicitly disable logging.
+            #   @return [::Logger,:default,nil]
             #
             class Configuration
               extend ::Gapic::Config
@@ -1053,6 +1347,7 @@ module Google
               config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
               config_attr :quota_project, nil, ::String, nil
               config_attr :universe_domain, nil, ::String, nil
+              config_attr :logger, :default, ::Logger, nil, :default
 
               # @private
               def initialize parent_config = nil
@@ -1139,6 +1434,21 @@ module Google
                 # @return [::Gapic::Config::Method]
                 #
                 attr_reader :get_partner
+                ##
+                # RPC-specific configuration for `create_customer`
+                # @return [::Gapic::Config::Method]
+                #
+                attr_reader :create_customer
+                ##
+                # RPC-specific configuration for `update_customer`
+                # @return [::Gapic::Config::Method]
+                #
+                attr_reader :update_customer
+                ##
+                # RPC-specific configuration for `delete_customer`
+                # @return [::Gapic::Config::Method]
+                #
+                attr_reader :delete_customer
 
                 # @private
                 def initialize parent_rpcs = nil
@@ -1158,6 +1468,12 @@ module Google
                   @list_access_approval_requests = ::Gapic::Config::Method.new list_access_approval_requests_config
                   get_partner_config = parent_rpcs.get_partner if parent_rpcs.respond_to? :get_partner
                   @get_partner = ::Gapic::Config::Method.new get_partner_config
+                  create_customer_config = parent_rpcs.create_customer if parent_rpcs.respond_to? :create_customer
+                  @create_customer = ::Gapic::Config::Method.new create_customer_config
+                  update_customer_config = parent_rpcs.update_customer if parent_rpcs.respond_to? :update_customer
+                  @update_customer = ::Gapic::Config::Method.new update_customer_config
+                  delete_customer_config = parent_rpcs.delete_customer if parent_rpcs.respond_to? :delete_customer
+                  @delete_customer = ::Gapic::Config::Method.new delete_customer_config
 
                   yield self if block_given?
                 end