Class: Google::Apis::DlpV2beta2::DLPService

Inherits:
Core::BaseService show all
Defined in:
generated/google/apis/dlp_v2beta2/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_v2beta2'

Dlp = Google::Apis::DlpV2beta2 # 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_v2beta2/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_v2beta2/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_v2beta2/service.rb', line 45

def quota_user
  @quota_user
end

Instance Method Details

#analyze_project_data_source(parent, google_privacy_dlp_v2beta2_analyze_data_source_risk_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DlpJob

Schedules a job to compute risk analysis metrics over content in a Google Cloud Platform repository. How-to guide

Parameters:

  • parent (String) —

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

  • google_privacy_dlp_v2beta2_analyze_data_source_risk_request_object (Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2AnalyzeDataSourceRiskRequest) (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:



560
561
562
563
564
565
566
567
568
569
570
 
# File 'generated/google/apis/dlp_v2beta2/service.rb', line 560

def analyze_project_data_source(parent, google_privacy_dlp_v2beta2_analyze_data_source_risk_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v2beta2/{+parent}/dataSource:analyze', options)
  command.request_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2AnalyzeDataSourceRiskRequest::Representation
  command.request_object = google_privacy_dlp_v2beta2_analyze_data_source_risk_request_object
  command.response_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DlpJob::Representation
  command.response_class = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DlpJob
  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

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

Starts asynchronous cancellation on a long-running DlpJob. The server makes a best effort to cancel the DlpJob, but success is not guaranteed.

Parameters:

  • name (String) —

    The name of the DlpJob resource to be cancelled.

  • google_privacy_dlp_v2beta2_cancel_dlp_job_request_object (Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2CancelDlpJobRequest) (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:



802
803
804
805
806
807
808
809
810
811
812
 
# File 'generated/google/apis/dlp_v2beta2/service.rb', line 802

def cancel_project_dlp_job(name, google_privacy_dlp_v2beta2_cancel_dlp_job_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v2beta2/{+name}:cancel', options)
  command.request_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2CancelDlpJobRequest::Representation
  command.request_object = google_privacy_dlp_v2beta2_cancel_dlp_job_request_object
  command.response_representation = Google::Apis::DlpV2beta2::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::DlpV2beta2::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_v2beta2_create_deidentify_template_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DeidentifyTemplate

Creates an Deidentify template for re-using frequently used configuration for Deidentifying content, images, and storage.

Parameters:

  • parent (String) —

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

  • google_privacy_dlp_v2beta2_create_deidentify_template_request_object (Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2CreateDeidentifyTemplateRequest) (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:



111
112
113
114
115
116
117
118
119
120
121
 
# File 'generated/google/apis/dlp_v2beta2/service.rb', line 111

def create_organization_deidentify_template(parent, google_privacy_dlp_v2beta2_create_deidentify_template_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v2beta2/{+parent}/deidentifyTemplates', options)
  command.request_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2CreateDeidentifyTemplateRequest::Representation
  command.request_object = google_privacy_dlp_v2beta2_create_deidentify_template_request_object
  command.response_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DeidentifyTemplate::Representation
  command.response_class = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DeidentifyTemplate
  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_v2beta2_create_inspect_template_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectTemplate

Creates an inspect template for re-using frequently used configuration for inspecting content, images, and storage.

Parameters:

  • parent (String) —

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

  • google_privacy_dlp_v2beta2_create_inspect_template_request_object (Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2CreateInspectTemplateRequest) (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:



284
285
286
287
288
289
290
291
292
293
294
 
# File 'generated/google/apis/dlp_v2beta2/service.rb', line 284

def create_organization_inspect_template(parent, google_privacy_dlp_v2beta2_create_inspect_template_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v2beta2/{+parent}/inspectTemplates', options)
  command.request_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2CreateInspectTemplateRequest::Representation
  command.request_object = google_privacy_dlp_v2beta2_create_inspect_template_request_object
  command.response_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectTemplate::Representation
  command.response_class = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectTemplate
  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_v2beta2_create_deidentify_template_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DeidentifyTemplate

Creates an Deidentify template for re-using frequently used configuration for Deidentifying content, images, and storage.

Parameters:

  • parent (String) —

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

  • google_privacy_dlp_v2beta2_create_deidentify_template_request_object (Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2CreateDeidentifyTemplateRequest) (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:



629
630
631
632
633
634
635
636
637
638
639
 
# File 'generated/google/apis/dlp_v2beta2/service.rb', line 629

def create_project_deidentify_template(parent, google_privacy_dlp_v2beta2_create_deidentify_template_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v2beta2/{+parent}/deidentifyTemplates', options)
  command.request_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2CreateDeidentifyTemplateRequest::Representation
  command.request_object = google_privacy_dlp_v2beta2_create_deidentify_template_request_object
  command.response_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DeidentifyTemplate::Representation
  command.response_class = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DeidentifyTemplate
  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_v2beta2_create_inspect_template_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectTemplate

Creates an inspect template for re-using frequently used configuration for inspecting content, images, and storage.

Parameters:

  • parent (String) —

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

  • google_privacy_dlp_v2beta2_create_inspect_template_request_object (Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2CreateInspectTemplateRequest) (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:



993
994
995
996
997
998
999
1000
1001
1002
1003
 
# File 'generated/google/apis/dlp_v2beta2/service.rb', line 993

def create_project_inspect_template(parent, google_privacy_dlp_v2beta2_create_inspect_template_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v2beta2/{+parent}/inspectTemplates', options)
  command.request_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2CreateInspectTemplateRequest::Representation
  command.request_object = google_privacy_dlp_v2beta2_create_inspect_template_request_object
  command.response_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectTemplate::Representation
  command.response_class = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectTemplate
  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_v2beta2_create_job_trigger_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2JobTrigger

Creates a job to run DLP actions such as scanning storage for sensitive information on a set schedule.

Parameters:

  • parent (String) —

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

  • google_privacy_dlp_v2beta2_create_job_trigger_request_object (Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2CreateJobTriggerRequest) (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:



1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
 
# File 'generated/google/apis/dlp_v2beta2/service.rb', line 1165

def create_project_job_trigger(parent, google_privacy_dlp_v2beta2_create_job_trigger_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v2beta2/{+parent}/jobTriggers', options)
  command.request_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2CreateJobTriggerRequest::Representation
  command.request_object = google_privacy_dlp_v2beta2_create_job_trigger_request_object
  command.response_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2JobTrigger::Representation
  command.response_class = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2JobTrigger
  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_v2beta2_deidentify_content_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DeidentifyContentResponse

De-identifies potentially sensitive info from a ContentItem. This method has limits on input size and output size. How-to guide

Parameters:

  • parent (String) —

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

  • google_privacy_dlp_v2beta2_deidentify_content_request_object (Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DeidentifyContentRequest) (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:



457
458
459
460
461
462
463
464
465
466
467
 
# File 'generated/google/apis/dlp_v2beta2/service.rb', line 457

def deidentify_project_content(parent, google_privacy_dlp_v2beta2_deidentify_content_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v2beta2/{+parent}/content:deidentify', options)
  command.request_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DeidentifyContentRequest::Representation
  command.request_object = google_privacy_dlp_v2beta2_deidentify_content_request_object
  command.response_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DeidentifyContentResponse::Representation
  command.response_class = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DeidentifyContentResponse
  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::DlpV2beta2::GoogleProtobufEmpty

Deletes inspect templates.

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:



145
146
147
148
149
150
151
152
153
 
# File 'generated/google/apis/dlp_v2beta2/service.rb', line 145

def delete_organization_deidentify_template(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'v2beta2/{+name}', options)
  command.response_representation = Google::Apis::DlpV2beta2::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::DlpV2beta2::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::DlpV2beta2::GoogleProtobufEmpty

Deletes inspect templates.

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:



318
319
320
321
322
323
324
325
326
 
# File 'generated/google/apis/dlp_v2beta2/service.rb', line 318

def delete_organization_inspect_template(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'v2beta2/{+name}', options)
  command.response_representation = Google::Apis::DlpV2beta2::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::DlpV2beta2::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::DlpV2beta2::GoogleProtobufEmpty

Deletes inspect templates.

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:



663
664
665
666
667
668
669
670
671
 
# File 'generated/google/apis/dlp_v2beta2/service.rb', line 663

def delete_project_deidentify_template(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'v2beta2/{+name}', options)
  command.response_representation = Google::Apis::DlpV2beta2::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::DlpV2beta2::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::DlpV2beta2::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.

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:



836
837
838
839
840
841
842
843
844
 
# File 'generated/google/apis/dlp_v2beta2/service.rb', line 836

def delete_project_dlp_job(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'v2beta2/{+name}', options)
  command.response_representation = Google::Apis::DlpV2beta2::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::DlpV2beta2::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::DlpV2beta2::GoogleProtobufEmpty

Deletes inspect templates.

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:



1027
1028
1029
1030
1031
1032
1033
1034
1035
 
# File 'generated/google/apis/dlp_v2beta2/service.rb', line 1027

def delete_project_inspect_template(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'v2beta2/{+name}', options)
  command.response_representation = Google::Apis::DlpV2beta2::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::DlpV2beta2::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::DlpV2beta2::GoogleProtobufEmpty

Deletes a job trigger.

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:



1198
1199
1200
1201
1202
1203
1204
1205
1206
 
# File 'generated/google/apis/dlp_v2beta2/service.rb', line 1198

def delete_project_job_trigger(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'v2beta2/{+name}', options)
  command.response_representation = Google::Apis::DlpV2beta2::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::DlpV2beta2::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::DlpV2beta2::GooglePrivacyDlpV2beta2DeidentifyTemplate

Gets an inspect template.

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:



177
178
179
180
181
182
183
184
185
 
# File 'generated/google/apis/dlp_v2beta2/service.rb', line 177

def get_organization_deidentify_template(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v2beta2/{+name}', options)
  command.response_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DeidentifyTemplate::Representation
  command.response_class = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DeidentifyTemplate
  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::DlpV2beta2::GooglePrivacyDlpV2beta2InspectTemplate

Gets an inspect template.

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:



350
351
352
353
354
355
356
357
358
 
# File 'generated/google/apis/dlp_v2beta2/service.rb', line 350

def get_organization_inspect_template(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v2beta2/{+name}', options)
  command.response_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectTemplate::Representation
  command.response_class = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectTemplate
  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::DlpV2beta2::GooglePrivacyDlpV2beta2DeidentifyTemplate

Gets an inspect template.

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:



695
696
697
698
699
700
701
702
703
 
# File 'generated/google/apis/dlp_v2beta2/service.rb', line 695

def get_project_deidentify_template(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v2beta2/{+name}', options)
  command.response_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DeidentifyTemplate::Representation
  command.response_class = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DeidentifyTemplate
  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::DlpV2beta2::GooglePrivacyDlpV2beta2DlpJob

Gets the latest state of a long-running DlpJob.

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:



866
867
868
869
870
871
872
873
874
 
# File 'generated/google/apis/dlp_v2beta2/service.rb', line 866

def get_project_dlp_job(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v2beta2/{+name}', options)
  command.response_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DlpJob::Representation
  command.response_class = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DlpJob
  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::DlpV2beta2::GooglePrivacyDlpV2beta2InspectTemplate

Gets an inspect template.

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:



1059
1060
1061
1062
1063
1064
1065
1066
1067
 
# File 'generated/google/apis/dlp_v2beta2/service.rb', line 1059

def get_project_inspect_template(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v2beta2/{+name}', options)
  command.response_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectTemplate::Representation
  command.response_class = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectTemplate
  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::DlpV2beta2::GooglePrivacyDlpV2beta2JobTrigger

Gets a job trigger.

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:



1229
1230
1231
1232
1233
1234
1235
1236
1237
 
# File 'generated/google/apis/dlp_v2beta2/service.rb', line 1229

def get_project_job_trigger(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v2beta2/{+name}', options)
  command.response_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2JobTrigger::Representation
  command.response_class = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2JobTrigger
  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_v2beta2_inspect_content_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectContentResponse

Finds potentially sensitive info in content. This method has limits on input size, processing time, and output size. How-to guide for text, How-to guide for images

Parameters:

  • parent (String) —

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

  • google_privacy_dlp_v2beta2_inspect_content_request_object (Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectContentRequest) (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:



493
494
495
496
497
498
499
500
501
502
503
 
# File 'generated/google/apis/dlp_v2beta2/service.rb', line 493

def inspect_project_content(parent, google_privacy_dlp_v2beta2_inspect_content_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v2beta2/{+parent}/content:inspect', options)
  command.request_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectContentRequest::Representation
  command.request_object = google_privacy_dlp_v2beta2_inspect_content_request_object
  command.response_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectContentResponse::Representation
  command.response_class = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectContentResponse
  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

#inspect_project_data_source(parent, google_privacy_dlp_v2beta2_inspect_data_source_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DlpJob

Schedules a job scanning content in a Google Cloud Platform data repository. How-to guide

Parameters:

  • parent (String) —

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

  • google_privacy_dlp_v2beta2_inspect_data_source_request_object (Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectDataSourceRequest) (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:



594
595
596
597
598
599
600
601
602
603
604
 
# File 'generated/google/apis/dlp_v2beta2/service.rb', line 594

def inspect_project_data_source(parent, google_privacy_dlp_v2beta2_inspect_data_source_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v2beta2/{+parent}/dataSource:inspect', options)
  command.request_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectDataSourceRequest::Representation
  command.request_object = google_privacy_dlp_v2beta2_inspect_data_source_request_object
  command.response_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DlpJob::Representation
  command.response_class = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DlpJob
  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::DlpV2beta2::GooglePrivacyDlpV2beta2ListInfoTypesResponse

Returns sensitive information types DLP supports.

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:



77
78
79
80
81
82
83
84
85
86
 
# File 'generated/google/apis/dlp_v2beta2/service.rb', line 77

def list_info_types(filter: nil, language_code: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v2beta2/infoTypes', options)
  command.response_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2ListInfoTypesResponse::Representation
  command.response_class = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2ListInfoTypesResponse
  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::DlpV2beta2::GooglePrivacyDlpV2beta2ListDeidentifyTemplatesResponse

Lists inspect templates.

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:



214
215
216
217
218
219
220
221
222
223
224
 
# File 'generated/google/apis/dlp_v2beta2/service.rb', line 214

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, 'v2beta2/{+parent}/deidentifyTemplates', options)
  command.response_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2ListDeidentifyTemplatesResponse::Representation
  command.response_class = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2ListDeidentifyTemplatesResponse
  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::DlpV2beta2::GooglePrivacyDlpV2beta2ListInspectTemplatesResponse

Lists inspect templates.

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:



387
388
389
390
391
392
393
394
395
396
397
 
# File 'generated/google/apis/dlp_v2beta2/service.rb', line 387

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, 'v2beta2/{+parent}/inspectTemplates', options)
  command.response_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2ListInspectTemplatesResponse::Representation
  command.response_class = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2ListInspectTemplatesResponse
  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::DlpV2beta2::GooglePrivacyDlpV2beta2ListDeidentifyTemplatesResponse

Lists inspect templates.

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:



732
733
734
735
736
737
738
739
740
741
742
 
# File 'generated/google/apis/dlp_v2beta2/service.rb', line 732

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, 'v2beta2/{+parent}/deidentifyTemplates', options)
  command.response_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2ListDeidentifyTemplatesResponse::Representation
  command.response_class = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2ListDeidentifyTemplatesResponse
  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::DlpV2beta2::GooglePrivacyDlpV2beta2ListDlpJobsResponse

Lists DlpJobs that match the specified filter in the request.

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:



921
922
923
924
925
926
927
928
929
930
931
932
933
 
# File 'generated/google/apis/dlp_v2beta2/service.rb', line 921

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, 'v2beta2/{+parent}/dlpJobs', options)
  command.response_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2ListDlpJobsResponse::Representation
  command.response_class = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2ListDlpJobsResponse
  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::DlpV2beta2::GooglePrivacyDlpV2beta2ListInspectTemplatesResponse

Lists inspect templates.

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:



1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
 
# File 'generated/google/apis/dlp_v2beta2/service.rb', line 1096

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, 'v2beta2/{+parent}/inspectTemplates', options)
  command.response_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2ListInspectTemplatesResponse::Representation
  command.response_class = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2ListInspectTemplatesResponse
  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::DlpV2beta2::GooglePrivacyDlpV2beta2ListJobTriggersResponse

Lists job triggers.

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/desc' postfix, i.e. "create_time asc,name desc,schedule_mode asc". This list is case-insensitive. Example: "name asc,schedule_mode desc, status desc" Supported filters keys and values 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 display name.
    • status: corresponds to the triggeredJob status.
  • 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 and filter should not change for subsequent calls, but can be omitted if token is specified.

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



1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
 
# File 'generated/google/apis/dlp_v2beta2/service.rb', line 1276

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, 'v2beta2/{+parent}/jobTriggers', options)
  command.response_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2ListJobTriggersResponse::Representation
  command.response_class = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2ListJobTriggersResponse
  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_v2beta2_update_deidentify_template_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DeidentifyTemplate

Updates the inspect template.

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_v2beta2_update_deidentify_template_request_object (Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2UpdateDeidentifyTemplateRequest) (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:



249
250
251
252
253
254
255
256
257
258
259
 
# File 'generated/google/apis/dlp_v2beta2/service.rb', line 249

def patch_organization_deidentify_template(name, google_privacy_dlp_v2beta2_update_deidentify_template_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'v2beta2/{+name}', options)
  command.request_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2UpdateDeidentifyTemplateRequest::Representation
  command.request_object = google_privacy_dlp_v2beta2_update_deidentify_template_request_object
  command.response_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DeidentifyTemplate::Representation
  command.response_class = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DeidentifyTemplate
  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_v2beta2_update_inspect_template_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectTemplate

Updates the inspect template.

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_v2beta2_update_inspect_template_request_object (Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2UpdateInspectTemplateRequest) (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:



422
423
424
425
426
427
428
429
430
431
432
 
# File 'generated/google/apis/dlp_v2beta2/service.rb', line 422

def patch_organization_inspect_template(name, google_privacy_dlp_v2beta2_update_inspect_template_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'v2beta2/{+name}', options)
  command.request_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2UpdateInspectTemplateRequest::Representation
  command.request_object = google_privacy_dlp_v2beta2_update_inspect_template_request_object
  command.response_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectTemplate::Representation
  command.response_class = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectTemplate
  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_v2beta2_update_deidentify_template_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DeidentifyTemplate

Updates the inspect template.

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_v2beta2_update_deidentify_template_request_object (Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2UpdateDeidentifyTemplateRequest) (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:



767
768
769
770
771
772
773
774
775
776
777
 
# File 'generated/google/apis/dlp_v2beta2/service.rb', line 767

def patch_project_deidentify_template(name, google_privacy_dlp_v2beta2_update_deidentify_template_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'v2beta2/{+name}', options)
  command.request_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2UpdateDeidentifyTemplateRequest::Representation
  command.request_object = google_privacy_dlp_v2beta2_update_deidentify_template_request_object
  command.response_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DeidentifyTemplate::Representation
  command.response_class = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2DeidentifyTemplate
  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_v2beta2_update_inspect_template_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectTemplate

Updates the inspect template.

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_v2beta2_update_inspect_template_request_object (Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2UpdateInspectTemplateRequest) (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:



1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
 
# File 'generated/google/apis/dlp_v2beta2/service.rb', line 1131

def patch_project_inspect_template(name, google_privacy_dlp_v2beta2_update_inspect_template_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'v2beta2/{+name}', options)
  command.request_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2UpdateInspectTemplateRequest::Representation
  command.request_object = google_privacy_dlp_v2beta2_update_inspect_template_request_object
  command.response_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectTemplate::Representation
  command.response_class = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2InspectTemplate
  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_v2beta2_update_job_trigger_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2JobTrigger

Updates a job trigger.

Parameters:

  • name (String) —

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

  • google_privacy_dlp_v2beta2_update_job_trigger_request_object (Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2UpdateJobTriggerRequest) (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:



1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
 
# File 'generated/google/apis/dlp_v2beta2/service.rb', line 1311

def patch_project_job_trigger(name, google_privacy_dlp_v2beta2_update_job_trigger_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'v2beta2/{+name}', options)
  command.request_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2UpdateJobTriggerRequest::Representation
  command.request_object = google_privacy_dlp_v2beta2_update_job_trigger_request_object
  command.response_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2JobTrigger::Representation
  command.response_class = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2JobTrigger
  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_v2beta2_redact_image_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2RedactImageResponse

Redacts potentially sensitive info from an image. This method has limits on input size, processing time, and output size. How-to guide

Parameters:

  • parent (String) —

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

  • google_privacy_dlp_v2beta2_redact_image_request_object (Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2RedactImageRequest) (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:



958
959
960
961
962
963
964
965
966
967
968
 
# File 'generated/google/apis/dlp_v2beta2/service.rb', line 958

def redact_project_image(parent, google_privacy_dlp_v2beta2_redact_image_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v2beta2/{+parent}/image:redact', options)
  command.request_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2RedactImageRequest::Representation
  command.request_object = google_privacy_dlp_v2beta2_redact_image_request_object
  command.response_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2RedactImageResponse::Representation
  command.response_class = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2RedactImageResponse
  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_v2beta2_reidentify_content_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2ReidentifyContentResponse

Re-identify content that has been de-identified.

Parameters:

  • parent (String) —

    The parent resource name.

  • google_privacy_dlp_v2beta2_reidentify_content_request_object (Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2ReidentifyContentRequest) (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:



526
527
528
529
530
531
532
533
534
535
536
 
# File 'generated/google/apis/dlp_v2beta2/service.rb', line 526

def reidentify_project_content(parent, google_privacy_dlp_v2beta2_reidentify_content_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v2beta2/{+parent}/content:reidentify', options)
  command.request_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2ReidentifyContentRequest::Representation
  command.request_object = google_privacy_dlp_v2beta2_reidentify_content_request_object
  command.response_representation = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2ReidentifyContentResponse::Representation
  command.response_class = Google::Apis::DlpV2beta2::GooglePrivacyDlpV2beta2ReidentifyContentResponse
  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