Class: Google::Privacy::Dlp::V2::InspectConfig

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/dlp/v2/doc/google/privacy/dlp/v2/dlp.rb

Overview

Configuration description of the scanning process. When used with redactContent only info_types and min_likelihood are currently used.

Defined Under Namespace

Classes: FindingLimits

Instance Attribute Summary collapse

Instance Attribute Details

#content_options ⇒ Array<Google::Privacy::Dlp::V2::ContentOption>

Returns List of options defining data content to scan. If empty, text, images, and other content will be included.

Returns:



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/google/cloud/dlp/v2/doc/google/privacy/dlp/v2/dlp.rb', line 58

class InspectConfig
  # @!attribute [rw] max_findings_per_item
  #   @return [Integer]
  #     Max number of findings that will be returned for each item scanned.
  #     When set within +InspectDataSourceRequest+,
  #     the maximum returned is 1000 regardless if this is set higher.
  #     When set within +InspectContentRequest+, this field is ignored.
  # @!attribute [rw] max_findings_per_request
  #   @return [Integer]
  #     Max number of findings that will be returned per request/job.
  #     When set within +InspectContentRequest+, the maximum returned is 1000
  #     regardless if this is set higher.
  # @!attribute [rw] max_findings_per_info_type
  #   @return [Array<Google::Privacy::Dlp::V2::InspectConfig::FindingLimits::InfoTypeLimit>]
  #     Configuration of findings limit given for specified infoTypes.
  class FindingLimits
    # Max findings configuration per infoType, per content item or long
    # running DlpJob.
    # @!attribute [rw] info_type
    #   @return [Google::Privacy::Dlp::V2::InfoType]
    #     Type of information the findings limit applies to. Only one limit per
    #     info_type should be provided. If InfoTypeLimit does not have an
    #     info_type, the DLP API applies the limit against all info_types that
    #     are found but not specified in another InfoTypeLimit.
    # @!attribute [rw] max_findings
    #   @return [Integer]
    #     Max findings limit for the given infoType.
    class InfoTypeLimit; end
  end
end

#custom_info_types ⇒ Array<Google::Privacy::Dlp::V2::CustomInfoType>

Returns CustomInfoTypes provided by the user. See https://cloud.google.com/dlp/docs/creating-custom-infotypes to learn more.

Returns:



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/google/cloud/dlp/v2/doc/google/privacy/dlp/v2/dlp.rb', line 58

class InspectConfig
  # @!attribute [rw] max_findings_per_item
  #   @return [Integer]
  #     Max number of findings that will be returned for each item scanned.
  #     When set within +InspectDataSourceRequest+,
  #     the maximum returned is 1000 regardless if this is set higher.
  #     When set within +InspectContentRequest+, this field is ignored.
  # @!attribute [rw] max_findings_per_request
  #   @return [Integer]
  #     Max number of findings that will be returned per request/job.
  #     When set within +InspectContentRequest+, the maximum returned is 1000
  #     regardless if this is set higher.
  # @!attribute [rw] max_findings_per_info_type
  #   @return [Array<Google::Privacy::Dlp::V2::InspectConfig::FindingLimits::InfoTypeLimit>]
  #     Configuration of findings limit given for specified infoTypes.
  class FindingLimits
    # Max findings configuration per infoType, per content item or long
    # running DlpJob.
    # @!attribute [rw] info_type
    #   @return [Google::Privacy::Dlp::V2::InfoType]
    #     Type of information the findings limit applies to. Only one limit per
    #     info_type should be provided. If InfoTypeLimit does not have an
    #     info_type, the DLP API applies the limit against all info_types that
    #     are found but not specified in another InfoTypeLimit.
    # @!attribute [rw] max_findings
    #   @return [Integer]
    #     Max findings limit for the given infoType.
    class InfoTypeLimit; end
  end
end

#exclude_info_types ⇒ true, false

Returns When true, excludes type information of the findings.

Returns:

  • (true, false) —

    When true, excludes type information of the findings.



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/google/cloud/dlp/v2/doc/google/privacy/dlp/v2/dlp.rb', line 58

class InspectConfig
  # @!attribute [rw] max_findings_per_item
  #   @return [Integer]
  #     Max number of findings that will be returned for each item scanned.
  #     When set within +InspectDataSourceRequest+,
  #     the maximum returned is 1000 regardless if this is set higher.
  #     When set within +InspectContentRequest+, this field is ignored.
  # @!attribute [rw] max_findings_per_request
  #   @return [Integer]
  #     Max number of findings that will be returned per request/job.
  #     When set within +InspectContentRequest+, the maximum returned is 1000
  #     regardless if this is set higher.
  # @!attribute [rw] max_findings_per_info_type
  #   @return [Array<Google::Privacy::Dlp::V2::InspectConfig::FindingLimits::InfoTypeLimit>]
  #     Configuration of findings limit given for specified infoTypes.
  class FindingLimits
    # Max findings configuration per infoType, per content item or long
    # running DlpJob.
    # @!attribute [rw] info_type
    #   @return [Google::Privacy::Dlp::V2::InfoType]
    #     Type of information the findings limit applies to. Only one limit per
    #     info_type should be provided. If InfoTypeLimit does not have an
    #     info_type, the DLP API applies the limit against all info_types that
    #     are found but not specified in another InfoTypeLimit.
    # @!attribute [rw] max_findings
    #   @return [Integer]
    #     Max findings limit for the given infoType.
    class InfoTypeLimit; end
  end
end

#include_quote ⇒ true, false

Returns When true, a contextual quote from the data that triggered a finding is included in the response; see Finding.quote.

Returns:

  • (true, false) —

    When true, a contextual quote from the data that triggered a finding is included in the response; see Finding.quote.



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/google/cloud/dlp/v2/doc/google/privacy/dlp/v2/dlp.rb', line 58

class InspectConfig
  # @!attribute [rw] max_findings_per_item
  #   @return [Integer]
  #     Max number of findings that will be returned for each item scanned.
  #     When set within +InspectDataSourceRequest+,
  #     the maximum returned is 1000 regardless if this is set higher.
  #     When set within +InspectContentRequest+, this field is ignored.
  # @!attribute [rw] max_findings_per_request
  #   @return [Integer]
  #     Max number of findings that will be returned per request/job.
  #     When set within +InspectContentRequest+, the maximum returned is 1000
  #     regardless if this is set higher.
  # @!attribute [rw] max_findings_per_info_type
  #   @return [Array<Google::Privacy::Dlp::V2::InspectConfig::FindingLimits::InfoTypeLimit>]
  #     Configuration of findings limit given for specified infoTypes.
  class FindingLimits
    # Max findings configuration per infoType, per content item or long
    # running DlpJob.
    # @!attribute [rw] info_type
    #   @return [Google::Privacy::Dlp::V2::InfoType]
    #     Type of information the findings limit applies to. Only one limit per
    #     info_type should be provided. If InfoTypeLimit does not have an
    #     info_type, the DLP API applies the limit against all info_types that
    #     are found but not specified in another InfoTypeLimit.
    # @!attribute [rw] max_findings
    #   @return [Integer]
    #     Max findings limit for the given infoType.
    class InfoTypeLimit; end
  end
end

#info_types ⇒ Array<Google::Privacy::Dlp::V2::InfoType>

Returns Restricts what info_types to look for. The values must correspond to InfoType values returned by ListInfoTypes or listed at https://cloud.google.com/dlp/docs/infotypes-reference.

When no InfoTypes or CustomInfoTypes are specified in a request, the system may automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated.

The special InfoType name "ALL_BASIC" can be used to trigger all detectors, but may change over time as new InfoTypes are added. If you need precise control and predictability as to what detectors are run you should specify specific InfoTypes listed in the reference.

Returns:

  • (Array<Google::Privacy::Dlp::V2::InfoType>) —

    Restricts what info_types to look for. The values must correspond to InfoType values returned by ListInfoTypes or listed at https://cloud.google.com/dlp/docs/infotypes-reference.

    When no InfoTypes or CustomInfoTypes are specified in a request, the system may automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated.

    The special InfoType name "ALL_BASIC" can be used to trigger all detectors, but may change over time as new InfoTypes are added. If you need precise control and predictability as to what detectors are run you should specify specific InfoTypes listed in the reference.



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/google/cloud/dlp/v2/doc/google/privacy/dlp/v2/dlp.rb', line 58

class InspectConfig
  # @!attribute [rw] max_findings_per_item
  #   @return [Integer]
  #     Max number of findings that will be returned for each item scanned.
  #     When set within +InspectDataSourceRequest+,
  #     the maximum returned is 1000 regardless if this is set higher.
  #     When set within +InspectContentRequest+, this field is ignored.
  # @!attribute [rw] max_findings_per_request
  #   @return [Integer]
  #     Max number of findings that will be returned per request/job.
  #     When set within +InspectContentRequest+, the maximum returned is 1000
  #     regardless if this is set higher.
  # @!attribute [rw] max_findings_per_info_type
  #   @return [Array<Google::Privacy::Dlp::V2::InspectConfig::FindingLimits::InfoTypeLimit>]
  #     Configuration of findings limit given for specified infoTypes.
  class FindingLimits
    # Max findings configuration per infoType, per content item or long
    # running DlpJob.
    # @!attribute [rw] info_type
    #   @return [Google::Privacy::Dlp::V2::InfoType]
    #     Type of information the findings limit applies to. Only one limit per
    #     info_type should be provided. If InfoTypeLimit does not have an
    #     info_type, the DLP API applies the limit against all info_types that
    #     are found but not specified in another InfoTypeLimit.
    # @!attribute [rw] max_findings
    #   @return [Integer]
    #     Max findings limit for the given infoType.
    class InfoTypeLimit; end
  end
end

#limits ⇒ Google::Privacy::Dlp::V2::InspectConfig::FindingLimits

Returns:



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/google/cloud/dlp/v2/doc/google/privacy/dlp/v2/dlp.rb', line 58

class InspectConfig
  # @!attribute [rw] max_findings_per_item
  #   @return [Integer]
  #     Max number of findings that will be returned for each item scanned.
  #     When set within +InspectDataSourceRequest+,
  #     the maximum returned is 1000 regardless if this is set higher.
  #     When set within +InspectContentRequest+, this field is ignored.
  # @!attribute [rw] max_findings_per_request
  #   @return [Integer]
  #     Max number of findings that will be returned per request/job.
  #     When set within +InspectContentRequest+, the maximum returned is 1000
  #     regardless if this is set higher.
  # @!attribute [rw] max_findings_per_info_type
  #   @return [Array<Google::Privacy::Dlp::V2::InspectConfig::FindingLimits::InfoTypeLimit>]
  #     Configuration of findings limit given for specified infoTypes.
  class FindingLimits
    # Max findings configuration per infoType, per content item or long
    # running DlpJob.
    # @!attribute [rw] info_type
    #   @return [Google::Privacy::Dlp::V2::InfoType]
    #     Type of information the findings limit applies to. Only one limit per
    #     info_type should be provided. If InfoTypeLimit does not have an
    #     info_type, the DLP API applies the limit against all info_types that
    #     are found but not specified in another InfoTypeLimit.
    # @!attribute [rw] max_findings
    #   @return [Integer]
    #     Max findings limit for the given infoType.
    class InfoTypeLimit; end
  end
end

#min_likelihood ⇒ Google::Privacy::Dlp::V2::Likelihood

Returns Only returns findings equal or above this threshold. The default is POSSIBLE. See https://cloud.google.com/dlp/docs/likelihood to learn more.

Returns:



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/google/cloud/dlp/v2/doc/google/privacy/dlp/v2/dlp.rb', line 58

class InspectConfig
  # @!attribute [rw] max_findings_per_item
  #   @return [Integer]
  #     Max number of findings that will be returned for each item scanned.
  #     When set within +InspectDataSourceRequest+,
  #     the maximum returned is 1000 regardless if this is set higher.
  #     When set within +InspectContentRequest+, this field is ignored.
  # @!attribute [rw] max_findings_per_request
  #   @return [Integer]
  #     Max number of findings that will be returned per request/job.
  #     When set within +InspectContentRequest+, the maximum returned is 1000
  #     regardless if this is set higher.
  # @!attribute [rw] max_findings_per_info_type
  #   @return [Array<Google::Privacy::Dlp::V2::InspectConfig::FindingLimits::InfoTypeLimit>]
  #     Configuration of findings limit given for specified infoTypes.
  class FindingLimits
    # Max findings configuration per infoType, per content item or long
    # running DlpJob.
    # @!attribute [rw] info_type
    #   @return [Google::Privacy::Dlp::V2::InfoType]
    #     Type of information the findings limit applies to. Only one limit per
    #     info_type should be provided. If InfoTypeLimit does not have an
    #     info_type, the DLP API applies the limit against all info_types that
    #     are found but not specified in another InfoTypeLimit.
    # @!attribute [rw] max_findings
    #   @return [Integer]
    #     Max findings limit for the given infoType.
    class InfoTypeLimit; end
  end
end