Cloud Data Loss Prevention (DLP) V2 API - Class Google::Cloud::Dlp::V2::DlpService::Client (v0.18.0)

Reference documentation and code samples for the Cloud Data Loss Prevention (DLP) V2 API class Google::Cloud::Dlp::V2::DlpService::Client.

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/dlp/docs/.

Inherits

Object

Includes

Google::Cloud::Dlp::V2::DlpService::Paths

Methods

.configure

def self.configure() { |config| ... } -> Client::Configuration

Configure the DlpService Client class.

See Configuration for a description of the configuration fields.

Yields

(config) — Configure the Client client.

Yield Parameter

config (Client::Configuration)

Returns

(Client::Configuration)

Example

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

#activate_job_trigger

def activate_job_trigger(request, options = nil) -> ::Google::Cloud::Dlp::V2::DlpJob
def 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.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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).

Parameter

name (::String) — Required. Resource name of the trigger to activate, for example projects/dlp-test-project/jobTriggers/53234423.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::Dlp::V2::DlpJob)
operation (::GRPC::ActiveCall::Operation)

Returns

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

Raises

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

Example

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::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

#cancel_dlp_job

def cancel_dlp_job(request, options = nil) -> ::Google::Protobuf::Empty
def 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/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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).

Parameter

name (::String) — Required. The name of the DlpJob resource to be cancelled.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Protobuf::Empty)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Protobuf::Empty)

Raises

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

Example

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::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

#configure

def 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 Client.configure.

See Configuration for a description of the configuration fields.

Yields

(config) — Configure the Client client.

Yield Parameter

config (Client::Configuration)

Returns

(Client::Configuration)

#create_deidentify_template

def create_deidentify_template(request, options = nil) -> ::Google::Cloud::Dlp::V2::DeidentifyTemplate
def 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/dlp/docs/creating-templates-deid to learn more.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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) —
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) — Required. The DeidentifyTemplate to create.
template_id (::String) — 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) — Deprecated. This field has no effect.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::Dlp::V2::DeidentifyTemplate)
operation (::GRPC::ActiveCall::Operation)

Returns

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

Raises

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

Example

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::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

#create_dlp_job

def create_dlp_job(request, options = nil) -> ::Google::Cloud::Dlp::V2::DlpJob
def 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/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/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.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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) —
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) — An inspection job scans a storage repository for InfoTypes.
risk_job (::Google::Cloud::Dlp::V2::RiskAnalysisJobConfig, ::Hash) — A risk analysis job calculates re-identification risk metrics for a BigQuery table.
job_id (::String) — 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) — Deprecated. This field has no effect.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::Dlp::V2::DlpJob)
operation (::GRPC::ActiveCall::Operation)

Returns

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

Raises

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

Example

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::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

#create_inspect_template

def create_inspect_template(request, options = nil) -> ::Google::Cloud::Dlp::V2::InspectTemplate
def 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/dlp/docs/creating-templates to learn more.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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) —
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) — Required. The InspectTemplate to create.
template_id (::String) — 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) — Deprecated. This field has no effect.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::Dlp::V2::InspectTemplate)
operation (::GRPC::ActiveCall::Operation)

Returns

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

Raises

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

Example

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::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

#create_job_trigger

def create_job_trigger(request, options = nil) -> ::Google::Cloud::Dlp::V2::JobTrigger
def 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/dlp/docs/creating-job-triggers to learn more.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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) —
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) — Required. The JobTrigger to create.
trigger_id (::String) — 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) — Deprecated. This field has no effect.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::Dlp::V2::JobTrigger)
operation (::GRPC::ActiveCall::Operation)

Returns

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

Raises

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

Example

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::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

#create_stored_info_type

def create_stored_info_type(request, options = nil) -> ::Google::Cloud::Dlp::V2::StoredInfoType
def 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/dlp/docs/creating-stored-infotypes to learn more.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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) —
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) — Required. Configuration of the storedInfoType to create.
stored_info_type_id (::String) — 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) — Deprecated. This field has no effect.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::Dlp::V2::StoredInfoType)
operation (::GRPC::ActiveCall::Operation)

Returns

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

Raises

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

Example

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::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

#deidentify_content

def deidentify_content(request, options = nil) -> ::Google::Cloud::Dlp::V2::DeidentifyContentResponse
def 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/dlp/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.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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) —
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) — 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) — 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) — 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) — 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) — 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) — Deprecated. This field has no effect.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::Dlp::V2::DeidentifyContentResponse)
operation (::GRPC::ActiveCall::Operation)

Returns

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

Raises

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

Example

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::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

#delete_deidentify_template

def delete_deidentify_template(request, options = nil) -> ::Google::Protobuf::Empty
def delete_deidentify_template(name: nil) -> ::Google::Protobuf::Empty

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

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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).

Parameter

name (::String) — 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

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Protobuf::Empty)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Protobuf::Empty)

Raises

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

Example

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::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

#delete_dlp_job

def delete_dlp_job(request, options = nil) -> ::Google::Protobuf::Empty
def 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/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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).

Parameter

name (::String) — Required. The name of the DlpJob resource to be deleted.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Protobuf::Empty)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Protobuf::Empty)

Raises

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

Example

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::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

#delete_inspect_template

def delete_inspect_template(request, options = nil) -> ::Google::Protobuf::Empty
def delete_inspect_template(name: nil) -> ::Google::Protobuf::Empty

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

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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).

Parameter

name (::String) — Required. Resource name of the organization and inspectTemplate to be deleted, for example organizations/433245324/inspectTemplates/432452342 or projects/project-id/inspectTemplates/432452342.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Protobuf::Empty)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Protobuf::Empty)

Raises

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

Example

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::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

#delete_job_trigger

def delete_job_trigger(request, options = nil) -> ::Google::Protobuf::Empty
def delete_job_trigger(name: nil) -> ::Google::Protobuf::Empty

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

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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).

Parameter

name (::String) — Required. Resource name of the project and the triggeredJob, for example projects/dlp-test-project/jobTriggers/53234423.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Protobuf::Empty)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Protobuf::Empty)

Raises

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

Example

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::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

#delete_stored_info_type

def delete_stored_info_type(request, options = nil) -> ::Google::Protobuf::Empty
def delete_stored_info_type(name: nil) -> ::Google::Protobuf::Empty

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

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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).

Parameter

name (::String) — Required. Resource name of the organization and storedInfoType to be deleted, for example organizations/433245324/storedInfoTypes/432452342 or projects/project-id/storedInfoTypes/432452342.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Protobuf::Empty)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Protobuf::Empty)

Raises

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

Example

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::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

#finish_dlp_job

def finish_dlp_job(request, options = nil) -> ::Google::Protobuf::Empty
def 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.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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).

Parameter

name (::String) — Required. The name of the DlpJob resource to be cancelled.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Protobuf::Empty)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Protobuf::Empty)

Raises

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

Example

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::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

#get_deidentify_template

def get_deidentify_template(request, options = nil) -> ::Google::Cloud::Dlp::V2::DeidentifyTemplate
def get_deidentify_template(name: nil) -> ::Google::Cloud::Dlp::V2::DeidentifyTemplate

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

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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).

Parameter

name (::String) — 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

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::Dlp::V2::DeidentifyTemplate)
operation (::GRPC::ActiveCall::Operation)

Returns

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

Raises

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

Example

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::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

#get_dlp_job

def get_dlp_job(request, options = nil) -> ::Google::Cloud::Dlp::V2::DlpJob
def get_dlp_job(name: nil) -> ::Google::Cloud::Dlp::V2::DlpJob

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

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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).

Parameter

name (::String) — Required. The name of the DlpJob resource.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::Dlp::V2::DlpJob)
operation (::GRPC::ActiveCall::Operation)

Returns

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

Raises

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

Example

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::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

#get_inspect_template

def get_inspect_template(request, options = nil) -> ::Google::Cloud::Dlp::V2::InspectTemplate
def get_inspect_template(name: nil) -> ::Google::Cloud::Dlp::V2::InspectTemplate

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

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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).

Parameter

name (::String) — Required. Resource name of the organization and inspectTemplate to be read, for example organizations/433245324/inspectTemplates/432452342 or projects/project-id/inspectTemplates/432452342.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::Dlp::V2::InspectTemplate)
operation (::GRPC::ActiveCall::Operation)

Returns

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

Raises

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

Example

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::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

#get_job_trigger

def get_job_trigger(request, options = nil) -> ::Google::Cloud::Dlp::V2::JobTrigger
def get_job_trigger(name: nil) -> ::Google::Cloud::Dlp::V2::JobTrigger

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

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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).

Parameter

name (::String) — Required. Resource name of the project and the triggeredJob, for example projects/dlp-test-project/jobTriggers/53234423.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::Dlp::V2::JobTrigger)
operation (::GRPC::ActiveCall::Operation)

Returns

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

Raises

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

Example

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::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

#get_stored_info_type

def get_stored_info_type(request, options = nil) -> ::Google::Cloud::Dlp::V2::StoredInfoType
def get_stored_info_type(name: nil) -> ::Google::Cloud::Dlp::V2::StoredInfoType

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

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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).

Parameter

name (::String) — Required. Resource name of the organization and storedInfoType to be read, for example organizations/433245324/storedInfoTypes/432452342 or projects/project-id/storedInfoTypes/432452342.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::Dlp::V2::StoredInfoType)
operation (::GRPC::ActiveCall::Operation)

Returns

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

Raises

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

Example

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::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

#hybrid_inspect_dlp_job

def hybrid_inspect_dlp_job(request, options = nil) -> ::Google::Cloud::Dlp::V2::HybridInspectResponse
def 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.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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) — 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) — The item to inspect.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::Dlp::V2::HybridInspectResponse)
operation (::GRPC::ActiveCall::Operation)

Returns

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

Raises

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

Example

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::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

#hybrid_inspect_job_trigger

def hybrid_inspect_job_trigger(request, options = nil) -> ::Google::Cloud::Dlp::V2::HybridInspectResponse
def 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.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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) — 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) — The item to inspect.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::Dlp::V2::HybridInspectResponse)
operation (::GRPC::ActiveCall::Operation)

Returns

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

Raises

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

Example

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::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

#initialize

def initialize() { |config| ... } -> Client

Create a new DlpService client object.

Yields

(config) — Configure the DlpService client.

Yield Parameter

config (Client::Configuration)

Returns

(Client) — a new instance of Client

Example

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

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

#inspect_content

def inspect_content(request, options = nil) -> ::Google::Cloud::Dlp::V2::InspectContentResponse
def 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/dlp/docs/inspecting-images and https://cloud.google.com/dlp/docs/inspecting-text,

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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) —
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) — 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) — The item to inspect.
inspect_template_name (::String) — 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) — Deprecated. This field has no effect.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::Dlp::V2::InspectContentResponse)
operation (::GRPC::ActiveCall::Operation)

Returns

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

Raises

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

Example

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::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

#list_deidentify_templates

def list_deidentify_templates(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dlp::V2::DeidentifyTemplate>
def list_deidentify_templates(parent: nil, page_token: nil, page_size: nil, order_by: nil, location_id: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dlp::V2::DeidentifyTemplate>

Lists DeidentifyTemplates. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.

Overloads

def list_deidentify_templates(request, options = nil) -> ::Gapic::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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def list_deidentify_templates(parent: nil, page_token: nil, page_size: nil, order_by: nil, location_id: nil) -> ::Gapic::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) —
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) — Page token to continue retrieval. Comes from previous call to ListDeidentifyTemplates.
page_size (::Integer) — Size of the page, can be limited by the server. If zero server returns a page of max size 100.
order_by (::String) —
Comma separated list of fields to order by, followed by asc or desc postfix. This list is case-insensitive, 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) — Deprecated. This field has no effect.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::PagedEnumerable<::Google::Cloud::Dlp::V2::DeidentifyTemplate>)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::PagedEnumerable<::Google::Cloud::Dlp::V2::DeidentifyTemplate>)

Raises

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

Example

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::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

#list_dlp_jobs

def list_dlp_jobs(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dlp::V2::DlpJob>
def list_dlp_jobs(parent: nil, filter: nil, page_size: nil, page_token: nil, type: nil, order_by: nil, location_id: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dlp::V2::DlpJob>

Lists DlpJobs that match the specified filter in the request. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more.

Overloads

def list_dlp_jobs(request, options = nil) -> ::Gapic::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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def list_dlp_jobs(parent: nil, filter: nil, page_size: nil, page_token: nil, type: nil, order_by: nil, location_id: nil) -> ::Gapic::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) —
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) — 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) — The standard list page size.
page_token (::String) — The standard list page token.
type (::Google::Cloud::Dlp::V2::DlpJobType) — The type of job. Defaults to DlpJobType.INSPECT
order_by (::String) —
Comma separated list of fields to order by, followed by asc or desc postfix. This list is case-insensitive, 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) — Deprecated. This field has no effect.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::PagedEnumerable<::Google::Cloud::Dlp::V2::DlpJob>)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::PagedEnumerable<::Google::Cloud::Dlp::V2::DlpJob>)

Raises

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

Example

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::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

#list_info_types

def list_info_types(request, options = nil) -> ::Google::Cloud::Dlp::V2::ListInfoTypesResponse
def 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/dlp/docs/infotypes-reference to learn more.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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) —
The parent resource name.

The format of this value is as follows:
```
locations/<var>LOCATION_ID</var>
```
language_code (::String) — 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) — filter to only return infoTypes supported by certain parts of the API. Defaults to supported_by=INSPECT.
location_id (::String) — Deprecated. This field has no effect.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::Dlp::V2::ListInfoTypesResponse)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::Dlp::V2::ListInfoTypesResponse)

Raises

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

Example

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::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

#list_inspect_templates

def list_inspect_templates(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dlp::V2::InspectTemplate>
def list_inspect_templates(parent: nil, page_token: nil, page_size: nil, order_by: nil, location_id: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dlp::V2::InspectTemplate>

Lists InspectTemplates. See https://cloud.google.com/dlp/docs/creating-templates to learn more.

Overloads

def list_inspect_templates(request, options = nil) -> ::Gapic::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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def list_inspect_templates(parent: nil, page_token: nil, page_size: nil, order_by: nil, location_id: nil) -> ::Gapic::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) —
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) — Page token to continue retrieval. Comes from previous call to ListInspectTemplates.
page_size (::Integer) — Size of the page, can be limited by the server. If zero server returns a page of max size 100.
order_by (::String) —
Comma separated list of fields to order by, followed by asc or desc postfix. This list is case-insensitive, 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) — Deprecated. This field has no effect.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::PagedEnumerable<::Google::Cloud::Dlp::V2::InspectTemplate>)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::PagedEnumerable<::Google::Cloud::Dlp::V2::InspectTemplate>)

Raises

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

Example

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::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

#list_job_triggers

def list_job_triggers(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dlp::V2::JobTrigger>
def list_job_triggers(parent: nil, page_token: nil, page_size: nil, order_by: nil, filter: nil, type: nil, location_id: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dlp::V2::JobTrigger>

Lists job triggers. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.

Overloads

def list_job_triggers(request, options = nil) -> ::Gapic::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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def list_job_triggers(parent: nil, page_token: nil, page_size: nil, order_by: nil, filter: nil, type: nil, location_id: nil) -> ::Gapic::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) —
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) — Page token to continue retrieval. Comes from previous call to ListJobTriggers. order_by field must not change for subsequent calls.
page_size (::Integer) — Size of the page, can be limited by a server.
order_by (::String) —
Comma separated list of triggeredJob fields to order by, followed by asc or desc postfix. This list is case-insensitive, 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) — 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) — The type of jobs. Will use DlpJobType.INSPECT if not set.
location_id (::String) — Deprecated. This field has no effect.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::PagedEnumerable<::Google::Cloud::Dlp::V2::JobTrigger>)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::PagedEnumerable<::Google::Cloud::Dlp::V2::JobTrigger>)

Raises

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

Example

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::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

#list_stored_info_types

def list_stored_info_types(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dlp::V2::StoredInfoType>
def list_stored_info_types(parent: nil, page_token: nil, page_size: nil, order_by: nil, location_id: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dlp::V2::StoredInfoType>

Lists stored infoTypes. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.

Overloads

def list_stored_info_types(request, options = nil) -> ::Gapic::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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def list_stored_info_types(parent: nil, page_token: nil, page_size: nil, order_by: nil, location_id: nil) -> ::Gapic::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) —
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) — Page token to continue retrieval. Comes from previous call to ListStoredInfoTypes.
page_size (::Integer) — Size of the page, can be limited by the server. If zero server returns a page of max size 100.
order_by (::String) —
Comma separated list of fields to order by, followed by asc or desc postfix. This list is case-insensitive, 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) — Deprecated. This field has no effect.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::PagedEnumerable<::Google::Cloud::Dlp::V2::StoredInfoType>)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::PagedEnumerable<::Google::Cloud::Dlp::V2::StoredInfoType>)

Raises

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

Example

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::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

#location_client

def location_client() -> Google::Cloud::Location::Locations::Client

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

Returns

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

#redact_image

def redact_image(request, options = nil) -> ::Google::Cloud::Dlp::V2::RedactImageResponse
def 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/dlp/docs/redacting-sensitive-data-images to learn more.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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) —
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) — Deprecated. This field has no effect.
inspect_config (::Google::Cloud::Dlp::V2::InspectConfig, ::Hash) — Configuration for the inspector.
image_redaction_configs (::Array<::Google::Cloud::Dlp::V2::RedactImageRequest::ImageRedactionConfig, ::Hash>) — The configuration for specifying what content to redact from images.
include_findings (::Boolean) — Whether the response should include findings along with the redacted image.
byte_item (::Google::Cloud::Dlp::V2::ByteContentItem, ::Hash) — The content must be PNG, JPEG, SVG or BMP.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::Dlp::V2::RedactImageResponse)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::Dlp::V2::RedactImageResponse)

Raises

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

Example

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::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

#reidentify_content

def reidentify_content(request, options = nil) -> ::Google::Cloud::Dlp::V2::ReidentifyContentResponse
def 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/dlp/docs/pseudonymization#re-identification_in_free_text_code_example to learn more.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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) —
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) —
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) — Configuration for the inspector.
item (::Google::Cloud::Dlp::V2::ContentItem, ::Hash) — The item to re-identify. Will be treated as text.
inspect_template_name (::String) — 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) — 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) — Deprecated. This field has no effect.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::Dlp::V2::ReidentifyContentResponse)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Google::Cloud::Dlp::V2::ReidentifyContentResponse)

Raises

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

Example

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::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

#update_deidentify_template

def update_deidentify_template(request, options = nil) -> ::Google::Cloud::Dlp::V2::DeidentifyTemplate
def update_deidentify_template(name: nil, deidentify_template: nil, update_mask: nil) -> ::Google::Cloud::Dlp::V2::DeidentifyTemplate

Updates the DeidentifyTemplate. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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) — 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) — New DeidentifyTemplate value.
update_mask (::Google::Protobuf::FieldMask, ::Hash) — Mask to control which fields get updated.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::Dlp::V2::DeidentifyTemplate)
operation (::GRPC::ActiveCall::Operation)

Returns

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

Raises

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

Example

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::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

#update_inspect_template

def update_inspect_template(request, options = nil) -> ::Google::Cloud::Dlp::V2::InspectTemplate
def update_inspect_template(name: nil, inspect_template: nil, update_mask: nil) -> ::Google::Cloud::Dlp::V2::InspectTemplate

Updates the InspectTemplate. See https://cloud.google.com/dlp/docs/creating-templates to learn more.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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) — 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) — New InspectTemplate value.
update_mask (::Google::Protobuf::FieldMask, ::Hash) — Mask to control which fields get updated.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::Dlp::V2::InspectTemplate)
operation (::GRPC::ActiveCall::Operation)

Returns

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

Raises

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

Example

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::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

#update_job_trigger

def update_job_trigger(request, options = nil) -> ::Google::Cloud::Dlp::V2::JobTrigger
def 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/dlp/docs/creating-job-triggers to learn more.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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) — 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) — New JobTrigger value.
update_mask (::Google::Protobuf::FieldMask, ::Hash) — Mask to control which fields get updated.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::Dlp::V2::JobTrigger)
operation (::GRPC::ActiveCall::Operation)

Returns

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

Raises

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

Example

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::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

#update_stored_info_type

def update_stored_info_type(request, options = nil) -> ::Google::Cloud::Dlp::V2::StoredInfoType
def 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/dlp/docs/creating-stored-infotypes to learn more.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

def 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) — 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) — 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) — Mask to control which fields get updated.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Google::Cloud::Dlp::V2::StoredInfoType)
operation (::GRPC::ActiveCall::Operation)

Returns

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

Raises

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

Example

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::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