Class: Google::Cloud::Dlp::V2::DlpServiceClient
- Inherits:
-
Object
- Object
- Google::Cloud::Dlp::V2::DlpServiceClient
- Defined in:
- lib/google/cloud/dlp/v2/dlp_service_client.rb
Overview
The Cloud Data Loss Prevention (DLP) API is a service that allows clients to detect the presence of Personally Identifiable Information (PII) and other privacy-sensitive data in user-supplied, unstructured data streams, like text blocks or images. The service also includes methods for sensitive data redaction and scheduling of data scans on Google Cloud Platform based data sets.
To learn more about concepts and find how-to guides see https://cloud.google.com/dlp/docs/.
Constant Summary collapse
- SERVICE_ADDRESS =
The default address of the service.
"dlp.googleapis.com".freeze
- DEFAULT_SERVICE_PORT =
The default port of the service.
443
- GRPC_INTERCEPTORS =
The default set of gRPC interceptors.
[]
- DEFAULT_TIMEOUT =
30
- ALL_SCOPES =
The scopes needed to make gRPC calls to all of the methods defined in this service.
[ "https://www.googleapis.com/auth/cloud-platform" ].freeze
Class Method Summary collapse
-
.dlp_job_path(project, dlp_job) ⇒ String
Returns a fully-qualified dlp_job resource name string.
-
.organization_deidentify_template_path(organization, deidentify_template) ⇒ String
Returns a fully-qualified organization_deidentify_template resource name string.
-
.organization_inspect_template_path(organization, inspect_template) ⇒ String
Returns a fully-qualified organization_inspect_template resource name string.
-
.organization_path(organization) ⇒ String
Returns a fully-qualified organization resource name string.
-
.organization_stored_info_type_path(organization, stored_info_type) ⇒ String
Returns a fully-qualified organization_stored_info_type resource name string.
-
.project_deidentify_template_path(project, deidentify_template) ⇒ String
Returns a fully-qualified project_deidentify_template resource name string.
-
.project_inspect_template_path(project, inspect_template) ⇒ String
Returns a fully-qualified project_inspect_template resource name string.
-
.project_job_trigger_path(project, job_trigger) ⇒ String
Returns a fully-qualified project_job_trigger resource name string.
-
.project_path(project) ⇒ String
Returns a fully-qualified project resource name string.
-
.project_stored_info_type_path(project, stored_info_type) ⇒ String
Returns a fully-qualified project_stored_info_type resource name string.
Instance Method Summary collapse
-
#cancel_dlp_job(name, options: nil) {|result, operation| ... } ⇒ Object
Starts asynchronous cancellation on a long-running DlpJob.
-
#create_deidentify_template(parent, deidentify_template: nil, template_id: nil, options: nil) {|result, operation| ... } ⇒ Google::Privacy::Dlp::V2::DeidentifyTemplate
Creates a DeidentifyTemplate for re-using frequently used configuration for de-identifying content, images, and storage.
-
#create_dlp_job(parent, inspect_job: nil, risk_job: nil, job_id: nil, options: nil) {|result, operation| ... } ⇒ Google::Privacy::Dlp::V2::DlpJob
Creates a new job to inspect storage or calculate risk metrics.
-
#create_inspect_template(parent, inspect_template: nil, template_id: nil, options: nil) {|result, operation| ... } ⇒ Google::Privacy::Dlp::V2::InspectTemplate
Creates an InspectTemplate for re-using frequently used configuration for inspecting content, images, and storage.
-
#create_job_trigger(parent, job_trigger: nil, trigger_id: nil, options: nil) {|result, operation| ... } ⇒ Google::Privacy::Dlp::V2::JobTrigger
Creates a job trigger to run DLP actions such as scanning storage for sensitive information on a set schedule.
-
#create_stored_info_type(parent, config: nil, stored_info_type_id: nil, options: nil) {|result, operation| ... } ⇒ Google::Privacy::Dlp::V2::StoredInfoType
Creates a pre-built stored infoType to be used for inspection.
-
#deidentify_content(parent, deidentify_config: nil, inspect_config: nil, item: nil, inspect_template_name: nil, deidentify_template_name: nil, options: nil) {|result, operation| ... } ⇒ Google::Privacy::Dlp::V2::DeidentifyContentResponse
De-identifies potentially sensitive info from a ContentItem.
-
#delete_deidentify_template(name, options: nil) {|result, operation| ... } ⇒ Object
Deletes a DeidentifyTemplate.
-
#delete_dlp_job(name, options: nil) {|result, operation| ... } ⇒ Object
Deletes a long-running DlpJob.
-
#delete_inspect_template(name, options: nil) {|result, operation| ... } ⇒ Object
Deletes an InspectTemplate.
-
#delete_job_trigger(name, options: nil) {|result, operation| ... } ⇒ Object
Deletes a job trigger.
-
#delete_stored_info_type(name, options: nil) {|result, operation| ... } ⇒ Object
Deletes a stored infoType.
-
#get_deidentify_template(name, options: nil) {|result, operation| ... } ⇒ Google::Privacy::Dlp::V2::DeidentifyTemplate
Gets a DeidentifyTemplate.
-
#get_dlp_job(name, options: nil) {|result, operation| ... } ⇒ Google::Privacy::Dlp::V2::DlpJob
Gets the latest state of a long-running DlpJob.
-
#get_inspect_template(name: nil, options: nil) {|result, operation| ... } ⇒ Google::Privacy::Dlp::V2::InspectTemplate
Gets an InspectTemplate.
-
#get_job_trigger(name, options: nil) {|result, operation| ... } ⇒ Google::Privacy::Dlp::V2::JobTrigger
Gets a job trigger.
-
#get_stored_info_type(name, options: nil) {|result, operation| ... } ⇒ Google::Privacy::Dlp::V2::StoredInfoType
Gets a stored infoType.
-
#initialize(credentials: nil, scopes: ALL_SCOPES, client_config: {}, timeout: DEFAULT_TIMEOUT, metadata: nil, exception_transformer: nil, lib_name: nil, lib_version: "") ⇒ DlpServiceClient
constructor
A new instance of DlpServiceClient.
-
#inspect_content(parent, inspect_config: nil, item: nil, inspect_template_name: nil, options: nil) {|result, operation| ... } ⇒ Google::Privacy::Dlp::V2::InspectContentResponse
Finds potentially sensitive info in content.
-
#list_deidentify_templates(parent, page_size: nil, order_by: nil, options: nil) {|result, operation| ... } ⇒ Google::Gax::PagedEnumerable<Google::Privacy::Dlp::V2::DeidentifyTemplate>
Lists DeidentifyTemplates.
-
#list_dlp_jobs(parent, filter: nil, page_size: nil, type: nil, order_by: nil, options: nil) {|result, operation| ... } ⇒ Google::Gax::PagedEnumerable<Google::Privacy::Dlp::V2::DlpJob>
Lists DlpJobs that match the specified filter in the request.
-
#list_info_types(language_code: nil, filter: nil, options: nil) {|result, operation| ... } ⇒ Google::Privacy::Dlp::V2::ListInfoTypesResponse
Returns a list of the sensitive information types that the DLP API supports.
-
#list_inspect_templates(parent, page_size: nil, order_by: nil, options: nil) {|result, operation| ... } ⇒ Google::Gax::PagedEnumerable<Google::Privacy::Dlp::V2::InspectTemplate>
Lists InspectTemplates.
-
#list_job_triggers(parent, page_size: nil, order_by: nil, options: nil) {|result, operation| ... } ⇒ Google::Gax::PagedEnumerable<Google::Privacy::Dlp::V2::JobTrigger>
Lists job triggers.
-
#list_stored_info_types(parent, page_size: nil, order_by: nil, options: nil) {|result, operation| ... } ⇒ Google::Gax::PagedEnumerable<Google::Privacy::Dlp::V2::StoredInfoType>
Lists stored infoTypes.
-
#redact_image(parent, inspect_config: nil, image_redaction_configs: nil, include_findings: nil, byte_item: nil, options: nil) {|result, operation| ... } ⇒ Google::Privacy::Dlp::V2::RedactImageResponse
Redacts potentially sensitive info from an image.
-
#reidentify_content(parent, reidentify_config: nil, inspect_config: nil, item: nil, inspect_template_name: nil, reidentify_template_name: nil, options: nil) {|result, operation| ... } ⇒ Google::Privacy::Dlp::V2::ReidentifyContentResponse
Re-identifies content that has been de-identified.
-
#update_deidentify_template(name, deidentify_template: nil, update_mask: nil, options: nil) {|result, operation| ... } ⇒ Google::Privacy::Dlp::V2::DeidentifyTemplate
Updates the DeidentifyTemplate.
-
#update_inspect_template(name, inspect_template: nil, update_mask: nil, options: nil) {|result, operation| ... } ⇒ Google::Privacy::Dlp::V2::InspectTemplate
Updates the InspectTemplate.
-
#update_job_trigger(name, job_trigger: nil, update_mask: nil, options: nil) {|result, operation| ... } ⇒ Google::Privacy::Dlp::V2::JobTrigger
Updates a job trigger.
-
#update_stored_info_type(name, config: nil, update_mask: nil, options: nil) {|result, operation| ... } ⇒ Google::Privacy::Dlp::V2::StoredInfoType
Updates the stored infoType by creating a new version.
Constructor Details
#initialize(credentials: nil, scopes: ALL_SCOPES, client_config: {}, timeout: DEFAULT_TIMEOUT, metadata: nil, exception_transformer: nil, lib_name: nil, lib_version: "") ⇒ DlpServiceClient
Returns a new instance of DlpServiceClient.
289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 |
# File 'lib/google/cloud/dlp/v2/dlp_service_client.rb', line 289 def initialize \ credentials: nil, scopes: ALL_SCOPES, client_config: {}, timeout: DEFAULT_TIMEOUT, metadata: nil, exception_transformer: nil, lib_name: nil, lib_version: "" # These require statements are intentionally placed here to initialize # the gRPC module only when it's required. # See https://github.com/googleapis/toolkit/issues/446 require "google/gax/grpc" require "google/privacy/dlp/v2/dlp_services_pb" credentials ||= Google::Cloud::Dlp::V2::Credentials.default if credentials.is_a?(String) || credentials.is_a?(Hash) updater_proc = Google::Cloud::Dlp::V2::Credentials.new(credentials).updater_proc end if credentials.is_a?(GRPC::Core::Channel) channel = credentials end if credentials.is_a?(GRPC::Core::ChannelCredentials) chan_creds = credentials end if credentials.is_a?(Proc) updater_proc = credentials end if credentials.is_a?(Google::Auth::Credentials) updater_proc = credentials.updater_proc end package_version = Gem.loaded_specs['google-cloud-dlp'].version.version google_api_client = "gl-ruby/#{RUBY_VERSION}" google_api_client << " #{lib_name}/#{lib_version}" if lib_name google_api_client << " gapic/#{package_version} gax/#{Google::Gax::VERSION}" google_api_client << " grpc/#{GRPC::VERSION}" google_api_client.freeze headers = { :"x-goog-api-client" => google_api_client } headers.merge!() unless .nil? client_config_file = Pathname.new(__dir__).join( "dlp_service_client_config.json" ) defaults = client_config_file.open do |f| Google::Gax.construct_settings( "google.privacy.dlp.v2.DlpService", JSON.parse(f.read), client_config, Google::Gax::Grpc::STATUS_CODE_NAMES, timeout, page_descriptors: PAGE_DESCRIPTORS, errors: Google::Gax::Grpc::API_ERRORS, metadata: headers ) end # Allow overriding the service path/port in subclasses. service_path = self.class::SERVICE_ADDRESS port = self.class::DEFAULT_SERVICE_PORT interceptors = self.class::GRPC_INTERCEPTORS @dlp_service_stub = Google::Gax::Grpc.create_stub( service_path, port, chan_creds: chan_creds, channel: channel, updater_proc: updater_proc, scopes: scopes, interceptors: interceptors, &Google::Privacy::Dlp::V2::DlpService::Stub.method(:new) ) @inspect_content = Google::Gax.create_api_call( @dlp_service_stub.method(:inspect_content), defaults["inspect_content"], exception_transformer: exception_transformer ) @redact_image = Google::Gax.create_api_call( @dlp_service_stub.method(:redact_image), defaults["redact_image"], exception_transformer: exception_transformer ) @deidentify_content = Google::Gax.create_api_call( @dlp_service_stub.method(:deidentify_content), defaults["deidentify_content"], exception_transformer: exception_transformer ) @reidentify_content = Google::Gax.create_api_call( @dlp_service_stub.method(:reidentify_content), defaults["reidentify_content"], exception_transformer: exception_transformer ) @list_info_types = Google::Gax.create_api_call( @dlp_service_stub.method(:list_info_types), defaults["list_info_types"], exception_transformer: exception_transformer ) @create_inspect_template = Google::Gax.create_api_call( @dlp_service_stub.method(:create_inspect_template), defaults["create_inspect_template"], exception_transformer: exception_transformer ) @update_inspect_template = Google::Gax.create_api_call( @dlp_service_stub.method(:update_inspect_template), defaults["update_inspect_template"], exception_transformer: exception_transformer ) @get_inspect_template = Google::Gax.create_api_call( @dlp_service_stub.method(:get_inspect_template), defaults["get_inspect_template"], exception_transformer: exception_transformer ) @list_inspect_templates = Google::Gax.create_api_call( @dlp_service_stub.method(:list_inspect_templates), defaults["list_inspect_templates"], exception_transformer: exception_transformer ) @delete_inspect_template = Google::Gax.create_api_call( @dlp_service_stub.method(:delete_inspect_template), defaults["delete_inspect_template"], exception_transformer: exception_transformer ) @create_deidentify_template = Google::Gax.create_api_call( @dlp_service_stub.method(:create_deidentify_template), defaults["create_deidentify_template"], exception_transformer: exception_transformer ) @update_deidentify_template = Google::Gax.create_api_call( @dlp_service_stub.method(:update_deidentify_template), defaults["update_deidentify_template"], exception_transformer: exception_transformer ) @get_deidentify_template = Google::Gax.create_api_call( @dlp_service_stub.method(:get_deidentify_template), defaults["get_deidentify_template"], exception_transformer: exception_transformer ) @list_deidentify_templates = Google::Gax.create_api_call( @dlp_service_stub.method(:list_deidentify_templates), defaults["list_deidentify_templates"], exception_transformer: exception_transformer ) @delete_deidentify_template = Google::Gax.create_api_call( @dlp_service_stub.method(:delete_deidentify_template), defaults["delete_deidentify_template"], exception_transformer: exception_transformer ) @create_dlp_job = Google::Gax.create_api_call( @dlp_service_stub.method(:create_dlp_job), defaults["create_dlp_job"], exception_transformer: exception_transformer ) @list_dlp_jobs = Google::Gax.create_api_call( @dlp_service_stub.method(:list_dlp_jobs), defaults["list_dlp_jobs"], exception_transformer: exception_transformer ) @get_dlp_job = Google::Gax.create_api_call( @dlp_service_stub.method(:get_dlp_job), defaults["get_dlp_job"], exception_transformer: exception_transformer ) @delete_dlp_job = Google::Gax.create_api_call( @dlp_service_stub.method(:delete_dlp_job), defaults["delete_dlp_job"], exception_transformer: exception_transformer ) @cancel_dlp_job = Google::Gax.create_api_call( @dlp_service_stub.method(:cancel_dlp_job), defaults["cancel_dlp_job"], exception_transformer: exception_transformer ) @list_job_triggers = Google::Gax.create_api_call( @dlp_service_stub.method(:list_job_triggers), defaults["list_job_triggers"], exception_transformer: exception_transformer ) @get_job_trigger = Google::Gax.create_api_call( @dlp_service_stub.method(:get_job_trigger), defaults["get_job_trigger"], exception_transformer: exception_transformer ) @delete_job_trigger = Google::Gax.create_api_call( @dlp_service_stub.method(:delete_job_trigger), defaults["delete_job_trigger"], exception_transformer: exception_transformer ) @update_job_trigger = Google::Gax.create_api_call( @dlp_service_stub.method(:update_job_trigger), defaults["update_job_trigger"], exception_transformer: exception_transformer ) @create_job_trigger = Google::Gax.create_api_call( @dlp_service_stub.method(:create_job_trigger), defaults["create_job_trigger"], exception_transformer: exception_transformer ) @create_stored_info_type = Google::Gax.create_api_call( @dlp_service_stub.method(:create_stored_info_type), defaults["create_stored_info_type"], exception_transformer: exception_transformer ) @update_stored_info_type = Google::Gax.create_api_call( @dlp_service_stub.method(:update_stored_info_type), defaults["update_stored_info_type"], exception_transformer: exception_transformer ) @get_stored_info_type = Google::Gax.create_api_call( @dlp_service_stub.method(:get_stored_info_type), defaults["get_stored_info_type"], exception_transformer: exception_transformer ) @list_stored_info_types = Google::Gax.create_api_call( @dlp_service_stub.method(:list_stored_info_types), defaults["list_stored_info_types"], exception_transformer: exception_transformer ) @delete_stored_info_type = Google::Gax.create_api_call( @dlp_service_stub.method(:delete_stored_info_type), defaults["delete_stored_info_type"], exception_transformer: exception_transformer ) end |
Class Method Details
.dlp_job_path(project, dlp_job) ⇒ String
Returns a fully-qualified dlp_job resource name string.
231 232 233 234 235 236 |
# File 'lib/google/cloud/dlp/v2/dlp_service_client.rb', line 231 def self.dlp_job_path project, dlp_job DLP_JOB_PATH_TEMPLATE.render( :"project" => project, :"dlp_job" => dlp_job ) end |
.organization_deidentify_template_path(organization, deidentify_template) ⇒ String
Returns a fully-qualified organization_deidentify_template resource name string.
167 168 169 170 171 172 |
# File 'lib/google/cloud/dlp/v2/dlp_service_client.rb', line 167 def self.organization_deidentify_template_path organization, deidentify_template ORGANIZATION_DEIDENTIFY_TEMPLATE_PATH_TEMPLATE.render( :"organization" => organization, :"deidentify_template" => deidentify_template ) end |
.organization_inspect_template_path(organization, inspect_template) ⇒ String
Returns a fully-qualified organization_inspect_template resource name string.
189 190 191 192 193 194 |
# File 'lib/google/cloud/dlp/v2/dlp_service_client.rb', line 189 def self.organization_inspect_template_path organization, inspect_template ORGANIZATION_INSPECT_TEMPLATE_PATH_TEMPLATE.render( :"organization" => organization, :"inspect_template" => inspect_template ) end |
.organization_path(organization) ⇒ String
Returns a fully-qualified organization resource name string.
157 158 159 160 161 |
# File 'lib/google/cloud/dlp/v2/dlp_service_client.rb', line 157 def self.organization_path organization ORGANIZATION_PATH_TEMPLATE.render( :"organization" => organization ) end |
.organization_stored_info_type_path(organization, stored_info_type) ⇒ String
Returns a fully-qualified organization_stored_info_type resource name string.
242 243 244 245 246 247 |
# File 'lib/google/cloud/dlp/v2/dlp_service_client.rb', line 242 def self.organization_stored_info_type_path organization, stored_info_type ORGANIZATION_STORED_INFO_TYPE_PATH_TEMPLATE.render( :"organization" => organization, :"stored_info_type" => stored_info_type ) end |
.project_deidentify_template_path(project, deidentify_template) ⇒ String
Returns a fully-qualified project_deidentify_template resource name string.
178 179 180 181 182 183 |
# File 'lib/google/cloud/dlp/v2/dlp_service_client.rb', line 178 def self.project_deidentify_template_path project, deidentify_template PROJECT_DEIDENTIFY_TEMPLATE_PATH_TEMPLATE.render( :"project" => project, :"deidentify_template" => deidentify_template ) end |
.project_inspect_template_path(project, inspect_template) ⇒ String
Returns a fully-qualified project_inspect_template resource name string.
200 201 202 203 204 205 |
# File 'lib/google/cloud/dlp/v2/dlp_service_client.rb', line 200 def self.project_inspect_template_path project, inspect_template PROJECT_INSPECT_TEMPLATE_PATH_TEMPLATE.render( :"project" => project, :"inspect_template" => inspect_template ) end |
.project_job_trigger_path(project, job_trigger) ⇒ String
Returns a fully-qualified project_job_trigger resource name string.
211 212 213 214 215 216 |
# File 'lib/google/cloud/dlp/v2/dlp_service_client.rb', line 211 def self.project_job_trigger_path project, job_trigger PROJECT_JOB_TRIGGER_PATH_TEMPLATE.render( :"project" => project, :"job_trigger" => job_trigger ) end |
.project_path(project) ⇒ String
Returns a fully-qualified project resource name string.
221 222 223 224 225 |
# File 'lib/google/cloud/dlp/v2/dlp_service_client.rb', line 221 def self.project_path project PROJECT_PATH_TEMPLATE.render( :"project" => project ) end |
.project_stored_info_type_path(project, stored_info_type) ⇒ String
Returns a fully-qualified project_stored_info_type resource name string.
253 254 255 256 257 258 |
# File 'lib/google/cloud/dlp/v2/dlp_service_client.rb', line 253 def self.project_stored_info_type_path project, stored_info_type PROJECT_STORED_INFO_TYPE_PATH_TEMPLATE.render( :"project" => project, :"stored_info_type" => stored_info_type ) end |
Instance Method Details
#cancel_dlp_job(name, options: nil) {|result, operation| ... } ⇒ Object
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.
1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 |
# File 'lib/google/cloud/dlp/v2/dlp_service_client.rb', line 1530 def cancel_dlp_job \ name, options: nil, &block req = { name: name }.delete_if { |_, v| v.nil? } req = Google::Gax::to_proto(req, Google::Privacy::Dlp::V2::CancelDlpJobRequest) @cancel_dlp_job.call(req, , &block) nil end |
#create_deidentify_template(parent, deidentify_template: nil, template_id: nil, options: nil) {|result, operation| ... } ⇒ Google::Privacy::Dlp::V2::DeidentifyTemplate
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.
1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 |
# File 'lib/google/cloud/dlp/v2/dlp_service_client.rb', line 1085 def create_deidentify_template \ parent, deidentify_template: nil, template_id: nil, options: nil, &block req = { parent: parent, deidentify_template: deidentify_template, template_id: template_id }.delete_if { |_, v| v.nil? } req = Google::Gax::to_proto(req, Google::Privacy::Dlp::V2::CreateDeidentifyTemplateRequest) @create_deidentify_template.call(req, , &block) end |
#create_dlp_job(parent, inspect_job: nil, risk_job: nil, job_id: nil, options: nil) {|result, operation| ... } ⇒ Google::Privacy::Dlp::V2::DlpJob
Creates a new job to inspect storage or calculate risk metrics. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more.
When no InfoTypes or CustomInfoTypes are specified in inspect jobs, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated.
1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 |
# File 'lib/google/cloud/dlp/v2/dlp_service_client.rb', line 1323 def create_dlp_job \ parent, inspect_job: nil, risk_job: nil, job_id: nil, options: nil, &block req = { parent: parent, inspect_job: inspect_job, risk_job: risk_job, job_id: job_id }.delete_if { |_, v| v.nil? } req = Google::Gax::to_proto(req, Google::Privacy::Dlp::V2::CreateDlpJobRequest) @create_dlp_job.call(req, , &block) end |
#create_inspect_template(parent, inspect_template: nil, template_id: nil, options: nil) {|result, operation| ... } ⇒ Google::Privacy::Dlp::V2::InspectTemplate
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.
856 857 858 859 860 861 862 863 864 865 866 867 868 869 |
# File 'lib/google/cloud/dlp/v2/dlp_service_client.rb', line 856 def create_inspect_template \ parent, inspect_template: nil, template_id: nil, options: nil, &block req = { parent: parent, inspect_template: inspect_template, template_id: template_id }.delete_if { |_, v| v.nil? } req = Google::Gax::to_proto(req, Google::Privacy::Dlp::V2::CreateInspectTemplateRequest) @create_inspect_template.call(req, , &block) end |
#create_job_trigger(parent, job_trigger: nil, trigger_id: nil, options: nil) {|result, operation| ... } ⇒ Google::Privacy::Dlp::V2::JobTrigger
Creates a job trigger to run DLP actions such as scanning storage for sensitive information on a set schedule. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.
1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 |
# File 'lib/google/cloud/dlp/v2/dlp_service_client.rb', line 1754 def create_job_trigger \ parent, job_trigger: nil, trigger_id: nil, options: nil, &block req = { parent: parent, job_trigger: job_trigger, trigger_id: trigger_id }.delete_if { |_, v| v.nil? } req = Google::Gax::to_proto(req, Google::Privacy::Dlp::V2::CreateJobTriggerRequest) @create_job_trigger.call(req, , &block) end |
#create_stored_info_type(parent, config: nil, stored_info_type_id: nil, options: nil) {|result, operation| ... } ⇒ Google::Privacy::Dlp::V2::StoredInfoType
Creates a pre-built stored infoType to be used for inspection. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.
1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 |
# File 'lib/google/cloud/dlp/v2/dlp_service_client.rb', line 1800 def create_stored_info_type \ parent, config: nil, stored_info_type_id: nil, options: nil, &block req = { parent: parent, config: config, stored_info_type_id: stored_info_type_id }.delete_if { |_, v| v.nil? } req = Google::Gax::to_proto(req, Google::Privacy::Dlp::V2::CreateStoredInfoTypeRequest) @create_stored_info_type.call(req, , &block) end |
#deidentify_content(parent, deidentify_config: nil, inspect_config: nil, item: nil, inspect_template_name: nil, deidentify_template_name: nil, options: nil) {|result, operation| ... } ⇒ Google::Privacy::Dlp::V2::DeidentifyContentResponse
De-identifies potentially sensitive info from a ContentItem. This method has limits on input size and output size. See https://cloud.google.com/dlp/docs/deidentify-sensitive-data to learn more.
When no InfoTypes or CustomInfoTypes are specified in this request, the system will automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated.
690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 |
# File 'lib/google/cloud/dlp/v2/dlp_service_client.rb', line 690 def deidentify_content \ parent, deidentify_config: nil, inspect_config: nil, item: nil, inspect_template_name: nil, deidentify_template_name: nil, options: nil, &block req = { parent: parent, deidentify_config: deidentify_config, inspect_config: inspect_config, item: item, inspect_template_name: inspect_template_name, deidentify_template_name: deidentify_template_name }.delete_if { |_, v| v.nil? } req = Google::Gax::to_proto(req, Google::Privacy::Dlp::V2::DeidentifyContentRequest) @deidentify_content.call(req, , &block) end |
#delete_deidentify_template(name, options: nil) {|result, operation| ... } ⇒ Object
Deletes a DeidentifyTemplate. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.
1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 |
# File 'lib/google/cloud/dlp/v2/dlp_service_client.rb', line 1275 def delete_deidentify_template \ name, options: nil, &block req = { name: name }.delete_if { |_, v| v.nil? } req = Google::Gax::to_proto(req, Google::Privacy::Dlp::V2::DeleteDeidentifyTemplateRequest) @delete_deidentify_template.call(req, , &block) nil end |
#delete_dlp_job(name, options: nil) {|result, operation| ... } ⇒ Object
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.
1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 |
# File 'lib/google/cloud/dlp/v2/dlp_service_client.rb', line 1496 def delete_dlp_job \ name, options: nil, &block req = { name: name }.delete_if { |_, v| v.nil? } req = Google::Gax::to_proto(req, Google::Privacy::Dlp::V2::DeleteDlpJobRequest) @delete_dlp_job.call(req, , &block) nil end |
#delete_inspect_template(name, options: nil) {|result, operation| ... } ⇒ Object
Deletes an InspectTemplate. See https://cloud.google.com/dlp/docs/creating-templates to learn more.
1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 |
# File 'lib/google/cloud/dlp/v2/dlp_service_client.rb', line 1041 def delete_inspect_template \ name, options: nil, &block req = { name: name }.delete_if { |_, v| v.nil? } req = Google::Gax::to_proto(req, Google::Privacy::Dlp::V2::DeleteInspectTemplateRequest) @delete_inspect_template.call(req, , &block) nil end |
#delete_job_trigger(name, options: nil) {|result, operation| ... } ⇒ Object
Deletes a job trigger. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.
1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 |
# File 'lib/google/cloud/dlp/v2/dlp_service_client.rb', line 1668 def delete_job_trigger \ name, options: nil, &block req = { name: name }.delete_if { |_, v| v.nil? } req = Google::Gax::to_proto(req, Google::Privacy::Dlp::V2::DeleteJobTriggerRequest) @delete_job_trigger.call(req, , &block) nil end |
#delete_stored_info_type(name, options: nil) {|result, operation| ... } ⇒ Object
Deletes a stored infoType. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.
1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 |
# File 'lib/google/cloud/dlp/v2/dlp_service_client.rb', line 1994 def delete_stored_info_type \ name, options: nil, &block req = { name: name }.delete_if { |_, v| v.nil? } req = Google::Gax::to_proto(req, Google::Privacy::Dlp::V2::DeleteStoredInfoTypeRequest) @delete_stored_info_type.call(req, , &block) nil end |
#get_deidentify_template(name, options: nil) {|result, operation| ... } ⇒ Google::Privacy::Dlp::V2::DeidentifyTemplate
Gets a DeidentifyTemplate. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.
1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 |
# File 'lib/google/cloud/dlp/v2/dlp_service_client.rb', line 1169 def get_deidentify_template \ name, options: nil, &block req = { name: name }.delete_if { |_, v| v.nil? } req = Google::Gax::to_proto(req, Google::Privacy::Dlp::V2::GetDeidentifyTemplateRequest) @get_deidentify_template.call(req, , &block) end |
#get_dlp_job(name, options: nil) {|result, operation| ... } ⇒ Google::Privacy::Dlp::V2::DlpJob
Gets the latest state of a long-running DlpJob. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more.
1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 |
# File 'lib/google/cloud/dlp/v2/dlp_service_client.rb', line 1463 def get_dlp_job \ name, options: nil, &block req = { name: name }.delete_if { |_, v| v.nil? } req = Google::Gax::to_proto(req, Google::Privacy::Dlp::V2::GetDlpJobRequest) @get_dlp_job.call(req, , &block) end |
#get_inspect_template(name: nil, options: nil) {|result, operation| ... } ⇒ Google::Privacy::Dlp::V2::InspectTemplate
Gets an InspectTemplate. See https://cloud.google.com/dlp/docs/creating-templates to learn more.
937 938 939 940 941 942 943 944 945 946 |
# File 'lib/google/cloud/dlp/v2/dlp_service_client.rb', line 937 def get_inspect_template \ name: nil, options: nil, &block req = { name: name }.delete_if { |_, v| v.nil? } req = Google::Gax::to_proto(req, Google::Privacy::Dlp::V2::GetInspectTemplateRequest) @get_inspect_template.call(req, , &block) end |
#get_job_trigger(name, options: nil) {|result, operation| ... } ⇒ Google::Privacy::Dlp::V2::JobTrigger
Gets a job trigger. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.
1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 |
# File 'lib/google/cloud/dlp/v2/dlp_service_client.rb', line 1635 def get_job_trigger \ name, options: nil, &block req = { name: name }.delete_if { |_, v| v.nil? } req = Google::Gax::to_proto(req, Google::Privacy::Dlp::V2::GetJobTriggerRequest) @get_job_trigger.call(req, , &block) end |
#get_stored_info_type(name, options: nil) {|result, operation| ... } ⇒ Google::Privacy::Dlp::V2::StoredInfoType
Gets a stored infoType. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.
1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 |
# File 'lib/google/cloud/dlp/v2/dlp_service_client.rb', line 1887 def get_stored_info_type \ name, options: nil, &block req = { name: name }.delete_if { |_, v| v.nil? } req = Google::Gax::to_proto(req, Google::Privacy::Dlp::V2::GetStoredInfoTypeRequest) @get_stored_info_type.call(req, , &block) end |
#inspect_content(parent, inspect_config: nil, item: nil, inspect_template_name: nil, options: nil) {|result, operation| ... } ⇒ Google::Privacy::Dlp::V2::InspectContentResponse
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,
559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 |
# File 'lib/google/cloud/dlp/v2/dlp_service_client.rb', line 559 def inspect_content \ parent, inspect_config: nil, item: nil, inspect_template_name: nil, options: nil, &block req = { parent: parent, inspect_config: inspect_config, item: item, inspect_template_name: inspect_template_name }.delete_if { |_, v| v.nil? } req = Google::Gax::to_proto(req, Google::Privacy::Dlp::V2::InspectContentRequest) @inspect_content.call(req, , &block) end |
#list_deidentify_templates(parent, page_size: nil, order_by: nil, options: nil) {|result, operation| ... } ⇒ Google::Gax::PagedEnumerable<Google::Privacy::Dlp::V2::DeidentifyTemplate>
Lists DeidentifyTemplates. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.
1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 |
# File 'lib/google/cloud/dlp/v2/dlp_service_client.rb', line 1238 def list_deidentify_templates \ parent, page_size: nil, order_by: nil, options: nil, &block req = { parent: parent, page_size: page_size, order_by: order_by }.delete_if { |_, v| v.nil? } req = Google::Gax::to_proto(req, Google::Privacy::Dlp::V2::ListDeidentifyTemplatesRequest) @list_deidentify_templates.call(req, , &block) end |
#list_dlp_jobs(parent, filter: nil, page_size: nil, type: nil, order_by: nil, options: nil) {|result, operation| ... } ⇒ Google::Gax::PagedEnumerable<Google::Privacy::Dlp::V2::DlpJob>
Lists DlpJobs that match the specified filter in the request. See https://cloud.google.com/dlp/docs/inspecting-storage and https://cloud.google.com/dlp/docs/compute-risk-analysis to learn more.
1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 |
# File 'lib/google/cloud/dlp/v2/dlp_service_client.rb', line 1423 def list_dlp_jobs \ parent, filter: nil, page_size: nil, type: nil, order_by: nil, options: nil, &block req = { parent: parent, filter: filter, page_size: page_size, type: type, order_by: order_by }.delete_if { |_, v| v.nil? } req = Google::Gax::to_proto(req, Google::Privacy::Dlp::V2::ListDlpJobsRequest) @list_dlp_jobs.call(req, , &block) end |
#list_info_types(language_code: nil, filter: nil, options: nil) {|result, operation| ... } ⇒ Google::Privacy::Dlp::V2::ListInfoTypesResponse
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.
812 813 814 815 816 817 818 819 820 821 822 823 |
# File 'lib/google/cloud/dlp/v2/dlp_service_client.rb', line 812 def list_info_types \ language_code: nil, filter: nil, options: nil, &block req = { language_code: language_code, filter: filter }.delete_if { |_, v| v.nil? } req = Google::Gax::to_proto(req, Google::Privacy::Dlp::V2::ListInfoTypesRequest) @list_info_types.call(req, , &block) end |
#list_inspect_templates(parent, page_size: nil, order_by: nil, options: nil) {|result, operation| ... } ⇒ Google::Gax::PagedEnumerable<Google::Privacy::Dlp::V2::InspectTemplate>
Lists InspectTemplates. See https://cloud.google.com/dlp/docs/creating-templates to learn more.
1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 |
# File 'lib/google/cloud/dlp/v2/dlp_service_client.rb', line 1005 def list_inspect_templates \ parent, page_size: nil, order_by: nil, options: nil, &block req = { parent: parent, page_size: page_size, order_by: order_by }.delete_if { |_, v| v.nil? } req = Google::Gax::to_proto(req, Google::Privacy::Dlp::V2::ListInspectTemplatesRequest) @list_inspect_templates.call(req, , &block) end |
#list_job_triggers(parent, page_size: nil, order_by: nil, options: nil) {|result, operation| ... } ⇒ Google::Gax::PagedEnumerable<Google::Privacy::Dlp::V2::JobTrigger>
Lists job triggers. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.
1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 |
# File 'lib/google/cloud/dlp/v2/dlp_service_client.rb', line 1599 def list_job_triggers \ parent, page_size: nil, order_by: nil, options: nil, &block req = { parent: parent, page_size: page_size, order_by: order_by }.delete_if { |_, v| v.nil? } req = Google::Gax::to_proto(req, Google::Privacy::Dlp::V2::ListJobTriggersRequest) @list_job_triggers.call(req, , &block) end |
#list_stored_info_types(parent, page_size: nil, order_by: nil, options: nil) {|result, operation| ... } ⇒ Google::Gax::PagedEnumerable<Google::Privacy::Dlp::V2::StoredInfoType>
Lists stored infoTypes. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.
1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 |
# File 'lib/google/cloud/dlp/v2/dlp_service_client.rb', line 1957 def list_stored_info_types \ parent, page_size: nil, order_by: nil, options: nil, &block req = { parent: parent, page_size: page_size, order_by: order_by }.delete_if { |_, v| v.nil? } req = Google::Gax::to_proto(req, Google::Privacy::Dlp::V2::ListStoredInfoTypesRequest) @list_stored_info_types.call(req, , &block) end |
#redact_image(parent, inspect_config: nil, image_redaction_configs: nil, include_findings: nil, byte_item: nil, options: nil) {|result, operation| ... } ⇒ Google::Privacy::Dlp::V2::RedactImageResponse
Redacts potentially sensitive info from an image. This method has limits on input size, processing time, and output size. See https://cloud.google.com/dlp/docs/redacting-sensitive-data-images to learn more.
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.
617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 |
# File 'lib/google/cloud/dlp/v2/dlp_service_client.rb', line 617 def redact_image \ parent, inspect_config: nil, image_redaction_configs: nil, include_findings: nil, byte_item: nil, options: nil, &block req = { parent: parent, inspect_config: inspect_config, image_redaction_configs: image_redaction_configs, include_findings: include_findings, byte_item: byte_item }.delete_if { |_, v| v.nil? } req = Google::Gax::to_proto(req, Google::Privacy::Dlp::V2::RedactImageRequest) @redact_image.call(req, , &block) end |
#reidentify_content(parent, reidentify_config: nil, inspect_config: nil, item: nil, inspect_template_name: nil, reidentify_template_name: nil, options: nil) {|result, operation| ... } ⇒ Google::Privacy::Dlp::V2::ReidentifyContentResponse
Re-identifies content that has been de-identified. See https://cloud.google.com/dlp/docs/pseudonymization#re-identification_in_free_text_code_example to learn more.
766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 |
# File 'lib/google/cloud/dlp/v2/dlp_service_client.rb', line 766 def reidentify_content \ parent, reidentify_config: nil, inspect_config: nil, item: nil, inspect_template_name: nil, reidentify_template_name: nil, options: nil, &block req = { parent: parent, reidentify_config: reidentify_config, inspect_config: inspect_config, item: item, inspect_template_name: inspect_template_name, reidentify_template_name: reidentify_template_name }.delete_if { |_, v| v.nil? } req = Google::Gax::to_proto(req, Google::Privacy::Dlp::V2::ReidentifyContentRequest) @reidentify_content.call(req, , &block) end |
#update_deidentify_template(name, deidentify_template: nil, update_mask: nil, options: nil) {|result, operation| ... } ⇒ Google::Privacy::Dlp::V2::DeidentifyTemplate
Updates the DeidentifyTemplate. See https://cloud.google.com/dlp/docs/creating-templates-deid to learn more.
1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 |
# File 'lib/google/cloud/dlp/v2/dlp_service_client.rb', line 1131 def update_deidentify_template \ name, deidentify_template: nil, update_mask: nil, options: nil, &block req = { name: name, deidentify_template: deidentify_template, update_mask: update_mask }.delete_if { |_, v| v.nil? } req = Google::Gax::to_proto(req, Google::Privacy::Dlp::V2::UpdateDeidentifyTemplateRequest) @update_deidentify_template.call(req, , &block) end |
#update_inspect_template(name, inspect_template: nil, update_mask: nil, options: nil) {|result, operation| ... } ⇒ Google::Privacy::Dlp::V2::InspectTemplate
Updates the InspectTemplate. See https://cloud.google.com/dlp/docs/creating-templates to learn more.
901 902 903 904 905 906 907 908 909 910 911 912 913 914 |
# File 'lib/google/cloud/dlp/v2/dlp_service_client.rb', line 901 def update_inspect_template \ name, inspect_template: nil, update_mask: nil, options: nil, &block req = { name: name, inspect_template: inspect_template, update_mask: update_mask }.delete_if { |_, v| v.nil? } req = Google::Gax::to_proto(req, Google::Privacy::Dlp::V2::UpdateInspectTemplateRequest) @update_inspect_template.call(req, , &block) end |
#update_job_trigger(name, job_trigger: nil, update_mask: nil, options: nil) {|result, operation| ... } ⇒ Google::Privacy::Dlp::V2::JobTrigger
Updates a job trigger. See https://cloud.google.com/dlp/docs/creating-job-triggers to learn more.
1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 |
# File 'lib/google/cloud/dlp/v2/dlp_service_client.rb', line 1709 def update_job_trigger \ name, job_trigger: nil, update_mask: nil, options: nil, &block req = { name: name, job_trigger: job_trigger, update_mask: update_mask }.delete_if { |_, v| v.nil? } req = Google::Gax::to_proto(req, Google::Privacy::Dlp::V2::UpdateJobTriggerRequest) @update_job_trigger.call(req, , &block) end |
#update_stored_info_type(name, config: nil, update_mask: nil, options: nil) {|result, operation| ... } ⇒ Google::Privacy::Dlp::V2::StoredInfoType
Updates the stored infoType by creating a new version. The existing version will continue to be used until the new version is ready. See https://cloud.google.com/dlp/docs/creating-stored-infotypes to learn more.
1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 |
# File 'lib/google/cloud/dlp/v2/dlp_service_client.rb', line 1849 def update_stored_info_type \ name, config: nil, update_mask: nil, options: nil, &block req = { name: name, config: config, update_mask: update_mask }.delete_if { |_, v| v.nil? } req = Google::Gax::to_proto(req, Google::Privacy::Dlp::V2::UpdateStoredInfoTypeRequest) @update_stored_info_type.call(req, , &block) end |