Class: Google::Privacy::Dlp::V2beta1::InspectConfig

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/dlp/v2beta1/doc/google/privacy/dlp/v2beta1/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: InfoTypeLimit

Instance Attribute Summary collapse

Instance Attribute Details

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

Returns Custom info types provided by the user.

Returns:



57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/google/cloud/dlp/v2beta1/doc/google/privacy/dlp/v2beta1/dlp.rb', line 57

class InspectConfig
  # Max findings configuration per info type, per content item or long running
  # operation.
  # @!attribute [rw] info_type
  #   @return [Google::Privacy::Dlp::V2beta1::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

#exclude_types ⇒ true, false

Returns When true, excludes type information of the findings.

Returns:

  • (true, false) —

    When true, excludes type information of the findings.



57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/google/cloud/dlp/v2beta1/doc/google/privacy/dlp/v2beta1/dlp.rb', line 57

class InspectConfig
  # Max findings configuration per info type, per content item or long running
  # operation.
  # @!attribute [rw] info_type
  #   @return [Google::Privacy::Dlp::V2beta1::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

#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.



57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/google/cloud/dlp/v2beta1/doc/google/privacy/dlp/v2beta1/dlp.rb', line 57

class InspectConfig
  # Max findings configuration per info type, per content item or long running
  # operation.
  # @!attribute [rw] info_type
  #   @return [Google::Privacy::Dlp::V2beta1::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

#info_type_limits ⇒ Array<Google::Privacy::Dlp::V2beta1::InspectConfig::InfoTypeLimit>

Returns Configuration of findings limit given for specified info types.

Returns:



57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/google/cloud/dlp/v2beta1/doc/google/privacy/dlp/v2beta1/dlp.rb', line 57

class InspectConfig
  # Max findings configuration per info type, per content item or long running
  # operation.
  # @!attribute [rw] info_type
  #   @return [Google::Privacy::Dlp::V2beta1::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

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

Returns Restricts what info_types to look for. The values must correspond to InfoType values returned by ListInfoTypes or found in documentation. Empty info_types runs all enabled detectors.

Returns:

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

    Restricts what info_types to look for. The values must correspond to InfoType values returned by ListInfoTypes or found in documentation. Empty info_types runs all enabled detectors.



57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/google/cloud/dlp/v2beta1/doc/google/privacy/dlp/v2beta1/dlp.rb', line 57

class InspectConfig
  # Max findings configuration per info type, per content item or long running
  # operation.
  # @!attribute [rw] info_type
  #   @return [Google::Privacy::Dlp::V2beta1::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

#max_findings ⇒ Integer

Returns Limits the number of findings per content item or long running operation.

Returns:

  • (Integer) —

    Limits the number of findings per content item or long running operation.



57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/google/cloud/dlp/v2beta1/doc/google/privacy/dlp/v2beta1/dlp.rb', line 57

class InspectConfig
  # Max findings configuration per info type, per content item or long running
  # operation.
  # @!attribute [rw] info_type
  #   @return [Google::Privacy::Dlp::V2beta1::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

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

Returns Only returns findings equal or above this threshold.

Returns:



57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/google/cloud/dlp/v2beta1/doc/google/privacy/dlp/v2beta1/dlp.rb', line 57

class InspectConfig
  # Max findings configuration per info type, per content item or long running
  # operation.
  # @!attribute [rw] info_type
  #   @return [Google::Privacy::Dlp::V2beta1::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