Class: Google::Cloud::Dlp::V2::DlpService::Rest::Client

Inherits:

Object

Object
Google::Cloud::Dlp::V2::DlpService::Rest::Client

show all

Includes:: Paths

Defined in:: lib/google/cloud/dlp/v2/dlp_service/rest/client.rb

Overview

REST client for the DlpService service.

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/sensitive-data-protection/docs/.

Defined Under Namespace

Classes: Configuration

Instance Attribute Summary collapse

#location_client ⇒ Google::Cloud::Location::Locations::Rest::Client readonly
Get the associated client for mix-in of the Locations.

Class Method Summary collapse

.configure {|config| ... } ⇒ Client::Configuration
Configure the DlpService Client class.

Instance Method Summary collapse

#activate_job_trigger(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Dlp::V2::DlpJob
Activate a job trigger.
#cancel_dlp_job(request, options = nil) {|result, operation| ... } ⇒ ::Google::Protobuf::Empty
Starts asynchronous cancellation on a long-running DlpJob.
#configure {|config| ... } ⇒ Client::Configuration
Configure the DlpService Client instance.
#create_connection(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Dlp::V2::Connection
Create a Connection to an external data source.
#create_deidentify_template(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Dlp::V2::DeidentifyTemplate
Creates a DeidentifyTemplate for reusing frequently used configuration for de-identifying content, images, and storage.
#create_discovery_config(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Dlp::V2::DiscoveryConfig
Creates a config for discovery to scan and profile storage.
#create_dlp_job(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Dlp::V2::DlpJob
Creates a new job to inspect storage or calculate risk metrics.
#create_inspect_template(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Dlp::V2::InspectTemplate
Creates an InspectTemplate for reusing frequently used configuration for inspecting content, images, and storage.
#create_job_trigger(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Dlp::V2::JobTrigger
Creates a job trigger to run DLP actions such as scanning storage for sensitive information on a set schedule.
#create_stored_info_type(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Dlp::V2::StoredInfoType
Creates a pre-built stored infoType to be used for inspection.
#deidentify_content(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Dlp::V2::DeidentifyContentResponse
De-identifies potentially sensitive info from a ContentItem.
#delete_connection(request, options = nil) {|result, operation| ... } ⇒ ::Google::Protobuf::Empty
Delete a Connection.
#delete_deidentify_template(request, options = nil) {|result, operation| ... } ⇒ ::Google::Protobuf::Empty
Deletes a DeidentifyTemplate.
#delete_discovery_config(request, options = nil) {|result, operation| ... } ⇒ ::Google::Protobuf::Empty
Deletes a discovery configuration.
#delete_dlp_job(request, options = nil) {|result, operation| ... } ⇒ ::Google::Protobuf::Empty
Deletes a long-running DlpJob.
#delete_file_store_data_profile(request, options = nil) {|result, operation| ... } ⇒ ::Google::Protobuf::Empty
Delete a FileStoreDataProfile.
#delete_inspect_template(request, options = nil) {|result, operation| ... } ⇒ ::Google::Protobuf::Empty
Deletes an InspectTemplate.
#delete_job_trigger(request, options = nil) {|result, operation| ... } ⇒ ::Google::Protobuf::Empty
Deletes a job trigger.
#delete_stored_info_type(request, options = nil) {|result, operation| ... } ⇒ ::Google::Protobuf::Empty
Deletes a stored infoType.
#delete_table_data_profile(request, options = nil) {|result, operation| ... } ⇒ ::Google::Protobuf::Empty
Delete a TableDataProfile.
#finish_dlp_job(request, options = nil) {|result, operation| ... } ⇒ ::Google::Protobuf::Empty
Finish a running hybrid DlpJob.
#get_column_data_profile(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Dlp::V2::ColumnDataProfile
Gets a column data profile.
#get_connection(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Dlp::V2::Connection
Get a Connection by name.
#get_deidentify_template(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Dlp::V2::DeidentifyTemplate
Gets a DeidentifyTemplate.
#get_discovery_config(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Dlp::V2::DiscoveryConfig
Gets a discovery configuration.
#get_dlp_job(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Dlp::V2::DlpJob
Gets the latest state of a long-running DlpJob.
#get_file_store_data_profile(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Dlp::V2::FileStoreDataProfile
Gets a file store data profile.
#get_inspect_template(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Dlp::V2::InspectTemplate
Gets an InspectTemplate.
#get_job_trigger(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Dlp::V2::JobTrigger
Gets a job trigger.
#get_project_data_profile(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Dlp::V2::ProjectDataProfile
Gets a project data profile.
#get_stored_info_type(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Dlp::V2::StoredInfoType
Gets a stored infoType.
#get_table_data_profile(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Dlp::V2::TableDataProfile
Gets a table data profile.
#hybrid_inspect_dlp_job(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Dlp::V2::HybridInspectResponse
Inspect hybrid content and store findings to a job.
#hybrid_inspect_job_trigger(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Dlp::V2::HybridInspectResponse
Inspect hybrid content and store findings to a trigger.
#initialize {|config| ... } ⇒ Client constructor
Create a new DlpService REST client object.
#inspect_content(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Dlp::V2::InspectContentResponse
Finds potentially sensitive info in content.
#list_column_data_profiles(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::ColumnDataProfile>
Lists column data profiles for an organization.
#list_connections(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::Connection>
Lists Connections in a parent.
#list_deidentify_templates(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::DeidentifyTemplate>
Lists DeidentifyTemplates.
#list_discovery_configs(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::DiscoveryConfig>
Lists discovery configurations.
#list_dlp_jobs(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::DlpJob>
Lists DlpJobs that match the specified filter in the request.
#list_file_store_data_profiles(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::FileStoreDataProfile>
Lists file store data profiles for an organization.
#list_info_types(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Dlp::V2::ListInfoTypesResponse
Returns a list of the sensitive information types that DLP API supports.
#list_inspect_templates(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::InspectTemplate>
Lists InspectTemplates.
#list_job_triggers(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::JobTrigger>
Lists job triggers.
#list_project_data_profiles(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::ProjectDataProfile>
Lists project data profiles for an organization.
#list_stored_info_types(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::StoredInfoType>
Lists stored infoTypes.
#list_table_data_profiles(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::TableDataProfile>
Lists table data profiles for an organization.
#redact_image(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Dlp::V2::RedactImageResponse
Redacts potentially sensitive info from an image.
#reidentify_content(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Dlp::V2::ReidentifyContentResponse
Re-identifies content that has been de-identified.
#search_connections(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::Connection>
Searches for Connections in a parent.
#universe_domain ⇒ String
The effective universe domain.
#update_connection(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Dlp::V2::Connection
Update a Connection.
#update_deidentify_template(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Dlp::V2::DeidentifyTemplate
Updates the DeidentifyTemplate.
#update_discovery_config(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Dlp::V2::DiscoveryConfig
Updates a discovery configuration.
#update_inspect_template(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Dlp::V2::InspectTemplate
Updates the InspectTemplate.
#update_job_trigger(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Dlp::V2::JobTrigger
Updates a job trigger.
#update_stored_info_type(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::Dlp::V2::StoredInfoType
Updates the stored infoType by creating a new version.

Methods included from Paths

#column_data_profile_path, #connection_path, #deidentify_template_path, #discovery_config_path, #dlp_job_path, #file_store_data_profile_path, #inspect_template_path, #job_trigger_path, #location_path, #organization_location_path, #organization_path, #project_data_profile_path, #project_path, #stored_info_type_path, #table_data_profile_path

Constructor Details

#initialize {|config| ... } ⇒ `Client`

Create a new DlpService REST client object.

Examples:


# Create a client using the default configuration
client = ::Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::Dlp::V2::DlpService::Rest::Client.new do |config|
  config.timeout = 10.0
end

Yields:

(config) —
Configure the DlpService client.

Yield Parameters:

config (Client::Configuration)

# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 327

def initialize
  # Create the configuration object
  @config = Configuration.new Client.configure

  # Yield the configuration if needed
  yield @config if block_given?

  # Create credentials
  credentials = @config.credentials
  # Use self-signed JWT if the endpoint is unchanged from default,
  # but only if the default endpoint does not have a region prefix.
  enable_self_signed_jwt = @config.endpoint.nil? ||
                           (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
                           !@config.endpoint.split(".").first.include?("-"))
  credentials ||= Credentials.default scope: @config.scope,
                                      enable_self_signed_jwt: enable_self_signed_jwt
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end

  @quota_project_id = @config.quota_project
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id

  @dlp_service_stub = ::Google::Cloud::Dlp::V2::DlpService::Rest::ServiceStub.new(
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    credentials: credentials
  )

  @location_client = Google::Cloud::Location::Locations::Rest::Client.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @dlp_service_stub.endpoint
    config.universe_domain = @dlp_service_stub.universe_domain
  end
end

Instance Attribute Details

#location_client ⇒ `Google::Cloud::Location::Locations::Rest::Client` (readonly)

Get the associated client for mix-in of the Locations.

Returns:

(Google::Cloud::Location::Locations::Rest::Client)



370
371
372

# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 370

def location_client
  @location_client
end

Class Method Details

.configure {|config| ... } ⇒ `Client::Configuration`

Configure the DlpService Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all DlpService clients
::Google::Cloud::Dlp::V2::DlpService::Rest::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

(config) —
Configure the Client client.

Yield Parameters:

config (Client::Configuration)

Returns:

(Client::Configuration)

# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 73

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "Dlp", "V2"]
    parent_config = while namespace.any?
                      parent_name = namespace.join "::"
                      parent_const = const_get parent_name
                      break parent_const.configure if parent_const.respond_to? :configure
                      namespace.pop
                    end
    default_config = Client::Configuration.new parent_config

    default_config.rpcs.inspect_content.timeout = 300.0
    default_config.rpcs.inspect_content.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config.rpcs.redact_image.timeout = 300.0
    default_config.rpcs.redact_image.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config.rpcs.deidentify_content.timeout = 300.0
    default_config.rpcs.deidentify_content.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config.rpcs.reidentify_content.timeout = 300.0
    default_config.rpcs.reidentify_content.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config.rpcs.list_info_types.timeout = 300.0
    default_config.rpcs.list_info_types.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config.rpcs.create_inspect_template.timeout = 300.0

    default_config.rpcs.update_inspect_template.timeout = 300.0

    default_config.rpcs.get_inspect_template.timeout = 300.0
    default_config.rpcs.get_inspect_template.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config.rpcs.list_inspect_templates.timeout = 300.0
    default_config.rpcs.list_inspect_templates.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config.rpcs.delete_inspect_template.timeout = 300.0
    default_config.rpcs.delete_inspect_template.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config.rpcs.create_deidentify_template.timeout = 300.0

    default_config.rpcs.update_deidentify_template.timeout = 300.0

    default_config.rpcs.get_deidentify_template.timeout = 300.0
    default_config.rpcs.get_deidentify_template.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config.rpcs.list_deidentify_templates.timeout = 300.0
    default_config.rpcs.list_deidentify_templates.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config.rpcs.delete_deidentify_template.timeout = 300.0
    default_config.rpcs.delete_deidentify_template.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config.rpcs.create_job_trigger.timeout = 300.0

    default_config.rpcs.update_job_trigger.timeout = 300.0

    default_config.rpcs.hybrid_inspect_job_trigger.timeout = 300.0

    default_config.rpcs.get_job_trigger.timeout = 300.0
    default_config.rpcs.get_job_trigger.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config.rpcs.list_job_triggers.timeout = 300.0
    default_config.rpcs.list_job_triggers.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config.rpcs.delete_job_trigger.timeout = 300.0
    default_config.rpcs.delete_job_trigger.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config.rpcs.activate_job_trigger.timeout = 300.0

    default_config.rpcs.create_discovery_config.timeout = 300.0

    default_config.rpcs.update_discovery_config.timeout = 300.0

    default_config.rpcs.get_discovery_config.timeout = 300.0
    default_config.rpcs.get_discovery_config.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config.rpcs.list_discovery_configs.timeout = 300.0
    default_config.rpcs.list_discovery_configs.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config.rpcs.delete_discovery_config.timeout = 300.0
    default_config.rpcs.delete_discovery_config.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config.rpcs.create_dlp_job.timeout = 300.0

    default_config.rpcs.list_dlp_jobs.timeout = 300.0
    default_config.rpcs.list_dlp_jobs.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config.rpcs.get_dlp_job.timeout = 300.0
    default_config.rpcs.get_dlp_job.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config.rpcs.delete_dlp_job.timeout = 300.0
    default_config.rpcs.delete_dlp_job.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config.rpcs.cancel_dlp_job.timeout = 300.0

    default_config.rpcs.create_stored_info_type.timeout = 300.0

    default_config.rpcs.update_stored_info_type.timeout = 300.0

    default_config.rpcs.get_stored_info_type.timeout = 300.0
    default_config.rpcs.get_stored_info_type.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config.rpcs.list_stored_info_types.timeout = 300.0
    default_config.rpcs.list_stored_info_types.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config.rpcs.delete_stored_info_type.timeout = 300.0
    default_config.rpcs.delete_stored_info_type.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config.rpcs.list_project_data_profiles.timeout = 300.0
    default_config.rpcs.list_project_data_profiles.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config.rpcs.list_table_data_profiles.timeout = 300.0
    default_config.rpcs.list_table_data_profiles.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config.rpcs.list_column_data_profiles.timeout = 300.0
    default_config.rpcs.list_column_data_profiles.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config.rpcs.get_project_data_profile.timeout = 300.0
    default_config.rpcs.get_project_data_profile.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config.rpcs.list_file_store_data_profiles.timeout = 300.0
    default_config.rpcs.list_file_store_data_profiles.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config.rpcs.get_file_store_data_profile.timeout = 300.0
    default_config.rpcs.get_file_store_data_profile.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config.rpcs.delete_file_store_data_profile.timeout = 300.0
    default_config.rpcs.delete_file_store_data_profile.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config.rpcs.get_table_data_profile.timeout = 300.0
    default_config.rpcs.get_table_data_profile.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config.rpcs.get_column_data_profile.timeout = 300.0
    default_config.rpcs.get_column_data_profile.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config.rpcs.hybrid_inspect_dlp_job.timeout = 300.0

    default_config.rpcs.finish_dlp_job.timeout = 300.0

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

#activate_job_trigger(request, options = nil) ⇒ `::Google::Cloud::Dlp::V2::DlpJob` #activate_job_trigger(name: nil) ⇒ `::Google::Cloud::Dlp::V2::DlpJob`

Activate a job trigger. Causes the immediate execute of a trigger instead of waiting on the trigger event to occur.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::ActivateJobTriggerRequest.new

# Call the activate_job_trigger method.
result = client.activate_job_trigger request

# The returned object is of type Google::Cloud::Dlp::V2::DlpJob.
p result

Overloads:

#activate_job_trigger(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::DlpJob

Pass arguments to activate_job_trigger via a request object, either of type ActivateJobTriggerRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::Dlp::V2::ActivateJobTriggerRequest, ::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.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#activate_job_trigger(name: nil) ⇒ ::Google::Cloud::Dlp::V2::DlpJob

Pass arguments to activate_job_trigger 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).
Parameters:
- name (::String) (defaults to: nil) —
  Required. Resource name of the trigger to activate, for example projects/dlp-test-project/jobTriggers/53234423.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Cloud::Dlp::V2::DlpJob)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Cloud::Dlp::V2::DlpJob)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 2594

def activate_job_trigger request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::ActivateJobTriggerRequest

  # 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
  call_metadata = @config.rpcs.activate_job_trigger.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Dlp::V2::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.activate_job_trigger.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.activate_job_trigger.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.activate_job_trigger request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#cancel_dlp_job(request, options = nil) ⇒ `::Google::Protobuf::Empty` #cancel_dlp_job(name: nil) ⇒ `::Google::Protobuf::Empty`

Starts asynchronous cancellation on a long-running DlpJob. The server makes a best effort to cancel the DlpJob, but success is not guaranteed. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::CancelDlpJobRequest.new

# Call the cancel_dlp_job method.
result = client.cancel_dlp_job request

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

#cancel_dlp_job(request, options = nil) ⇒ ::Google::Protobuf::Empty

Pass arguments to cancel_dlp_job via a request object, either of type CancelDlpJobRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::Dlp::V2::CancelDlpJobRequest, ::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.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#cancel_dlp_job(name: nil) ⇒ ::Google::Protobuf::Empty

Pass arguments to cancel_dlp_job 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).
Parameters:
- name (::String) (defaults to: nil) —
  Required. The name of the DlpJob resource to be cancelled.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Protobuf::Empty)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Protobuf::Empty)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 3576

def cancel_dlp_job request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::CancelDlpJobRequest

  # 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
  call_metadata = @config.rpcs.cancel_dlp_job.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Dlp::V2::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.cancel_dlp_job.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.cancel_dlp_job.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.cancel_dlp_job request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#configure {|config| ... } ⇒ `Client::Configuration`

Configure the DlpService Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on configure.

See Configuration for a description of the configuration fields.

Yields:

(config) —
Configure the Client client.

Yield Parameters:

config (Client::Configuration)

Returns:

(Client::Configuration)

# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 297

def configure
  yield @config if block_given?
  @config
end

#create_connection(request, options = nil) ⇒ `::Google::Cloud::Dlp::V2::Connection` #create_connection(parent: nil, connection: nil) ⇒ `::Google::Cloud::Dlp::V2::Connection`

Create a Connection to an external data source.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::CreateConnectionRequest.new

# Call the create_connection method.
result = client.create_connection request

# The returned object is of type Google::Cloud::Dlp::V2::Connection.
p result

Overloads:

#create_connection(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::Connection

Pass arguments to create_connection via a request object, either of type CreateConnectionRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::Dlp::V2::CreateConnectionRequest, ::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.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#create_connection(parent: nil, connection: nil) ⇒ ::Google::Cloud::Dlp::V2::Connection

Pass arguments to create_connection 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).
Parameters:
- parent (::String) (defaults to: nil) —
  Required. Parent resource name.
  
  The format of this value varies depending on the scope of the request (project or organization):
  - Projects scope: projects/{project_id}/locations/{location_id}
  - Organizations scope: organizations/{org_id}/locations/{location_id}
- connection (::Google::Cloud::Dlp::V2::Connection, ::Hash) (defaults to: nil) —
  Required. The connection resource.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Cloud::Dlp::V2::Connection)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Cloud::Dlp::V2::Connection)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 5361

def create_connection request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::CreateConnectionRequest

  # 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
  call_metadata = @config.rpcs.create_connection.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Dlp::V2::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_connection.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.create_connection.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.create_connection request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_deidentify_template(request, options = nil) ⇒ `::Google::Cloud::Dlp::V2::DeidentifyTemplate` #create_deidentify_template(parent: nil, deidentify_template: nil, template_id: nil, location_id: nil) ⇒ `::Google::Cloud::Dlp::V2::DeidentifyTemplate`

Creates a DeidentifyTemplate for reusing frequently used configuration for de-identifying content, images, and storage. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::CreateDeidentifyTemplateRequest.new

# Call the create_deidentify_template method.
result = client.create_deidentify_template request

# The returned object is of type Google::Cloud::Dlp::V2::DeidentifyTemplate.
p result

Overloads:

#create_deidentify_template(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::DeidentifyTemplate

Pass arguments to create_deidentify_template via a request object, either of type CreateDeidentifyTemplateRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::Dlp::V2::CreateDeidentifyTemplateRequest, ::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.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#create_deidentify_template(parent: nil, deidentify_template: nil, template_id: nil, location_id: nil) ⇒ ::Google::Cloud::Dlp::V2::DeidentifyTemplate

Pass arguments to create_deidentify_template 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).
Parameters:
- parent (::String) (defaults to: nil) —
  Required. Parent resource name.
  
  The format of this value varies depending on the scope of the request (project or organization) and whether you have specified a processing location:
  - Projects scope, location specified: projects/{project_id}/locations/{location_id}
  - Projects scope, no location specified (defaults to global): projects/{project_id}
  - Organizations scope, location specified: organizations/{org_id}/locations/{location_id}
  - Organizations scope, no location specified (defaults to global): organizations/{org_id}
  The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:
```
parent=projects/example-project/locations/europe-west3
```
- deidentify_template (::Google::Cloud::Dlp::V2::DeidentifyTemplate, ::Hash) (defaults to: nil) —
  Required. The DeidentifyTemplate to create.
- template_id (::String) (defaults to: nil) —
  The template id can contain uppercase and lowercase letters, numbers, and hyphens; that is, it must match the regular expression: [a-zA-Z\d-_]+. The maximum length is 100 characters. Can be empty to allow the system to generate one.
- location_id (::String) (defaults to: nil) —
  Deprecated. This field has no effect.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Cloud::Dlp::V2::DeidentifyTemplate)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Cloud::Dlp::V2::DeidentifyTemplate)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 1530

def create_deidentify_template request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::CreateDeidentifyTemplateRequest

  # 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
  call_metadata = @config.rpcs.create_deidentify_template.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Dlp::V2::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_deidentify_template.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.create_deidentify_template.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.create_deidentify_template request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_discovery_config(request, options = nil) ⇒ `::Google::Cloud::Dlp::V2::DiscoveryConfig` #create_discovery_config(parent: nil, discovery_config: nil, config_id: nil) ⇒ `::Google::Cloud::Dlp::V2::DiscoveryConfig`

Creates a config for discovery to scan and profile storage.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::CreateDiscoveryConfigRequest.new

# Call the create_discovery_config method.
result = client.create_discovery_config request

# The returned object is of type Google::Cloud::Dlp::V2::DiscoveryConfig.
p result

Overloads:

#create_discovery_config(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::DiscoveryConfig

Pass arguments to create_discovery_config via a request object, either of type CreateDiscoveryConfigRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::Dlp::V2::CreateDiscoveryConfigRequest, ::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.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#create_discovery_config(parent: nil, discovery_config: nil, config_id: nil) ⇒ ::Google::Cloud::Dlp::V2::DiscoveryConfig

Pass arguments to create_discovery_config 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).
Parameters:
- parent (::String) (defaults to: nil) —
  Required. Parent resource name.
  
  The format of this value varies depending on the scope of the request (project or organization):
  - Projects scope: projects/{project_id}/locations/{location_id}
  - Organizations scope: organizations/{org_id}/locations/{location_id}
  The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:
```
parent=projects/example-project/locations/europe-west3
```
- discovery_config (::Google::Cloud::Dlp::V2::DiscoveryConfig, ::Hash) (defaults to: nil) —
  Required. The DiscoveryConfig to create.
- config_id (::String) (defaults to: nil) —
  The config ID can contain uppercase and lowercase letters, numbers, and hyphens; that is, it must match the regular expression: [a-zA-Z\d-_]+. The maximum length is 100 characters. Can be empty to allow the system to generate one.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Cloud::Dlp::V2::DiscoveryConfig)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Cloud::Dlp::V2::DiscoveryConfig)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 2694

def create_discovery_config request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::CreateDiscoveryConfigRequest

  # 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
  call_metadata = @config.rpcs.create_discovery_config.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Dlp::V2::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_discovery_config.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.create_discovery_config.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.create_discovery_config request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_dlp_job(request, options = nil) ⇒ `::Google::Cloud::Dlp::V2::DlpJob` #create_dlp_job(parent: nil, inspect_job: nil, risk_job: nil, job_id: nil, location_id: nil) ⇒ `::Google::Cloud::Dlp::V2::DlpJob`

Creates a new job to inspect storage or calculate risk metrics. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.

When no InfoTypes or CustomInfoTypes are specified in inspect jobs, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::CreateDlpJobRequest.new

# Call the create_dlp_job method.
result = client.create_dlp_job request

# The returned object is of type Google::Cloud::Dlp::V2::DlpJob.
p result

Overloads:

#create_dlp_job(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::DlpJob

Pass arguments to create_dlp_job via a request object, either of type CreateDlpJobRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::Dlp::V2::CreateDlpJobRequest, ::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.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#create_dlp_job(parent: nil, inspect_job: nil, risk_job: nil, job_id: nil, location_id: nil) ⇒ ::Google::Cloud::Dlp::V2::DlpJob

Pass arguments to create_dlp_job 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).
Parameters:
- parent (::String) (defaults to: nil) —
  Required. Parent resource name.
  
  The format of this value varies depending on whether you have specified a processing location:
  - Projects scope, location specified: projects/{project_id}/locations/{location_id}
  - Projects scope, no location specified (defaults to global): projects/{project_id}
  The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:
```
parent=projects/example-project/locations/europe-west3
```
- inspect_job (::Google::Cloud::Dlp::V2::InspectJobConfig, ::Hash) (defaults to: nil) —
  An inspection job scans a storage repository for InfoTypes.
- risk_job (::Google::Cloud::Dlp::V2::RiskAnalysisJobConfig, ::Hash) (defaults to: nil) —
  A risk analysis job calculates re-identification risk metrics for a BigQuery table.
- job_id (::String) (defaults to: nil) —
  The job id can contain uppercase and lowercase letters, numbers, and hyphens; that is, it must match the regular expression: [a-zA-Z\d-_]+. The maximum length is 100 characters. Can be empty to allow the system to generate one.
- location_id (::String) (defaults to: nil) —
  Deprecated. This field has no effect.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Cloud::Dlp::V2::DlpJob)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Cloud::Dlp::V2::DlpJob)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 3165

def create_dlp_job request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::CreateDlpJobRequest

  # 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
  call_metadata = @config.rpcs.create_dlp_job.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Dlp::V2::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_dlp_job.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.create_dlp_job.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.create_dlp_job request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_inspect_template(request, options = nil) ⇒ `::Google::Cloud::Dlp::V2::InspectTemplate` #create_inspect_template(parent: nil, inspect_template: nil, template_id: nil, location_id: nil) ⇒ `::Google::Cloud::Dlp::V2::InspectTemplate`

Creates an InspectTemplate for reusing frequently used configuration for inspecting content, images, and storage. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::CreateInspectTemplateRequest.new

# Call the create_inspect_template method.
result = client.create_inspect_template request

# The returned object is of type Google::Cloud::Dlp::V2::InspectTemplate.
p result

Overloads:

#create_inspect_template(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::InspectTemplate

Pass arguments to create_inspect_template via a request object, either of type CreateInspectTemplateRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::Dlp::V2::CreateInspectTemplateRequest, ::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.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#create_inspect_template(parent: nil, inspect_template: nil, template_id: nil, location_id: nil) ⇒ ::Google::Cloud::Dlp::V2::InspectTemplate

Pass arguments to create_inspect_template 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).
Parameters:
- parent (::String) (defaults to: nil) —
  Required. Parent resource name.
  
  The format of this value varies depending on the scope of the request (project or organization) and whether you have specified a processing location:
  - Projects scope, location specified: projects/{project_id}/locations/{location_id}
  - Projects scope, no location specified (defaults to global): projects/{project_id}
  - Organizations scope, location specified: organizations/{org_id}/locations/{location_id}
  - Organizations scope, no location specified (defaults to global): organizations/{org_id}
  The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:
```
parent=projects/example-project/locations/europe-west3
```
- inspect_template (::Google::Cloud::Dlp::V2::InspectTemplate, ::Hash) (defaults to: nil) —
  Required. The InspectTemplate to create.
- template_id (::String) (defaults to: nil) —
  The template id can contain uppercase and lowercase letters, numbers, and hyphens; that is, it must match the regular expression: [a-zA-Z\d-_]+. The maximum length is 100 characters. Can be empty to allow the system to generate one.
- location_id (::String) (defaults to: nil) —
  Deprecated. This field has no effect.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Cloud::Dlp::V2::InspectTemplate)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Cloud::Dlp::V2::InspectTemplate)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 1035

def create_inspect_template request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::CreateInspectTemplateRequest

  # 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
  call_metadata = @config.rpcs.create_inspect_template.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Dlp::V2::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_inspect_template.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.create_inspect_template.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.create_inspect_template request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_job_trigger(request, options = nil) ⇒ `::Google::Cloud::Dlp::V2::JobTrigger` #create_job_trigger(parent: nil, job_trigger: nil, trigger_id: nil, location_id: nil) ⇒ `::Google::Cloud::Dlp::V2::JobTrigger`

Creates a job trigger to run DLP actions such as scanning storage for sensitive information on a set schedule. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::CreateJobTriggerRequest.new

# Call the create_job_trigger method.
result = client.create_job_trigger request

# The returned object is of type Google::Cloud::Dlp::V2::JobTrigger.
p result

Overloads:

#create_job_trigger(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::JobTrigger

Pass arguments to create_job_trigger via a request object, either of type CreateJobTriggerRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::Dlp::V2::CreateJobTriggerRequest, ::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.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#create_job_trigger(parent: nil, job_trigger: nil, trigger_id: nil, location_id: nil) ⇒ ::Google::Cloud::Dlp::V2::JobTrigger

Pass arguments to create_job_trigger 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).
Parameters:
- parent (::String) (defaults to: nil) —
  Required. Parent resource name.
  
  The format of this value varies depending on whether you have specified a processing location:
  - Projects scope, location specified: projects/{project_id}/locations/{location_id}
  - Projects scope, no location specified (defaults to global): projects/{project_id}
  The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:
```
parent=projects/example-project/locations/europe-west3
```
- job_trigger (::Google::Cloud::Dlp::V2::JobTrigger, ::Hash) (defaults to: nil) —
  Required. The JobTrigger to create.
- trigger_id (::String) (defaults to: nil) —
  The trigger id can contain uppercase and lowercase letters, numbers, and hyphens; that is, it must match the regular expression: [a-zA-Z\d-_]+. The maximum length is 100 characters. Can be empty to allow the system to generate one.
- location_id (::String) (defaults to: nil) —
  Deprecated. This field has no effect.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Cloud::Dlp::V2::JobTrigger)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Cloud::Dlp::V2::JobTrigger)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 2023

def create_job_trigger request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::CreateJobTriggerRequest

  # 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
  call_metadata = @config.rpcs.create_job_trigger.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Dlp::V2::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_job_trigger.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.create_job_trigger.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.create_job_trigger request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_stored_info_type(request, options = nil) ⇒ `::Google::Cloud::Dlp::V2::StoredInfoType` #create_stored_info_type(parent: nil, config: nil, stored_info_type_id: nil, location_id: nil) ⇒ `::Google::Cloud::Dlp::V2::StoredInfoType`

Creates a pre-built stored infoType to be used for inspection. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::CreateStoredInfoTypeRequest.new

# Call the create_stored_info_type method.
result = client.create_stored_info_type request

# The returned object is of type Google::Cloud::Dlp::V2::StoredInfoType.
p result

Overloads:

#create_stored_info_type(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::StoredInfoType

Pass arguments to create_stored_info_type via a request object, either of type CreateStoredInfoTypeRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::Dlp::V2::CreateStoredInfoTypeRequest, ::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.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#create_stored_info_type(parent: nil, config: nil, stored_info_type_id: nil, location_id: nil) ⇒ ::Google::Cloud::Dlp::V2::StoredInfoType

Pass arguments to create_stored_info_type 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).
Parameters:
- parent (::String) (defaults to: nil) —
  Required. Parent resource name.
  
  The format of this value varies depending on the scope of the request (project or organization) and whether you have specified a processing location:
  - Projects scope, location specified: projects/{project_id}/locations/{location_id}
  - Projects scope, no location specified (defaults to global): projects/{project_id}
  - Organizations scope, location specified: organizations/{org_id}/locations/{location_id}
  - Organizations scope, no location specified (defaults to global): organizations/{org_id}
  The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:
```
parent=projects/example-project/locations/europe-west3
```
- config (::Google::Cloud::Dlp::V2::StoredInfoTypeConfig, ::Hash) (defaults to: nil) —
  Required. Configuration of the storedInfoType to create.
- stored_info_type_id (::String) (defaults to: nil) —
  The storedInfoType ID can contain uppercase and lowercase letters, numbers, and hyphens; that is, it must match the regular expression: [a-zA-Z\d-_]+. The maximum length is 100 characters. Can be empty to allow the system to generate one.
- location_id (::String) (defaults to: nil) —
  Deprecated. This field has no effect.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Cloud::Dlp::V2::StoredInfoType)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Cloud::Dlp::V2::StoredInfoType)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 3686

def create_stored_info_type request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::CreateStoredInfoTypeRequest

  # 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
  call_metadata = @config.rpcs.create_stored_info_type.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Dlp::V2::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_stored_info_type.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.create_stored_info_type.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.create_stored_info_type request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#deidentify_content(request, options = nil) ⇒ `::Google::Cloud::Dlp::V2::DeidentifyContentResponse` #deidentify_content(parent: nil, deidentify_config: nil, inspect_config: nil, item: nil, inspect_template_name: nil, deidentify_template_name: nil, location_id: nil) ⇒ `::Google::Cloud::Dlp::V2::DeidentifyContentResponse`

De-identifies potentially sensitive info from a ContentItem. This method has limits on input size and output size. See https://cloud.google.com/sensitive-data-protection/docs/deidentify-sensitive-data to learn more.

When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::DeidentifyContentRequest.new

# Call the deidentify_content method.
result = client.deidentify_content request

# The returned object is of type Google::Cloud::Dlp::V2::DeidentifyContentResponse.
p result

Overloads:

#deidentify_content(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::DeidentifyContentResponse

Pass arguments to deidentify_content via a request object, either of type Google::Cloud::Dlp::V2::DeidentifyContentRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::Dlp::V2::DeidentifyContentRequest, ::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.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#deidentify_content(parent: nil, deidentify_config: nil, inspect_config: nil, item: nil, inspect_template_name: nil, deidentify_template_name: nil, location_id: nil) ⇒ ::Google::Cloud::Dlp::V2::DeidentifyContentResponse

Pass arguments to deidentify_content 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).
Parameters:
- parent (::String) (defaults to: nil) —
  Parent resource name.
  
  The format of this value varies depending on whether you have specified a processing location:
  - Projects scope, location specified: projects/{project_id}/locations/{location_id}
  - Projects scope, no location specified (defaults to global): projects/{project_id}
  The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:
```
parent=projects/example-project/locations/europe-west3
```
- deidentify_config (::Google::Cloud::Dlp::V2::DeidentifyConfig, ::Hash) (defaults to: nil) —
  Configuration for the de-identification of the content item. Items specified here will override the template referenced by the deidentify_template_name argument.
- inspect_config (::Google::Cloud::Dlp::V2::InspectConfig, ::Hash) (defaults to: nil) —
  Configuration for the inspector. Items specified here will override the template referenced by the inspect_template_name argument.
- item (::Google::Cloud::Dlp::V2::ContentItem, ::Hash) (defaults to: nil) —
  The item to de-identify. Will be treated as text.
  
  This value must be of type Table if your deidentify_config is a RecordTransformations object.
- inspect_template_name (::String) (defaults to: nil) —
  Template to use. Any configuration directly specified in inspect_config will override those set in the template. Singular fields that are set in this request will replace their corresponding fields in the template. Repeated fields are appended. Singular sub-messages and groups are recursively merged.
- deidentify_template_name (::String) (defaults to: nil) —
  Template to use. Any configuration directly specified in deidentify_config will override those set in the template. Singular fields that are set in this request will replace their corresponding fields in the template. Repeated fields are appended. Singular sub-messages and groups are recursively merged.
- location_id (::String) (defaults to: nil) —
  Deprecated. This field has no effect.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Cloud::Dlp::V2::DeidentifyContentResponse)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Cloud::Dlp::V2::DeidentifyContentResponse)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 701

def deidentify_content request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::DeidentifyContentRequest

  # 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
  call_metadata = @config.rpcs.deidentify_content.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Dlp::V2::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.deidentify_content.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.deidentify_content.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.deidentify_content request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_connection(request, options = nil) ⇒ `::Google::Protobuf::Empty` #delete_connection(name: nil) ⇒ `::Google::Protobuf::Empty`

Delete a Connection.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::DeleteConnectionRequest.new

# Call the delete_connection method.
result = client.delete_connection request

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

#delete_connection(request, options = nil) ⇒ ::Google::Protobuf::Empty

Pass arguments to delete_connection via a request object, either of type Google::Cloud::Dlp::V2::DeleteConnectionRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::Dlp::V2::DeleteConnectionRequest, ::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.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#delete_connection(name: nil) ⇒ ::Google::Protobuf::Empty

Pass arguments to delete_connection 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).
Parameters:
- name (::String) (defaults to: nil) —
  Required. Resource name of the Connection to be deleted, in the format: projects/{project}/locations/{location}/connections/{connection}.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Protobuf::Empty)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Protobuf::Empty)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 5708

def delete_connection request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::DeleteConnectionRequest

  # 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
  call_metadata = @config.rpcs.delete_connection.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Dlp::V2::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_connection.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.delete_connection.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.delete_connection request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_deidentify_template(request, options = nil) ⇒ `::Google::Protobuf::Empty` #delete_deidentify_template(name: nil) ⇒ `::Google::Protobuf::Empty`

Deletes a DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::DeleteDeidentifyTemplateRequest.new

# Call the delete_deidentify_template method.
result = client.delete_deidentify_template request

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

#delete_deidentify_template(request, options = nil) ⇒ ::Google::Protobuf::Empty

Pass arguments to delete_deidentify_template via a request object, either of type Google::Cloud::Dlp::V2::DeleteDeidentifyTemplateRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::Dlp::V2::DeleteDeidentifyTemplateRequest, ::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.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#delete_deidentify_template(name: nil) ⇒ ::Google::Protobuf::Empty

Pass arguments to delete_deidentify_template 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).
Parameters:
- name (::String) (defaults to: nil) —
  Required. Resource name of the organization and deidentify template to be deleted, for example organizations/433245324/deidentifyTemplates/432452342 or projects/project-id/deidentifyTemplates/432452342.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Protobuf::Empty)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Protobuf::Empty)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 1916

def delete_deidentify_template request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::DeleteDeidentifyTemplateRequest

  # 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
  call_metadata = @config.rpcs.delete_deidentify_template.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Dlp::V2::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_deidentify_template.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.delete_deidentify_template.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.delete_deidentify_template request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_discovery_config(request, options = nil) ⇒ `::Google::Protobuf::Empty` #delete_discovery_config(name: nil) ⇒ `::Google::Protobuf::Empty`

Deletes a discovery configuration.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::DeleteDiscoveryConfigRequest.new

# Call the delete_discovery_config method.
result = client.delete_discovery_config request

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

#delete_discovery_config(request, options = nil) ⇒ ::Google::Protobuf::Empty

Pass arguments to delete_discovery_config via a request object, either of type Google::Cloud::Dlp::V2::DeleteDiscoveryConfigRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::Dlp::V2::DeleteDiscoveryConfigRequest, ::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.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#delete_discovery_config(name: nil) ⇒ ::Google::Protobuf::Empty

Pass arguments to delete_discovery_config 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).
Parameters:
- name (::String) (defaults to: nil) —
  Required. Resource name of the project and the config, for example projects/dlp-test-project/discoveryConfigs/53234423.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Protobuf::Empty)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Protobuf::Empty)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 3050

def delete_discovery_config request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::DeleteDiscoveryConfigRequest

  # 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
  call_metadata = @config.rpcs.delete_discovery_config.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Dlp::V2::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_discovery_config.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.delete_discovery_config.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.delete_discovery_config request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_dlp_job(request, options = nil) ⇒ `::Google::Protobuf::Empty` #delete_dlp_job(name: nil) ⇒ `::Google::Protobuf::Empty`

Deletes a long-running DlpJob. This method indicates that the client is no longer interested in the DlpJob result. The job will be canceled if possible. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::DeleteDlpJobRequest.new

# Call the delete_dlp_job method.
result = client.delete_dlp_job request

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

#delete_dlp_job(request, options = nil) ⇒ ::Google::Protobuf::Empty

Pass arguments to delete_dlp_job via a request object, either of type Google::Cloud::Dlp::V2::DeleteDlpJobRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::Dlp::V2::DeleteDlpJobRequest, ::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.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#delete_dlp_job(name: nil) ⇒ ::Google::Protobuf::Empty

Pass arguments to delete_dlp_job 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).
Parameters:
- name (::String) (defaults to: nil) —
  Required. The name of the DlpJob resource to be deleted.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Protobuf::Empty)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Protobuf::Empty)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 3490

def delete_dlp_job request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::DeleteDlpJobRequest

  # 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
  call_metadata = @config.rpcs.delete_dlp_job.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Dlp::V2::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_dlp_job.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.delete_dlp_job.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.delete_dlp_job request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_file_store_data_profile(request, options = nil) ⇒ `::Google::Protobuf::Empty` #delete_file_store_data_profile(name: nil) ⇒ `::Google::Protobuf::Empty`

Delete a FileStoreDataProfile. Will not prevent the profile from being regenerated if the resource is still included in a discovery configuration.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::DeleteFileStoreDataProfileRequest.new

# Call the delete_file_store_data_profile method.
result = client.delete_file_store_data_profile request

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

#delete_file_store_data_profile(request, options = nil) ⇒ ::Google::Protobuf::Empty

Pass arguments to delete_file_store_data_profile via a request object, either of type Google::Cloud::Dlp::V2::DeleteFileStoreDataProfileRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::Dlp::V2::DeleteFileStoreDataProfileRequest, ::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.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#delete_file_store_data_profile(name: nil) ⇒ ::Google::Protobuf::Empty

Pass arguments to delete_file_store_data_profile 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).
Parameters:
- name (::String) (defaults to: nil) —
  Required. Resource name of the file store data profile.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Protobuf::Empty)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Protobuf::Empty)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 4868

def delete_file_store_data_profile request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::DeleteFileStoreDataProfileRequest

  # 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
  call_metadata = @config.rpcs.delete_file_store_data_profile.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Dlp::V2::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_file_store_data_profile.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.delete_file_store_data_profile.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.delete_file_store_data_profile request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_inspect_template(request, options = nil) ⇒ `::Google::Protobuf::Empty` #delete_inspect_template(name: nil) ⇒ `::Google::Protobuf::Empty`

Deletes an InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::DeleteInspectTemplateRequest.new

# Call the delete_inspect_template method.
result = client.delete_inspect_template request

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

#delete_inspect_template(request, options = nil) ⇒ ::Google::Protobuf::Empty

Pass arguments to delete_inspect_template via a request object, either of type Google::Cloud::Dlp::V2::DeleteInspectTemplateRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::Dlp::V2::DeleteInspectTemplateRequest, ::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.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#delete_inspect_template(name: nil) ⇒ ::Google::Protobuf::Empty

Pass arguments to delete_inspect_template 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).
Parameters:
- name (::String) (defaults to: nil) —
  Required. Resource name of the organization and inspectTemplate to be deleted, for example organizations/433245324/inspectTemplates/432452342 or projects/project-id/inspectTemplates/432452342.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Protobuf::Empty)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Protobuf::Empty)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 1419

def delete_inspect_template request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::DeleteInspectTemplateRequest

  # 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
  call_metadata = @config.rpcs.delete_inspect_template.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Dlp::V2::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_inspect_template.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.delete_inspect_template.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.delete_inspect_template request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_job_trigger(request, options = nil) ⇒ `::Google::Protobuf::Empty` #delete_job_trigger(name: nil) ⇒ `::Google::Protobuf::Empty`

Deletes a job trigger. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::DeleteJobTriggerRequest.new

# Call the delete_job_trigger method.
result = client.delete_job_trigger request

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

#delete_job_trigger(request, options = nil) ⇒ ::Google::Protobuf::Empty

Pass arguments to delete_job_trigger via a request object, either of type Google::Cloud::Dlp::V2::DeleteJobTriggerRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::Dlp::V2::DeleteJobTriggerRequest, ::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.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#delete_job_trigger(name: nil) ⇒ ::Google::Protobuf::Empty

Pass arguments to delete_job_trigger 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).
Parameters:
- name (::String) (defaults to: nil) —
  Required. Resource name of the project and the triggeredJob, for example projects/dlp-test-project/jobTriggers/53234423.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Protobuf::Empty)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Protobuf::Empty)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 2513

def delete_job_trigger request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::DeleteJobTriggerRequest

  # 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
  call_metadata = @config.rpcs.delete_job_trigger.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Dlp::V2::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_job_trigger.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.delete_job_trigger.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.delete_job_trigger request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_stored_info_type(request, options = nil) ⇒ `::Google::Protobuf::Empty` #delete_stored_info_type(name: nil) ⇒ `::Google::Protobuf::Empty`

Deletes a stored infoType. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::DeleteStoredInfoTypeRequest.new

# Call the delete_stored_info_type method.
result = client.delete_stored_info_type request

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

#delete_stored_info_type(request, options = nil) ⇒ ::Google::Protobuf::Empty

Pass arguments to delete_stored_info_type via a request object, either of type Google::Cloud::Dlp::V2::DeleteStoredInfoTypeRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::Dlp::V2::DeleteStoredInfoTypeRequest, ::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.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#delete_stored_info_type(name: nil) ⇒ ::Google::Protobuf::Empty

Pass arguments to delete_stored_info_type 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).
Parameters:
- name (::String) (defaults to: nil) —
  Required. Resource name of the organization and storedInfoType to be deleted, for example organizations/433245324/storedInfoTypes/432452342 or projects/project-id/storedInfoTypes/432452342.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Protobuf::Empty)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Protobuf::Empty)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 4070

def delete_stored_info_type request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::DeleteStoredInfoTypeRequest

  # 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
  call_metadata = @config.rpcs.delete_stored_info_type.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Dlp::V2::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_stored_info_type.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.delete_stored_info_type.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.delete_stored_info_type request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_table_data_profile(request, options = nil) ⇒ `::Google::Protobuf::Empty` #delete_table_data_profile(name: nil) ⇒ `::Google::Protobuf::Empty`

Delete a TableDataProfile. Will not prevent the profile from being regenerated if the table is still included in a discovery configuration.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::DeleteTableDataProfileRequest.new

# Call the delete_table_data_profile method.
result = client.delete_table_data_profile request

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

#delete_table_data_profile(request, options = nil) ⇒ ::Google::Protobuf::Empty

Pass arguments to delete_table_data_profile via a request object, either of type Google::Cloud::Dlp::V2::DeleteTableDataProfileRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::Dlp::V2::DeleteTableDataProfileRequest, ::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.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#delete_table_data_profile(name: nil) ⇒ ::Google::Protobuf::Empty

Pass arguments to delete_table_data_profile 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).
Parameters:
- name (::String) (defaults to: nil) —
  Required. Resource name of the table data profile.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Protobuf::Empty)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Protobuf::Empty)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 5108

def delete_table_data_profile request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::DeleteTableDataProfileRequest

  # 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
  call_metadata = @config.rpcs.delete_table_data_profile.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Dlp::V2::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_table_data_profile.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.delete_table_data_profile.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.delete_table_data_profile request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#finish_dlp_job(request, options = nil) ⇒ `::Google::Protobuf::Empty` #finish_dlp_job(name: nil) ⇒ `::Google::Protobuf::Empty`

Finish a running hybrid DlpJob. Triggers the finalization steps and running of any enabled actions that have not yet run.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::FinishDlpJobRequest.new

# Call the finish_dlp_job method.
result = client.finish_dlp_job request

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

#finish_dlp_job(request, options = nil) ⇒ ::Google::Protobuf::Empty

Pass arguments to finish_dlp_job via a request object, either of type FinishDlpJobRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::Dlp::V2::FinishDlpJobRequest, ::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.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#finish_dlp_job(name: nil) ⇒ ::Google::Protobuf::Empty

Pass arguments to finish_dlp_job 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).
Parameters:
- name (::String) (defaults to: nil) —
  Required. The name of the DlpJob resource to be finished.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Protobuf::Empty)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Protobuf::Empty)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 5272

def finish_dlp_job request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::FinishDlpJobRequest

  # 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
  call_metadata = @config.rpcs.finish_dlp_job.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Dlp::V2::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.finish_dlp_job.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.finish_dlp_job.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.finish_dlp_job request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_column_data_profile(request, options = nil) ⇒ `::Google::Cloud::Dlp::V2::ColumnDataProfile` #get_column_data_profile(name: nil) ⇒ `::Google::Cloud::Dlp::V2::ColumnDataProfile`

Gets a column data profile.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::GetColumnDataProfileRequest.new

# Call the get_column_data_profile method.
result = client.get_column_data_profile request

# The returned object is of type Google::Cloud::Dlp::V2::ColumnDataProfile.
p result

Overloads:

#get_column_data_profile(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::ColumnDataProfile

Pass arguments to get_column_data_profile via a request object, either of type GetColumnDataProfileRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::Dlp::V2::GetColumnDataProfileRequest, ::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.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#get_column_data_profile(name: nil) ⇒ ::Google::Cloud::Dlp::V2::ColumnDataProfile

Pass arguments to get_column_data_profile 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).
Parameters:
- name (::String) (defaults to: nil) —
  Required. Resource name, for example organizations/12345/locations/us/columnDataProfiles/53234423.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Cloud::Dlp::V2::ColumnDataProfile)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Cloud::Dlp::V2::ColumnDataProfile)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 5028

def get_column_data_profile request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::GetColumnDataProfileRequest

  # 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
  call_metadata = @config.rpcs.get_column_data_profile.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Dlp::V2::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_column_data_profile.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_column_data_profile.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.get_column_data_profile request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_connection(request, options = nil) ⇒ `::Google::Cloud::Dlp::V2::Connection` #get_connection(name: nil) ⇒ `::Google::Cloud::Dlp::V2::Connection`

Get a Connection by name.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::GetConnectionRequest.new

# Call the get_connection method.
result = client.get_connection request

# The returned object is of type Google::Cloud::Dlp::V2::Connection.
p result

Overloads:

#get_connection(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::Connection

Pass arguments to get_connection via a request object, either of type GetConnectionRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::Dlp::V2::GetConnectionRequest, ::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.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#get_connection(name: nil) ⇒ ::Google::Cloud::Dlp::V2::Connection

Pass arguments to get_connection 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).
Parameters:
- name (::String) (defaults to: nil) —
  Required. Resource name in the format: projects/{project}/locations/{location}/connections/{connection}.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Cloud::Dlp::V2::Connection)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Cloud::Dlp::V2::Connection)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 5441

def get_connection request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::GetConnectionRequest

  # 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
  call_metadata = @config.rpcs.get_connection.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Dlp::V2::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_connection.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_connection.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.get_connection request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_deidentify_template(request, options = nil) ⇒ `::Google::Cloud::Dlp::V2::DeidentifyTemplate` #get_deidentify_template(name: nil) ⇒ `::Google::Cloud::Dlp::V2::DeidentifyTemplate`

Gets a DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::GetDeidentifyTemplateRequest.new

# Call the get_deidentify_template method.
result = client.get_deidentify_template request

# The returned object is of type Google::Cloud::Dlp::V2::DeidentifyTemplate.
p result

Overloads:

#get_deidentify_template(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::DeidentifyTemplate

Pass arguments to get_deidentify_template via a request object, either of type GetDeidentifyTemplateRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::Dlp::V2::GetDeidentifyTemplateRequest, ::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.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#get_deidentify_template(name: nil) ⇒ ::Google::Cloud::Dlp::V2::DeidentifyTemplate

Pass arguments to get_deidentify_template 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).
Parameters:
- name (::String) (defaults to: nil) —
  Required. Resource name of the organization and deidentify template to be read, for example organizations/433245324/deidentifyTemplates/432452342 or projects/project-id/deidentifyTemplates/432452342.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Cloud::Dlp::V2::DeidentifyTemplate)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Cloud::Dlp::V2::DeidentifyTemplate)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 1703

def get_deidentify_template request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::GetDeidentifyTemplateRequest

  # 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
  call_metadata = @config.rpcs.get_deidentify_template.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Dlp::V2::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_deidentify_template.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_deidentify_template.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.get_deidentify_template request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_discovery_config(request, options = nil) ⇒ `::Google::Cloud::Dlp::V2::DiscoveryConfig` #get_discovery_config(name: nil) ⇒ `::Google::Cloud::Dlp::V2::DiscoveryConfig`

Gets a discovery configuration.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::GetDiscoveryConfigRequest.new

# Call the get_discovery_config method.
result = client.get_discovery_config request

# The returned object is of type Google::Cloud::Dlp::V2::DiscoveryConfig.
p result

Overloads:

#get_discovery_config(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::DiscoveryConfig

Pass arguments to get_discovery_config via a request object, either of type GetDiscoveryConfigRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::Dlp::V2::GetDiscoveryConfigRequest, ::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.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#get_discovery_config(name: nil) ⇒ ::Google::Cloud::Dlp::V2::DiscoveryConfig

Pass arguments to get_discovery_config 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).
Parameters:
- name (::String) (defaults to: nil) —
  Required. Resource name of the project and the configuration, for example projects/dlp-test-project/discoveryConfigs/53234423.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Cloud::Dlp::V2::DiscoveryConfig)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Cloud::Dlp::V2::DiscoveryConfig)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 2858

def get_discovery_config request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::GetDiscoveryConfigRequest

  # 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
  call_metadata = @config.rpcs.get_discovery_config.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Dlp::V2::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_discovery_config.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_discovery_config.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.get_discovery_config request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_dlp_job(request, options = nil) ⇒ `::Google::Cloud::Dlp::V2::DlpJob` #get_dlp_job(name: nil) ⇒ `::Google::Cloud::Dlp::V2::DlpJob`

Gets the latest state of a long-running DlpJob. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::GetDlpJobRequest.new

# Call the get_dlp_job method.
result = client.get_dlp_job request

# The returned object is of type Google::Cloud::Dlp::V2::DlpJob.
p result

Overloads:

#get_dlp_job(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::DlpJob

Pass arguments to get_dlp_job via a request object, either of type GetDlpJobRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::Dlp::V2::GetDlpJobRequest, ::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.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#get_dlp_job(name: nil) ⇒ ::Google::Cloud::Dlp::V2::DlpJob

Pass arguments to get_dlp_job 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).
Parameters:
- name (::String) (defaults to: nil) —
  Required. The name of the DlpJob resource.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Cloud::Dlp::V2::DlpJob)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Cloud::Dlp::V2::DlpJob)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 3404

def get_dlp_job request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::GetDlpJobRequest

  # 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
  call_metadata = @config.rpcs.get_dlp_job.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Dlp::V2::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_dlp_job.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_dlp_job.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.get_dlp_job request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_file_store_data_profile(request, options = nil) ⇒ `::Google::Cloud::Dlp::V2::FileStoreDataProfile` #get_file_store_data_profile(name: nil) ⇒ `::Google::Cloud::Dlp::V2::FileStoreDataProfile`

Gets a file store data profile.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::GetFileStoreDataProfileRequest.new

# Call the get_file_store_data_profile method.
result = client.get_file_store_data_profile request

# The returned object is of type Google::Cloud::Dlp::V2::FileStoreDataProfile.
p result

Overloads:

#get_file_store_data_profile(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::FileStoreDataProfile

Pass arguments to get_file_store_data_profile via a request object, either of type GetFileStoreDataProfileRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::Dlp::V2::GetFileStoreDataProfileRequest, ::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.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#get_file_store_data_profile(name: nil) ⇒ ::Google::Cloud::Dlp::V2::FileStoreDataProfile

Pass arguments to get_file_store_data_profile 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).
Parameters:
- name (::String) (defaults to: nil) —
  Required. Resource name, for example organizations/12345/locations/us/fileStoreDataProfiles/53234423.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Cloud::Dlp::V2::FileStoreDataProfile)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Cloud::Dlp::V2::FileStoreDataProfile)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 4788

def get_file_store_data_profile request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::GetFileStoreDataProfileRequest

  # 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
  call_metadata = @config.rpcs.get_file_store_data_profile.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Dlp::V2::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_file_store_data_profile.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_file_store_data_profile.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.get_file_store_data_profile request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_inspect_template(request, options = nil) ⇒ `::Google::Cloud::Dlp::V2::InspectTemplate` #get_inspect_template(name: nil) ⇒ `::Google::Cloud::Dlp::V2::InspectTemplate`

Gets an InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::GetInspectTemplateRequest.new

# Call the get_inspect_template method.
result = client.get_inspect_template request

# The returned object is of type Google::Cloud::Dlp::V2::InspectTemplate.
p result

Overloads:

#get_inspect_template(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::InspectTemplate

Pass arguments to get_inspect_template via a request object, either of type GetInspectTemplateRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::Dlp::V2::GetInspectTemplateRequest, ::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.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#get_inspect_template(name: nil) ⇒ ::Google::Cloud::Dlp::V2::InspectTemplate

Pass arguments to get_inspect_template 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).
Parameters:
- name (::String) (defaults to: nil) —
  Required. Resource name of the organization and inspectTemplate to be read, for example organizations/433245324/inspectTemplates/432452342 or projects/project-id/inspectTemplates/432452342.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Cloud::Dlp::V2::InspectTemplate)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Cloud::Dlp::V2::InspectTemplate)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 1207

def get_inspect_template request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::GetInspectTemplateRequest

  # 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
  call_metadata = @config.rpcs.get_inspect_template.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Dlp::V2::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_inspect_template.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_inspect_template.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.get_inspect_template request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_job_trigger(request, options = nil) ⇒ `::Google::Cloud::Dlp::V2::JobTrigger` #get_job_trigger(name: nil) ⇒ `::Google::Cloud::Dlp::V2::JobTrigger`

Gets a job trigger. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::GetJobTriggerRequest.new

# Call the get_job_trigger method.
result = client.get_job_trigger request

# The returned object is of type Google::Cloud::Dlp::V2::JobTrigger.
p result

Overloads:

#get_job_trigger(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::JobTrigger

Pass arguments to get_job_trigger via a request object, either of type GetJobTriggerRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::Dlp::V2::GetJobTriggerRequest, ::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.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#get_job_trigger(name: nil) ⇒ ::Google::Cloud::Dlp::V2::JobTrigger

Pass arguments to get_job_trigger 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).
Parameters:
- name (::String) (defaults to: nil) —
  Required. Resource name of the project and the triggeredJob, for example projects/dlp-test-project/jobTriggers/53234423.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Cloud::Dlp::V2::JobTrigger)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Cloud::Dlp::V2::JobTrigger)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 2277

def get_job_trigger request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::GetJobTriggerRequest

  # 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
  call_metadata = @config.rpcs.get_job_trigger.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Dlp::V2::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_job_trigger.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_job_trigger.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.get_job_trigger request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_project_data_profile(request, options = nil) ⇒ `::Google::Cloud::Dlp::V2::ProjectDataProfile` #get_project_data_profile(name: nil) ⇒ `::Google::Cloud::Dlp::V2::ProjectDataProfile`

Gets a project data profile.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::GetProjectDataProfileRequest.new

# Call the get_project_data_profile method.
result = client.get_project_data_profile request

# The returned object is of type Google::Cloud::Dlp::V2::ProjectDataProfile.
p result

Overloads:

#get_project_data_profile(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::ProjectDataProfile

Pass arguments to get_project_data_profile via a request object, either of type GetProjectDataProfileRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::Dlp::V2::GetProjectDataProfileRequest, ::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.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#get_project_data_profile(name: nil) ⇒ ::Google::Cloud::Dlp::V2::ProjectDataProfile

Pass arguments to get_project_data_profile 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).
Parameters:
- name (::String) (defaults to: nil) —
  Required. Resource name, for example organizations/12345/locations/us/projectDataProfiles/53234423.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Cloud::Dlp::V2::ProjectDataProfile)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Cloud::Dlp::V2::ProjectDataProfile)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 4562

def get_project_data_profile request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::GetProjectDataProfileRequest

  # 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
  call_metadata = @config.rpcs.get_project_data_profile.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Dlp::V2::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_project_data_profile.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_project_data_profile.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.get_project_data_profile request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_stored_info_type(request, options = nil) ⇒ `::Google::Cloud::Dlp::V2::StoredInfoType` #get_stored_info_type(name: nil) ⇒ `::Google::Cloud::Dlp::V2::StoredInfoType`

Gets a stored infoType. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::GetStoredInfoTypeRequest.new

# Call the get_stored_info_type method.
result = client.get_stored_info_type request

# The returned object is of type Google::Cloud::Dlp::V2::StoredInfoType.
p result

Overloads:

#get_stored_info_type(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::StoredInfoType

Pass arguments to get_stored_info_type via a request object, either of type GetStoredInfoTypeRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::Dlp::V2::GetStoredInfoTypeRequest, ::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.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#get_stored_info_type(name: nil) ⇒ ::Google::Cloud::Dlp::V2::StoredInfoType

Pass arguments to get_stored_info_type 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).
Parameters:
- name (::String) (defaults to: nil) —
  Required. Resource name of the organization and storedInfoType to be read, for example organizations/433245324/storedInfoTypes/432452342 or projects/project-id/storedInfoTypes/432452342.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Cloud::Dlp::V2::StoredInfoType)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Cloud::Dlp::V2::StoredInfoType)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 3861

def get_stored_info_type request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::GetStoredInfoTypeRequest

  # 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
  call_metadata = @config.rpcs.get_stored_info_type.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Dlp::V2::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_stored_info_type.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_stored_info_type.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.get_stored_info_type request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_table_data_profile(request, options = nil) ⇒ `::Google::Cloud::Dlp::V2::TableDataProfile` #get_table_data_profile(name: nil) ⇒ `::Google::Cloud::Dlp::V2::TableDataProfile`

Gets a table data profile.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::GetTableDataProfileRequest.new

# Call the get_table_data_profile method.
result = client.get_table_data_profile request

# The returned object is of type Google::Cloud::Dlp::V2::TableDataProfile.
p result

Overloads:

#get_table_data_profile(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::TableDataProfile

Pass arguments to get_table_data_profile via a request object, either of type GetTableDataProfileRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::Dlp::V2::GetTableDataProfileRequest, ::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.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#get_table_data_profile(name: nil) ⇒ ::Google::Cloud::Dlp::V2::TableDataProfile

Pass arguments to get_table_data_profile 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).
Parameters:
- name (::String) (defaults to: nil) —
  Required. Resource name, for example organizations/12345/locations/us/tableDataProfiles/53234423.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Cloud::Dlp::V2::TableDataProfile)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Cloud::Dlp::V2::TableDataProfile)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 4948

def get_table_data_profile request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::GetTableDataProfileRequest

  # 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
  call_metadata = @config.rpcs.get_table_data_profile.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Dlp::V2::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_table_data_profile.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_table_data_profile.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.get_table_data_profile request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#hybrid_inspect_dlp_job(request, options = nil) ⇒ `::Google::Cloud::Dlp::V2::HybridInspectResponse` #hybrid_inspect_dlp_job(name: nil, hybrid_item: nil) ⇒ `::Google::Cloud::Dlp::V2::HybridInspectResponse`

Inspect hybrid content and store findings to a job. To review the findings, inspect the job. Inspection will occur asynchronously.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::HybridInspectDlpJobRequest.new

# Call the hybrid_inspect_dlp_job method.
result = client.hybrid_inspect_dlp_job request

# The returned object is of type Google::Cloud::Dlp::V2::HybridInspectResponse.
p result

Overloads:

#hybrid_inspect_dlp_job(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::HybridInspectResponse

Pass arguments to hybrid_inspect_dlp_job via a request object, either of type HybridInspectDlpJobRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::Dlp::V2::HybridInspectDlpJobRequest, ::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.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#hybrid_inspect_dlp_job(name: nil, hybrid_item: nil) ⇒ ::Google::Cloud::Dlp::V2::HybridInspectResponse

Pass arguments to hybrid_inspect_dlp_job 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).
Parameters:
- name (::String) (defaults to: nil) —
  Required. Resource name of the job to execute a hybrid inspect on, for example projects/dlp-test-project/dlpJob/53234423.
- hybrid_item (::Google::Cloud::Dlp::V2::HybridContentItem, ::Hash) (defaults to: nil) —
  The item to inspect.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Cloud::Dlp::V2::HybridInspectResponse)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Cloud::Dlp::V2::HybridInspectResponse)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 5192

def hybrid_inspect_dlp_job request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::HybridInspectDlpJobRequest

  # 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
  call_metadata = @config.rpcs.hybrid_inspect_dlp_job.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Dlp::V2::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.hybrid_inspect_dlp_job.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.hybrid_inspect_dlp_job.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.hybrid_inspect_dlp_job request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#hybrid_inspect_job_trigger(request, options = nil) ⇒ `::Google::Cloud::Dlp::V2::HybridInspectResponse` #hybrid_inspect_job_trigger(name: nil, hybrid_item: nil) ⇒ `::Google::Cloud::Dlp::V2::HybridInspectResponse`

Inspect hybrid content and store findings to a trigger. The inspection will be processed asynchronously. To review the findings monitor the jobs within the trigger.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::HybridInspectJobTriggerRequest.new

# Call the hybrid_inspect_job_trigger method.
result = client.hybrid_inspect_job_trigger request

# The returned object is of type Google::Cloud::Dlp::V2::HybridInspectResponse.
p result

Overloads:

#hybrid_inspect_job_trigger(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::HybridInspectResponse

Pass arguments to hybrid_inspect_job_trigger via a request object, either of type HybridInspectJobTriggerRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::Dlp::V2::HybridInspectJobTriggerRequest, ::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.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#hybrid_inspect_job_trigger(name: nil, hybrid_item: nil) ⇒ ::Google::Cloud::Dlp::V2::HybridInspectResponse

Pass arguments to hybrid_inspect_job_trigger 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).
Parameters:
- name (::String) (defaults to: nil) —
  Required. Resource name of the trigger to execute a hybrid inspect on, for example projects/dlp-test-project/jobTriggers/53234423.
- hybrid_item (::Google::Cloud::Dlp::V2::HybridContentItem, ::Hash) (defaults to: nil) —
  The item to inspect.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Cloud::Dlp::V2::HybridInspectResponse)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Cloud::Dlp::V2::HybridInspectResponse)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 2194

def hybrid_inspect_job_trigger request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::HybridInspectJobTriggerRequest

  # 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
  call_metadata = @config.rpcs.hybrid_inspect_job_trigger.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Dlp::V2::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.hybrid_inspect_job_trigger.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.hybrid_inspect_job_trigger.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.hybrid_inspect_job_trigger request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#inspect_content(request, options = nil) ⇒ `::Google::Cloud::Dlp::V2::InspectContentResponse` #inspect_content(parent: nil, inspect_config: nil, item: nil, inspect_template_name: nil, location_id: nil) ⇒ `::Google::Cloud::Dlp::V2::InspectContentResponse`

Finds potentially sensitive info in content. This method has limits on input size, processing time, and output size.

For how to guides, see https://cloud.google.com/sensitive-data-protection/docs/inspecting-images and https://cloud.google.com/sensitive-data-protection/docs/inspecting-text,

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::InspectContentRequest.new

# Call the inspect_content method.
result = client.inspect_content request

# The returned object is of type Google::Cloud::Dlp::V2::InspectContentResponse.
p result

Overloads:

#inspect_content(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::InspectContentResponse

Pass arguments to inspect_content via a request object, either of type InspectContentRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::Dlp::V2::InspectContentRequest, ::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.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#inspect_content(parent: nil, inspect_config: nil, item: nil, inspect_template_name: nil, location_id: nil) ⇒ ::Google::Cloud::Dlp::V2::InspectContentResponse

Pass arguments to inspect_content 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).
Parameters:
- parent (::String) (defaults to: nil) —
  Parent resource name.
  
  The format of this value varies depending on whether you have specified a processing location:
  - Projects scope, location specified: projects/{project_id}/locations/{location_id}
  - Projects scope, no location specified (defaults to global): projects/{project_id}
  The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:
```
parent=projects/example-project/locations/europe-west3
```
- inspect_config (::Google::Cloud::Dlp::V2::InspectConfig, ::Hash) (defaults to: nil) —
  Configuration for the inspector. What specified here will override the template referenced by the inspect_template_name argument.
- item (::Google::Cloud::Dlp::V2::ContentItem, ::Hash) (defaults to: nil) —
  The item to inspect.
- inspect_template_name (::String) (defaults to: nil) —
  Template to use. Any configuration directly specified in inspect_config will override those set in the template. Singular fields that are set in this request will replace their corresponding fields in the template. Repeated fields are appended. Singular sub-messages and groups are recursively merged.
- location_id (::String) (defaults to: nil) —
  Deprecated. This field has no effect.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Cloud::Dlp::V2::InspectContentResponse)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Cloud::Dlp::V2::InspectContentResponse)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 455

def inspect_content request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::InspectContentRequest

  # 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
  call_metadata = @config.rpcs.inspect_content.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Dlp::V2::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.inspect_content.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.inspect_content.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.inspect_content request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_column_data_profiles(request, options = nil) ⇒ `::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::ColumnDataProfile>` #list_column_data_profiles(parent: nil, page_token: nil, page_size: nil, order_by: nil, filter: nil) ⇒ `::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::ColumnDataProfile>`

Lists column data profiles for an organization.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::ListColumnDataProfilesRequest.new

# Call the list_column_data_profiles method.
result = client.list_column_data_profiles request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Dlp::V2::ColumnDataProfile.
  p item
end

Overloads:

#list_column_data_profiles(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::ColumnDataProfile>

Pass arguments to list_column_data_profiles via a request object, either of type ListColumnDataProfilesRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::Dlp::V2::ListColumnDataProfilesRequest, ::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.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#list_column_data_profiles(parent: nil, page_token: nil, page_size: nil, order_by: nil, filter: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::ColumnDataProfile>

Pass arguments to list_column_data_profiles 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).
Parameters:
- parent (::String) (defaults to: nil) —
  Required. Resource name of the organization or project, for example organizations/433245324/locations/europe or projects/project-id/locations/asia.
- page_token (::String) (defaults to: nil) —
  Page token to continue retrieval.
- page_size (::Integer) (defaults to: nil) —
  Size of the page. This value can be limited by the server. If zero, server returns a page of max size 100.
- order_by (::String) (defaults to: nil) —
  Comma-separated list of fields to order by, followed by asc or desc postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed.
  
  Examples:
  - project_id asc
  - table_id
  - sensitivity_level desc
  Supported fields are:
  - project_id: The Google Cloud project ID.
  - dataset_id: The ID of a BigQuery dataset.
  - table_id: The ID of a BigQuery table.
  - sensitivity_level: How sensitive the data in a column is, at most.
  - data_risk_level: How much risk is associated with this data.
  - profile_last_generated: When the profile was last updated in epoch seconds.
- filter (::String) (defaults to: nil) —
  Allows filtering.
  
  Supported syntax:
  - Filter expressions are made up of one or more restrictions.
  - Restrictions can be combined by AND or OR logical operators. A sequence of restrictions implicitly uses AND.
  - A restriction has the form of {field} {operator} {value}.
  - Supported fields/values:
    
    table_data_profile_name - The name of the related table data profile.
    
    project_id - The Google Cloud project ID. (REQUIRED)
    
    dataset_id - The BigQuery dataset ID. (REQUIRED)
    
    table_id - The BigQuery table ID. (REQUIRED)
    
    field_id - The ID of the BigQuery field.
    
    info_type - The infotype detected in the resource.
    
    sensitivity_level - HIGH|MEDIUM|LOW
    
    data_risk_level: How much risk is associated with this data.
    
    status_code - an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto
  - The operator must be = for project_id, dataset_id, and table_id. Other filters also support !=.
  Examples:
  - project_id = 12345 AND status_code = 1
  - project_id = 12345 AND sensitivity_level = HIGH
  - project_id = 12345 AND info_type = STREET_ADDRESS
  The length of this field should be no more than 500 characters.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::ColumnDataProfile>)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::ColumnDataProfile>)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 4481

def list_column_data_profiles request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::ListColumnDataProfilesRequest

  # 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
  call_metadata = @config.rpcs.list_column_data_profiles.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Dlp::V2::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_column_data_profiles.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_column_data_profiles.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.list_column_data_profiles request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @dlp_service_stub, :list_column_data_profiles, "column_data_profiles", request, result, options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_connections(request, options = nil) ⇒ `::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::Connection>` #list_connections(parent: nil, page_size: nil, page_token: nil, filter: nil) ⇒ `::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::Connection>`

Lists Connections in a parent. Use SearchConnections to see all connections within an organization.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::ListConnectionsRequest.new

# Call the list_connections method.
result = client.list_connections request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Dlp::V2::Connection.
  p item
end

Overloads:

#list_connections(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::Connection>

Pass arguments to list_connections via a request object, either of type ListConnectionsRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::Dlp::V2::ListConnectionsRequest, ::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.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#list_connections(parent: nil, page_size: nil, page_token: nil, filter: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::Connection>

Pass arguments to list_connections 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).
Parameters:
- parent (::String) (defaults to: nil) —
  Required. Resource name of the organization or project, for example, organizations/433245324/locations/europe or projects/project-id/locations/asia.
- page_size (::Integer) (defaults to: nil) —
  Optional. Number of results per page, max 1000.
- page_token (::String) (defaults to: nil) —
  Optional. Page token from a previous page to return the next set of results. If set, all other request fields must match the original request.
- filter (::String) (defaults to: nil) —
  Optional. Supported field/value: state - MISSING|AVAILABLE|ERROR

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::Connection>)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::Connection>)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 5534

def list_connections request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::ListConnectionsRequest

  # 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
  call_metadata = @config.rpcs.list_connections.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Dlp::V2::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_connections.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_connections.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.list_connections request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @dlp_service_stub, :list_connections, "connections", request, result, options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_deidentify_templates(request, options = nil) ⇒ `::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::DeidentifyTemplate>` #list_deidentify_templates(parent: nil, page_token: nil, page_size: nil, order_by: nil, location_id: nil) ⇒ `::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::DeidentifyTemplate>`

Lists DeidentifyTemplates. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::ListDeidentifyTemplatesRequest.new

# Call the list_deidentify_templates method.
result = client.list_deidentify_templates request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Dlp::V2::DeidentifyTemplate.
  p item
end

Overloads:

#list_deidentify_templates(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::DeidentifyTemplate>

Pass arguments to list_deidentify_templates via a request object, either of type ListDeidentifyTemplatesRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::Dlp::V2::ListDeidentifyTemplatesRequest, ::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.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#list_deidentify_templates(parent: nil, page_token: nil, page_size: nil, order_by: nil, location_id: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::DeidentifyTemplate>

Pass arguments to list_deidentify_templates 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).
Parameters:
- parent (::String) (defaults to: nil) —
  Required. Parent resource name.
  
  The format of this value varies depending on the scope of the request (project or organization) and whether you have specified a processing location:
  - Projects scope, location specified: projects/{project_id}/locations/{location_id}
  - Projects scope, no location specified (defaults to global): projects/{project_id}
  - Organizations scope, location specified: organizations/{org_id}/locations/{location_id}
  - Organizations scope, no location specified (defaults to global): organizations/{org_id}
  The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:
```
parent=projects/example-project/locations/europe-west3
```
- page_token (::String) (defaults to: nil) —
  Page token to continue retrieval. Comes from the previous call to ListDeidentifyTemplates.
- page_size (::Integer) (defaults to: nil) —
  Size of the page. This value can be limited by the server. If zero server returns a page of max size 100.
- order_by (::String) (defaults to: nil) —
  Comma-separated list of fields to order by, followed by asc or desc postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant.
  
  Example: name asc,update_time, create_time desc
  
  Supported fields are:
  - create_time: corresponds to the time the template was created.
  - update_time: corresponds to the time the template was last updated.
  - name: corresponds to the template's name.
  - display_name: corresponds to the template's display name.
- location_id (::String) (defaults to: nil) —
  Deprecated. This field has no effect.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::DeidentifyTemplate>)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::DeidentifyTemplate>)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 1830

def list_deidentify_templates request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::ListDeidentifyTemplatesRequest

  # 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
  call_metadata = @config.rpcs.list_deidentify_templates.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Dlp::V2::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_deidentify_templates.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_deidentify_templates.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.list_deidentify_templates request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @dlp_service_stub, :list_deidentify_templates, "deidentify_templates", request, result, options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_discovery_configs(request, options = nil) ⇒ `::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::DiscoveryConfig>` #list_discovery_configs(parent: nil, page_token: nil, page_size: nil, order_by: nil) ⇒ `::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::DiscoveryConfig>`

Lists discovery configurations.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::ListDiscoveryConfigsRequest.new

# Call the list_discovery_configs method.
result = client.list_discovery_configs request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Dlp::V2::DiscoveryConfig.
  p item
end

Overloads:

#list_discovery_configs(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::DiscoveryConfig>

Pass arguments to list_discovery_configs via a request object, either of type ListDiscoveryConfigsRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::Dlp::V2::ListDiscoveryConfigsRequest, ::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.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#list_discovery_configs(parent: nil, page_token: nil, page_size: nil, order_by: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::DiscoveryConfig>

Pass arguments to list_discovery_configs 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).
Parameters:
- parent (::String) (defaults to: nil) —
  Required. Parent resource name.
  
  The format of this value is as follows: projects/{project_id}/locations/{location_id}
  
  The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:
```
parent=projects/example-project/locations/europe-west3
```
- page_token (::String) (defaults to: nil) —
  Page token to continue retrieval. Comes from the previous call to ListDiscoveryConfigs. order_by field must not change for subsequent calls.
- page_size (::Integer) (defaults to: nil) —
  Size of the page. This value can be limited by a server.
- order_by (::String) (defaults to: nil) —
  Comma-separated list of config fields to order by, followed by asc or desc postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant.
  
  Example: name asc,update_time, create_time desc
  
  Supported fields are:
  - last_run_time: corresponds to the last time the DiscoveryConfig ran.
  - name: corresponds to the DiscoveryConfig's name.
  - status: corresponds to DiscoveryConfig's status.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::DiscoveryConfig>)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::DiscoveryConfig>)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 2969

def list_discovery_configs request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::ListDiscoveryConfigsRequest

  # 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
  call_metadata = @config.rpcs.list_discovery_configs.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Dlp::V2::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_discovery_configs.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_discovery_configs.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.list_discovery_configs request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @dlp_service_stub, :list_discovery_configs, "discovery_configs", request, result, options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_dlp_jobs(request, options = nil) ⇒ `::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::DlpJob>` #list_dlp_jobs(parent: nil, filter: nil, page_size: nil, page_token: nil, type: nil, order_by: nil, location_id: nil) ⇒ `::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::DlpJob>`

Lists DlpJobs that match the specified filter in the request. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-storage and https://cloud.google.com/sensitive-data-protection/docs/compute-risk-analysis to learn more.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::ListDlpJobsRequest.new

# Call the list_dlp_jobs method.
result = client.list_dlp_jobs request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Dlp::V2::DlpJob.
  p item
end

Overloads:

#list_dlp_jobs(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::DlpJob>

Pass arguments to list_dlp_jobs via a request object, either of type ListDlpJobsRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::Dlp::V2::ListDlpJobsRequest, ::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.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#list_dlp_jobs(parent: nil, filter: nil, page_size: nil, page_token: nil, type: nil, order_by: nil, location_id: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::DlpJob>

Pass arguments to list_dlp_jobs 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).
Parameters:
- parent (::String) (defaults to: nil) —
  Required. Parent resource name.
  
  The format of this value varies depending on whether you have specified a processing location:
  - Projects scope, location specified: projects/{project_id}/locations/{location_id}
  - Projects scope, no location specified (defaults to global): projects/{project_id}
  The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:
```
parent=projects/example-project/locations/europe-west3
```
- filter (::String) (defaults to: nil) —
  Allows filtering.
  
  Supported syntax:
  - Filter expressions are made up of one or more restrictions.
  - Restrictions can be combined by AND or OR logical operators. A sequence of restrictions implicitly uses AND.
  - A restriction has the form of {field} {operator} {value}.
  - Supported fields/values for inspect jobs:
    
    state - PENDING|RUNNING|CANCELED|FINISHED|FAILED
    
    inspected_storage - DATASTORE|CLOUD_STORAGE|BIGQUERY
    
    trigger_name - The name of the trigger that created the job.
    
    'end_time` - Corresponds to the time the job finished.
    
    'start_time` - Corresponds to the time the job finished.
  - Supported fields for risk analysis jobs:
    
    state - RUNNING|CANCELED|FINISHED|FAILED
    
    'end_time` - Corresponds to the time the job finished.
    
    'start_time` - Corresponds to the time the job finished.
  - The operator must be = or !=.
  Examples:
  - inspected_storage = cloud_storage AND state = done
  - inspected_storage = cloud_storage OR inspected_storage = bigquery
  - inspected_storage = cloud_storage AND (state = done OR state = canceled)
  - end_time > \"2017-12-12T00:00:00+00:00\"
  The length of this field should be no more than 500 characters.
- page_size (::Integer) (defaults to: nil) —
  The standard list page size.
- page_token (::String) (defaults to: nil) —
  The standard list page token.
- type (::Google::Cloud::Dlp::V2::DlpJobType) (defaults to: nil) —
  The type of job. Defaults to DlpJobType.INSPECT
- order_by (::String) (defaults to: nil) —
  Comma-separated list of fields to order by, followed by asc or desc postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant.
  
  Example: name asc, end_time asc, create_time desc
  
  Supported fields are:
  - create_time: corresponds to the time the job was created.
  - end_time: corresponds to the time the job ended.
  - name: corresponds to the job's name.
  - state: corresponds to state
- location_id (::String) (defaults to: nil) —
  Deprecated. This field has no effect.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::DlpJob>)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::DlpJob>)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 3319

def list_dlp_jobs request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::ListDlpJobsRequest

  # 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
  call_metadata = @config.rpcs.list_dlp_jobs.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Dlp::V2::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_dlp_jobs.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_dlp_jobs.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.list_dlp_jobs request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @dlp_service_stub, :list_dlp_jobs, "jobs", request, result, options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_file_store_data_profiles(request, options = nil) ⇒ `::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::FileStoreDataProfile>` #list_file_store_data_profiles(parent: nil, page_token: nil, page_size: nil, order_by: nil, filter: nil) ⇒ `::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::FileStoreDataProfile>`

Lists file store data profiles for an organization.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::ListFileStoreDataProfilesRequest.new

# Call the list_file_store_data_profiles method.
result = client.list_file_store_data_profiles request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Dlp::V2::FileStoreDataProfile.
  p item
end

Overloads:

#list_file_store_data_profiles(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::FileStoreDataProfile>

Pass arguments to list_file_store_data_profiles via a request object, either of type ListFileStoreDataProfilesRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::Dlp::V2::ListFileStoreDataProfilesRequest, ::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.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#list_file_store_data_profiles(parent: nil, page_token: nil, page_size: nil, order_by: nil, filter: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::FileStoreDataProfile>

Pass arguments to list_file_store_data_profiles 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).
Parameters:
- parent (::String) (defaults to: nil) —
  Required. Resource name of the organization or project, for example organizations/433245324/locations/europe or projects/project-id/locations/asia.
- page_token (::String) (defaults to: nil) —
  Optional. Page token to continue retrieval.
- page_size (::Integer) (defaults to: nil) —
  Optional. Size of the page. This value can be limited by the server. If zero, server returns a page of max size 100.
- order_by (::String) (defaults to: nil) —
  Optional. Comma-separated list of fields to order by, followed by asc or desc postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed.
  
  Examples:
  - project_id asc
  - name
  - sensitivity_level desc
  Supported fields are:
  - project_id: The Google Cloud project ID.
  - sensitivity_level: How sensitive the data in a table is, at most.
  - data_risk_level: How much risk is associated with this data.
  - profile_last_generated: When the profile was last updated in epoch seconds.
  - last_modified: The last time the resource was modified.
  - resource_visibility: Visibility restriction for this resource.
  - name: The name of the profile.
  - create_time: The time the file store was first created.
- filter (::String) (defaults to: nil) —
  Optional. Allows filtering.
  
  Supported syntax:
  - Filter expressions are made up of one or more restrictions.
  - Restrictions can be combined by AND or OR logical operators. A sequence of restrictions implicitly uses AND.
  - A restriction has the form of {field} {operator} {value}.
  - Supported fields/values:
    
    project_id - The Google Cloud project ID.
    
    account_id - The AWS account ID.
    
    file_store_path - The path like "gs://bucket".
    
    data_source_type - The profile's data source type, like "google/storage/bucket".
    
    data_storage_location - The location where the file store's data is stored, like "us-central1".
    
    sensitivity_level - HIGH|MODERATE|LOW
    
    data_risk_level - HIGH|MODERATE|LOW
    
    resource_visibility: PUBLIC|RESTRICTED
    
    status_code - an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto
  - The operator must be = or !=.
  Examples:
  - project_id = 12345 AND status_code = 1
  - project_id = 12345 AND sensitivity_level = HIGH
  - project_id = 12345 AND resource_visibility = PUBLIC
  - file_store_path = "gs://mybucket"
  The length of this field should be no more than 500 characters.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::FileStoreDataProfile>)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::FileStoreDataProfile>)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 4707

def list_file_store_data_profiles request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::ListFileStoreDataProfilesRequest

  # 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
  call_metadata = @config.rpcs.list_file_store_data_profiles.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Dlp::V2::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_file_store_data_profiles.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_file_store_data_profiles.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.list_file_store_data_profiles request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @dlp_service_stub, :list_file_store_data_profiles, "file_store_data_profiles", request, result, options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_info_types(request, options = nil) ⇒ `::Google::Cloud::Dlp::V2::ListInfoTypesResponse` #list_info_types(parent: nil, language_code: nil, filter: nil, location_id: nil) ⇒ `::Google::Cloud::Dlp::V2::ListInfoTypesResponse`

Returns a list of the sensitive information types that DLP API supports. See https://cloud.google.com/sensitive-data-protection/docs/infotypes-reference to learn more.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::ListInfoTypesRequest.new

# Call the list_info_types method.
result = client.list_info_types request

# The returned object is of type Google::Cloud::Dlp::V2::ListInfoTypesResponse.
p result

Overloads:

#list_info_types(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::ListInfoTypesResponse

Pass arguments to list_info_types via a request object, either of type ListInfoTypesRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::Dlp::V2::ListInfoTypesRequest, ::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.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#list_info_types(parent: nil, language_code: nil, filter: nil, location_id: nil) ⇒ ::Google::Cloud::Dlp::V2::ListInfoTypesResponse

Pass arguments to list_info_types 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).
Parameters:
- parent (::String) (defaults to: nil) —
  The parent resource name.
  
  The format of this value is as follows:
```
`locations/{location_id}`
```
- language_code (::String) (defaults to: nil) —
  BCP-47 language code for localized infoType friendly names. If omitted, or if localized strings are not available, en-US strings will be returned.
- filter (::String) (defaults to: nil) —
  filter to only return infoTypes supported by certain parts of the API. Defaults to supported_by=INSPECT.
- location_id (::String) (defaults to: nil) —
  Deprecated. This field has no effect.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Cloud::Dlp::V2::ListInfoTypesResponse)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Cloud::Dlp::V2::ListInfoTypesResponse)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 924

def list_info_types request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::ListInfoTypesRequest

  # 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
  call_metadata = @config.rpcs.list_info_types.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Dlp::V2::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_info_types.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_info_types.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.list_info_types request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_inspect_templates(request, options = nil) ⇒ `::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::InspectTemplate>` #list_inspect_templates(parent: nil, page_token: nil, page_size: nil, order_by: nil, location_id: nil) ⇒ `::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::InspectTemplate>`

Lists InspectTemplates. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::ListInspectTemplatesRequest.new

# Call the list_inspect_templates method.
result = client.list_inspect_templates request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Dlp::V2::InspectTemplate.
  p item
end

Overloads:

#list_inspect_templates(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::InspectTemplate>

Pass arguments to list_inspect_templates via a request object, either of type ListInspectTemplatesRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::Dlp::V2::ListInspectTemplatesRequest, ::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.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#list_inspect_templates(parent: nil, page_token: nil, page_size: nil, order_by: nil, location_id: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::InspectTemplate>

Pass arguments to list_inspect_templates 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).
Parameters:
- parent (::String) (defaults to: nil) —
  Required. Parent resource name.
  
  The format of this value varies depending on the scope of the request (project or organization) and whether you have specified a processing location:
  - Projects scope, location specified: projects/{project_id}/locations/{location_id}
  - Projects scope, no location specified (defaults to global): projects/{project_id}
  - Organizations scope, location specified: organizations/{org_id}/locations/{location_id}
  - Organizations scope, no location specified (defaults to global): organizations/{org_id}
  The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:
```
parent=projects/example-project/locations/europe-west3
```
- page_token (::String) (defaults to: nil) —
  Page token to continue retrieval. Comes from the previous call to ListInspectTemplates.
- page_size (::Integer) (defaults to: nil) —
  Size of the page. This value can be limited by the server. If zero server returns a page of max size 100.
- order_by (::String) (defaults to: nil) —
  Comma-separated list of fields to order by, followed by asc or desc postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant.
  
  Example: name asc,update_time, create_time desc
  
  Supported fields are:
  - create_time: corresponds to the time the template was created.
  - update_time: corresponds to the time the template was last updated.
  - name: corresponds to the template's name.
  - display_name: corresponds to the template's display name.
- location_id (::String) (defaults to: nil) —
  Deprecated. This field has no effect.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::InspectTemplate>)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::InspectTemplate>)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 1334

def list_inspect_templates request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::ListInspectTemplatesRequest

  # 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
  call_metadata = @config.rpcs.list_inspect_templates.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Dlp::V2::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_inspect_templates.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_inspect_templates.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.list_inspect_templates request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @dlp_service_stub, :list_inspect_templates, "inspect_templates", request, result, options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_job_triggers(request, options = nil) ⇒ `::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::JobTrigger>` #list_job_triggers(parent: nil, page_token: nil, page_size: nil, order_by: nil, filter: nil, type: nil, location_id: nil) ⇒ `::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::JobTrigger>`

Lists job triggers. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::ListJobTriggersRequest.new

# Call the list_job_triggers method.
result = client.list_job_triggers request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Dlp::V2::JobTrigger.
  p item
end

Overloads:

#list_job_triggers(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::JobTrigger>

Pass arguments to list_job_triggers via a request object, either of type ListJobTriggersRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::Dlp::V2::ListJobTriggersRequest, ::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.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#list_job_triggers(parent: nil, page_token: nil, page_size: nil, order_by: nil, filter: nil, type: nil, location_id: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::JobTrigger>

Pass arguments to list_job_triggers 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).
Parameters:
- parent (::String) (defaults to: nil) —
  Required. Parent resource name.
  
  The format of this value varies depending on whether you have specified a processing location:
  - Projects scope, location specified: projects/{project_id}/locations/{location_id}
  - Projects scope, no location specified (defaults to global): projects/{project_id}
  The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:
```
parent=projects/example-project/locations/europe-west3
```
- page_token (::String) (defaults to: nil) —
  Page token to continue retrieval. Comes from the previous call to ListJobTriggers. order_by field must not change for subsequent calls.
- page_size (::Integer) (defaults to: nil) —
  Size of the page. This value can be limited by a server.
- order_by (::String) (defaults to: nil) —
  Comma-separated list of triggeredJob fields to order by, followed by asc or desc postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant.
  
  Example: name asc,update_time, create_time desc
  
  Supported fields are:
  - create_time: corresponds to the time the JobTrigger was created.
  - update_time: corresponds to the time the JobTrigger was last updated.
  - last_run_time: corresponds to the last time the JobTrigger ran.
  - name: corresponds to the JobTrigger's name.
  - display_name: corresponds to the JobTrigger's display name.
  - status: corresponds to JobTrigger's status.
- filter (::String) (defaults to: nil) —
  Allows filtering.
  
  Supported syntax:
  - Filter expressions are made up of one or more restrictions.
  - Restrictions can be combined by AND or OR logical operators. A sequence of restrictions implicitly uses AND.
  - A restriction has the form of {field} {operator} {value}.
  - Supported fields/values for inspect triggers:
    
    status - HEALTHY|PAUSED|CANCELLED
    
    inspected_storage - DATASTORE|CLOUD_STORAGE|BIGQUERY
    
    'last_run_time` - RFC 3339 formatted timestamp, surrounded by quotation marks. Nanoseconds are ignored.
    
    'error_count' - Number of errors that have occurred while running.
  - The operator must be = or != for status and inspected_storage.
  Examples:
  - inspected_storage = cloud_storage AND status = HEALTHY
  - inspected_storage = cloud_storage OR inspected_storage = bigquery
  - inspected_storage = cloud_storage AND (state = PAUSED OR state = HEALTHY)
  - last_run_time > \"2017-12-12T00:00:00+00:00\"
  The length of this field should be no more than 500 characters.
- type (::Google::Cloud::Dlp::V2::DlpJobType) (defaults to: nil) —
  The type of jobs. Will use DlpJobType.INSPECT if not set.
- location_id (::String) (defaults to: nil) —
  Deprecated. This field has no effect.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::JobTrigger>)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::JobTrigger>)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 2429

def list_job_triggers request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::ListJobTriggersRequest

  # 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
  call_metadata = @config.rpcs.list_job_triggers.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Dlp::V2::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_job_triggers.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_job_triggers.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.list_job_triggers request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @dlp_service_stub, :list_job_triggers, "job_triggers", request, result, options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_project_data_profiles(request, options = nil) ⇒ `::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::ProjectDataProfile>` #list_project_data_profiles(parent: nil, page_token: nil, page_size: nil, order_by: nil, filter: nil) ⇒ `::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::ProjectDataProfile>`

Lists project data profiles for an organization.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::ListProjectDataProfilesRequest.new

# Call the list_project_data_profiles method.
result = client.list_project_data_profiles request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Dlp::V2::ProjectDataProfile.
  p item
end

Overloads:

#list_project_data_profiles(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::ProjectDataProfile>

Pass arguments to list_project_data_profiles via a request object, either of type ListProjectDataProfilesRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::Dlp::V2::ListProjectDataProfilesRequest, ::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.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#list_project_data_profiles(parent: nil, page_token: nil, page_size: nil, order_by: nil, filter: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::ProjectDataProfile>

Pass arguments to list_project_data_profiles 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).
Parameters:
- parent (::String) (defaults to: nil) —
  Required. organizations/{org_id}/locations/{loc_id}
- page_token (::String) (defaults to: nil) —
  Page token to continue retrieval.
- page_size (::Integer) (defaults to: nil) —
  Size of the page. This value can be limited by the server. If zero, server returns a page of max size 100.
- order_by (::String) (defaults to: nil) —
  Comma-separated list of fields to order by, followed by asc or desc postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed.
  
  Examples:
  - project_id
  - sensitivity_level desc
  Supported fields are:
  - project_id: Google Cloud project ID
  - sensitivity_level: How sensitive the data in a project is, at most.
  - data_risk_level: How much risk is associated with this data.
  - profile_last_generated: When the profile was last updated in epoch seconds.
- filter (::String) (defaults to: nil) —
  Allows filtering.
  
  Supported syntax:
  - Filter expressions are made up of one or more restrictions.
  - Restrictions can be combined by AND or OR logical operators. A sequence of restrictions implicitly uses AND.
  - A restriction has the form of {field} {operator} {value}.
  - Supported fields/values:
    
    sensitivity_level - HIGH|MODERATE|LOW
    
    data_risk_level - HIGH|MODERATE|LOW
    
    status_code - an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto
  - The operator must be = or !=.
  Examples:
  - project_id = 12345 AND status_code = 1
  - project_id = 12345 AND sensitivity_level = HIGH
  The length of this field should be no more than 500 characters.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::ProjectDataProfile>)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::ProjectDataProfile>)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 4197

def list_project_data_profiles request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::ListProjectDataProfilesRequest

  # 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
  call_metadata = @config.rpcs.list_project_data_profiles.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Dlp::V2::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_project_data_profiles.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_project_data_profiles.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.list_project_data_profiles request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @dlp_service_stub, :list_project_data_profiles, "project_data_profiles", request, result, options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_stored_info_types(request, options = nil) ⇒ `::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::StoredInfoType>` #list_stored_info_types(parent: nil, page_token: nil, page_size: nil, order_by: nil, location_id: nil) ⇒ `::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::StoredInfoType>`

Lists stored infoTypes. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::ListStoredInfoTypesRequest.new

# Call the list_stored_info_types method.
result = client.list_stored_info_types request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Dlp::V2::StoredInfoType.
  p item
end

Overloads:

#list_stored_info_types(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::StoredInfoType>

Pass arguments to list_stored_info_types via a request object, either of type ListStoredInfoTypesRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::Dlp::V2::ListStoredInfoTypesRequest, ::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.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#list_stored_info_types(parent: nil, page_token: nil, page_size: nil, order_by: nil, location_id: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::StoredInfoType>

Pass arguments to list_stored_info_types 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).
Parameters:
- parent (::String) (defaults to: nil) —
  Required. Parent resource name.
  
  The format of this value varies depending on the scope of the request (project or organization) and whether you have specified a processing location:
  - Projects scope, location specified: projects/{project_id}/locations/{location_id}
  - Projects scope, no location specified (defaults to global): projects/{project_id}
  The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:
```
parent=projects/example-project/locations/europe-west3
```
- page_token (::String) (defaults to: nil) —
  Page token to continue retrieval. Comes from the previous call to ListStoredInfoTypes.
- page_size (::Integer) (defaults to: nil) —
  Size of the page. This value can be limited by the server. If zero server returns a page of max size 100.
- order_by (::String) (defaults to: nil) —
  Comma-separated list of fields to order by, followed by asc or desc postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant.
  
  Example: name asc, display_name, create_time desc
  
  Supported fields are:
  - create_time: corresponds to the time the most recent version of the resource was created.
  - state: corresponds to the state of the resource.
  - name: corresponds to resource name.
  - display_name: corresponds to info type's display name.
- location_id (::String) (defaults to: nil) —
  Deprecated. This field has no effect.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::StoredInfoType>)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::StoredInfoType>)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 3985

def list_stored_info_types request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::ListStoredInfoTypesRequest

  # 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
  call_metadata = @config.rpcs.list_stored_info_types.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Dlp::V2::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_stored_info_types.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_stored_info_types.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.list_stored_info_types request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @dlp_service_stub, :list_stored_info_types, "stored_info_types", request, result, options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_table_data_profiles(request, options = nil) ⇒ `::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::TableDataProfile>` #list_table_data_profiles(parent: nil, page_token: nil, page_size: nil, order_by: nil, filter: nil) ⇒ `::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::TableDataProfile>`

Lists table data profiles for an organization.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::ListTableDataProfilesRequest.new

# Call the list_table_data_profiles method.
result = client.list_table_data_profiles request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Dlp::V2::TableDataProfile.
  p item
end

Overloads:

#list_table_data_profiles(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::TableDataProfile>

Pass arguments to list_table_data_profiles via a request object, either of type ListTableDataProfilesRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::Dlp::V2::ListTableDataProfilesRequest, ::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.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#list_table_data_profiles(parent: nil, page_token: nil, page_size: nil, order_by: nil, filter: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::TableDataProfile>

Pass arguments to list_table_data_profiles 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).
Parameters:
- parent (::String) (defaults to: nil) —
  Required. Resource name of the organization or project, for example organizations/433245324/locations/europe or projects/project-id/locations/asia.
- page_token (::String) (defaults to: nil) —
  Page token to continue retrieval.
- page_size (::Integer) (defaults to: nil) —
  Size of the page. This value can be limited by the server. If zero, server returns a page of max size 100.
- order_by (::String) (defaults to: nil) —
  Comma-separated list of fields to order by, followed by asc or desc postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed.
  
  Examples:
  - project_id asc
  - table_id
  - sensitivity_level desc
  Supported fields are:
  - project_id: The Google Cloud project ID.
  - dataset_id: The ID of a BigQuery dataset.
  - table_id: The ID of a BigQuery table.
  - sensitivity_level: How sensitive the data in a table is, at most.
  - data_risk_level: How much risk is associated with this data.
  - profile_last_generated: When the profile was last updated in epoch seconds.
  - last_modified: The last time the resource was modified.
  - resource_visibility: Visibility restriction for this resource.
  - row_count: Number of rows in this resource.
- filter (::String) (defaults to: nil) —
  Allows filtering.
  
  Supported syntax:
  - Filter expressions are made up of one or more restrictions.
  - Restrictions can be combined by AND or OR logical operators. A sequence of restrictions implicitly uses AND.
  - A restriction has the form of {field} {operator} {value}.
  - Supported fields/values:
    
    project_id - The Google Cloud project ID.
    
    dataset_id - The BigQuery dataset ID.
    
    table_id - The ID of the BigQuery table.
    
    sensitivity_level - HIGH|MODERATE|LOW
    
    data_risk_level - HIGH|MODERATE|LOW
    
    resource_visibility: PUBLIC|RESTRICTED
    
    status_code - an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto
  - The operator must be = or !=.
  Examples:
  - project_id = 12345 AND status_code = 1
  - project_id = 12345 AND sensitivity_level = HIGH
  - project_id = 12345 AND resource_visibility = PUBLIC
  The length of this field should be no more than 500 characters.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::TableDataProfile>)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::TableDataProfile>)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 4338

def list_table_data_profiles request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::ListTableDataProfilesRequest

  # 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
  call_metadata = @config.rpcs.list_table_data_profiles.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Dlp::V2::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_table_data_profiles.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_table_data_profiles.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.list_table_data_profiles request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @dlp_service_stub, :list_table_data_profiles, "table_data_profiles", request, result, options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#redact_image(request, options = nil) ⇒ `::Google::Cloud::Dlp::V2::RedactImageResponse` #redact_image(parent: nil, location_id: nil, inspect_config: nil, image_redaction_configs: nil, include_findings: nil, byte_item: nil) ⇒ `::Google::Cloud::Dlp::V2::RedactImageResponse`

Redacts potentially sensitive info from an image. This method has limits on input size, processing time, and output size. See https://cloud.google.com/sensitive-data-protection/docs/redacting-sensitive-data-images to learn more.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::RedactImageRequest.new

# Call the redact_image method.
result = client.redact_image request

# The returned object is of type Google::Cloud::Dlp::V2::RedactImageResponse.
p result

Overloads:

#redact_image(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::RedactImageResponse

Pass arguments to redact_image via a request object, either of type RedactImageRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::Dlp::V2::RedactImageRequest, ::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.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#redact_image(parent: nil, location_id: nil, inspect_config: nil, image_redaction_configs: nil, include_findings: nil, byte_item: nil) ⇒ ::Google::Cloud::Dlp::V2::RedactImageResponse

Pass arguments to redact_image 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).
Parameters:
- parent (::String) (defaults to: nil) —
  Parent resource name.
  
  The format of this value varies depending on whether you have specified a processing location:
  - Projects scope, location specified: projects/{project_id}/locations/{location_id}
  - Projects scope, no location specified (defaults to global): projects/{project_id}
  The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:
```
parent=projects/example-project/locations/europe-west3
```
- location_id (::String) (defaults to: nil) —
  Deprecated. This field has no effect.
- inspect_config (::Google::Cloud::Dlp::V2::InspectConfig, ::Hash) (defaults to: nil) —
  Configuration for the inspector.
- image_redaction_configs (::Array<::Google::Cloud::Dlp::V2::RedactImageRequest::ImageRedactionConfig, ::Hash>) (defaults to: nil) —
  The configuration for specifying what content to redact from images.
- include_findings (::Boolean) (defaults to: nil) —
  Whether the response should include findings along with the redacted image.
- byte_item (::Google::Cloud::Dlp::V2::ByteContentItem, ::Hash) (defaults to: nil) —
  The content must be PNG, JPEG, SVG or BMP.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Cloud::Dlp::V2::RedactImageResponse)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Cloud::Dlp::V2::RedactImageResponse)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 568

def redact_image request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::RedactImageRequest

  # 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
  call_metadata = @config.rpcs.redact_image.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Dlp::V2::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.redact_image.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.redact_image.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.redact_image request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#reidentify_content(request, options = nil) ⇒ `::Google::Cloud::Dlp::V2::ReidentifyContentResponse` #reidentify_content(parent: nil, reidentify_config: nil, inspect_config: nil, item: nil, inspect_template_name: nil, reidentify_template_name: nil, location_id: nil) ⇒ `::Google::Cloud::Dlp::V2::ReidentifyContentResponse`

Re-identifies content that has been de-identified. See https://cloud.google.com/sensitive-data-protection/docs/pseudonymization#re-identification_in_free_text_code_example to learn more.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::ReidentifyContentRequest.new

# Call the reidentify_content method.
result = client.reidentify_content request

# The returned object is of type Google::Cloud::Dlp::V2::ReidentifyContentResponse.
p result

Overloads:

#reidentify_content(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::ReidentifyContentResponse

Pass arguments to reidentify_content via a request object, either of type ReidentifyContentRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::Dlp::V2::ReidentifyContentRequest, ::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.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#reidentify_content(parent: nil, reidentify_config: nil, inspect_config: nil, item: nil, inspect_template_name: nil, reidentify_template_name: nil, location_id: nil) ⇒ ::Google::Cloud::Dlp::V2::ReidentifyContentResponse

Pass arguments to reidentify_content 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).
Parameters:
- parent (::String) (defaults to: nil) —
  Required. Parent resource name.
  
  The format of this value varies depending on whether you have specified a processing location:
  - Projects scope, location specified: projects/{project_id}/locations/{location_id}
  - Projects scope, no location specified (defaults to global): projects/{project_id}
  The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:
```
parent=projects/example-project/locations/europe-west3
```
- reidentify_config (::Google::Cloud::Dlp::V2::DeidentifyConfig, ::Hash) (defaults to: nil) —
  Configuration for the re-identification of the content item. This field shares the same proto message type that is used for de-identification, however its usage here is for the reversal of the previous de-identification. Re-identification is performed by examining the transformations used to de-identify the items and executing the reverse. This requires that only reversible transformations be provided here. The reversible transformations are:
  - CryptoDeterministicConfig
  - CryptoReplaceFfxFpeConfig
- inspect_config (::Google::Cloud::Dlp::V2::InspectConfig, ::Hash) (defaults to: nil) —
  Configuration for the inspector.
- item (::Google::Cloud::Dlp::V2::ContentItem, ::Hash) (defaults to: nil) —
  The item to re-identify. Will be treated as text.
- inspect_template_name (::String) (defaults to: nil) —
  Template to use. Any configuration directly specified in inspect_config will override those set in the template. Singular fields that are set in this request will replace their corresponding fields in the template. Repeated fields are appended. Singular sub-messages and groups are recursively merged.
- reidentify_template_name (::String) (defaults to: nil) —
  Template to use. References an instance of DeidentifyTemplate. Any configuration directly specified in reidentify_config or inspect_config will override those set in the template. The DeidentifyTemplate used must include only reversible transformations. Singular fields that are set in this request will replace their corresponding fields in the template. Repeated fields are appended. Singular sub-messages and groups are recursively merged.
- location_id (::String) (defaults to: nil) —
  Deprecated. This field has no effect.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Cloud::Dlp::V2::ReidentifyContentResponse)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Cloud::Dlp::V2::ReidentifyContentResponse)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 829

def reidentify_content request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::ReidentifyContentRequest

  # 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
  call_metadata = @config.rpcs.reidentify_content.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Dlp::V2::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.reidentify_content.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.reidentify_content.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.reidentify_content request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#search_connections(request, options = nil) ⇒ `::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::Connection>` #search_connections(parent: nil, page_size: nil, page_token: nil, filter: nil) ⇒ `::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::Connection>`

Searches for Connections in a parent.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::SearchConnectionsRequest.new

# Call the search_connections method.
result = client.search_connections request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Dlp::V2::Connection.
  p item
end

Overloads:

#search_connections(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::Connection>

Pass arguments to search_connections via a request object, either of type SearchConnectionsRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::Dlp::V2::SearchConnectionsRequest, ::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.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#search_connections(parent: nil, page_size: nil, page_token: nil, filter: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::Connection>

Pass arguments to search_connections 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).
Parameters:
- parent (::String) (defaults to: nil) —
  Required. Resource name of the organization or project with a wildcard location, for example, organizations/433245324/locations/- or projects/project-id/locations/-.
- page_size (::Integer) (defaults to: nil) —
  Optional. Number of results per page, max 1000.
- page_token (::String) (defaults to: nil) —
  Optional. Page token from a previous page to return the next set of results. If set, all other request fields must match the original request.
- filter (::String) (defaults to: nil) —
  Optional. Supported field/value: - state - MISSING|AVAILABLE|ERROR

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::Connection>)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::Connection>)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 5627

def search_connections request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::SearchConnectionsRequest

  # 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
  call_metadata = @config.rpcs.search_connections.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Dlp::V2::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.search_connections.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.search_connections.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.search_connections request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @dlp_service_stub, :search_connections, "connections", request, result, options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#universe_domain ⇒ `String`

The effective universe domain

Returns:

(String)



307
308
309

# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 307

def universe_domain
  @dlp_service_stub.universe_domain
end

#update_connection(request, options = nil) ⇒ `::Google::Cloud::Dlp::V2::Connection` #update_connection(name: nil, connection: nil, update_mask: nil) ⇒ `::Google::Cloud::Dlp::V2::Connection`

Update a Connection.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::UpdateConnectionRequest.new

# Call the update_connection method.
result = client.update_connection request

# The returned object is of type Google::Cloud::Dlp::V2::Connection.
p result

Overloads:

#update_connection(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::Connection

Pass arguments to update_connection via a request object, either of type UpdateConnectionRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::Dlp::V2::UpdateConnectionRequest, ::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.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#update_connection(name: nil, connection: nil, update_mask: nil) ⇒ ::Google::Cloud::Dlp::V2::Connection

Pass arguments to update_connection 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).
Parameters:
- name (::String) (defaults to: nil) —
  Required. Resource name in the format: projects/{project}/locations/{location}/connections/{connection}.
- connection (::Google::Cloud::Dlp::V2::Connection, ::Hash) (defaults to: nil) —
  Required. The connection with new values for the relevant fields.
- update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —
  Optional. Mask to control which fields get updated.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Cloud::Dlp::V2::Connection)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Cloud::Dlp::V2::Connection)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 5792

def update_connection request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::UpdateConnectionRequest

  # 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
  call_metadata = @config.rpcs.update_connection.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Dlp::V2::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_connection.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.update_connection.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.update_connection request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_deidentify_template(request, options = nil) ⇒ `::Google::Cloud::Dlp::V2::DeidentifyTemplate` #update_deidentify_template(name: nil, deidentify_template: nil, update_mask: nil) ⇒ `::Google::Cloud::Dlp::V2::DeidentifyTemplate`

Updates the DeidentifyTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates-deid to learn more.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::UpdateDeidentifyTemplateRequest.new

# Call the update_deidentify_template method.
result = client.update_deidentify_template request

# The returned object is of type Google::Cloud::Dlp::V2::DeidentifyTemplate.
p result

Overloads:

#update_deidentify_template(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::DeidentifyTemplate

Pass arguments to update_deidentify_template via a request object, either of type UpdateDeidentifyTemplateRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::Dlp::V2::UpdateDeidentifyTemplateRequest, ::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.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#update_deidentify_template(name: nil, deidentify_template: nil, update_mask: nil) ⇒ ::Google::Cloud::Dlp::V2::DeidentifyTemplate

Pass arguments to update_deidentify_template 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).
Parameters:
- name (::String) (defaults to: nil) —
  Required. Resource name of organization and deidentify template to be updated, for example organizations/433245324/deidentifyTemplates/432452342 or projects/project-id/deidentifyTemplates/432452342.
- deidentify_template (::Google::Cloud::Dlp::V2::DeidentifyTemplate, ::Hash) (defaults to: nil) —
  New DeidentifyTemplate value.
- update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —
  Mask to control which fields get updated.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Cloud::Dlp::V2::DeidentifyTemplate)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Cloud::Dlp::V2::DeidentifyTemplate)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 1619

def update_deidentify_template request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::UpdateDeidentifyTemplateRequest

  # 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
  call_metadata = @config.rpcs.update_deidentify_template.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Dlp::V2::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_deidentify_template.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.update_deidentify_template.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.update_deidentify_template request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_discovery_config(request, options = nil) ⇒ `::Google::Cloud::Dlp::V2::DiscoveryConfig` #update_discovery_config(name: nil, discovery_config: nil, update_mask: nil) ⇒ `::Google::Cloud::Dlp::V2::DiscoveryConfig`

Updates a discovery configuration.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::UpdateDiscoveryConfigRequest.new

# Call the update_discovery_config method.
result = client.update_discovery_config request

# The returned object is of type Google::Cloud::Dlp::V2::DiscoveryConfig.
p result

Overloads:

#update_discovery_config(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::DiscoveryConfig

Pass arguments to update_discovery_config via a request object, either of type UpdateDiscoveryConfigRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::Dlp::V2::UpdateDiscoveryConfigRequest, ::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.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#update_discovery_config(name: nil, discovery_config: nil, update_mask: nil) ⇒ ::Google::Cloud::Dlp::V2::DiscoveryConfig

Pass arguments to update_discovery_config 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).
Parameters:
- name (::String) (defaults to: nil) —
  Required. Resource name of the project and the configuration, for example projects/dlp-test-project/discoveryConfigs/53234423.
- discovery_config (::Google::Cloud::Dlp::V2::DiscoveryConfig, ::Hash) (defaults to: nil) —
  Required. New DiscoveryConfig value.
- update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —
  Mask to control which fields get updated.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Cloud::Dlp::V2::DiscoveryConfig)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Cloud::Dlp::V2::DiscoveryConfig)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 2778

def update_discovery_config request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::UpdateDiscoveryConfigRequest

  # 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
  call_metadata = @config.rpcs.update_discovery_config.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Dlp::V2::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_discovery_config.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.update_discovery_config.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.update_discovery_config request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_inspect_template(request, options = nil) ⇒ `::Google::Cloud::Dlp::V2::InspectTemplate` #update_inspect_template(name: nil, inspect_template: nil, update_mask: nil) ⇒ `::Google::Cloud::Dlp::V2::InspectTemplate`

Updates the InspectTemplate. See https://cloud.google.com/sensitive-data-protection/docs/creating-templates to learn more.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::UpdateInspectTemplateRequest.new

# Call the update_inspect_template method.
result = client.update_inspect_template request

# The returned object is of type Google::Cloud::Dlp::V2::InspectTemplate.
p result

Overloads:

#update_inspect_template(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::InspectTemplate

Pass arguments to update_inspect_template via a request object, either of type UpdateInspectTemplateRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::Dlp::V2::UpdateInspectTemplateRequest, ::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.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#update_inspect_template(name: nil, inspect_template: nil, update_mask: nil) ⇒ ::Google::Cloud::Dlp::V2::InspectTemplate

Pass arguments to update_inspect_template 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).
Parameters:
- name (::String) (defaults to: nil) —
  Required. Resource name of organization and inspectTemplate to be updated, for example organizations/433245324/inspectTemplates/432452342 or projects/project-id/inspectTemplates/432452342.
- inspect_template (::Google::Cloud::Dlp::V2::InspectTemplate, ::Hash) (defaults to: nil) —
  New InspectTemplate value.
- update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —
  Mask to control which fields get updated.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Cloud::Dlp::V2::InspectTemplate)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Cloud::Dlp::V2::InspectTemplate)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 1123

def update_inspect_template request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::UpdateInspectTemplateRequest

  # 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
  call_metadata = @config.rpcs.update_inspect_template.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Dlp::V2::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_inspect_template.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.update_inspect_template.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.update_inspect_template request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_job_trigger(request, options = nil) ⇒ `::Google::Cloud::Dlp::V2::JobTrigger` #update_job_trigger(name: nil, job_trigger: nil, update_mask: nil) ⇒ `::Google::Cloud::Dlp::V2::JobTrigger`

Updates a job trigger. See https://cloud.google.com/sensitive-data-protection/docs/creating-job-triggers to learn more.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::UpdateJobTriggerRequest.new

# Call the update_job_trigger method.
result = client.update_job_trigger request

# The returned object is of type Google::Cloud::Dlp::V2::JobTrigger.
p result

Overloads:

#update_job_trigger(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::JobTrigger

Pass arguments to update_job_trigger via a request object, either of type UpdateJobTriggerRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::Dlp::V2::UpdateJobTriggerRequest, ::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.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#update_job_trigger(name: nil, job_trigger: nil, update_mask: nil) ⇒ ::Google::Cloud::Dlp::V2::JobTrigger

Pass arguments to update_job_trigger 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).
Parameters:
- name (::String) (defaults to: nil) —
  Required. Resource name of the project and the triggeredJob, for example projects/dlp-test-project/jobTriggers/53234423.
- job_trigger (::Google::Cloud::Dlp::V2::JobTrigger, ::Hash) (defaults to: nil) —
  New JobTrigger value.
- update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —
  Mask to control which fields get updated.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Cloud::Dlp::V2::JobTrigger)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Cloud::Dlp::V2::JobTrigger)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 2110

def update_job_trigger request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::UpdateJobTriggerRequest

  # 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
  call_metadata = @config.rpcs.update_job_trigger.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Dlp::V2::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_job_trigger.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.update_job_trigger.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.update_job_trigger request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_stored_info_type(request, options = nil) ⇒ `::Google::Cloud::Dlp::V2::StoredInfoType` #update_stored_info_type(name: nil, config: nil, update_mask: nil) ⇒ `::Google::Cloud::Dlp::V2::StoredInfoType`

Updates the stored infoType by creating a new version. The existing version will continue to be used until the new version is ready. See https://cloud.google.com/sensitive-data-protection/docs/creating-stored-infotypes to learn more.

Examples:

Basic example

require "google/cloud/dlp/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dlp::V2::DlpService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dlp::V2::UpdateStoredInfoTypeRequest.new

# Call the update_stored_info_type method.
result = client.update_stored_info_type request

# The returned object is of type Google::Cloud::Dlp::V2::StoredInfoType.
p result

Overloads:

#update_stored_info_type(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::StoredInfoType

Pass arguments to update_stored_info_type via a request object, either of type UpdateStoredInfoTypeRequest or an equivalent Hash.
Parameters:
- request (::Google::Cloud::Dlp::V2::UpdateStoredInfoTypeRequest, ::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.
- options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —
  Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#update_stored_info_type(name: nil, config: nil, update_mask: nil) ⇒ ::Google::Cloud::Dlp::V2::StoredInfoType

Pass arguments to update_stored_info_type 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).
Parameters:
- name (::String) (defaults to: nil) —
  Required. Resource name of organization and storedInfoType to be updated, for example organizations/433245324/storedInfoTypes/432452342 or projects/project-id/storedInfoTypes/432452342.
- config (::Google::Cloud::Dlp::V2::StoredInfoTypeConfig, ::Hash) (defaults to: nil) —
  Updated configuration for the storedInfoType. If not provided, a new version of the storedInfoType will be created with the existing configuration.
- update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —
  Mask to control which fields get updated.

Yields:

(result, operation) —
Access the result along with the TransportOperation object

Yield Parameters:

result (::Google::Cloud::Dlp::V2::StoredInfoType)
operation (::Gapic::Rest::TransportOperation)

Returns:

(::Google::Cloud::Dlp::V2::StoredInfoType)

Raises:

(::Google::Cloud::Error) —
if the REST call is aborted.

# File 'lib/google/cloud/dlp/v2/dlp_service/rest/client.rb', line 3777

def update_stored_info_type request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dlp::V2::UpdateStoredInfoTypeRequest

  # 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
  call_metadata = @config.rpcs.update_stored_info_type.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::Dlp::V2::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_stored_info_type.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.update_stored_info_type.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dlp_service_stub.update_stored_info_type request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

Class: Google::Cloud::Dlp::V2::DlpService::Rest::Client

Overview

Defined Under Namespace

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

Constructor Details

#initialize {|config| ... } ⇒ Client

Examples:

Instance Attribute Details

#location_client ⇒ Google::Cloud::Location::Locations::Rest::Client (readonly)

Class Method Details

.configure {|config| ... } ⇒ Client::Configuration

Examples:

Instance Method Details

#activate_job_trigger(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::DlpJob #activate_job_trigger(name: nil) ⇒ ::Google::Cloud::Dlp::V2::DlpJob

Examples:

Basic example

#cancel_dlp_job(request, options = nil) ⇒ ::Google::Protobuf::Empty #cancel_dlp_job(name: nil) ⇒ ::Google::Protobuf::Empty

Examples:

Basic example

#configure {|config| ... } ⇒ Client::Configuration

#create_connection(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::Connection #create_connection(parent: nil, connection: nil) ⇒ ::Google::Cloud::Dlp::V2::Connection

Examples:

Basic example

#create_deidentify_template(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::DeidentifyTemplate #create_deidentify_template(parent: nil, deidentify_template: nil, template_id: nil, location_id: nil) ⇒ ::Google::Cloud::Dlp::V2::DeidentifyTemplate

Examples:

Basic example

#create_discovery_config(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::DiscoveryConfig #create_discovery_config(parent: nil, discovery_config: nil, config_id: nil) ⇒ ::Google::Cloud::Dlp::V2::DiscoveryConfig

Examples:

Basic example

#create_dlp_job(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::DlpJob #create_dlp_job(parent: nil, inspect_job: nil, risk_job: nil, job_id: nil, location_id: nil) ⇒ ::Google::Cloud::Dlp::V2::DlpJob

Examples:

Basic example

#create_inspect_template(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::InspectTemplate #create_inspect_template(parent: nil, inspect_template: nil, template_id: nil, location_id: nil) ⇒ ::Google::Cloud::Dlp::V2::InspectTemplate

Examples:

Basic example

#create_job_trigger(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::JobTrigger #create_job_trigger(parent: nil, job_trigger: nil, trigger_id: nil, location_id: nil) ⇒ ::Google::Cloud::Dlp::V2::JobTrigger

Examples:

Basic example

#create_stored_info_type(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::StoredInfoType #create_stored_info_type(parent: nil, config: nil, stored_info_type_id: nil, location_id: nil) ⇒ ::Google::Cloud::Dlp::V2::StoredInfoType

Examples:

Basic example

Examples:

Basic example

#delete_connection(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_connection(name: nil) ⇒ ::Google::Protobuf::Empty

Examples:

Basic example

#delete_deidentify_template(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_deidentify_template(name: nil) ⇒ ::Google::Protobuf::Empty

Examples:

Basic example

#delete_discovery_config(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_discovery_config(name: nil) ⇒ ::Google::Protobuf::Empty

Examples:

Basic example

#delete_dlp_job(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_dlp_job(name: nil) ⇒ ::Google::Protobuf::Empty

Examples:

Basic example

#delete_file_store_data_profile(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_file_store_data_profile(name: nil) ⇒ ::Google::Protobuf::Empty

Examples:

Basic example

#delete_inspect_template(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_inspect_template(name: nil) ⇒ ::Google::Protobuf::Empty

Examples:

Basic example

#delete_job_trigger(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_job_trigger(name: nil) ⇒ ::Google::Protobuf::Empty

Examples:

Basic example

#delete_stored_info_type(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_stored_info_type(name: nil) ⇒ ::Google::Protobuf::Empty

Examples:

Basic example

#delete_table_data_profile(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_table_data_profile(name: nil) ⇒ ::Google::Protobuf::Empty

Examples:

Basic example

#finish_dlp_job(request, options = nil) ⇒ ::Google::Protobuf::Empty #finish_dlp_job(name: nil) ⇒ ::Google::Protobuf::Empty

Examples:

Basic example

#get_column_data_profile(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::ColumnDataProfile #get_column_data_profile(name: nil) ⇒ ::Google::Cloud::Dlp::V2::ColumnDataProfile

Examples:

Basic example

#get_connection(request, options = nil) ⇒ ::Google::Cloud::Dlp::V2::Connection #get_connection(name: nil) ⇒ ::Google::Cloud::Dlp::V2::Connection

#initialize {|config| ... } ⇒ `Client`

#location_client ⇒ `Google::Cloud::Location::Locations::Rest::Client` (readonly)

.configure {|config| ... } ⇒ `Client::Configuration`

#activate_job_trigger(request, options = nil) ⇒ `::Google::Cloud::Dlp::V2::DlpJob` #activate_job_trigger(name: nil) ⇒ `::Google::Cloud::Dlp::V2::DlpJob`

#cancel_dlp_job(request, options = nil) ⇒ `::Google::Protobuf::Empty` #cancel_dlp_job(name: nil) ⇒ `::Google::Protobuf::Empty`

#configure {|config| ... } ⇒ `Client::Configuration`

#create_connection(request, options = nil) ⇒ `::Google::Cloud::Dlp::V2::Connection` #create_connection(parent: nil, connection: nil) ⇒ `::Google::Cloud::Dlp::V2::Connection`

#create_deidentify_template(request, options = nil) ⇒ `::Google::Cloud::Dlp::V2::DeidentifyTemplate` #create_deidentify_template(parent: nil, deidentify_template: nil, template_id: nil, location_id: nil) ⇒ `::Google::Cloud::Dlp::V2::DeidentifyTemplate`

#create_discovery_config(request, options = nil) ⇒ `::Google::Cloud::Dlp::V2::DiscoveryConfig` #create_discovery_config(parent: nil, discovery_config: nil, config_id: nil) ⇒ `::Google::Cloud::Dlp::V2::DiscoveryConfig`

#create_dlp_job(request, options = nil) ⇒ `::Google::Cloud::Dlp::V2::DlpJob` #create_dlp_job(parent: nil, inspect_job: nil, risk_job: nil, job_id: nil, location_id: nil) ⇒ `::Google::Cloud::Dlp::V2::DlpJob`

#create_inspect_template(request, options = nil) ⇒ `::Google::Cloud::Dlp::V2::InspectTemplate` #create_inspect_template(parent: nil, inspect_template: nil, template_id: nil, location_id: nil) ⇒ `::Google::Cloud::Dlp::V2::InspectTemplate`

#create_job_trigger(request, options = nil) ⇒ `::Google::Cloud::Dlp::V2::JobTrigger` #create_job_trigger(parent: nil, job_trigger: nil, trigger_id: nil, location_id: nil) ⇒ `::Google::Cloud::Dlp::V2::JobTrigger`

#create_stored_info_type(request, options = nil) ⇒ `::Google::Cloud::Dlp::V2::StoredInfoType` #create_stored_info_type(parent: nil, config: nil, stored_info_type_id: nil, location_id: nil) ⇒ `::Google::Cloud::Dlp::V2::StoredInfoType`

#delete_connection(request, options = nil) ⇒ `::Google::Protobuf::Empty` #delete_connection(name: nil) ⇒ `::Google::Protobuf::Empty`

#delete_deidentify_template(request, options = nil) ⇒ `::Google::Protobuf::Empty` #delete_deidentify_template(name: nil) ⇒ `::Google::Protobuf::Empty`

#delete_discovery_config(request, options = nil) ⇒ `::Google::Protobuf::Empty` #delete_discovery_config(name: nil) ⇒ `::Google::Protobuf::Empty`

#delete_dlp_job(request, options = nil) ⇒ `::Google::Protobuf::Empty` #delete_dlp_job(name: nil) ⇒ `::Google::Protobuf::Empty`

#delete_file_store_data_profile(request, options = nil) ⇒ `::Google::Protobuf::Empty` #delete_file_store_data_profile(name: nil) ⇒ `::Google::Protobuf::Empty`

#delete_inspect_template(request, options = nil) ⇒ `::Google::Protobuf::Empty` #delete_inspect_template(name: nil) ⇒ `::Google::Protobuf::Empty`

#delete_job_trigger(request, options = nil) ⇒ `::Google::Protobuf::Empty` #delete_job_trigger(name: nil) ⇒ `::Google::Protobuf::Empty`

#delete_stored_info_type(request, options = nil) ⇒ `::Google::Protobuf::Empty` #delete_stored_info_type(name: nil) ⇒ `::Google::Protobuf::Empty`

#delete_table_data_profile(request, options = nil) ⇒ `::Google::Protobuf::Empty` #delete_table_data_profile(name: nil) ⇒ `::Google::Protobuf::Empty`

#finish_dlp_job(request, options = nil) ⇒ `::Google::Protobuf::Empty` #finish_dlp_job(name: nil) ⇒ `::Google::Protobuf::Empty`

#get_column_data_profile(request, options = nil) ⇒ `::Google::Cloud::Dlp::V2::ColumnDataProfile` #get_column_data_profile(name: nil) ⇒ `::Google::Cloud::Dlp::V2::ColumnDataProfile`

#get_connection(request, options = nil) ⇒ `::Google::Cloud::Dlp::V2::Connection` #get_connection(name: nil) ⇒ `::Google::Cloud::Dlp::V2::Connection`

#get_deidentify_template(request, options = nil) ⇒ `::Google::Cloud::Dlp::V2::DeidentifyTemplate` #get_deidentify_template(name: nil) ⇒ `::Google::Cloud::Dlp::V2::DeidentifyTemplate`

#get_discovery_config(request, options = nil) ⇒ `::Google::Cloud::Dlp::V2::DiscoveryConfig` #get_discovery_config(name: nil) ⇒ `::Google::Cloud::Dlp::V2::DiscoveryConfig`

#get_dlp_job(request, options = nil) ⇒ `::Google::Cloud::Dlp::V2::DlpJob` #get_dlp_job(name: nil) ⇒ `::Google::Cloud::Dlp::V2::DlpJob`

#get_file_store_data_profile(request, options = nil) ⇒ `::Google::Cloud::Dlp::V2::FileStoreDataProfile` #get_file_store_data_profile(name: nil) ⇒ `::Google::Cloud::Dlp::V2::FileStoreDataProfile`

#get_inspect_template(request, options = nil) ⇒ `::Google::Cloud::Dlp::V2::InspectTemplate` #get_inspect_template(name: nil) ⇒ `::Google::Cloud::Dlp::V2::InspectTemplate`

#get_job_trigger(request, options = nil) ⇒ `::Google::Cloud::Dlp::V2::JobTrigger` #get_job_trigger(name: nil) ⇒ `::Google::Cloud::Dlp::V2::JobTrigger`

#get_project_data_profile(request, options = nil) ⇒ `::Google::Cloud::Dlp::V2::ProjectDataProfile` #get_project_data_profile(name: nil) ⇒ `::Google::Cloud::Dlp::V2::ProjectDataProfile`

#get_stored_info_type(request, options = nil) ⇒ `::Google::Cloud::Dlp::V2::StoredInfoType` #get_stored_info_type(name: nil) ⇒ `::Google::Cloud::Dlp::V2::StoredInfoType`

#get_table_data_profile(request, options = nil) ⇒ `::Google::Cloud::Dlp::V2::TableDataProfile` #get_table_data_profile(name: nil) ⇒ `::Google::Cloud::Dlp::V2::TableDataProfile`

#hybrid_inspect_dlp_job(request, options = nil) ⇒ `::Google::Cloud::Dlp::V2::HybridInspectResponse` #hybrid_inspect_dlp_job(name: nil, hybrid_item: nil) ⇒ `::Google::Cloud::Dlp::V2::HybridInspectResponse`

#hybrid_inspect_job_trigger(request, options = nil) ⇒ `::Google::Cloud::Dlp::V2::HybridInspectResponse` #hybrid_inspect_job_trigger(name: nil, hybrid_item: nil) ⇒ `::Google::Cloud::Dlp::V2::HybridInspectResponse`

#inspect_content(request, options = nil) ⇒ `::Google::Cloud::Dlp::V2::InspectContentResponse` #inspect_content(parent: nil, inspect_config: nil, item: nil, inspect_template_name: nil, location_id: nil) ⇒ `::Google::Cloud::Dlp::V2::InspectContentResponse`

#list_connections(request, options = nil) ⇒ `::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::Connection>` #list_connections(parent: nil, page_size: nil, page_token: nil, filter: nil) ⇒ `::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::Connection>`

#list_discovery_configs(request, options = nil) ⇒ `::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::DiscoveryConfig>` #list_discovery_configs(parent: nil, page_token: nil, page_size: nil, order_by: nil) ⇒ `::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::DiscoveryConfig>`

#list_dlp_jobs(request, options = nil) ⇒ `::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::DlpJob>` #list_dlp_jobs(parent: nil, filter: nil, page_size: nil, page_token: nil, type: nil, order_by: nil, location_id: nil) ⇒ `::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dlp::V2::DlpJob>`

#list_info_types(request, options = nil) ⇒ `::Google::Cloud::Dlp::V2::ListInfoTypesResponse` #list_info_types(parent: nil, language_code: nil, filter: nil, location_id: nil) ⇒ `::Google::Cloud::Dlp::V2::ListInfoTypesResponse`