Class: Google::Cloud::Dlp::V2::RedactImageRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/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::Cloud::Dlp::V2::ByteContentItem

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

Returns:



741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
 
# File 'proto_docs/google/privacy/dlp/v2/dlp.rb', line 741

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

  # Configuration for determining how redaction of images should occur.
  # @!attribute [rw] info_type
  #   @return [::Google::Cloud::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.
  #
  #     Note: The following fields are mutually exclusive: `info_type`, `redact_all_text`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] redact_all_text
  #   @return [::Boolean]
  #     If true, all text found in the image, regardless whether it matches an
  #     info_type, is redacted. Only one should be provided.
  #
  #     Note: The following fields are mutually exclusive: `redact_all_text`, `info_type`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] redaction_color
  #   @return [::Google::Cloud::Dlp::V2::Color]
  #     The color to use when redacting content from an image. If not specified,
  #     the default is black.
  class ImageRedactionConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

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

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

Returns:



741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
 
# File 'proto_docs/google/privacy/dlp/v2/dlp.rb', line 741

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

  # Configuration for determining how redaction of images should occur.
  # @!attribute [rw] info_type
  #   @return [::Google::Cloud::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.
  #
  #     Note: The following fields are mutually exclusive: `info_type`, `redact_all_text`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] redact_all_text
  #   @return [::Boolean]
  #     If true, all text found in the image, regardless whether it matches an
  #     info_type, is redacted. Only one should be provided.
  #
  #     Note: The following fields are mutually exclusive: `redact_all_text`, `info_type`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] redaction_color
  #   @return [::Google::Cloud::Dlp::V2::Color]
  #     The color to use when redacting content from an image. If not specified,
  #     the default is black.
  class ImageRedactionConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#include_findings ⇒ ::Boolean

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

Returns:

  • (::Boolean) —

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



741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
 
# File 'proto_docs/google/privacy/dlp/v2/dlp.rb', line 741

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

  # Configuration for determining how redaction of images should occur.
  # @!attribute [rw] info_type
  #   @return [::Google::Cloud::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.
  #
  #     Note: The following fields are mutually exclusive: `info_type`, `redact_all_text`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] redact_all_text
  #   @return [::Boolean]
  #     If true, all text found in the image, regardless whether it matches an
  #     info_type, is redacted. Only one should be provided.
  #
  #     Note: The following fields are mutually exclusive: `redact_all_text`, `info_type`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] redaction_color
  #   @return [::Google::Cloud::Dlp::V2::Color]
  #     The color to use when redacting content from an image. If not specified,
  #     the default is black.
  class ImageRedactionConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

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

Returns Configuration for the inspector.

Returns:



741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
 
# File 'proto_docs/google/privacy/dlp/v2/dlp.rb', line 741

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

  # Configuration for determining how redaction of images should occur.
  # @!attribute [rw] info_type
  #   @return [::Google::Cloud::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.
  #
  #     Note: The following fields are mutually exclusive: `info_type`, `redact_all_text`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] redact_all_text
  #   @return [::Boolean]
  #     If true, all text found in the image, regardless whether it matches an
  #     info_type, is redacted. Only one should be provided.
  #
  #     Note: The following fields are mutually exclusive: `redact_all_text`, `info_type`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] redaction_color
  #   @return [::Google::Cloud::Dlp::V2::Color]
  #     The color to use when redacting content from an image. If not specified,
  #     the default is black.
  class ImageRedactionConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#location_id ⇒ ::String

Returns Deprecated. This field has no effect.

Returns:

  • (::String) —

    Deprecated. This field has no effect.



741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
 
# File 'proto_docs/google/privacy/dlp/v2/dlp.rb', line 741

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

  # Configuration for determining how redaction of images should occur.
  # @!attribute [rw] info_type
  #   @return [::Google::Cloud::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.
  #
  #     Note: The following fields are mutually exclusive: `info_type`, `redact_all_text`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] redact_all_text
  #   @return [::Boolean]
  #     If true, all text found in the image, regardless whether it matches an
  #     info_type, is redacted. Only one should be provided.
  #
  #     Note: The following fields are mutually exclusive: `redact_all_text`, `info_type`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] redaction_color
  #   @return [::Google::Cloud::Dlp::V2::Color]
  #     The color to use when redacting content from an image. If not specified,
  #     the default is black.
  class ImageRedactionConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#parent ⇒ ::String

Returns Parent resource name.

The format of this value varies depending on whether you have specified a processing location:

  • Projects scope, location specified: projects/{project_id}/locations/{location_id}
  • Projects scope, no location specified (defaults to global): projects/{project_id}

The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

parent=projects/example-project/locations/europe-west3.

Returns:

  • (::String) —

    Parent resource name.

    The format of this value varies depending on whether you have specified a processing location:

    • Projects scope, location specified: projects/{project_id}/locations/{location_id}
    • Projects scope, no location specified (defaults to global): projects/{project_id}

    The following example parent string specifies a parent project with the identifier example-project, and specifies the europe-west3 location for processing data:

    parent=projects/example-project/locations/europe-west3



741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
 
# File 'proto_docs/google/privacy/dlp/v2/dlp.rb', line 741

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

  # Configuration for determining how redaction of images should occur.
  # @!attribute [rw] info_type
  #   @return [::Google::Cloud::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.
  #
  #     Note: The following fields are mutually exclusive: `info_type`, `redact_all_text`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] redact_all_text
  #   @return [::Boolean]
  #     If true, all text found in the image, regardless whether it matches an
  #     info_type, is redacted. Only one should be provided.
  #
  #     Note: The following fields are mutually exclusive: `redact_all_text`, `info_type`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] redaction_color
  #   @return [::Google::Cloud::Dlp::V2::Color]
  #     The color to use when redacting content from an image. If not specified,
  #     the default is black.
  class ImageRedactionConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end