Class: Google::Privacy::Dlp::V2::RedactImageRequest

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

Overview

Request to search for potentially sensitive info in an image and redact it by covering it with a colored rectangle.

Defined Under Namespace

Classes: ImageRedactionConfig

Instance Attribute Summary collapse

Instance Attribute Details

#byte_item ⇒ Google::Privacy::Dlp::V2::ByteContentItem

Returns The content must be PNG, JPEG, SVG or BMP.

Returns:



303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/google/cloud/dlp/v2/doc/google/privacy/dlp/v2/dlp.rb', line 303

class RedactImageRequest
  # Configuration for determining how redaction of images should occur.
  # @!attribute [rw] info_type
  #   @return [Google::Privacy::Dlp::V2::InfoType]
  #     Only one per info_type should be provided per request. If not
  #     specified, and redact_all_text is false, the DLP API will redact all
  #     text that it matches against all info_types that are found, but not
  #     specified in another ImageRedactionConfig.
  # @!attribute [rw] redact_all_text
  #   @return [true, false]
  #     If true, all text found in the image, regardless whether it matches an
  #     info_type, is redacted. Only one should be provided.
  # @!attribute [rw] redaction_color
  #   @return [Google::Privacy::Dlp::V2::Color]
  #     The color to use when redacting content from an image. If not specified,
  #     the default is black.
  class ImageRedactionConfig; end
end

#image_redaction_configs ⇒ Array<Google::Privacy::Dlp::V2::RedactImageRequest::ImageRedactionConfig>

Returns The configuration for specifying what content to redact from images.

Returns:



303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/google/cloud/dlp/v2/doc/google/privacy/dlp/v2/dlp.rb', line 303

class RedactImageRequest
  # Configuration for determining how redaction of images should occur.
  # @!attribute [rw] info_type
  #   @return [Google::Privacy::Dlp::V2::InfoType]
  #     Only one per info_type should be provided per request. If not
  #     specified, and redact_all_text is false, the DLP API will redact all
  #     text that it matches against all info_types that are found, but not
  #     specified in another ImageRedactionConfig.
  # @!attribute [rw] redact_all_text
  #   @return [true, false]
  #     If true, all text found in the image, regardless whether it matches an
  #     info_type, is redacted. Only one should be provided.
  # @!attribute [rw] redaction_color
  #   @return [Google::Privacy::Dlp::V2::Color]
  #     The color to use when redacting content from an image. If not specified,
  #     the default is black.
  class ImageRedactionConfig; end
end

#include_findings ⇒ true, false

Returns Whether the response should include findings along with the redacted image.

Returns:

  • (true, false) —

    Whether the response should include findings along with the redacted image.



303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/google/cloud/dlp/v2/doc/google/privacy/dlp/v2/dlp.rb', line 303

class RedactImageRequest
  # Configuration for determining how redaction of images should occur.
  # @!attribute [rw] info_type
  #   @return [Google::Privacy::Dlp::V2::InfoType]
  #     Only one per info_type should be provided per request. If not
  #     specified, and redact_all_text is false, the DLP API will redact all
  #     text that it matches against all info_types that are found, but not
  #     specified in another ImageRedactionConfig.
  # @!attribute [rw] redact_all_text
  #   @return [true, false]
  #     If true, all text found in the image, regardless whether it matches an
  #     info_type, is redacted. Only one should be provided.
  # @!attribute [rw] redaction_color
  #   @return [Google::Privacy::Dlp::V2::Color]
  #     The color to use when redacting content from an image. If not specified,
  #     the default is black.
  class ImageRedactionConfig; end
end

#inspect_config ⇒ Google::Privacy::Dlp::V2::InspectConfig

Returns Configuration for the inspector.

Returns:



303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/google/cloud/dlp/v2/doc/google/privacy/dlp/v2/dlp.rb', line 303

class RedactImageRequest
  # Configuration for determining how redaction of images should occur.
  # @!attribute [rw] info_type
  #   @return [Google::Privacy::Dlp::V2::InfoType]
  #     Only one per info_type should be provided per request. If not
  #     specified, and redact_all_text is false, the DLP API will redact all
  #     text that it matches against all info_types that are found, but not
  #     specified in another ImageRedactionConfig.
  # @!attribute [rw] redact_all_text
  #   @return [true, false]
  #     If true, all text found in the image, regardless whether it matches an
  #     info_type, is redacted. Only one should be provided.
  # @!attribute [rw] redaction_color
  #   @return [Google::Privacy::Dlp::V2::Color]
  #     The color to use when redacting content from an image. If not specified,
  #     the default is black.
  class ImageRedactionConfig; end
end

#parent ⇒ String

Returns The parent resource name, for example projects/my-project-id.

Returns:

  • (String) —

    The parent resource name, for example projects/my-project-id.



303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/google/cloud/dlp/v2/doc/google/privacy/dlp/v2/dlp.rb', line 303

class RedactImageRequest
  # Configuration for determining how redaction of images should occur.
  # @!attribute [rw] info_type
  #   @return [Google::Privacy::Dlp::V2::InfoType]
  #     Only one per info_type should be provided per request. If not
  #     specified, and redact_all_text is false, the DLP API will redact all
  #     text that it matches against all info_types that are found, but not
  #     specified in another ImageRedactionConfig.
  # @!attribute [rw] redact_all_text
  #   @return [true, false]
  #     If true, all text found in the image, regardless whether it matches an
  #     info_type, is redacted. Only one should be provided.
  # @!attribute [rw] redaction_color
  #   @return [Google::Privacy::Dlp::V2::Color]
  #     The color to use when redacting content from an image. If not specified,
  #     the default is black.
  class ImageRedactionConfig; end
end