Cloud Data Loss Prevention (DLP) V2 API - Class Google::Cloud::Dlp::V2::DiscoveryConfig (v0.20.0)

Reference documentation and code samples for the Cloud Data Loss Prevention (DLP) V2 API class Google::Cloud::Dlp::V2::DiscoveryConfig.

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.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#actions

def actions() -> ::Array<::Google::Cloud::Dlp::V2::DataProfileAction>

Returns

(::Array<::Google::Cloud::Dlp::V2::DataProfileAction>) — Actions to execute at the completion of scanning.

#actions=

def actions=(value) -> ::Array<::Google::Cloud::Dlp::V2::DataProfileAction>

Parameter

value (::Array<::Google::Cloud::Dlp::V2::DataProfileAction>) — Actions to execute at the completion of scanning.

Returns

(::Array<::Google::Cloud::Dlp::V2::DataProfileAction>) — Actions to execute at the completion of scanning.

#create_time

def create_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Output only. The creation timestamp of a DiscoveryConfig.

#display_name

def display_name() -> ::String

Returns

(::String) — Display name (max 100 chars)

#display_name=

def display_name=(value) -> ::String

Parameter

value (::String) — Display name (max 100 chars)

Returns

(::String) — Display name (max 100 chars)

#errors

def errors() -> ::Array<::Google::Cloud::Dlp::V2::Error>

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.

#inspect_templates

def inspect_templates() -> ::Array<::String>

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/dlp/docs/data-profiles#data-residency.

#inspect_templates=

def inspect_templates=(value) -> ::Array<::String>

Parameter

value (::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/dlp/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/dlp/docs/data-profiles#data-residency.

#last_run_time

def last_run_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Output only. The timestamp of the last time this config was executed.

#name

def name() -> ::String

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.

#name=

def name=(value) -> ::String

Parameter

value (::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.

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.

#org_config

def org_config() -> ::Google::Cloud::Dlp::V2::DiscoveryConfig::OrgConfig

Returns

(::Google::Cloud::Dlp::V2::DiscoveryConfig::OrgConfig) — Only set when the parent is an org.

#org_config=

def org_config=(value) -> ::Google::Cloud::Dlp::V2::DiscoveryConfig::OrgConfig

Parameter

value (::Google::Cloud::Dlp::V2::DiscoveryConfig::OrgConfig) — Only set when the parent is an org.

Returns

(::Google::Cloud::Dlp::V2::DiscoveryConfig::OrgConfig) — Only set when the parent is an org.

#status

def status() -> ::Google::Cloud::Dlp::V2::DiscoveryConfig::Status

Returns

(::Google::Cloud::Dlp::V2::DiscoveryConfig::Status) — Required. A status for this configuration.

#status=

def status=(value) -> ::Google::Cloud::Dlp::V2::DiscoveryConfig::Status

Parameter

value (::Google::Cloud::Dlp::V2::DiscoveryConfig::Status) — Required. A status for this configuration.

Returns

(::Google::Cloud::Dlp::V2::DiscoveryConfig::Status) — Required. A status for this configuration.

#targets

def targets() -> ::Array<::Google::Cloud::Dlp::V2::DiscoveryTarget>

Returns

(::Array<::Google::Cloud::Dlp::V2::DiscoveryTarget>) — Target to match against for determining what to scan and how frequently.

#targets=

def targets=(value) -> ::Array<::Google::Cloud::Dlp::V2::DiscoveryTarget>

Parameter

value (::Array<::Google::Cloud::Dlp::V2::DiscoveryTarget>) — Target to match against for determining what to scan and how frequently.

Returns

(::Array<::Google::Cloud::Dlp::V2::DiscoveryTarget>) — Target to match against for determining what to scan and how frequently.

#update_time

def update_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Output only. The last update timestamp of a DiscoveryConfig.