Class: Google::Cloud::Dlp::V2::InspectConfig

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 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::Cloud::Dlp::V2::ContentOption>

Returns Deprecated and unused.

Returns:



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'proto_docs/google/privacy/dlp/v2/dlp.rb', line 158

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

  # Configuration to control the number of findings returned for inspection.
  # This is not used for de-identification or data profiling.
  #
  # When redacting sensitive data from images, finding limits don't apply. They
  # can cause unexpected or inconsistent results, where only some data is
  # redacted. Don't include finding limits in
  # {::Google::Cloud::Dlp::V2::DlpService::Client#redact_image RedactImage}
  # requests. Otherwise, Cloud DLP returns an error.
  # @!attribute [rw] max_findings_per_item
  #   @return [::Integer]
  #     Max number of findings that will be returned for each item scanned.
  #     When set within `InspectJobConfig`,
  #     the maximum returned is 2000 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 2000
  #     regardless if this is set higher.
  # @!attribute [rw] max_findings_per_info_type
  #   @return [::Array<::Google::Cloud::Dlp::V2::InspectConfig::FindingLimits::InfoTypeLimit>]
  #     Configuration of findings limit given for specified infoTypes.
  class FindingLimits
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Max findings configuration per infoType, per content item or long
    # running DlpJob.
    # @!attribute [rw] info_type
    #   @return [::Google::Cloud::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
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end
end

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

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

Returns:



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'proto_docs/google/privacy/dlp/v2/dlp.rb', line 158

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

  # Configuration to control the number of findings returned for inspection.
  # This is not used for de-identification or data profiling.
  #
  # When redacting sensitive data from images, finding limits don't apply. They
  # can cause unexpected or inconsistent results, where only some data is
  # redacted. Don't include finding limits in
  # {::Google::Cloud::Dlp::V2::DlpService::Client#redact_image RedactImage}
  # requests. Otherwise, Cloud DLP returns an error.
  # @!attribute [rw] max_findings_per_item
  #   @return [::Integer]
  #     Max number of findings that will be returned for each item scanned.
  #     When set within `InspectJobConfig`,
  #     the maximum returned is 2000 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 2000
  #     regardless if this is set higher.
  # @!attribute [rw] max_findings_per_info_type
  #   @return [::Array<::Google::Cloud::Dlp::V2::InspectConfig::FindingLimits::InfoTypeLimit>]
  #     Configuration of findings limit given for specified infoTypes.
  class FindingLimits
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Max findings configuration per infoType, per content item or long
    # running DlpJob.
    # @!attribute [rw] info_type
    #   @return [::Google::Cloud::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
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end
end

#exclude_info_types ⇒ ::Boolean

Returns When true, excludes type information of the findings. This is not used for data profiling.

Returns:

  • (::Boolean) —

    When true, excludes type information of the findings. This is not used for data profiling.



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'proto_docs/google/privacy/dlp/v2/dlp.rb', line 158

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

  # Configuration to control the number of findings returned for inspection.
  # This is not used for de-identification or data profiling.
  #
  # When redacting sensitive data from images, finding limits don't apply. They
  # can cause unexpected or inconsistent results, where only some data is
  # redacted. Don't include finding limits in
  # {::Google::Cloud::Dlp::V2::DlpService::Client#redact_image RedactImage}
  # requests. Otherwise, Cloud DLP returns an error.
  # @!attribute [rw] max_findings_per_item
  #   @return [::Integer]
  #     Max number of findings that will be returned for each item scanned.
  #     When set within `InspectJobConfig`,
  #     the maximum returned is 2000 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 2000
  #     regardless if this is set higher.
  # @!attribute [rw] max_findings_per_info_type
  #   @return [::Array<::Google::Cloud::Dlp::V2::InspectConfig::FindingLimits::InfoTypeLimit>]
  #     Configuration of findings limit given for specified infoTypes.
  class FindingLimits
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Max findings configuration per infoType, per content item or long
    # running DlpJob.
    # @!attribute [rw] info_type
    #   @return [::Google::Cloud::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
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end
end

#include_quote ⇒ ::Boolean

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

Returns:

  • (::Boolean) —

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



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'proto_docs/google/privacy/dlp/v2/dlp.rb', line 158

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

  # Configuration to control the number of findings returned for inspection.
  # This is not used for de-identification or data profiling.
  #
  # When redacting sensitive data from images, finding limits don't apply. They
  # can cause unexpected or inconsistent results, where only some data is
  # redacted. Don't include finding limits in
  # {::Google::Cloud::Dlp::V2::DlpService::Client#redact_image RedactImage}
  # requests. Otherwise, Cloud DLP returns an error.
  # @!attribute [rw] max_findings_per_item
  #   @return [::Integer]
  #     Max number of findings that will be returned for each item scanned.
  #     When set within `InspectJobConfig`,
  #     the maximum returned is 2000 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 2000
  #     regardless if this is set higher.
  # @!attribute [rw] max_findings_per_info_type
  #   @return [::Array<::Google::Cloud::Dlp::V2::InspectConfig::FindingLimits::InfoTypeLimit>]
  #     Configuration of findings limit given for specified infoTypes.
  class FindingLimits
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Max findings configuration per infoType, per content item or long
    # running DlpJob.
    # @!attribute [rw] info_type
    #   @return [::Google::Cloud::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
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end
end

#info_types ⇒ ::Array<::Google::Cloud::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.

If you need precise control and predictability as to what detectors are run you should specify specific InfoTypes listed in the reference, otherwise a default list will be used, which may change over time.

Returns:

  • (::Array<::Google::Cloud::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.

    If you need precise control and predictability as to what detectors are run you should specify specific InfoTypes listed in the reference, otherwise a default list will be used, which may change over time.



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'proto_docs/google/privacy/dlp/v2/dlp.rb', line 158

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

  # Configuration to control the number of findings returned for inspection.
  # This is not used for de-identification or data profiling.
  #
  # When redacting sensitive data from images, finding limits don't apply. They
  # can cause unexpected or inconsistent results, where only some data is
  # redacted. Don't include finding limits in
  # {::Google::Cloud::Dlp::V2::DlpService::Client#redact_image RedactImage}
  # requests. Otherwise, Cloud DLP returns an error.
  # @!attribute [rw] max_findings_per_item
  #   @return [::Integer]
  #     Max number of findings that will be returned for each item scanned.
  #     When set within `InspectJobConfig`,
  #     the maximum returned is 2000 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 2000
  #     regardless if this is set higher.
  # @!attribute [rw] max_findings_per_info_type
  #   @return [::Array<::Google::Cloud::Dlp::V2::InspectConfig::FindingLimits::InfoTypeLimit>]
  #     Configuration of findings limit given for specified infoTypes.
  class FindingLimits
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Max findings configuration per infoType, per content item or long
    # running DlpJob.
    # @!attribute [rw] info_type
    #   @return [::Google::Cloud::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
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end
end

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

Returns Configuration to control the number of findings returned. This is not used for data profiling.

When redacting sensitive data from images, finding limits don't apply. They can cause unexpected or inconsistent results, where only some data is redacted. Don't include finding limits in RedactImage requests. Otherwise, Cloud DLP returns an error.

Returns:

  • (::Google::Cloud::Dlp::V2::InspectConfig::FindingLimits) —

    Configuration to control the number of findings returned. This is not used for data profiling.

    When redacting sensitive data from images, finding limits don't apply. They can cause unexpected or inconsistent results, where only some data is redacted. Don't include finding limits in RedactImage requests. Otherwise, Cloud DLP returns an error.



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'proto_docs/google/privacy/dlp/v2/dlp.rb', line 158

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

  # Configuration to control the number of findings returned for inspection.
  # This is not used for de-identification or data profiling.
  #
  # When redacting sensitive data from images, finding limits don't apply. They
  # can cause unexpected or inconsistent results, where only some data is
  # redacted. Don't include finding limits in
  # {::Google::Cloud::Dlp::V2::DlpService::Client#redact_image RedactImage}
  # requests. Otherwise, Cloud DLP returns an error.
  # @!attribute [rw] max_findings_per_item
  #   @return [::Integer]
  #     Max number of findings that will be returned for each item scanned.
  #     When set within `InspectJobConfig`,
  #     the maximum returned is 2000 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 2000
  #     regardless if this is set higher.
  # @!attribute [rw] max_findings_per_info_type
  #   @return [::Array<::Google::Cloud::Dlp::V2::InspectConfig::FindingLimits::InfoTypeLimit>]
  #     Configuration of findings limit given for specified infoTypes.
  class FindingLimits
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Max findings configuration per infoType, per content item or long
    # running DlpJob.
    # @!attribute [rw] info_type
    #   @return [::Google::Cloud::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
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end
end

#min_likelihood ⇒ ::Google::Cloud::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:



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'proto_docs/google/privacy/dlp/v2/dlp.rb', line 158

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

  # Configuration to control the number of findings returned for inspection.
  # This is not used for de-identification or data profiling.
  #
  # When redacting sensitive data from images, finding limits don't apply. They
  # can cause unexpected or inconsistent results, where only some data is
  # redacted. Don't include finding limits in
  # {::Google::Cloud::Dlp::V2::DlpService::Client#redact_image RedactImage}
  # requests. Otherwise, Cloud DLP returns an error.
  # @!attribute [rw] max_findings_per_item
  #   @return [::Integer]
  #     Max number of findings that will be returned for each item scanned.
  #     When set within `InspectJobConfig`,
  #     the maximum returned is 2000 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 2000
  #     regardless if this is set higher.
  # @!attribute [rw] max_findings_per_info_type
  #   @return [::Array<::Google::Cloud::Dlp::V2::InspectConfig::FindingLimits::InfoTypeLimit>]
  #     Configuration of findings limit given for specified infoTypes.
  class FindingLimits
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Max findings configuration per infoType, per content item or long
    # running DlpJob.
    # @!attribute [rw] info_type
    #   @return [::Google::Cloud::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
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end
end

#rule_set ⇒ ::Array<::Google::Cloud::Dlp::V2::InspectionRuleSet>

Returns Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type.

Returns:

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

    Set of rules to apply to the findings for this InspectConfig. Exclusion rules, contained in the set are executed in the end, other rules are executed in the order they are specified for each info type.



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'proto_docs/google/privacy/dlp/v2/dlp.rb', line 158

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

  # Configuration to control the number of findings returned for inspection.
  # This is not used for de-identification or data profiling.
  #
  # When redacting sensitive data from images, finding limits don't apply. They
  # can cause unexpected or inconsistent results, where only some data is
  # redacted. Don't include finding limits in
  # {::Google::Cloud::Dlp::V2::DlpService::Client#redact_image RedactImage}
  # requests. Otherwise, Cloud DLP returns an error.
  # @!attribute [rw] max_findings_per_item
  #   @return [::Integer]
  #     Max number of findings that will be returned for each item scanned.
  #     When set within `InspectJobConfig`,
  #     the maximum returned is 2000 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 2000
  #     regardless if this is set higher.
  # @!attribute [rw] max_findings_per_info_type
  #   @return [::Array<::Google::Cloud::Dlp::V2::InspectConfig::FindingLimits::InfoTypeLimit>]
  #     Configuration of findings limit given for specified infoTypes.
  class FindingLimits
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Max findings configuration per infoType, per content item or long
    # running DlpJob.
    # @!attribute [rw] info_type
    #   @return [::Google::Cloud::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
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end
end