gcloud_alpha_dlp_images_redact (1)

NAME

gcloud alpha dlp images redact - redact potentially sensitive data from image content

SYNOPSIS

gcloud alpha dlp images redact IMAGE [--include-quote] [--info-types=[INFOTYPE,...]] [--min-likelihood=MIN_LIKELIHOOD; default="possible"] [--output-file=OUTPUT_FILE] [--redact-all-text] [--redact-color=REDACT_COLOR] [GCLOUD_WIDE_FLAG ...]

DESCRIPTION

(ALPHA) Redact potentially sensitive data from image content.

POSITIONAL ARGUMENTS

IMAGE

Image file to search for sensitive info. The file type must be one of PNG, JPEG, SVG, or BMP.

FLAGS

--include-quote

If True, the server will attempt to filter out profanities, replacing all but the initial character in each filtered word with asterisks, e.g. "f**".

--info-types=[INFOTYPE,...]

Which infoTypes to scan input for. The values must correspond to infoType values found in documentation. For more information about valid infoTypes, see infoTypes Reference (cloud.google.com/dlp/docs/infotypes-reference

--min-likelihood=MIN_LIKELIHOOD; default="possible"

Only return findings equal to or above this threshold. MIN_LIKELIHOOD must be one of: likely, possible, unlikely, very-likely, very-unlikely.

--output-file=OUTPUT_FILE

Path to the file to write redacted contents to.

--redact-all-text

If specified, all text info in the image will be removed, whether it is detected as sensitive or not.

--redact-color=REDACT_COLOR

The color to use when redacting content from an image. If not specified, the default value is black. Colors should be specified as a string of r,g,b float values in the interval [0,1] representing the amount of red, green, and blue in the color, respectively. For example, black = 0,0,0, red = 1.0,0,0, white = 1.0,1.0,1.0, and so on.

GCLOUD WIDE FLAGS

These flags are available to all commands: --account, --configuration, --flags-file, --flatten, --format, --help, --log-http, --project, --quiet, --trace-token, --user-output-enabled, --verbosity. Run $ gcloud help for details.

API REFERENCE

This command uses the dlp/v2 API. The full documentation for this API can be found at: cloud.google.com/dlp/docs

EXAMPLES

To redact phone numbers from an image named my-image.jpg and write the redacted image to my-redacted-image.jpg, run:

$ gcloud alpha dlp images redact my-image.jpg \
    --info-types PHONE_NUMBER \
    --output-file my-redacted-image.jpg

NOTES

This command is currently in ALPHA and may change without notice. If this command fails with API permission errors despite specifying the right project, you will have to apply for early access and have your projects registered on the API whitelist to use it. To do so, contact Support at cloud.google.com/support