Module: Google::Cloud::Dlp

Defined in:
lib/google/cloud/dlp.rb,
lib/google/cloud/dlp/version.rb

Constant Summary collapse

VERSION = 
"1.3.0"

Class Method Summary collapse

Class Method Details

.configure {|::Google::Cloud.configure.dlp| ... } ⇒ ::Google::Cloud::Config

Configure the google-cloud-dlp library.

The following configuration parameters are supported:

  • credentials (type: String, Hash, Google::Auth::Credentials) - The path to the keyfile as a String, the contents of the keyfile as a Hash, or a Google::Auth::Credentials object.
  • lib_name (type: String) - The library name as recorded in instrumentation and logging.
  • lib_version (type: String) - The library version as recorded in instrumentation and logging.
  • interceptors (type: Array<GRPC::ClientInterceptor>) - An array of interceptors that are run before calls are executed.
  • timeout (type: Numeric) - Default timeout in seconds.
  • metadata (type: Hash{Symbol=>String}) - Additional gRPC headers to be sent with the call.
  • retry_policy (type: Hash) - 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.

Yields:

Returns:

  • (::Google::Cloud::Config) —

    The default configuration used by this library



113
114
115
116
117
 
# File 'lib/google/cloud/dlp.rb', line 113

def self.configure
  yield ::Google::Cloud.configure.dlp if block_given?

  ::Google::Cloud.configure.dlp
end

.dlp_service(version: :v2, &block) ⇒ DlpService::Client

Create a new client object for DlpService.

By default, this returns an instance of Google::Cloud::Dlp::V2::DlpService::Client for version V2 of the API. However, you can specify specify a different API version by passing it in the version parameter. If the DlpService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned.

About DlpService

The Cloud Data Loss Prevention (DLP) API is a service that allows clients to detect the presence of Personally Identifiable Information (PII) and other privacy-sensitive data in user-supplied, unstructured data streams, like text blocks or images. The service also includes methods for sensitive data redaction and scheduling of data scans on Google Cloud Platform based data sets.

To learn more about concepts and find how-to guides see https://cloud.google.com/dlp/docs/.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v2) —

    The API version to connect to. Optional. Defaults to :v2.

Returns:

  • (DlpService::Client) —

    A client object for the specified version.



74
75
76
77
78
79
80
81
82
83
 
# File 'lib/google/cloud/dlp.rb', line 74

def self.dlp_service version: :v2, &block
  require "google/cloud/dlp/#{version.to_s.downcase}"

  package_name = Google::Cloud::Dlp
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  package_module = Google::Cloud::Dlp.const_get package_name
  package_module.const_get(:DlpService).const_get(:Client).new(&block)
end