Class: Google::Cloud::Dlp::V2::Action

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/privacy/dlp/v2/dlp.rb

Overview

A task to execute on the completion of a job. See https://cloud.google.com/sensitive-data-protection/docs/concepts-actions to learn more.

Defined Under Namespace

Classes: Deidentify, JobNotificationEmails, PublishFindingsToCloudDataCatalog, PublishSummaryToCscc, PublishToPubSub, PublishToStackdriver, SaveFindings

Instance Attribute Summary collapse

Instance Attribute Details

#deidentify ⇒ ::Google::Cloud::Dlp::V2::Action::Deidentify

Returns Create a de-identified copy of the input data.

Note: The following fields are mutually exclusive: deidentify, save_findings, pub_sub, publish_summary_to_cscc, publish_findings_to_cloud_data_catalog, job_notification_emails, publish_to_stackdriver. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::Dlp::V2::Action::Deidentify) —

    Create a de-identified copy of the input data.

    Note: The following fields are mutually exclusive: deidentify, save_findings, pub_sub, publish_summary_to_cscc, publish_findings_to_cloud_data_catalog, job_notification_emails, publish_to_stackdriver. If a field in that set is populated, all other fields in the set will automatically be cleared.



3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
 
# File 'proto_docs/google/privacy/dlp/v2/dlp.rb', line 3580

class Action
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # If set, the detailed findings will be persisted to the specified
  # OutputStorageConfig. Only a single instance of this action can be
  # specified.
  # Compatible with: Inspect, Risk
  # @!attribute [rw] output_config
  #   @return [::Google::Cloud::Dlp::V2::OutputStorageConfig]
  #     Location to store findings outside of DLP.
  class SaveFindings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Publish a message into a given Pub/Sub topic when DlpJob has completed. The
  # message contains a single field, `DlpJobName`, which is equal to the
  # finished job's
  # [`DlpJob.name`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob).
  # Compatible with: Inspect, Risk
  # @!attribute [rw] topic
  #   @return [::String]
  #     Cloud Pub/Sub topic to send notifications to. The topic must have given
  #     publishing access rights to the DLP API service account executing
  #     the long running DlpJob sending the notifications.
  #     Format is projects/\\{project}/topics/\\{topic}.
  class PublishToPubSub
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Publish the result summary of a DlpJob to [Security Command
  # Center](https://cloud.google.com/security-command-center). This action is
  # available for only projects that belong to an organization. This action
  # publishes the count of finding instances and their infoTypes. The summary
  # of findings are persisted in Security Command Center and are governed by
  # [service-specific policies for Security Command
  # Center](https://cloud.google.com/terms/service-terms). Only a single
  # instance of this action can be specified. Compatible with: Inspect
  class PublishSummaryToCscc
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag
  # templates are applied to the resource that Cloud DLP scanned. Data
  # Catalog tag templates are stored in the same project and region where the
  # BigQuery table exists. For Cloud DLP to create and apply the tag template,
  # the Cloud DLP service agent must have the
  # `roles/datacatalog.tagTemplateOwner` permission on the project. The tag
  # template contains fields summarizing the results of the DlpJob. Any field
  # values previously written by another DlpJob are deleted. [InfoType naming
  # patterns][google.privacy.dlp.v2.InfoType] are strictly enforced when using
  # this feature.
  #
  # Findings are persisted in Data Catalog storage and are governed by
  # service-specific policies for Data Catalog. For more information, see
  # [Service Specific Terms](https://cloud.google.com/terms/service-terms).
  #
  # Only a single instance of this action can be specified. This action is
  # allowed only if all resources being scanned are BigQuery tables.
  # Compatible with: Inspect
  class PublishFindingsToCloudDataCatalog
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Create a de-identified copy of a storage bucket. Only compatible
  # with Cloud Storage buckets.
  #
  #
  # A TransformationDetail will be created for each transformation.
  #
  #
  # Compatible with: Inspection of Cloud Storage
  # @!attribute [rw] transformation_config
  #   @return [::Google::Cloud::Dlp::V2::TransformationConfig]
  #     User specified deidentify templates and configs for structured,
  #     unstructured, and image files.
  # @!attribute [rw] transformation_details_storage_config
  #   @return [::Google::Cloud::Dlp::V2::TransformationDetailsStorageConfig]
  #     Config for storing transformation details.
  #
  #     This field specifies the configuration for storing detailed metadata
  #     about each transformation performed during a de-identification process.
  #     The metadata is stored separately from the de-identified content itself
  #     and provides a granular record of both successful transformations and any
  #     failures that occurred.
  #
  #     Enabling this configuration is essential for users who need to access
  #     comprehensive information about the status, outcome, and specifics of
  #     each transformation. The details are captured in the
  #     {::Google::Cloud::Dlp::V2::TransformationDetails TransformationDetails}
  #     message for each operation.
  #
  #     Key use cases:
  #
  #     * **Auditing and compliance**
  #         * Provides a verifiable audit trail of de-identification activities,
  #         which is crucial for meeting regulatory requirements and internal
  #         data governance policies.
  #         * Logs what data was transformed, what transformations were applied,
  #         when they occurred, and their success status. This helps
  #         demonstrate accountability and due diligence in protecting
  #         sensitive data.
  #
  #     * **Troubleshooting and debugging**
  #         * Offers detailed error messages and context if a transformation
  #         fails. This information is useful for diagnosing and resolving
  #         issues in the de-identification pipeline.
  #         * Helps pinpoint the exact location and nature of failures, speeding
  #         up the debugging process.
  #
  #     * **Process verification and quality assurance**
  #         * Allows users to confirm that de-identification rules and
  #         transformations were applied correctly and consistently across
  #         the dataset as intended.
  #         * Helps in verifying the effectiveness of the chosen
  #         de-identification strategies.
  #
  #     * **Data lineage and impact analysis**
  #         * Creates a record of how data elements were modified, contributing
  #         to data lineage. This is useful for understanding the provenance
  #         of de-identified data.
  #         * Aids in assessing the potential impact of de-identification choices
  #         on downstream analytical processes or data usability.
  #
  #     * **Reporting and operational insights**
  #         * You can analyze the metadata stored in a queryable BigQuery table
  #         to generate reports on transformation success rates, common
  #         error types, processing volumes (e.g., transformedBytes), and the
  #         types of transformations applied.
  #         * These insights can inform optimization of de-identification
  #         configurations and resource planning.
  #
  #     To take advantage of these benefits, set this configuration. The stored
  #     details include a description of the transformation, success or
  #     error codes, error messages, the number of bytes transformed, the
  #     location of the transformed content, and identifiers for the job and
  #     source data.
  # @!attribute [rw] cloud_storage_output
  #   @return [::String]
  #     Required. User settable Cloud Storage bucket and folders to store
  #     de-identified files. This field must be set for Cloud Storage
  #     deidentification. The output Cloud Storage bucket must be different
  #     from the input bucket. De-identified files will overwrite files in the
  #     output path.
  #
  #     Form of: gs://bucket/folder/ or gs://bucket
  # @!attribute [rw] file_types_to_transform
  #   @return [::Array<::Google::Cloud::Dlp::V2::FileType>]
  #     List of user-specified file type groups to transform. If specified, only
  #     the files with these file types will be transformed. If empty, all
  #     supported files will be transformed. Supported types may be automatically
  #     added over time. If a file type is set in this field that isn't supported
  #     by the Deidentify action then the job will fail and will not be
  #     successfully created/started. Currently the only file types supported
  #     are: IMAGES, TEXT_FILES, CSV, TSV.
  class Deidentify
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Sends an email when the job completes. The email goes to IAM project owners
  # and technical [Essential
  # Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts).
  class JobNotificationEmails
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Enable Stackdriver metric dlp.googleapis.com/finding_count. This
  # will publish a metric to stack driver on each infotype requested and
  # how many findings were found for it. CustomDetectors will be bucketed
  # as 'Custom' under the Stackdriver label 'info_type'.
  class PublishToStackdriver
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#job_notification_emails ⇒ ::Google::Cloud::Dlp::V2::Action::JobNotificationEmails

Returns Sends an email when the job completes. The email goes to IAM project owners and technical Essential Contacts.

Note: The following fields are mutually exclusive: job_notification_emails, save_findings, pub_sub, publish_summary_to_cscc, publish_findings_to_cloud_data_catalog, deidentify, publish_to_stackdriver. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::Dlp::V2::Action::JobNotificationEmails) —

    Sends an email when the job completes. The email goes to IAM project owners and technical Essential Contacts.

    Note: The following fields are mutually exclusive: job_notification_emails, save_findings, pub_sub, publish_summary_to_cscc, publish_findings_to_cloud_data_catalog, deidentify, publish_to_stackdriver. If a field in that set is populated, all other fields in the set will automatically be cleared.



3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
 
# File 'proto_docs/google/privacy/dlp/v2/dlp.rb', line 3580

class Action
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # If set, the detailed findings will be persisted to the specified
  # OutputStorageConfig. Only a single instance of this action can be
  # specified.
  # Compatible with: Inspect, Risk
  # @!attribute [rw] output_config
  #   @return [::Google::Cloud::Dlp::V2::OutputStorageConfig]
  #     Location to store findings outside of DLP.
  class SaveFindings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Publish a message into a given Pub/Sub topic when DlpJob has completed. The
  # message contains a single field, `DlpJobName`, which is equal to the
  # finished job's
  # [`DlpJob.name`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob).
  # Compatible with: Inspect, Risk
  # @!attribute [rw] topic
  #   @return [::String]
  #     Cloud Pub/Sub topic to send notifications to. The topic must have given
  #     publishing access rights to the DLP API service account executing
  #     the long running DlpJob sending the notifications.
  #     Format is projects/\\{project}/topics/\\{topic}.
  class PublishToPubSub
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Publish the result summary of a DlpJob to [Security Command
  # Center](https://cloud.google.com/security-command-center). This action is
  # available for only projects that belong to an organization. This action
  # publishes the count of finding instances and their infoTypes. The summary
  # of findings are persisted in Security Command Center and are governed by
  # [service-specific policies for Security Command
  # Center](https://cloud.google.com/terms/service-terms). Only a single
  # instance of this action can be specified. Compatible with: Inspect
  class PublishSummaryToCscc
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag
  # templates are applied to the resource that Cloud DLP scanned. Data
  # Catalog tag templates are stored in the same project and region where the
  # BigQuery table exists. For Cloud DLP to create and apply the tag template,
  # the Cloud DLP service agent must have the
  # `roles/datacatalog.tagTemplateOwner` permission on the project. The tag
  # template contains fields summarizing the results of the DlpJob. Any field
  # values previously written by another DlpJob are deleted. [InfoType naming
  # patterns][google.privacy.dlp.v2.InfoType] are strictly enforced when using
  # this feature.
  #
  # Findings are persisted in Data Catalog storage and are governed by
  # service-specific policies for Data Catalog. For more information, see
  # [Service Specific Terms](https://cloud.google.com/terms/service-terms).
  #
  # Only a single instance of this action can be specified. This action is
  # allowed only if all resources being scanned are BigQuery tables.
  # Compatible with: Inspect
  class PublishFindingsToCloudDataCatalog
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Create a de-identified copy of a storage bucket. Only compatible
  # with Cloud Storage buckets.
  #
  #
  # A TransformationDetail will be created for each transformation.
  #
  #
  # Compatible with: Inspection of Cloud Storage
  # @!attribute [rw] transformation_config
  #   @return [::Google::Cloud::Dlp::V2::TransformationConfig]
  #     User specified deidentify templates and configs for structured,
  #     unstructured, and image files.
  # @!attribute [rw] transformation_details_storage_config
  #   @return [::Google::Cloud::Dlp::V2::TransformationDetailsStorageConfig]
  #     Config for storing transformation details.
  #
  #     This field specifies the configuration for storing detailed metadata
  #     about each transformation performed during a de-identification process.
  #     The metadata is stored separately from the de-identified content itself
  #     and provides a granular record of both successful transformations and any
  #     failures that occurred.
  #
  #     Enabling this configuration is essential for users who need to access
  #     comprehensive information about the status, outcome, and specifics of
  #     each transformation. The details are captured in the
  #     {::Google::Cloud::Dlp::V2::TransformationDetails TransformationDetails}
  #     message for each operation.
  #
  #     Key use cases:
  #
  #     * **Auditing and compliance**
  #         * Provides a verifiable audit trail of de-identification activities,
  #         which is crucial for meeting regulatory requirements and internal
  #         data governance policies.
  #         * Logs what data was transformed, what transformations were applied,
  #         when they occurred, and their success status. This helps
  #         demonstrate accountability and due diligence in protecting
  #         sensitive data.
  #
  #     * **Troubleshooting and debugging**
  #         * Offers detailed error messages and context if a transformation
  #         fails. This information is useful for diagnosing and resolving
  #         issues in the de-identification pipeline.
  #         * Helps pinpoint the exact location and nature of failures, speeding
  #         up the debugging process.
  #
  #     * **Process verification and quality assurance**
  #         * Allows users to confirm that de-identification rules and
  #         transformations were applied correctly and consistently across
  #         the dataset as intended.
  #         * Helps in verifying the effectiveness of the chosen
  #         de-identification strategies.
  #
  #     * **Data lineage and impact analysis**
  #         * Creates a record of how data elements were modified, contributing
  #         to data lineage. This is useful for understanding the provenance
  #         of de-identified data.
  #         * Aids in assessing the potential impact of de-identification choices
  #         on downstream analytical processes or data usability.
  #
  #     * **Reporting and operational insights**
  #         * You can analyze the metadata stored in a queryable BigQuery table
  #         to generate reports on transformation success rates, common
  #         error types, processing volumes (e.g., transformedBytes), and the
  #         types of transformations applied.
  #         * These insights can inform optimization of de-identification
  #         configurations and resource planning.
  #
  #     To take advantage of these benefits, set this configuration. The stored
  #     details include a description of the transformation, success or
  #     error codes, error messages, the number of bytes transformed, the
  #     location of the transformed content, and identifiers for the job and
  #     source data.
  # @!attribute [rw] cloud_storage_output
  #   @return [::String]
  #     Required. User settable Cloud Storage bucket and folders to store
  #     de-identified files. This field must be set for Cloud Storage
  #     deidentification. The output Cloud Storage bucket must be different
  #     from the input bucket. De-identified files will overwrite files in the
  #     output path.
  #
  #     Form of: gs://bucket/folder/ or gs://bucket
  # @!attribute [rw] file_types_to_transform
  #   @return [::Array<::Google::Cloud::Dlp::V2::FileType>]
  #     List of user-specified file type groups to transform. If specified, only
  #     the files with these file types will be transformed. If empty, all
  #     supported files will be transformed. Supported types may be automatically
  #     added over time. If a file type is set in this field that isn't supported
  #     by the Deidentify action then the job will fail and will not be
  #     successfully created/started. Currently the only file types supported
  #     are: IMAGES, TEXT_FILES, CSV, TSV.
  class Deidentify
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Sends an email when the job completes. The email goes to IAM project owners
  # and technical [Essential
  # Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts).
  class JobNotificationEmails
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Enable Stackdriver metric dlp.googleapis.com/finding_count. This
  # will publish a metric to stack driver on each infotype requested and
  # how many findings were found for it. CustomDetectors will be bucketed
  # as 'Custom' under the Stackdriver label 'info_type'.
  class PublishToStackdriver
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#pub_sub ⇒ ::Google::Cloud::Dlp::V2::Action::PublishToPubSub

Returns Publish a notification to a Pub/Sub topic.

Note: The following fields are mutually exclusive: pub_sub, save_findings, publish_summary_to_cscc, publish_findings_to_cloud_data_catalog, deidentify, job_notification_emails, publish_to_stackdriver. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::Dlp::V2::Action::PublishToPubSub) —

    Publish a notification to a Pub/Sub topic.

    Note: The following fields are mutually exclusive: pub_sub, save_findings, publish_summary_to_cscc, publish_findings_to_cloud_data_catalog, deidentify, job_notification_emails, publish_to_stackdriver. If a field in that set is populated, all other fields in the set will automatically be cleared.



3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
 
# File 'proto_docs/google/privacy/dlp/v2/dlp.rb', line 3580

class Action
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # If set, the detailed findings will be persisted to the specified
  # OutputStorageConfig. Only a single instance of this action can be
  # specified.
  # Compatible with: Inspect, Risk
  # @!attribute [rw] output_config
  #   @return [::Google::Cloud::Dlp::V2::OutputStorageConfig]
  #     Location to store findings outside of DLP.
  class SaveFindings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Publish a message into a given Pub/Sub topic when DlpJob has completed. The
  # message contains a single field, `DlpJobName`, which is equal to the
  # finished job's
  # [`DlpJob.name`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob).
  # Compatible with: Inspect, Risk
  # @!attribute [rw] topic
  #   @return [::String]
  #     Cloud Pub/Sub topic to send notifications to. The topic must have given
  #     publishing access rights to the DLP API service account executing
  #     the long running DlpJob sending the notifications.
  #     Format is projects/\\{project}/topics/\\{topic}.
  class PublishToPubSub
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Publish the result summary of a DlpJob to [Security Command
  # Center](https://cloud.google.com/security-command-center). This action is
  # available for only projects that belong to an organization. This action
  # publishes the count of finding instances and their infoTypes. The summary
  # of findings are persisted in Security Command Center and are governed by
  # [service-specific policies for Security Command
  # Center](https://cloud.google.com/terms/service-terms). Only a single
  # instance of this action can be specified. Compatible with: Inspect
  class PublishSummaryToCscc
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag
  # templates are applied to the resource that Cloud DLP scanned. Data
  # Catalog tag templates are stored in the same project and region where the
  # BigQuery table exists. For Cloud DLP to create and apply the tag template,
  # the Cloud DLP service agent must have the
  # `roles/datacatalog.tagTemplateOwner` permission on the project. The tag
  # template contains fields summarizing the results of the DlpJob. Any field
  # values previously written by another DlpJob are deleted. [InfoType naming
  # patterns][google.privacy.dlp.v2.InfoType] are strictly enforced when using
  # this feature.
  #
  # Findings are persisted in Data Catalog storage and are governed by
  # service-specific policies for Data Catalog. For more information, see
  # [Service Specific Terms](https://cloud.google.com/terms/service-terms).
  #
  # Only a single instance of this action can be specified. This action is
  # allowed only if all resources being scanned are BigQuery tables.
  # Compatible with: Inspect
  class PublishFindingsToCloudDataCatalog
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Create a de-identified copy of a storage bucket. Only compatible
  # with Cloud Storage buckets.
  #
  #
  # A TransformationDetail will be created for each transformation.
  #
  #
  # Compatible with: Inspection of Cloud Storage
  # @!attribute [rw] transformation_config
  #   @return [::Google::Cloud::Dlp::V2::TransformationConfig]
  #     User specified deidentify templates and configs for structured,
  #     unstructured, and image files.
  # @!attribute [rw] transformation_details_storage_config
  #   @return [::Google::Cloud::Dlp::V2::TransformationDetailsStorageConfig]
  #     Config for storing transformation details.
  #
  #     This field specifies the configuration for storing detailed metadata
  #     about each transformation performed during a de-identification process.
  #     The metadata is stored separately from the de-identified content itself
  #     and provides a granular record of both successful transformations and any
  #     failures that occurred.
  #
  #     Enabling this configuration is essential for users who need to access
  #     comprehensive information about the status, outcome, and specifics of
  #     each transformation. The details are captured in the
  #     {::Google::Cloud::Dlp::V2::TransformationDetails TransformationDetails}
  #     message for each operation.
  #
  #     Key use cases:
  #
  #     * **Auditing and compliance**
  #         * Provides a verifiable audit trail of de-identification activities,
  #         which is crucial for meeting regulatory requirements and internal
  #         data governance policies.
  #         * Logs what data was transformed, what transformations were applied,
  #         when they occurred, and their success status. This helps
  #         demonstrate accountability and due diligence in protecting
  #         sensitive data.
  #
  #     * **Troubleshooting and debugging**
  #         * Offers detailed error messages and context if a transformation
  #         fails. This information is useful for diagnosing and resolving
  #         issues in the de-identification pipeline.
  #         * Helps pinpoint the exact location and nature of failures, speeding
  #         up the debugging process.
  #
  #     * **Process verification and quality assurance**
  #         * Allows users to confirm that de-identification rules and
  #         transformations were applied correctly and consistently across
  #         the dataset as intended.
  #         * Helps in verifying the effectiveness of the chosen
  #         de-identification strategies.
  #
  #     * **Data lineage and impact analysis**
  #         * Creates a record of how data elements were modified, contributing
  #         to data lineage. This is useful for understanding the provenance
  #         of de-identified data.
  #         * Aids in assessing the potential impact of de-identification choices
  #         on downstream analytical processes or data usability.
  #
  #     * **Reporting and operational insights**
  #         * You can analyze the metadata stored in a queryable BigQuery table
  #         to generate reports on transformation success rates, common
  #         error types, processing volumes (e.g., transformedBytes), and the
  #         types of transformations applied.
  #         * These insights can inform optimization of de-identification
  #         configurations and resource planning.
  #
  #     To take advantage of these benefits, set this configuration. The stored
  #     details include a description of the transformation, success or
  #     error codes, error messages, the number of bytes transformed, the
  #     location of the transformed content, and identifiers for the job and
  #     source data.
  # @!attribute [rw] cloud_storage_output
  #   @return [::String]
  #     Required. User settable Cloud Storage bucket and folders to store
  #     de-identified files. This field must be set for Cloud Storage
  #     deidentification. The output Cloud Storage bucket must be different
  #     from the input bucket. De-identified files will overwrite files in the
  #     output path.
  #
  #     Form of: gs://bucket/folder/ or gs://bucket
  # @!attribute [rw] file_types_to_transform
  #   @return [::Array<::Google::Cloud::Dlp::V2::FileType>]
  #     List of user-specified file type groups to transform. If specified, only
  #     the files with these file types will be transformed. If empty, all
  #     supported files will be transformed. Supported types may be automatically
  #     added over time. If a file type is set in this field that isn't supported
  #     by the Deidentify action then the job will fail and will not be
  #     successfully created/started. Currently the only file types supported
  #     are: IMAGES, TEXT_FILES, CSV, TSV.
  class Deidentify
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Sends an email when the job completes. The email goes to IAM project owners
  # and technical [Essential
  # Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts).
  class JobNotificationEmails
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Enable Stackdriver metric dlp.googleapis.com/finding_count. This
  # will publish a metric to stack driver on each infotype requested and
  # how many findings were found for it. CustomDetectors will be bucketed
  # as 'Custom' under the Stackdriver label 'info_type'.
  class PublishToStackdriver
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#publish_findings_to_cloud_data_catalog ⇒ ::Google::Cloud::Dlp::V2::Action::PublishFindingsToCloudDataCatalog

Returns Publish findings to Cloud Datahub.

Note: The following fields are mutually exclusive: publish_findings_to_cloud_data_catalog, save_findings, pub_sub, publish_summary_to_cscc, deidentify, job_notification_emails, publish_to_stackdriver. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::Dlp::V2::Action::PublishFindingsToCloudDataCatalog) —

    Publish findings to Cloud Datahub.

    Note: The following fields are mutually exclusive: publish_findings_to_cloud_data_catalog, save_findings, pub_sub, publish_summary_to_cscc, deidentify, job_notification_emails, publish_to_stackdriver. If a field in that set is populated, all other fields in the set will automatically be cleared.



3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
 
# File 'proto_docs/google/privacy/dlp/v2/dlp.rb', line 3580

class Action
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # If set, the detailed findings will be persisted to the specified
  # OutputStorageConfig. Only a single instance of this action can be
  # specified.
  # Compatible with: Inspect, Risk
  # @!attribute [rw] output_config
  #   @return [::Google::Cloud::Dlp::V2::OutputStorageConfig]
  #     Location to store findings outside of DLP.
  class SaveFindings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Publish a message into a given Pub/Sub topic when DlpJob has completed. The
  # message contains a single field, `DlpJobName`, which is equal to the
  # finished job's
  # [`DlpJob.name`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob).
  # Compatible with: Inspect, Risk
  # @!attribute [rw] topic
  #   @return [::String]
  #     Cloud Pub/Sub topic to send notifications to. The topic must have given
  #     publishing access rights to the DLP API service account executing
  #     the long running DlpJob sending the notifications.
  #     Format is projects/\\{project}/topics/\\{topic}.
  class PublishToPubSub
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Publish the result summary of a DlpJob to [Security Command
  # Center](https://cloud.google.com/security-command-center). This action is
  # available for only projects that belong to an organization. This action
  # publishes the count of finding instances and their infoTypes. The summary
  # of findings are persisted in Security Command Center and are governed by
  # [service-specific policies for Security Command
  # Center](https://cloud.google.com/terms/service-terms). Only a single
  # instance of this action can be specified. Compatible with: Inspect
  class PublishSummaryToCscc
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag
  # templates are applied to the resource that Cloud DLP scanned. Data
  # Catalog tag templates are stored in the same project and region where the
  # BigQuery table exists. For Cloud DLP to create and apply the tag template,
  # the Cloud DLP service agent must have the
  # `roles/datacatalog.tagTemplateOwner` permission on the project. The tag
  # template contains fields summarizing the results of the DlpJob. Any field
  # values previously written by another DlpJob are deleted. [InfoType naming
  # patterns][google.privacy.dlp.v2.InfoType] are strictly enforced when using
  # this feature.
  #
  # Findings are persisted in Data Catalog storage and are governed by
  # service-specific policies for Data Catalog. For more information, see
  # [Service Specific Terms](https://cloud.google.com/terms/service-terms).
  #
  # Only a single instance of this action can be specified. This action is
  # allowed only if all resources being scanned are BigQuery tables.
  # Compatible with: Inspect
  class PublishFindingsToCloudDataCatalog
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Create a de-identified copy of a storage bucket. Only compatible
  # with Cloud Storage buckets.
  #
  #
  # A TransformationDetail will be created for each transformation.
  #
  #
  # Compatible with: Inspection of Cloud Storage
  # @!attribute [rw] transformation_config
  #   @return [::Google::Cloud::Dlp::V2::TransformationConfig]
  #     User specified deidentify templates and configs for structured,
  #     unstructured, and image files.
  # @!attribute [rw] transformation_details_storage_config
  #   @return [::Google::Cloud::Dlp::V2::TransformationDetailsStorageConfig]
  #     Config for storing transformation details.
  #
  #     This field specifies the configuration for storing detailed metadata
  #     about each transformation performed during a de-identification process.
  #     The metadata is stored separately from the de-identified content itself
  #     and provides a granular record of both successful transformations and any
  #     failures that occurred.
  #
  #     Enabling this configuration is essential for users who need to access
  #     comprehensive information about the status, outcome, and specifics of
  #     each transformation. The details are captured in the
  #     {::Google::Cloud::Dlp::V2::TransformationDetails TransformationDetails}
  #     message for each operation.
  #
  #     Key use cases:
  #
  #     * **Auditing and compliance**
  #         * Provides a verifiable audit trail of de-identification activities,
  #         which is crucial for meeting regulatory requirements and internal
  #         data governance policies.
  #         * Logs what data was transformed, what transformations were applied,
  #         when they occurred, and their success status. This helps
  #         demonstrate accountability and due diligence in protecting
  #         sensitive data.
  #
  #     * **Troubleshooting and debugging**
  #         * Offers detailed error messages and context if a transformation
  #         fails. This information is useful for diagnosing and resolving
  #         issues in the de-identification pipeline.
  #         * Helps pinpoint the exact location and nature of failures, speeding
  #         up the debugging process.
  #
  #     * **Process verification and quality assurance**
  #         * Allows users to confirm that de-identification rules and
  #         transformations were applied correctly and consistently across
  #         the dataset as intended.
  #         * Helps in verifying the effectiveness of the chosen
  #         de-identification strategies.
  #
  #     * **Data lineage and impact analysis**
  #         * Creates a record of how data elements were modified, contributing
  #         to data lineage. This is useful for understanding the provenance
  #         of de-identified data.
  #         * Aids in assessing the potential impact of de-identification choices
  #         on downstream analytical processes or data usability.
  #
  #     * **Reporting and operational insights**
  #         * You can analyze the metadata stored in a queryable BigQuery table
  #         to generate reports on transformation success rates, common
  #         error types, processing volumes (e.g., transformedBytes), and the
  #         types of transformations applied.
  #         * These insights can inform optimization of de-identification
  #         configurations and resource planning.
  #
  #     To take advantage of these benefits, set this configuration. The stored
  #     details include a description of the transformation, success or
  #     error codes, error messages, the number of bytes transformed, the
  #     location of the transformed content, and identifiers for the job and
  #     source data.
  # @!attribute [rw] cloud_storage_output
  #   @return [::String]
  #     Required. User settable Cloud Storage bucket and folders to store
  #     de-identified files. This field must be set for Cloud Storage
  #     deidentification. The output Cloud Storage bucket must be different
  #     from the input bucket. De-identified files will overwrite files in the
  #     output path.
  #
  #     Form of: gs://bucket/folder/ or gs://bucket
  # @!attribute [rw] file_types_to_transform
  #   @return [::Array<::Google::Cloud::Dlp::V2::FileType>]
  #     List of user-specified file type groups to transform. If specified, only
  #     the files with these file types will be transformed. If empty, all
  #     supported files will be transformed. Supported types may be automatically
  #     added over time. If a file type is set in this field that isn't supported
  #     by the Deidentify action then the job will fail and will not be
  #     successfully created/started. Currently the only file types supported
  #     are: IMAGES, TEXT_FILES, CSV, TSV.
  class Deidentify
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Sends an email when the job completes. The email goes to IAM project owners
  # and technical [Essential
  # Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts).
  class JobNotificationEmails
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Enable Stackdriver metric dlp.googleapis.com/finding_count. This
  # will publish a metric to stack driver on each infotype requested and
  # how many findings were found for it. CustomDetectors will be bucketed
  # as 'Custom' under the Stackdriver label 'info_type'.
  class PublishToStackdriver
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#publish_summary_to_cscc ⇒ ::Google::Cloud::Dlp::V2::Action::PublishSummaryToCscc

Returns Publish summary to Cloud Security Command Center (Alpha).

Note: The following fields are mutually exclusive: publish_summary_to_cscc, save_findings, pub_sub, publish_findings_to_cloud_data_catalog, deidentify, job_notification_emails, publish_to_stackdriver. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::Dlp::V2::Action::PublishSummaryToCscc) —

    Publish summary to Cloud Security Command Center (Alpha).

    Note: The following fields are mutually exclusive: publish_summary_to_cscc, save_findings, pub_sub, publish_findings_to_cloud_data_catalog, deidentify, job_notification_emails, publish_to_stackdriver. If a field in that set is populated, all other fields in the set will automatically be cleared.



3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
 
# File 'proto_docs/google/privacy/dlp/v2/dlp.rb', line 3580

class Action
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # If set, the detailed findings will be persisted to the specified
  # OutputStorageConfig. Only a single instance of this action can be
  # specified.
  # Compatible with: Inspect, Risk
  # @!attribute [rw] output_config
  #   @return [::Google::Cloud::Dlp::V2::OutputStorageConfig]
  #     Location to store findings outside of DLP.
  class SaveFindings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Publish a message into a given Pub/Sub topic when DlpJob has completed. The
  # message contains a single field, `DlpJobName`, which is equal to the
  # finished job's
  # [`DlpJob.name`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob).
  # Compatible with: Inspect, Risk
  # @!attribute [rw] topic
  #   @return [::String]
  #     Cloud Pub/Sub topic to send notifications to. The topic must have given
  #     publishing access rights to the DLP API service account executing
  #     the long running DlpJob sending the notifications.
  #     Format is projects/\\{project}/topics/\\{topic}.
  class PublishToPubSub
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Publish the result summary of a DlpJob to [Security Command
  # Center](https://cloud.google.com/security-command-center). This action is
  # available for only projects that belong to an organization. This action
  # publishes the count of finding instances and their infoTypes. The summary
  # of findings are persisted in Security Command Center and are governed by
  # [service-specific policies for Security Command
  # Center](https://cloud.google.com/terms/service-terms). Only a single
  # instance of this action can be specified. Compatible with: Inspect
  class PublishSummaryToCscc
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag
  # templates are applied to the resource that Cloud DLP scanned. Data
  # Catalog tag templates are stored in the same project and region where the
  # BigQuery table exists. For Cloud DLP to create and apply the tag template,
  # the Cloud DLP service agent must have the
  # `roles/datacatalog.tagTemplateOwner` permission on the project. The tag
  # template contains fields summarizing the results of the DlpJob. Any field
  # values previously written by another DlpJob are deleted. [InfoType naming
  # patterns][google.privacy.dlp.v2.InfoType] are strictly enforced when using
  # this feature.
  #
  # Findings are persisted in Data Catalog storage and are governed by
  # service-specific policies for Data Catalog. For more information, see
  # [Service Specific Terms](https://cloud.google.com/terms/service-terms).
  #
  # Only a single instance of this action can be specified. This action is
  # allowed only if all resources being scanned are BigQuery tables.
  # Compatible with: Inspect
  class PublishFindingsToCloudDataCatalog
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Create a de-identified copy of a storage bucket. Only compatible
  # with Cloud Storage buckets.
  #
  #
  # A TransformationDetail will be created for each transformation.
  #
  #
  # Compatible with: Inspection of Cloud Storage
  # @!attribute [rw] transformation_config
  #   @return [::Google::Cloud::Dlp::V2::TransformationConfig]
  #     User specified deidentify templates and configs for structured,
  #     unstructured, and image files.
  # @!attribute [rw] transformation_details_storage_config
  #   @return [::Google::Cloud::Dlp::V2::TransformationDetailsStorageConfig]
  #     Config for storing transformation details.
  #
  #     This field specifies the configuration for storing detailed metadata
  #     about each transformation performed during a de-identification process.
  #     The metadata is stored separately from the de-identified content itself
  #     and provides a granular record of both successful transformations and any
  #     failures that occurred.
  #
  #     Enabling this configuration is essential for users who need to access
  #     comprehensive information about the status, outcome, and specifics of
  #     each transformation. The details are captured in the
  #     {::Google::Cloud::Dlp::V2::TransformationDetails TransformationDetails}
  #     message for each operation.
  #
  #     Key use cases:
  #
  #     * **Auditing and compliance**
  #         * Provides a verifiable audit trail of de-identification activities,
  #         which is crucial for meeting regulatory requirements and internal
  #         data governance policies.
  #         * Logs what data was transformed, what transformations were applied,
  #         when they occurred, and their success status. This helps
  #         demonstrate accountability and due diligence in protecting
  #         sensitive data.
  #
  #     * **Troubleshooting and debugging**
  #         * Offers detailed error messages and context if a transformation
  #         fails. This information is useful for diagnosing and resolving
  #         issues in the de-identification pipeline.
  #         * Helps pinpoint the exact location and nature of failures, speeding
  #         up the debugging process.
  #
  #     * **Process verification and quality assurance**
  #         * Allows users to confirm that de-identification rules and
  #         transformations were applied correctly and consistently across
  #         the dataset as intended.
  #         * Helps in verifying the effectiveness of the chosen
  #         de-identification strategies.
  #
  #     * **Data lineage and impact analysis**
  #         * Creates a record of how data elements were modified, contributing
  #         to data lineage. This is useful for understanding the provenance
  #         of de-identified data.
  #         * Aids in assessing the potential impact of de-identification choices
  #         on downstream analytical processes or data usability.
  #
  #     * **Reporting and operational insights**
  #         * You can analyze the metadata stored in a queryable BigQuery table
  #         to generate reports on transformation success rates, common
  #         error types, processing volumes (e.g., transformedBytes), and the
  #         types of transformations applied.
  #         * These insights can inform optimization of de-identification
  #         configurations and resource planning.
  #
  #     To take advantage of these benefits, set this configuration. The stored
  #     details include a description of the transformation, success or
  #     error codes, error messages, the number of bytes transformed, the
  #     location of the transformed content, and identifiers for the job and
  #     source data.
  # @!attribute [rw] cloud_storage_output
  #   @return [::String]
  #     Required. User settable Cloud Storage bucket and folders to store
  #     de-identified files. This field must be set for Cloud Storage
  #     deidentification. The output Cloud Storage bucket must be different
  #     from the input bucket. De-identified files will overwrite files in the
  #     output path.
  #
  #     Form of: gs://bucket/folder/ or gs://bucket
  # @!attribute [rw] file_types_to_transform
  #   @return [::Array<::Google::Cloud::Dlp::V2::FileType>]
  #     List of user-specified file type groups to transform. If specified, only
  #     the files with these file types will be transformed. If empty, all
  #     supported files will be transformed. Supported types may be automatically
  #     added over time. If a file type is set in this field that isn't supported
  #     by the Deidentify action then the job will fail and will not be
  #     successfully created/started. Currently the only file types supported
  #     are: IMAGES, TEXT_FILES, CSV, TSV.
  class Deidentify
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Sends an email when the job completes. The email goes to IAM project owners
  # and technical [Essential
  # Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts).
  class JobNotificationEmails
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Enable Stackdriver metric dlp.googleapis.com/finding_count. This
  # will publish a metric to stack driver on each infotype requested and
  # how many findings were found for it. CustomDetectors will be bucketed
  # as 'Custom' under the Stackdriver label 'info_type'.
  class PublishToStackdriver
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#publish_to_stackdriver ⇒ ::Google::Cloud::Dlp::V2::Action::PublishToStackdriver

Returns Enable Stackdriver metric dlp.googleapis.com/finding_count.

Note: The following fields are mutually exclusive: publish_to_stackdriver, save_findings, pub_sub, publish_summary_to_cscc, publish_findings_to_cloud_data_catalog, deidentify, job_notification_emails. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::Dlp::V2::Action::PublishToStackdriver) —

    Enable Stackdriver metric dlp.googleapis.com/finding_count.

    Note: The following fields are mutually exclusive: publish_to_stackdriver, save_findings, pub_sub, publish_summary_to_cscc, publish_findings_to_cloud_data_catalog, deidentify, job_notification_emails. If a field in that set is populated, all other fields in the set will automatically be cleared.



3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
 
# File 'proto_docs/google/privacy/dlp/v2/dlp.rb', line 3580

class Action
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # If set, the detailed findings will be persisted to the specified
  # OutputStorageConfig. Only a single instance of this action can be
  # specified.
  # Compatible with: Inspect, Risk
  # @!attribute [rw] output_config
  #   @return [::Google::Cloud::Dlp::V2::OutputStorageConfig]
  #     Location to store findings outside of DLP.
  class SaveFindings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Publish a message into a given Pub/Sub topic when DlpJob has completed. The
  # message contains a single field, `DlpJobName`, which is equal to the
  # finished job's
  # [`DlpJob.name`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob).
  # Compatible with: Inspect, Risk
  # @!attribute [rw] topic
  #   @return [::String]
  #     Cloud Pub/Sub topic to send notifications to. The topic must have given
  #     publishing access rights to the DLP API service account executing
  #     the long running DlpJob sending the notifications.
  #     Format is projects/\\{project}/topics/\\{topic}.
  class PublishToPubSub
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Publish the result summary of a DlpJob to [Security Command
  # Center](https://cloud.google.com/security-command-center). This action is
  # available for only projects that belong to an organization. This action
  # publishes the count of finding instances and their infoTypes. The summary
  # of findings are persisted in Security Command Center and are governed by
  # [service-specific policies for Security Command
  # Center](https://cloud.google.com/terms/service-terms). Only a single
  # instance of this action can be specified. Compatible with: Inspect
  class PublishSummaryToCscc
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag
  # templates are applied to the resource that Cloud DLP scanned. Data
  # Catalog tag templates are stored in the same project and region where the
  # BigQuery table exists. For Cloud DLP to create and apply the tag template,
  # the Cloud DLP service agent must have the
  # `roles/datacatalog.tagTemplateOwner` permission on the project. The tag
  # template contains fields summarizing the results of the DlpJob. Any field
  # values previously written by another DlpJob are deleted. [InfoType naming
  # patterns][google.privacy.dlp.v2.InfoType] are strictly enforced when using
  # this feature.
  #
  # Findings are persisted in Data Catalog storage and are governed by
  # service-specific policies for Data Catalog. For more information, see
  # [Service Specific Terms](https://cloud.google.com/terms/service-terms).
  #
  # Only a single instance of this action can be specified. This action is
  # allowed only if all resources being scanned are BigQuery tables.
  # Compatible with: Inspect
  class PublishFindingsToCloudDataCatalog
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Create a de-identified copy of a storage bucket. Only compatible
  # with Cloud Storage buckets.
  #
  #
  # A TransformationDetail will be created for each transformation.
  #
  #
  # Compatible with: Inspection of Cloud Storage
  # @!attribute [rw] transformation_config
  #   @return [::Google::Cloud::Dlp::V2::TransformationConfig]
  #     User specified deidentify templates and configs for structured,
  #     unstructured, and image files.
  # @!attribute [rw] transformation_details_storage_config
  #   @return [::Google::Cloud::Dlp::V2::TransformationDetailsStorageConfig]
  #     Config for storing transformation details.
  #
  #     This field specifies the configuration for storing detailed metadata
  #     about each transformation performed during a de-identification process.
  #     The metadata is stored separately from the de-identified content itself
  #     and provides a granular record of both successful transformations and any
  #     failures that occurred.
  #
  #     Enabling this configuration is essential for users who need to access
  #     comprehensive information about the status, outcome, and specifics of
  #     each transformation. The details are captured in the
  #     {::Google::Cloud::Dlp::V2::TransformationDetails TransformationDetails}
  #     message for each operation.
  #
  #     Key use cases:
  #
  #     * **Auditing and compliance**
  #         * Provides a verifiable audit trail of de-identification activities,
  #         which is crucial for meeting regulatory requirements and internal
  #         data governance policies.
  #         * Logs what data was transformed, what transformations were applied,
  #         when they occurred, and their success status. This helps
  #         demonstrate accountability and due diligence in protecting
  #         sensitive data.
  #
  #     * **Troubleshooting and debugging**
  #         * Offers detailed error messages and context if a transformation
  #         fails. This information is useful for diagnosing and resolving
  #         issues in the de-identification pipeline.
  #         * Helps pinpoint the exact location and nature of failures, speeding
  #         up the debugging process.
  #
  #     * **Process verification and quality assurance**
  #         * Allows users to confirm that de-identification rules and
  #         transformations were applied correctly and consistently across
  #         the dataset as intended.
  #         * Helps in verifying the effectiveness of the chosen
  #         de-identification strategies.
  #
  #     * **Data lineage and impact analysis**
  #         * Creates a record of how data elements were modified, contributing
  #         to data lineage. This is useful for understanding the provenance
  #         of de-identified data.
  #         * Aids in assessing the potential impact of de-identification choices
  #         on downstream analytical processes or data usability.
  #
  #     * **Reporting and operational insights**
  #         * You can analyze the metadata stored in a queryable BigQuery table
  #         to generate reports on transformation success rates, common
  #         error types, processing volumes (e.g., transformedBytes), and the
  #         types of transformations applied.
  #         * These insights can inform optimization of de-identification
  #         configurations and resource planning.
  #
  #     To take advantage of these benefits, set this configuration. The stored
  #     details include a description of the transformation, success or
  #     error codes, error messages, the number of bytes transformed, the
  #     location of the transformed content, and identifiers for the job and
  #     source data.
  # @!attribute [rw] cloud_storage_output
  #   @return [::String]
  #     Required. User settable Cloud Storage bucket and folders to store
  #     de-identified files. This field must be set for Cloud Storage
  #     deidentification. The output Cloud Storage bucket must be different
  #     from the input bucket. De-identified files will overwrite files in the
  #     output path.
  #
  #     Form of: gs://bucket/folder/ or gs://bucket
  # @!attribute [rw] file_types_to_transform
  #   @return [::Array<::Google::Cloud::Dlp::V2::FileType>]
  #     List of user-specified file type groups to transform. If specified, only
  #     the files with these file types will be transformed. If empty, all
  #     supported files will be transformed. Supported types may be automatically
  #     added over time. If a file type is set in this field that isn't supported
  #     by the Deidentify action then the job will fail and will not be
  #     successfully created/started. Currently the only file types supported
  #     are: IMAGES, TEXT_FILES, CSV, TSV.
  class Deidentify
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Sends an email when the job completes. The email goes to IAM project owners
  # and technical [Essential
  # Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts).
  class JobNotificationEmails
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Enable Stackdriver metric dlp.googleapis.com/finding_count. This
  # will publish a metric to stack driver on each infotype requested and
  # how many findings were found for it. CustomDetectors will be bucketed
  # as 'Custom' under the Stackdriver label 'info_type'.
  class PublishToStackdriver
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#save_findings ⇒ ::Google::Cloud::Dlp::V2::Action::SaveFindings

Returns Save resulting findings in a provided location.

Note: The following fields are mutually exclusive: save_findings, pub_sub, publish_summary_to_cscc, publish_findings_to_cloud_data_catalog, deidentify, job_notification_emails, publish_to_stackdriver. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::Dlp::V2::Action::SaveFindings) —

    Save resulting findings in a provided location.

    Note: The following fields are mutually exclusive: save_findings, pub_sub, publish_summary_to_cscc, publish_findings_to_cloud_data_catalog, deidentify, job_notification_emails, publish_to_stackdriver. If a field in that set is populated, all other fields in the set will automatically be cleared.



3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
 
# File 'proto_docs/google/privacy/dlp/v2/dlp.rb', line 3580

class Action
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # If set, the detailed findings will be persisted to the specified
  # OutputStorageConfig. Only a single instance of this action can be
  # specified.
  # Compatible with: Inspect, Risk
  # @!attribute [rw] output_config
  #   @return [::Google::Cloud::Dlp::V2::OutputStorageConfig]
  #     Location to store findings outside of DLP.
  class SaveFindings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Publish a message into a given Pub/Sub topic when DlpJob has completed. The
  # message contains a single field, `DlpJobName`, which is equal to the
  # finished job's
  # [`DlpJob.name`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob).
  # Compatible with: Inspect, Risk
  # @!attribute [rw] topic
  #   @return [::String]
  #     Cloud Pub/Sub topic to send notifications to. The topic must have given
  #     publishing access rights to the DLP API service account executing
  #     the long running DlpJob sending the notifications.
  #     Format is projects/\\{project}/topics/\\{topic}.
  class PublishToPubSub
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Publish the result summary of a DlpJob to [Security Command
  # Center](https://cloud.google.com/security-command-center). This action is
  # available for only projects that belong to an organization. This action
  # publishes the count of finding instances and their infoTypes. The summary
  # of findings are persisted in Security Command Center and are governed by
  # [service-specific policies for Security Command
  # Center](https://cloud.google.com/terms/service-terms). Only a single
  # instance of this action can be specified. Compatible with: Inspect
  class PublishSummaryToCscc
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Publish findings of a DlpJob to Data Catalog. In Data Catalog, tag
  # templates are applied to the resource that Cloud DLP scanned. Data
  # Catalog tag templates are stored in the same project and region where the
  # BigQuery table exists. For Cloud DLP to create and apply the tag template,
  # the Cloud DLP service agent must have the
  # `roles/datacatalog.tagTemplateOwner` permission on the project. The tag
  # template contains fields summarizing the results of the DlpJob. Any field
  # values previously written by another DlpJob are deleted. [InfoType naming
  # patterns][google.privacy.dlp.v2.InfoType] are strictly enforced when using
  # this feature.
  #
  # Findings are persisted in Data Catalog storage and are governed by
  # service-specific policies for Data Catalog. For more information, see
  # [Service Specific Terms](https://cloud.google.com/terms/service-terms).
  #
  # Only a single instance of this action can be specified. This action is
  # allowed only if all resources being scanned are BigQuery tables.
  # Compatible with: Inspect
  class PublishFindingsToCloudDataCatalog
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Create a de-identified copy of a storage bucket. Only compatible
  # with Cloud Storage buckets.
  #
  #
  # A TransformationDetail will be created for each transformation.
  #
  #
  # Compatible with: Inspection of Cloud Storage
  # @!attribute [rw] transformation_config
  #   @return [::Google::Cloud::Dlp::V2::TransformationConfig]
  #     User specified deidentify templates and configs for structured,
  #     unstructured, and image files.
  # @!attribute [rw] transformation_details_storage_config
  #   @return [::Google::Cloud::Dlp::V2::TransformationDetailsStorageConfig]
  #     Config for storing transformation details.
  #
  #     This field specifies the configuration for storing detailed metadata
  #     about each transformation performed during a de-identification process.
  #     The metadata is stored separately from the de-identified content itself
  #     and provides a granular record of both successful transformations and any
  #     failures that occurred.
  #
  #     Enabling this configuration is essential for users who need to access
  #     comprehensive information about the status, outcome, and specifics of
  #     each transformation. The details are captured in the
  #     {::Google::Cloud::Dlp::V2::TransformationDetails TransformationDetails}
  #     message for each operation.
  #
  #     Key use cases:
  #
  #     * **Auditing and compliance**
  #         * Provides a verifiable audit trail of de-identification activities,
  #         which is crucial for meeting regulatory requirements and internal
  #         data governance policies.
  #         * Logs what data was transformed, what transformations were applied,
  #         when they occurred, and their success status. This helps
  #         demonstrate accountability and due diligence in protecting
  #         sensitive data.
  #
  #     * **Troubleshooting and debugging**
  #         * Offers detailed error messages and context if a transformation
  #         fails. This information is useful for diagnosing and resolving
  #         issues in the de-identification pipeline.
  #         * Helps pinpoint the exact location and nature of failures, speeding
  #         up the debugging process.
  #
  #     * **Process verification and quality assurance**
  #         * Allows users to confirm that de-identification rules and
  #         transformations were applied correctly and consistently across
  #         the dataset as intended.
  #         * Helps in verifying the effectiveness of the chosen
  #         de-identification strategies.
  #
  #     * **Data lineage and impact analysis**
  #         * Creates a record of how data elements were modified, contributing
  #         to data lineage. This is useful for understanding the provenance
  #         of de-identified data.
  #         * Aids in assessing the potential impact of de-identification choices
  #         on downstream analytical processes or data usability.
  #
  #     * **Reporting and operational insights**
  #         * You can analyze the metadata stored in a queryable BigQuery table
  #         to generate reports on transformation success rates, common
  #         error types, processing volumes (e.g., transformedBytes), and the
  #         types of transformations applied.
  #         * These insights can inform optimization of de-identification
  #         configurations and resource planning.
  #
  #     To take advantage of these benefits, set this configuration. The stored
  #     details include a description of the transformation, success or
  #     error codes, error messages, the number of bytes transformed, the
  #     location of the transformed content, and identifiers for the job and
  #     source data.
  # @!attribute [rw] cloud_storage_output
  #   @return [::String]
  #     Required. User settable Cloud Storage bucket and folders to store
  #     de-identified files. This field must be set for Cloud Storage
  #     deidentification. The output Cloud Storage bucket must be different
  #     from the input bucket. De-identified files will overwrite files in the
  #     output path.
  #
  #     Form of: gs://bucket/folder/ or gs://bucket
  # @!attribute [rw] file_types_to_transform
  #   @return [::Array<::Google::Cloud::Dlp::V2::FileType>]
  #     List of user-specified file type groups to transform. If specified, only
  #     the files with these file types will be transformed. If empty, all
  #     supported files will be transformed. Supported types may be automatically
  #     added over time. If a file type is set in this field that isn't supported
  #     by the Deidentify action then the job will fail and will not be
  #     successfully created/started. Currently the only file types supported
  #     are: IMAGES, TEXT_FILES, CSV, TSV.
  class Deidentify
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Sends an email when the job completes. The email goes to IAM project owners
  # and technical [Essential
  # Contacts](https://cloud.google.com/resource-manager/docs/managing-notification-contacts).
  class JobNotificationEmails
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Enable Stackdriver metric dlp.googleapis.com/finding_count. This
  # will publish a metric to stack driver on each infotype requested and
  # how many findings were found for it. CustomDetectors will be bucketed
  # as 'Custom' under the Stackdriver label 'info_type'.
  class PublishToStackdriver
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end