Cloud Data Loss Prevention (DLP) V2 API - Class Google::Cloud::Dlp::V2::RedactImageRequest (v1.15.0)

Reference documentation and code samples for the Cloud Data Loss Prevention (DLP) V2 API class Google::Cloud::Dlp::V2::RedactImageRequest.

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

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#byte_item

def byte_item() -> ::Google::Cloud::Dlp::V2::ByteContentItem
Returns

#byte_item=

def byte_item=(value) -> ::Google::Cloud::Dlp::V2::ByteContentItem
Parameter
Returns

#deidentify_template

def deidentify_template() -> ::String
Returns
  • (::String) — The full resource name of the de-identification template to use. Settings in the main image_redaction_configs field override the corresponding settings in this de-identification template. The request fails if the type of the template's deidentify_config is not image_transformations.

#deidentify_template=

def deidentify_template=(value) -> ::String
Parameter
  • value (::String) — The full resource name of the de-identification template to use. Settings in the main image_redaction_configs field override the corresponding settings in this de-identification template. The request fails if the type of the template's deidentify_config is not image_transformations.
Returns
  • (::String) — The full resource name of the de-identification template to use. Settings in the main image_redaction_configs field override the corresponding settings in this de-identification template. The request fails if the type of the template's deidentify_config is not image_transformations.

#image_redaction_configs

def image_redaction_configs() -> ::Array<::Google::Cloud::Dlp::V2::RedactImageRequest::ImageRedactionConfig>
Returns

#image_redaction_configs=

def image_redaction_configs=(value) -> ::Array<::Google::Cloud::Dlp::V2::RedactImageRequest::ImageRedactionConfig>
Parameter
Returns

#include_findings

def include_findings() -> ::Boolean
Returns
  • (::Boolean) — Whether the response should include findings along with the redacted image.

#include_findings=

def include_findings=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Whether the response should include findings along with the redacted image.
Returns
  • (::Boolean) — Whether the response should include findings along with the redacted image.

#inspect_config

def inspect_config() -> ::Google::Cloud::Dlp::V2::InspectConfig
Returns

#inspect_config=

def inspect_config=(value) -> ::Google::Cloud::Dlp::V2::InspectConfig
Parameter
Returns

#inspect_template

def inspect_template() -> ::String
Returns
  • (::String) —

    The full resource name of the inspection template to use. Settings in the main inspect_config field override the corresponding settings in this inspection template.

    The merge behavior is as follows:

    • Singular field: The main field's value replaces the value of the corresponding field in the template.
    • Repeated fields: The field values are appended to the list defined in the template.
    • Sub-messages and groups: The fields are recursively merged.

#inspect_template=

def inspect_template=(value) -> ::String
Parameter
  • value (::String) —

    The full resource name of the inspection template to use. Settings in the main inspect_config field override the corresponding settings in this inspection template.

    The merge behavior is as follows:

    • Singular field: The main field's value replaces the value of the corresponding field in the template.
    • Repeated fields: The field values are appended to the list defined in the template.
    • Sub-messages and groups: The fields are recursively merged.
Returns
  • (::String) —

    The full resource name of the inspection template to use. Settings in the main inspect_config field override the corresponding settings in this inspection template.

    The merge behavior is as follows:

    • Singular field: The main field's value replaces the value of the corresponding field in the template.
    • Repeated fields: The field values are appended to the list defined in the template.
    • Sub-messages and groups: The fields are recursively merged.

#location_id

def location_id() -> ::String
Returns
  • (::String) — Deprecated. This field has no effect.

#location_id=

def location_id=(value) -> ::String
Parameter
  • value (::String) — Deprecated. This field has no effect.
Returns
  • (::String) — Deprecated. This field has no effect.

#parent

def parent() -> ::String
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

#parent=

def parent=(value) -> ::String
Parameter
  • value (::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
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