Module: Google::Cloud::Dlp

Defined in:
lib/google/cloud/dlp.rb,
lib/google/cloud/dlp/v2.rb,
lib/google/cloud/dlp/credentials.rb,
lib/google/cloud/dlp/v2/doc/overview.rb,
lib/google/cloud/dlp/v2/dlp_service_client.rb

Overview

Ruby Client for Cloud Data Loss Prevention (DLP) API (Alpha)

Cloud Data Loss Prevention (DLP) API: Provides methods for detection, risk analysis, and de-identification of privacy-sensitive fragments in text, images, and Google Cloud Platform storage repositories.

Quick Start

In order to use this library, you first need to go through the following steps:

  1. Select or create a Cloud Platform project.
  2. Enable billing for your project.
  3. Enable the Cloud Data Loss Prevention (DLP) API.
  4. Setup Authentication.

Installation

$ gem install google-cloud-dlp

Next Steps

Defined Under Namespace

Modules: V2 Classes: Credentials

Constant Summary collapse

FILE_DIR =

rubocop:enable LineLength

File.realdirpath(Pathname.new(__FILE__).join("..").join("dlp"))
AVAILABLE_VERSIONS = 
Dir["#{FILE_DIR}/*"]
.select { |file| File.directory?(file) }
.select { |dir| Google::Gax::VERSION_MATCHER.match(File.basename(dir)) }
.select { |dir| File.exist?(dir + ".rb") }
.map { |dir| File.basename(dir) }

Class Method Summary collapse

Class Method Details

.new(version: , credentials: , scopes: , client_config: , timeout: ) ⇒ Object

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.

Parameters:

  • credentials (Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc) —

    Provides the means for authenticating requests made by the client. This parameter can be many types. A Google::Auth::Credentials uses a the properties of its represented keyfile for authenticating requests made by this client. A String will be treated as the path to the keyfile to be used for the construction of credentials for this client. A Hash will be treated as the contents of a keyfile to be used for the construction of credentials for this client. A GRPC::Core::Channel will be used to make calls through. A GRPC::Core::ChannelCredentials for the setting up the RPC client. The channel credentials should already be composed with a GRPC::Core::CallCredentials object. A Proc will be used as an updater_proc for the Grpc channel. The proc transforms the metadata for requests, generally, to give OAuth credentials.

  • scopes (Array<String>) —

    The OAuth scopes for this service. This parameter is ignored if an updater_proc is supplied.

  • client_config (Hash) —

    A Hash for call options for each method. See Google::Gax#construct_settings for the structure of this data. Falls back to the default config if not specified or the specified config is missing data points.

  • timeout (Numeric) —

    The default timeout, in seconds, for calls made through this client.

Parameters:

  • version (Symbol, String) —

    The major version of the service to be used. By default :v2 is used.



111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/google/cloud/dlp.rb', line 111

def self.new(*args, version: :v2, **kwargs)
  unless AVAILABLE_VERSIONS.include?(version.to_s.downcase)
    raise "The version: #{version} is not available. The available versions " \
      "are: [#{AVAILABLE_VERSIONS.join(", ")}]"
  end

  require "#{FILE_DIR}/#{version.to_s.downcase}"
  version_module = Google::Cloud::Dlp
    .constants
    .select {|sym| sym.to_s.downcase == version.to_s.downcase}
    .first
  Google::Cloud::Dlp.const_get(version_module).new(*args, **kwargs)
end