Class: Google::Cloud::Dlp::V2::DiscoveryConfig

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

Overview

Configuration for discovery to scan resources for profile generation. Only one discovery configuration may exist per organization, folder, or project.

The generated data profiles are retained according to the data retention policy.

Defined Under Namespace

Modules: Status Classes: OrgConfig

Instance Attribute Summary collapse

Instance Attribute Details

#actions ⇒ ::Array<::Google::Cloud::Dlp::V2::DataProfileAction>

Returns Actions to execute at the completion of scanning.

Returns:



4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
 
# File 'proto_docs/google/privacy/dlp/v2/dlp.rb', line 4701

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

  # Project and scan location information. Only set when the parent is an org.
  # @!attribute [rw] location
  #   @return [::Google::Cloud::Dlp::V2::DiscoveryStartingLocation]
  #     The data to scan: folder, org, or project
  # @!attribute [rw] project_id
  #   @return [::String]
  #     The project that will run the scan. The DLP service
  #     account that exists within this project must have access to all resources
  #     that are profiled, and the DLP API must be enabled.
  class OrgConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Whether the discovery config is currently active. New options may be added
  # at a later time.
  module Status
    # Unused
    STATUS_UNSPECIFIED = 0

    # The discovery config is currently active.
    RUNNING = 1

    # The discovery config is paused temporarily.
    PAUSED = 2
  end
end

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The creation timestamp of a DiscoveryConfig.

Returns:



4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
 
# File 'proto_docs/google/privacy/dlp/v2/dlp.rb', line 4701

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

  # Project and scan location information. Only set when the parent is an org.
  # @!attribute [rw] location
  #   @return [::Google::Cloud::Dlp::V2::DiscoveryStartingLocation]
  #     The data to scan: folder, org, or project
  # @!attribute [rw] project_id
  #   @return [::String]
  #     The project that will run the scan. The DLP service
  #     account that exists within this project must have access to all resources
  #     that are profiled, and the DLP API must be enabled.
  class OrgConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Whether the discovery config is currently active. New options may be added
  # at a later time.
  module Status
    # Unused
    STATUS_UNSPECIFIED = 0

    # The discovery config is currently active.
    RUNNING = 1

    # The discovery config is paused temporarily.
    PAUSED = 2
  end
end

#display_name ⇒ ::String

Returns Display name (max 100 chars).

Returns:

  • (::String) —

    Display name (max 100 chars)



4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
 
# File 'proto_docs/google/privacy/dlp/v2/dlp.rb', line 4701

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

  # Project and scan location information. Only set when the parent is an org.
  # @!attribute [rw] location
  #   @return [::Google::Cloud::Dlp::V2::DiscoveryStartingLocation]
  #     The data to scan: folder, org, or project
  # @!attribute [rw] project_id
  #   @return [::String]
  #     The project that will run the scan. The DLP service
  #     account that exists within this project must have access to all resources
  #     that are profiled, and the DLP API must be enabled.
  class OrgConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Whether the discovery config is currently active. New options may be added
  # at a later time.
  module Status
    # Unused
    STATUS_UNSPECIFIED = 0

    # The discovery config is currently active.
    RUNNING = 1

    # The discovery config is paused temporarily.
    PAUSED = 2
  end
end

#errors ⇒ ::Array<::Google::Cloud::Dlp::V2::Error> (readonly)

Returns Output only. A stream of errors encountered when the config was activated. Repeated errors may result in the config automatically being paused. Output only field. Will return the last 100 errors. Whenever the config is modified this list will be cleared.

Returns:

  • (::Array<::Google::Cloud::Dlp::V2::Error>) —

    Output only. A stream of errors encountered when the config was activated. Repeated errors may result in the config automatically being paused. Output only field. Will return the last 100 errors. Whenever the config is modified this list will be cleared.



4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
 
# File 'proto_docs/google/privacy/dlp/v2/dlp.rb', line 4701

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

  # Project and scan location information. Only set when the parent is an org.
  # @!attribute [rw] location
  #   @return [::Google::Cloud::Dlp::V2::DiscoveryStartingLocation]
  #     The data to scan: folder, org, or project
  # @!attribute [rw] project_id
  #   @return [::String]
  #     The project that will run the scan. The DLP service
  #     account that exists within this project must have access to all resources
  #     that are profiled, and the DLP API must be enabled.
  class OrgConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Whether the discovery config is currently active. New options may be added
  # at a later time.
  module Status
    # Unused
    STATUS_UNSPECIFIED = 0

    # The discovery config is currently active.
    RUNNING = 1

    # The discovery config is paused temporarily.
    PAUSED = 2
  end
end

#inspect_templates ⇒ ::Array<::String>

Returns Detection logic for profile generation.

Not all template features are used by Discovery. FindingLimits, include_quote and exclude_info_types have no impact on Discovery.

Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned.

For more information, see https://cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency.

Returns:

  • (::Array<::String>) —

    Detection logic for profile generation.

    Not all template features are used by Discovery. FindingLimits, include_quote and exclude_info_types have no impact on Discovery.

    Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned.

    For more information, see https://cloud.google.com/sensitive-data-protection/docs/data-profiles#data-residency.



4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
 
# File 'proto_docs/google/privacy/dlp/v2/dlp.rb', line 4701

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

  # Project and scan location information. Only set when the parent is an org.
  # @!attribute [rw] location
  #   @return [::Google::Cloud::Dlp::V2::DiscoveryStartingLocation]
  #     The data to scan: folder, org, or project
  # @!attribute [rw] project_id
  #   @return [::String]
  #     The project that will run the scan. The DLP service
  #     account that exists within this project must have access to all resources
  #     that are profiled, and the DLP API must be enabled.
  class OrgConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Whether the discovery config is currently active. New options may be added
  # at a later time.
  module Status
    # Unused
    STATUS_UNSPECIFIED = 0

    # The discovery config is currently active.
    RUNNING = 1

    # The discovery config is paused temporarily.
    PAUSED = 2
  end
end

#last_run_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The timestamp of the last time this config was executed.

Returns:



4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
 
# File 'proto_docs/google/privacy/dlp/v2/dlp.rb', line 4701

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

  # Project and scan location information. Only set when the parent is an org.
  # @!attribute [rw] location
  #   @return [::Google::Cloud::Dlp::V2::DiscoveryStartingLocation]
  #     The data to scan: folder, org, or project
  # @!attribute [rw] project_id
  #   @return [::String]
  #     The project that will run the scan. The DLP service
  #     account that exists within this project must have access to all resources
  #     that are profiled, and the DLP API must be enabled.
  class OrgConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Whether the discovery config is currently active. New options may be added
  # at a later time.
  module Status
    # Unused
    STATUS_UNSPECIFIED = 0

    # The discovery config is currently active.
    RUNNING = 1

    # The discovery config is paused temporarily.
    PAUSED = 2
  end
end

#name ⇒ ::String

Returns Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example projects/dlp-test-project/locations/global/discoveryConfigs/53234423.

Returns:

  • (::String) —

    Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example projects/dlp-test-project/locations/global/discoveryConfigs/53234423.



4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
 
# File 'proto_docs/google/privacy/dlp/v2/dlp.rb', line 4701

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

  # Project and scan location information. Only set when the parent is an org.
  # @!attribute [rw] location
  #   @return [::Google::Cloud::Dlp::V2::DiscoveryStartingLocation]
  #     The data to scan: folder, org, or project
  # @!attribute [rw] project_id
  #   @return [::String]
  #     The project that will run the scan. The DLP service
  #     account that exists within this project must have access to all resources
  #     that are profiled, and the DLP API must be enabled.
  class OrgConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Whether the discovery config is currently active. New options may be added
  # at a later time.
  module Status
    # Unused
    STATUS_UNSPECIFIED = 0

    # The discovery config is currently active.
    RUNNING = 1

    # The discovery config is paused temporarily.
    PAUSED = 2
  end
end

#org_config ⇒ ::Google::Cloud::Dlp::V2::DiscoveryConfig::OrgConfig

Returns Only set when the parent is an org.

Returns:



4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
 
# File 'proto_docs/google/privacy/dlp/v2/dlp.rb', line 4701

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

  # Project and scan location information. Only set when the parent is an org.
  # @!attribute [rw] location
  #   @return [::Google::Cloud::Dlp::V2::DiscoveryStartingLocation]
  #     The data to scan: folder, org, or project
  # @!attribute [rw] project_id
  #   @return [::String]
  #     The project that will run the scan. The DLP service
  #     account that exists within this project must have access to all resources
  #     that are profiled, and the DLP API must be enabled.
  class OrgConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Whether the discovery config is currently active. New options may be added
  # at a later time.
  module Status
    # Unused
    STATUS_UNSPECIFIED = 0

    # The discovery config is currently active.
    RUNNING = 1

    # The discovery config is paused temporarily.
    PAUSED = 2
  end
end

#other_cloud_starting_location ⇒ ::Google::Cloud::Dlp::V2::OtherCloudDiscoveryStartingLocation

Returns Must be set only when scanning other clouds.

Returns:



4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
 
# File 'proto_docs/google/privacy/dlp/v2/dlp.rb', line 4701

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

  # Project and scan location information. Only set when the parent is an org.
  # @!attribute [rw] location
  #   @return [::Google::Cloud::Dlp::V2::DiscoveryStartingLocation]
  #     The data to scan: folder, org, or project
  # @!attribute [rw] project_id
  #   @return [::String]
  #     The project that will run the scan. The DLP service
  #     account that exists within this project must have access to all resources
  #     that are profiled, and the DLP API must be enabled.
  class OrgConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Whether the discovery config is currently active. New options may be added
  # at a later time.
  module Status
    # Unused
    STATUS_UNSPECIFIED = 0

    # The discovery config is currently active.
    RUNNING = 1

    # The discovery config is paused temporarily.
    PAUSED = 2
  end
end

#processing_location ⇒ ::Google::Cloud::Dlp::V2::ProcessingLocation

Returns Optional. Processing location configuration. Vertex AI dataset scanning will set processing_location.image_fallback_type to MultiRegionProcessing by default.

Returns:



4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
 
# File 'proto_docs/google/privacy/dlp/v2/dlp.rb', line 4701

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

  # Project and scan location information. Only set when the parent is an org.
  # @!attribute [rw] location
  #   @return [::Google::Cloud::Dlp::V2::DiscoveryStartingLocation]
  #     The data to scan: folder, org, or project
  # @!attribute [rw] project_id
  #   @return [::String]
  #     The project that will run the scan. The DLP service
  #     account that exists within this project must have access to all resources
  #     that are profiled, and the DLP API must be enabled.
  class OrgConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Whether the discovery config is currently active. New options may be added
  # at a later time.
  module Status
    # Unused
    STATUS_UNSPECIFIED = 0

    # The discovery config is currently active.
    RUNNING = 1

    # The discovery config is paused temporarily.
    PAUSED = 2
  end
end

#status ⇒ ::Google::Cloud::Dlp::V2::DiscoveryConfig::Status

Returns Required. A status for this configuration.

Returns:



4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
 
# File 'proto_docs/google/privacy/dlp/v2/dlp.rb', line 4701

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

  # Project and scan location information. Only set when the parent is an org.
  # @!attribute [rw] location
  #   @return [::Google::Cloud::Dlp::V2::DiscoveryStartingLocation]
  #     The data to scan: folder, org, or project
  # @!attribute [rw] project_id
  #   @return [::String]
  #     The project that will run the scan. The DLP service
  #     account that exists within this project must have access to all resources
  #     that are profiled, and the DLP API must be enabled.
  class OrgConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Whether the discovery config is currently active. New options may be added
  # at a later time.
  module Status
    # Unused
    STATUS_UNSPECIFIED = 0

    # The discovery config is currently active.
    RUNNING = 1

    # The discovery config is paused temporarily.
    PAUSED = 2
  end
end

#targets ⇒ ::Array<::Google::Cloud::Dlp::V2::DiscoveryTarget>

Returns Target to match against for determining what to scan and how frequently.

Returns:



4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
 
# File 'proto_docs/google/privacy/dlp/v2/dlp.rb', line 4701

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

  # Project and scan location information. Only set when the parent is an org.
  # @!attribute [rw] location
  #   @return [::Google::Cloud::Dlp::V2::DiscoveryStartingLocation]
  #     The data to scan: folder, org, or project
  # @!attribute [rw] project_id
  #   @return [::String]
  #     The project that will run the scan. The DLP service
  #     account that exists within this project must have access to all resources
  #     that are profiled, and the DLP API must be enabled.
  class OrgConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Whether the discovery config is currently active. New options may be added
  # at a later time.
  module Status
    # Unused
    STATUS_UNSPECIFIED = 0

    # The discovery config is currently active.
    RUNNING = 1

    # The discovery config is paused temporarily.
    PAUSED = 2
  end
end

#update_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The last update timestamp of a DiscoveryConfig.

Returns:



4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
 
# File 'proto_docs/google/privacy/dlp/v2/dlp.rb', line 4701

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

  # Project and scan location information. Only set when the parent is an org.
  # @!attribute [rw] location
  #   @return [::Google::Cloud::Dlp::V2::DiscoveryStartingLocation]
  #     The data to scan: folder, org, or project
  # @!attribute [rw] project_id
  #   @return [::String]
  #     The project that will run the scan. The DLP service
  #     account that exists within this project must have access to all resources
  #     that are profiled, and the DLP API must be enabled.
  class OrgConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Whether the discovery config is currently active. New options may be added
  # at a later time.
  module Status
    # Unused
    STATUS_UNSPECIFIED = 0

    # The discovery config is currently active.
    RUNNING = 1

    # The discovery config is paused temporarily.
    PAUSED = 2
  end
end