Class: Google::Apis::DlpV2::DLPService

Inherits:
Core::BaseService show all
Defined in:
generated/google/apis/dlp_v2/service.rb

Overview

Cloud Data Loss Prevention (DLP) API

Provides methods for detection, risk analysis, and de-identification of privacy-sensitive fragments in text, images, and Google Cloud Platform storage repositories.

Examples:

require 'google/apis/dlp_v2'

Dlp = Google::Apis::DlpV2 # Alias the module
service = Dlp::DLPService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Core::Logging

#logger

Constructor Details

#initialize ⇒ DLPService

Returns a new instance of DLPService



47
48
49
50
 
# File 'generated/google/apis/dlp_v2/service.rb', line 47

def initialize
  super('https://dlp.googleapis.com/', '')
  @batch_path = 'batch'
end

Instance Attribute Details

#key ⇒ String

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

  • (String) —

    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.



40
41
42
 
# File 'generated/google/apis/dlp_v2/service.rb', line 40

def key
  @key
end

#quota_user ⇒ String

Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Returns:

  • (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.



45
46
47
 
# File 'generated/google/apis/dlp_v2/service.rb', line 45

def quota_user
  @quota_user
end

Instance Method Details

#cancel_project_dlp_job(name, google_privacy_dlp_v2_cancel_dlp_job_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DlpV2::GoogleProtobufEmpty

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.

Parameters:

  • name (String) —

    The name of the DlpJob resource to be cancelled.

  • google_privacy_dlp_v2_cancel_dlp_job_request_object (Google::Apis::DlpV2::GooglePrivacyDlpV2CancelDlpJobRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



774
775
776
777
778
779
780
781
782
783
784
 
# File 'generated/google/apis/dlp_v2/service.rb', line 774

def cancel_project_dlp_job(name, google_privacy_dlp_v2_cancel_dlp_job_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v2/{+name}:cancel', options)
  command.request_representation = Google::Apis::DlpV2::GooglePrivacyDlpV2CancelDlpJobRequest::Representation
  command.request_object = google_privacy_dlp_v2_cancel_dlp_job_request_object
  command.response_representation = Google::Apis::DlpV2::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::DlpV2::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_organization_deidentify_template(parent, google_privacy_dlp_v2_create_deidentify_template_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DlpV2::GooglePrivacyDlpV2DeidentifyTemplate

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

Parameters:

  • parent (String) —

    The parent resource name, for example projects/my-project-id or organizations/my-org-id.

  • google_privacy_dlp_v2_create_deidentify_template_request_object (Google::Apis::DlpV2::GooglePrivacyDlpV2CreateDeidentifyTemplateRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



115
116
117
118
119
120
121
122
123
124
125
 
# File 'generated/google/apis/dlp_v2/service.rb', line 115

def create_organization_deidentify_template(parent, google_privacy_dlp_v2_create_deidentify_template_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v2/{+parent}/deidentifyTemplates', options)
  command.request_representation = Google::Apis::DlpV2::GooglePrivacyDlpV2CreateDeidentifyTemplateRequest::Representation
  command.request_object = google_privacy_dlp_v2_create_deidentify_template_request_object
  command.response_representation = Google::Apis::DlpV2::GooglePrivacyDlpV2DeidentifyTemplate::Representation
  command.response_class = Google::Apis::DlpV2::GooglePrivacyDlpV2DeidentifyTemplate
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_organization_inspect_template(parent, google_privacy_dlp_v2_create_inspect_template_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DlpV2::GooglePrivacyDlpV2InspectTemplate

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

Parameters:

  • parent (String) —

    The parent resource name, for example projects/my-project-id or organizations/my-org-id.

  • google_privacy_dlp_v2_create_inspect_template_request_object (Google::Apis::DlpV2::GooglePrivacyDlpV2CreateInspectTemplateRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



297
298
299
300
301
302
303
304
305
306
307
 
# File 'generated/google/apis/dlp_v2/service.rb', line 297

def create_organization_inspect_template(parent, google_privacy_dlp_v2_create_inspect_template_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v2/{+parent}/inspectTemplates', options)
  command.request_representation = Google::Apis::DlpV2::GooglePrivacyDlpV2CreateInspectTemplateRequest::Representation
  command.request_object = google_privacy_dlp_v2_create_inspect_template_request_object
  command.response_representation = Google::Apis::DlpV2::GooglePrivacyDlpV2InspectTemplate::Representation
  command.response_class = Google::Apis::DlpV2::GooglePrivacyDlpV2InspectTemplate
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_deidentify_template(parent, google_privacy_dlp_v2_create_deidentify_template_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DlpV2::GooglePrivacyDlpV2DeidentifyTemplate

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

Parameters:

  • parent (String) —

    The parent resource name, for example projects/my-project-id or organizations/my-org-id.

  • google_privacy_dlp_v2_create_deidentify_template_request_object (Google::Apis::DlpV2::GooglePrivacyDlpV2CreateDeidentifyTemplateRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



591
592
593
594
595
596
597
598
599
600
601
 
# File 'generated/google/apis/dlp_v2/service.rb', line 591

def create_project_deidentify_template(parent, google_privacy_dlp_v2_create_deidentify_template_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v2/{+parent}/deidentifyTemplates', options)
  command.request_representation = Google::Apis::DlpV2::GooglePrivacyDlpV2CreateDeidentifyTemplateRequest::Representation
  command.request_object = google_privacy_dlp_v2_create_deidentify_template_request_object
  command.response_representation = Google::Apis::DlpV2::GooglePrivacyDlpV2DeidentifyTemplate::Representation
  command.response_class = Google::Apis::DlpV2::GooglePrivacyDlpV2DeidentifyTemplate
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_dlp_job(parent, google_privacy_dlp_v2_create_dlp_job_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DlpV2::GooglePrivacyDlpV2DlpJob

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.

Parameters:

  • parent (String) —

    The parent resource name, for example projects/my-project-id.

  • google_privacy_dlp_v2_create_dlp_job_request_object (Google::Apis::DlpV2::GooglePrivacyDlpV2CreateDlpJobRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



812
813
814
815
816
817
818
819
820
821
822
 
# File 'generated/google/apis/dlp_v2/service.rb', line 812

def create_project_dlp_job(parent, google_privacy_dlp_v2_create_dlp_job_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v2/{+parent}/dlpJobs', options)
  command.request_representation = Google::Apis::DlpV2::GooglePrivacyDlpV2CreateDlpJobRequest::Representation
  command.request_object = google_privacy_dlp_v2_create_dlp_job_request_object
  command.response_representation = Google::Apis::DlpV2::GooglePrivacyDlpV2DlpJob::Representation
  command.response_class = Google::Apis::DlpV2::GooglePrivacyDlpV2DlpJob
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_inspect_template(parent, google_privacy_dlp_v2_create_inspect_template_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DlpV2::GooglePrivacyDlpV2InspectTemplate

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

Parameters:

  • parent (String) —

    The parent resource name, for example projects/my-project-id or organizations/my-org-id.

  • google_privacy_dlp_v2_create_inspect_template_request_object (Google::Apis::DlpV2::GooglePrivacyDlpV2CreateInspectTemplateRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
 
# File 'generated/google/apis/dlp_v2/service.rb', line 1014

def create_project_inspect_template(parent, google_privacy_dlp_v2_create_inspect_template_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v2/{+parent}/inspectTemplates', options)
  command.request_representation = Google::Apis::DlpV2::GooglePrivacyDlpV2CreateInspectTemplateRequest::Representation
  command.request_object = google_privacy_dlp_v2_create_inspect_template_request_object
  command.response_representation = Google::Apis::DlpV2::GooglePrivacyDlpV2InspectTemplate::Representation
  command.response_class = Google::Apis::DlpV2::GooglePrivacyDlpV2InspectTemplate
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_job_trigger(parent, google_privacy_dlp_v2_create_job_trigger_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DlpV2::GooglePrivacyDlpV2JobTrigger

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.

Parameters:

  • parent (String) —

    The parent resource name, for example projects/my-project-id.

  • google_privacy_dlp_v2_create_job_trigger_request_object (Google::Apis::DlpV2::GooglePrivacyDlpV2CreateJobTriggerRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
 
# File 'generated/google/apis/dlp_v2/service.rb', line 1191

def create_project_job_trigger(parent, google_privacy_dlp_v2_create_job_trigger_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v2/{+parent}/jobTriggers', options)
  command.request_representation = Google::Apis::DlpV2::GooglePrivacyDlpV2CreateJobTriggerRequest::Representation
  command.request_object = google_privacy_dlp_v2_create_job_trigger_request_object
  command.response_representation = Google::Apis::DlpV2::GooglePrivacyDlpV2JobTrigger::Representation
  command.response_class = Google::Apis::DlpV2::GooglePrivacyDlpV2JobTrigger
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#deidentify_project_content(parent, google_privacy_dlp_v2_deidentify_content_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DlpV2::GooglePrivacyDlpV2DeidentifyContentResponse

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.

Parameters:

  • parent (String) —

    The parent resource name, for example projects/my-project-id.

  • google_privacy_dlp_v2_deidentify_content_request_object (Google::Apis::DlpV2::GooglePrivacyDlpV2DeidentifyContentRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



478
479
480
481
482
483
484
485
486
487
488
 
# File 'generated/google/apis/dlp_v2/service.rb', line 478

def deidentify_project_content(parent, google_privacy_dlp_v2_deidentify_content_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v2/{+parent}/content:deidentify', options)
  command.request_representation = Google::Apis::DlpV2::GooglePrivacyDlpV2DeidentifyContentRequest::Representation
  command.request_object = google_privacy_dlp_v2_deidentify_content_request_object
  command.response_representation = Google::Apis::DlpV2::GooglePrivacyDlpV2DeidentifyContentResponse::Representation
  command.response_class = Google::Apis::DlpV2::GooglePrivacyDlpV2DeidentifyContentResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_organization_deidentify_template(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DlpV2::GoogleProtobufEmpty

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

Parameters:

  • name (String) —

    Resource name of the organization and deidentify template to be deleted, for example organizations/433245324/deidentifyTemplates/432452342 or projects/project-id/deidentifyTemplates/432452342.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



151
152
153
154
155
156
157
158
159
 
# File 'generated/google/apis/dlp_v2/service.rb', line 151

def delete_organization_deidentify_template(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'v2/{+name}', options)
  command.response_representation = Google::Apis::DlpV2::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::DlpV2::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_organization_inspect_template(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DlpV2::GoogleProtobufEmpty

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

Parameters:

  • name (String) —

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

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



332
333
334
335
336
337
338
339
340
 
# File 'generated/google/apis/dlp_v2/service.rb', line 332

def delete_organization_inspect_template(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'v2/{+name}', options)
  command.response_representation = Google::Apis::DlpV2::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::DlpV2::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_deidentify_template(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DlpV2::GoogleProtobufEmpty

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

Parameters:

  • name (String) —

    Resource name of the organization and deidentify template to be deleted, for example organizations/433245324/deidentifyTemplates/432452342 or projects/project-id/deidentifyTemplates/432452342.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



627
628
629
630
631
632
633
634
635
 
# File 'generated/google/apis/dlp_v2/service.rb', line 627

def delete_project_deidentify_template(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'v2/{+name}', options)
  command.response_representation = Google::Apis::DlpV2::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::DlpV2::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_dlp_job(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DlpV2::GoogleProtobufEmpty

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

Parameters:

  • name (String) —

    The name of the DlpJob resource to be deleted.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



848
849
850
851
852
853
854
855
856
 
# File 'generated/google/apis/dlp_v2/service.rb', line 848

def delete_project_dlp_job(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'v2/{+name}', options)
  command.response_representation = Google::Apis::DlpV2::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::DlpV2::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_inspect_template(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DlpV2::GoogleProtobufEmpty

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

Parameters:

  • name (String) —

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

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1049
1050
1051
1052
1053
1054
1055
1056
1057
 
# File 'generated/google/apis/dlp_v2/service.rb', line 1049

def delete_project_inspect_template(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'v2/{+name}', options)
  command.response_representation = Google::Apis::DlpV2::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::DlpV2::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_job_trigger(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DlpV2::GoogleProtobufEmpty

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

Parameters:

  • name (String) —

    Resource name of the project and the triggeredJob, for example projects/dlp-test-project/jobTriggers/53234423.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1225
1226
1227
1228
1229
1230
1231
1232
1233
 
# File 'generated/google/apis/dlp_v2/service.rb', line 1225

def delete_project_job_trigger(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'v2/{+name}', options)
  command.response_representation = Google::Apis::DlpV2::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::DlpV2::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_organization_deidentify_template(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DlpV2::GooglePrivacyDlpV2DeidentifyTemplate

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

Parameters:

  • name (String) —

    Resource name of the organization and deidentify template to be read, for example organizations/433245324/deidentifyTemplates/432452342 or projects/project-id/deidentifyTemplates/432452342.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



185
186
187
188
189
190
191
192
193
 
# File 'generated/google/apis/dlp_v2/service.rb', line 185

def get_organization_deidentify_template(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v2/{+name}', options)
  command.response_representation = Google::Apis::DlpV2::GooglePrivacyDlpV2DeidentifyTemplate::Representation
  command.response_class = Google::Apis::DlpV2::GooglePrivacyDlpV2DeidentifyTemplate
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_organization_inspect_template(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DlpV2::GooglePrivacyDlpV2InspectTemplate

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

Parameters:

  • name (String) —

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

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



365
366
367
368
369
370
371
372
373
 
# File 'generated/google/apis/dlp_v2/service.rb', line 365

def get_organization_inspect_template(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v2/{+name}', options)
  command.response_representation = Google::Apis::DlpV2::GooglePrivacyDlpV2InspectTemplate::Representation
  command.response_class = Google::Apis::DlpV2::GooglePrivacyDlpV2InspectTemplate
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_deidentify_template(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DlpV2::GooglePrivacyDlpV2DeidentifyTemplate

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

Parameters:

  • name (String) —

    Resource name of the organization and deidentify template to be read, for example organizations/433245324/deidentifyTemplates/432452342 or projects/project-id/deidentifyTemplates/432452342.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



661
662
663
664
665
666
667
668
669
 
# File 'generated/google/apis/dlp_v2/service.rb', line 661

def get_project_deidentify_template(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v2/{+name}', options)
  command.response_representation = Google::Apis::DlpV2::GooglePrivacyDlpV2DeidentifyTemplate::Representation
  command.response_class = Google::Apis::DlpV2::GooglePrivacyDlpV2DeidentifyTemplate
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_dlp_job(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DlpV2::GooglePrivacyDlpV2DlpJob

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.

Parameters:

  • name (String) —

    The name of the DlpJob resource.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



880
881
882
883
884
885
886
887
888
 
# File 'generated/google/apis/dlp_v2/service.rb', line 880

def get_project_dlp_job(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v2/{+name}', options)
  command.response_representation = Google::Apis::DlpV2::GooglePrivacyDlpV2DlpJob::Representation
  command.response_class = Google::Apis::DlpV2::GooglePrivacyDlpV2DlpJob
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_inspect_template(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DlpV2::GooglePrivacyDlpV2InspectTemplate

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

Parameters:

  • name (String) —

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

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1082
1083
1084
1085
1086
1087
1088
1089
1090
 
# File 'generated/google/apis/dlp_v2/service.rb', line 1082

def get_project_inspect_template(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v2/{+name}', options)
  command.response_representation = Google::Apis::DlpV2::GooglePrivacyDlpV2InspectTemplate::Representation
  command.response_class = Google::Apis::DlpV2::GooglePrivacyDlpV2InspectTemplate
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_job_trigger(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DlpV2::GooglePrivacyDlpV2JobTrigger

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

Parameters:

  • name (String) —

    Resource name of the project and the triggeredJob, for example projects/dlp-test-project/jobTriggers/53234423.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1257
1258
1259
1260
1261
1262
1263
1264
1265
 
# File 'generated/google/apis/dlp_v2/service.rb', line 1257

def get_project_job_trigger(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v2/{+name}', options)
  command.response_representation = Google::Apis::DlpV2::GooglePrivacyDlpV2JobTrigger::Representation
  command.response_class = Google::Apis::DlpV2::GooglePrivacyDlpV2JobTrigger
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#inspect_project_content(parent, google_privacy_dlp_v2_inspect_content_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DlpV2::GooglePrivacyDlpV2InspectContentResponse

Finds potentially sensitive info in content. This method has limits on input size, processing time, and output size. 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. For how to guides, see https://cloud.google.com/dlp/docs/inspecting-images and https://cloud.google.com/dlp/docs/inspecting-text,

Parameters:

  • parent (String) —

    The parent resource name, for example projects/my-project-id.

  • google_privacy_dlp_v2_inspect_content_request_object (Google::Apis::DlpV2::GooglePrivacyDlpV2InspectContentRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



517
518
519
520
521
522
523
524
525
526
527
 
# File 'generated/google/apis/dlp_v2/service.rb', line 517

def inspect_project_content(parent, google_privacy_dlp_v2_inspect_content_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v2/{+parent}/content:inspect', options)
  command.request_representation = Google::Apis::DlpV2::GooglePrivacyDlpV2InspectContentRequest::Representation
  command.request_object = google_privacy_dlp_v2_inspect_content_request_object
  command.response_representation = Google::Apis::DlpV2::GooglePrivacyDlpV2InspectContentResponse::Representation
  command.response_class = Google::Apis::DlpV2::GooglePrivacyDlpV2InspectContentResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_info_types(filter: nil, language_code: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DlpV2::GooglePrivacyDlpV2ListInfoTypesResponse

Returns a list of the sensitive information types that the DLP API supports. See https://cloud.google.com/dlp/docs/infotypes-reference to learn more.

Parameters:

  • filter (String) —

    Optional filter to only return infoTypes supported by certain parts of the API. Defaults to supported_by=INSPECT.

  • language_code (String) —

    Optional BCP-47 language code for localized infoType friendly names. If omitted, or if localized strings are not available, en-US strings will be returned.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



79
80
81
82
83
84
85
86
87
88
 
# File 'generated/google/apis/dlp_v2/service.rb', line 79

def list_info_types(filter: nil, language_code: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v2/infoTypes', options)
  command.response_representation = Google::Apis::DlpV2::GooglePrivacyDlpV2ListInfoTypesResponse::Representation
  command.response_class = Google::Apis::DlpV2::GooglePrivacyDlpV2ListInfoTypesResponse
  command.query['filter'] = filter unless filter.nil?
  command.query['languageCode'] = language_code unless language_code.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_organization_deidentify_templates(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DlpV2::GooglePrivacyDlpV2ListDeidentifyTemplatesResponse

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

Parameters:

  • parent (String) —

    The parent resource name, for example projects/my-project-id or organizations/my-org-id.

  • page_size (Fixnum) —

    Optional size of the page, can be limited by server. If zero server returns a page of max size 100.

  • page_token (String) —

    Optional page token to continue retrieval. Comes from previous call to ListDeidentifyTemplates.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



224
225
226
227
228
229
230
231
232
233
234
 
# File 'generated/google/apis/dlp_v2/service.rb', line 224

def list_organization_deidentify_templates(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v2/{+parent}/deidentifyTemplates', options)
  command.response_representation = Google::Apis::DlpV2::GooglePrivacyDlpV2ListDeidentifyTemplatesResponse::Representation
  command.response_class = Google::Apis::DlpV2::GooglePrivacyDlpV2ListDeidentifyTemplatesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_organization_inspect_templates(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DlpV2::GooglePrivacyDlpV2ListInspectTemplatesResponse

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

Parameters:

  • parent (String) —

    The parent resource name, for example projects/my-project-id or organizations/my-org-id.

  • page_size (Fixnum) —

    Optional size of the page, can be limited by server. If zero server returns a page of max size 100.

  • page_token (String) —

    Optional page token to continue retrieval. Comes from previous call to ListInspectTemplates.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



403
404
405
406
407
408
409
410
411
412
413
 
# File 'generated/google/apis/dlp_v2/service.rb', line 403

def list_organization_inspect_templates(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v2/{+parent}/inspectTemplates', options)
  command.response_representation = Google::Apis::DlpV2::GooglePrivacyDlpV2ListInspectTemplatesResponse::Representation
  command.response_class = Google::Apis::DlpV2::GooglePrivacyDlpV2ListInspectTemplatesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_deidentify_templates(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DlpV2::GooglePrivacyDlpV2ListDeidentifyTemplatesResponse

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

Parameters:

  • parent (String) —

    The parent resource name, for example projects/my-project-id or organizations/my-org-id.

  • page_size (Fixnum) —

    Optional size of the page, can be limited by server. If zero server returns a page of max size 100.

  • page_token (String) —

    Optional page token to continue retrieval. Comes from previous call to ListDeidentifyTemplates.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



700
701
702
703
704
705
706
707
708
709
710
 
# File 'generated/google/apis/dlp_v2/service.rb', line 700

def list_project_deidentify_templates(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v2/{+parent}/deidentifyTemplates', options)
  command.response_representation = Google::Apis::DlpV2::GooglePrivacyDlpV2ListDeidentifyTemplatesResponse::Representation
  command.response_class = Google::Apis::DlpV2::GooglePrivacyDlpV2ListDeidentifyTemplatesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_dlp_jobs(parent, filter: nil, page_size: nil, page_token: nil, type: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DlpV2::GooglePrivacyDlpV2ListDlpJobsResponse

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.

Parameters:

  • parent (String) —

    The parent resource name, for example projects/my-project-id.

  • filter (String) —

    Optional. Allows filtering. Supported syntax:

    • Filter expressions are made up of one or more restrictions.
    • Restrictions can be combined by AND or OR logical operators. A sequence of restrictions implicitly uses AND.
    • A restriction has the form of <field> <operator> <value>.
    • Supported fields/values for inspect jobs:
    • state - PENDING|RUNNING|CANCELED|FINISHED|FAILED
    • inspected_storage - DATASTORE|CLOUD_STORAGE|BIGQUERY
    • trigger_name - The resource name of the trigger that created job.
    • Supported fields for risk analysis jobs:
    • state - RUNNING|CANCELED|FINISHED|FAILED
    • 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) The length of this field should be no more than 500 characters.
  • page_size (Fixnum) —

    The standard list page size.

  • page_token (String) —

    The standard list page token.

  • type (String) —

    The type of job. Defaults to DlpJobType.INSPECT

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



937
938
939
940
941
942
943
944
945
946
947
948
949
 
# File 'generated/google/apis/dlp_v2/service.rb', line 937

def list_project_dlp_jobs(parent, filter: nil, page_size: nil, page_token: nil, type: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v2/{+parent}/dlpJobs', options)
  command.response_representation = Google::Apis::DlpV2::GooglePrivacyDlpV2ListDlpJobsResponse::Representation
  command.response_class = Google::Apis::DlpV2::GooglePrivacyDlpV2ListDlpJobsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['type'] = type unless type.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_inspect_templates(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DlpV2::GooglePrivacyDlpV2ListInspectTemplatesResponse

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

Parameters:

  • parent (String) —

    The parent resource name, for example projects/my-project-id or organizations/my-org-id.

  • page_size (Fixnum) —

    Optional size of the page, can be limited by server. If zero server returns a page of max size 100.

  • page_token (String) —

    Optional page token to continue retrieval. Comes from previous call to ListInspectTemplates.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
 
# File 'generated/google/apis/dlp_v2/service.rb', line 1120

def list_project_inspect_templates(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v2/{+parent}/inspectTemplates', options)
  command.response_representation = Google::Apis::DlpV2::GooglePrivacyDlpV2ListInspectTemplatesResponse::Representation
  command.response_class = Google::Apis::DlpV2::GooglePrivacyDlpV2ListInspectTemplatesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_job_triggers(parent, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DlpV2::GooglePrivacyDlpV2ListJobTriggersResponse

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

Parameters:

  • parent (String) —

    The parent resource name, for example projects/my-project-id.

  • order_by (String) —

    Optional 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 time the triggeredJob was created.
    • update_time: corresponds to time the triggeredJob was last updated.
    • name: corresponds to JobTrigger's name.
  • page_size (Fixnum) —

    Optional size of the page, can be limited by a server.

  • page_token (String) —

    Optional page token to continue retrieval. Comes from previous call to ListJobTriggers. order_by field must not change for subsequent calls.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
 
# File 'generated/google/apis/dlp_v2/service.rb', line 1304

def list_project_job_triggers(parent, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v2/{+parent}/jobTriggers', options)
  command.response_representation = Google::Apis::DlpV2::GooglePrivacyDlpV2ListJobTriggersResponse::Representation
  command.response_class = Google::Apis::DlpV2::GooglePrivacyDlpV2ListJobTriggersResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_organization_deidentify_template(name, google_privacy_dlp_v2_update_deidentify_template_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DlpV2::GooglePrivacyDlpV2DeidentifyTemplate

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

Parameters:

  • name (String) —

    Resource name of organization and deidentify template to be updated, for example organizations/433245324/deidentifyTemplates/432452342 or projects/project-id/deidentifyTemplates/432452342.

  • google_privacy_dlp_v2_update_deidentify_template_request_object (Google::Apis::DlpV2::GooglePrivacyDlpV2UpdateDeidentifyTemplateRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



261
262
263
264
265
266
267
268
269
270
271
 
# File 'generated/google/apis/dlp_v2/service.rb', line 261

def patch_organization_deidentify_template(name, google_privacy_dlp_v2_update_deidentify_template_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'v2/{+name}', options)
  command.request_representation = Google::Apis::DlpV2::GooglePrivacyDlpV2UpdateDeidentifyTemplateRequest::Representation
  command.request_object = google_privacy_dlp_v2_update_deidentify_template_request_object
  command.response_representation = Google::Apis::DlpV2::GooglePrivacyDlpV2DeidentifyTemplate::Representation
  command.response_class = Google::Apis::DlpV2::GooglePrivacyDlpV2DeidentifyTemplate
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_organization_inspect_template(name, google_privacy_dlp_v2_update_inspect_template_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DlpV2::GooglePrivacyDlpV2InspectTemplate

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

Parameters:

  • name (String) —

    Resource name of organization and inspectTemplate to be updated, for example organizations/433245324/inspectTemplates/432452342 or projects/project-id/inspectTemplates/432452342.

  • google_privacy_dlp_v2_update_inspect_template_request_object (Google::Apis::DlpV2::GooglePrivacyDlpV2UpdateInspectTemplateRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



439
440
441
442
443
444
445
446
447
448
449
 
# File 'generated/google/apis/dlp_v2/service.rb', line 439

def patch_organization_inspect_template(name, google_privacy_dlp_v2_update_inspect_template_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'v2/{+name}', options)
  command.request_representation = Google::Apis::DlpV2::GooglePrivacyDlpV2UpdateInspectTemplateRequest::Representation
  command.request_object = google_privacy_dlp_v2_update_inspect_template_request_object
  command.response_representation = Google::Apis::DlpV2::GooglePrivacyDlpV2InspectTemplate::Representation
  command.response_class = Google::Apis::DlpV2::GooglePrivacyDlpV2InspectTemplate
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_deidentify_template(name, google_privacy_dlp_v2_update_deidentify_template_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DlpV2::GooglePrivacyDlpV2DeidentifyTemplate

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

Parameters:

  • name (String) —

    Resource name of organization and deidentify template to be updated, for example organizations/433245324/deidentifyTemplates/432452342 or projects/project-id/deidentifyTemplates/432452342.

  • google_privacy_dlp_v2_update_deidentify_template_request_object (Google::Apis::DlpV2::GooglePrivacyDlpV2UpdateDeidentifyTemplateRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



737
738
739
740
741
742
743
744
745
746
747
 
# File 'generated/google/apis/dlp_v2/service.rb', line 737

def patch_project_deidentify_template(name, google_privacy_dlp_v2_update_deidentify_template_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'v2/{+name}', options)
  command.request_representation = Google::Apis::DlpV2::GooglePrivacyDlpV2UpdateDeidentifyTemplateRequest::Representation
  command.request_object = google_privacy_dlp_v2_update_deidentify_template_request_object
  command.response_representation = Google::Apis::DlpV2::GooglePrivacyDlpV2DeidentifyTemplate::Representation
  command.response_class = Google::Apis::DlpV2::GooglePrivacyDlpV2DeidentifyTemplate
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_inspect_template(name, google_privacy_dlp_v2_update_inspect_template_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DlpV2::GooglePrivacyDlpV2InspectTemplate

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

Parameters:

  • name (String) —

    Resource name of organization and inspectTemplate to be updated, for example organizations/433245324/inspectTemplates/432452342 or projects/project-id/inspectTemplates/432452342.

  • google_privacy_dlp_v2_update_inspect_template_request_object (Google::Apis::DlpV2::GooglePrivacyDlpV2UpdateInspectTemplateRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
 
# File 'generated/google/apis/dlp_v2/service.rb', line 1156

def patch_project_inspect_template(name, google_privacy_dlp_v2_update_inspect_template_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'v2/{+name}', options)
  command.request_representation = Google::Apis::DlpV2::GooglePrivacyDlpV2UpdateInspectTemplateRequest::Representation
  command.request_object = google_privacy_dlp_v2_update_inspect_template_request_object
  command.response_representation = Google::Apis::DlpV2::GooglePrivacyDlpV2InspectTemplate::Representation
  command.response_class = Google::Apis::DlpV2::GooglePrivacyDlpV2InspectTemplate
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_job_trigger(name, google_privacy_dlp_v2_update_job_trigger_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DlpV2::GooglePrivacyDlpV2JobTrigger

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

Parameters:

  • name (String) —

    Resource name of the project and the triggeredJob, for example projects/dlp-test-project/jobTriggers/53234423.

  • google_privacy_dlp_v2_update_job_trigger_request_object (Google::Apis::DlpV2::GooglePrivacyDlpV2UpdateJobTriggerRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
 
# File 'generated/google/apis/dlp_v2/service.rb', line 1340

def patch_project_job_trigger(name, google_privacy_dlp_v2_update_job_trigger_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'v2/{+name}', options)
  command.request_representation = Google::Apis::DlpV2::GooglePrivacyDlpV2UpdateJobTriggerRequest::Representation
  command.request_object = google_privacy_dlp_v2_update_job_trigger_request_object
  command.response_representation = Google::Apis::DlpV2::GooglePrivacyDlpV2JobTrigger::Representation
  command.response_class = Google::Apis::DlpV2::GooglePrivacyDlpV2JobTrigger
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#redact_project_image(parent, google_privacy_dlp_v2_redact_image_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DlpV2::GooglePrivacyDlpV2RedactImageResponse

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

Parameters:

  • parent (String) —

    The parent resource name, for example projects/my-project-id.

  • google_privacy_dlp_v2_redact_image_request_object (Google::Apis::DlpV2::GooglePrivacyDlpV2RedactImageRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



978
979
980
981
982
983
984
985
986
987
988
 
# File 'generated/google/apis/dlp_v2/service.rb', line 978

def redact_project_image(parent, google_privacy_dlp_v2_redact_image_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v2/{+parent}/image:redact', options)
  command.request_representation = Google::Apis::DlpV2::GooglePrivacyDlpV2RedactImageRequest::Representation
  command.request_object = google_privacy_dlp_v2_redact_image_request_object
  command.response_representation = Google::Apis::DlpV2::GooglePrivacyDlpV2RedactImageResponse::Representation
  command.response_class = Google::Apis::DlpV2::GooglePrivacyDlpV2RedactImageResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#reidentify_project_content(parent, google_privacy_dlp_v2_reidentify_content_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DlpV2::GooglePrivacyDlpV2ReidentifyContentResponse

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.

Parameters:

  • parent (String) —

    The parent resource name.

  • google_privacy_dlp_v2_reidentify_content_request_object (Google::Apis::DlpV2::GooglePrivacyDlpV2ReidentifyContentRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



554
555
556
557
558
559
560
561
562
563
564
 
# File 'generated/google/apis/dlp_v2/service.rb', line 554

def reidentify_project_content(parent, google_privacy_dlp_v2_reidentify_content_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v2/{+parent}/content:reidentify', options)
  command.request_representation = Google::Apis::DlpV2::GooglePrivacyDlpV2ReidentifyContentRequest::Representation
  command.request_object = google_privacy_dlp_v2_reidentify_content_request_object
  command.response_representation = Google::Apis::DlpV2::GooglePrivacyDlpV2ReidentifyContentResponse::Representation
  command.response_class = Google::Apis::DlpV2::GooglePrivacyDlpV2ReidentifyContentResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end