Class RedactImageRequest (3.82.0) 

public final class RedactImageRequest extends GeneratedMessageV3 implements RedactImageRequestOrBuilder

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

Protobuf type google.privacy.dlp.v2.RedactImageRequest

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > RedactImageRequest

Static Fields

BYTE_ITEM_FIELD_NUMBER

public static final int BYTE_ITEM_FIELD_NUMBER
Field Value
Type Description
int

DEIDENTIFY_TEMPLATE_FIELD_NUMBER

public static final int DEIDENTIFY_TEMPLATE_FIELD_NUMBER
Field Value
Type Description
int

IMAGE_REDACTION_CONFIGS_FIELD_NUMBER

public static final int IMAGE_REDACTION_CONFIGS_FIELD_NUMBER
Field Value
Type Description
int

INCLUDE_FINDINGS_FIELD_NUMBER

public static final int INCLUDE_FINDINGS_FIELD_NUMBER
Field Value
Type Description
int

INSPECT_CONFIG_FIELD_NUMBER

public static final int INSPECT_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

INSPECT_TEMPLATE_FIELD_NUMBER

public static final int INSPECT_TEMPLATE_FIELD_NUMBER
Field Value
Type Description
int

LOCATION_ID_FIELD_NUMBER

public static final int LOCATION_ID_FIELD_NUMBER
Field Value
Type Description
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static RedactImageRequest getDefaultInstance()
Returns
Type Description
RedactImageRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static RedactImageRequest.Builder newBuilder()
Returns
Type Description
RedactImageRequest.Builder

newBuilder(RedactImageRequest prototype)

public static RedactImageRequest.Builder newBuilder(RedactImageRequest prototype)
Parameter
Name Description
prototype RedactImageRequest
Returns
Type Description
RedactImageRequest.Builder

parseDelimitedFrom(InputStream input)

public static RedactImageRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RedactImageRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RedactImageRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RedactImageRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static RedactImageRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
RedactImageRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static RedactImageRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RedactImageRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static RedactImageRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
RedactImageRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static RedactImageRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RedactImageRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static RedactImageRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
RedactImageRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static RedactImageRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RedactImageRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static RedactImageRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RedactImageRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RedactImageRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RedactImageRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static RedactImageRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
RedactImageRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static RedactImageRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RedactImageRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<RedactImageRequest> parser()
Returns
Type Description
Parser<RedactImageRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getByteItem()

public ByteContentItem getByteItem()

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

.google.privacy.dlp.v2.ByteContentItem byte_item = 7;

Returns
Type Description
ByteContentItem

The byteItem.

getByteItemOrBuilder()

public ByteContentItemOrBuilder getByteItemOrBuilder()

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

.google.privacy.dlp.v2.ByteContentItem byte_item = 7;

Returns
Type Description
ByteContentItemOrBuilder

getDefaultInstanceForType()

public RedactImageRequest getDefaultInstanceForType()
Returns
Type Description
RedactImageRequest

getDeidentifyTemplate()

public String getDeidentifyTemplate()

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.

string deidentify_template = 10;

Returns
Type Description
String

The deidentifyTemplate.

getDeidentifyTemplateBytes()

public ByteString getDeidentifyTemplateBytes()

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.

string deidentify_template = 10;

Returns
Type Description
ByteString

The bytes for deidentifyTemplate.

getImageRedactionConfigs(int index)

public RedactImageRequest.ImageRedactionConfig getImageRedactionConfigs(int index)

The configuration for specifying what content to redact from images.

repeated .google.privacy.dlp.v2.RedactImageRequest.ImageRedactionConfig image_redaction_configs = 5;

Parameter
Name Description
index int
Returns
Type Description
RedactImageRequest.ImageRedactionConfig

getImageRedactionConfigsCount()

public int getImageRedactionConfigsCount()

The configuration for specifying what content to redact from images.

repeated .google.privacy.dlp.v2.RedactImageRequest.ImageRedactionConfig image_redaction_configs = 5;

Returns
Type Description
int

getImageRedactionConfigsList()

public List<RedactImageRequest.ImageRedactionConfig> getImageRedactionConfigsList()

The configuration for specifying what content to redact from images.

repeated .google.privacy.dlp.v2.RedactImageRequest.ImageRedactionConfig image_redaction_configs = 5;

Returns
Type Description
List<ImageRedactionConfig>

getImageRedactionConfigsOrBuilder(int index)

public RedactImageRequest.ImageRedactionConfigOrBuilder getImageRedactionConfigsOrBuilder(int index)

The configuration for specifying what content to redact from images.

repeated .google.privacy.dlp.v2.RedactImageRequest.ImageRedactionConfig image_redaction_configs = 5;

Parameter
Name Description
index int
Returns
Type Description
RedactImageRequest.ImageRedactionConfigOrBuilder

getImageRedactionConfigsOrBuilderList()

public List<? extends RedactImageRequest.ImageRedactionConfigOrBuilder> getImageRedactionConfigsOrBuilderList()

The configuration for specifying what content to redact from images.

repeated .google.privacy.dlp.v2.RedactImageRequest.ImageRedactionConfig image_redaction_configs = 5;

Returns
Type Description
List<? extends com.google.privacy.dlp.v2.RedactImageRequest.ImageRedactionConfigOrBuilder>

getIncludeFindings()

public boolean getIncludeFindings()

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

bool include_findings = 6;

Returns
Type Description
boolean

The includeFindings.

getInspectConfig()

public InspectConfig getInspectConfig()

Configuration for the inspector.

.google.privacy.dlp.v2.InspectConfig inspect_config = 2;

Returns
Type Description
InspectConfig

The inspectConfig.

getInspectConfigOrBuilder()

public InspectConfigOrBuilder getInspectConfigOrBuilder()

Configuration for the inspector.

.google.privacy.dlp.v2.InspectConfig inspect_config = 2;

Returns
Type Description
InspectConfigOrBuilder

getInspectTemplate()

public String getInspectTemplate()

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.

string inspect_template = 9;

Returns
Type Description
String

The inspectTemplate.

getInspectTemplateBytes()

public ByteString getInspectTemplateBytes()

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.

string inspect_template = 9;

Returns
Type Description
ByteString

The bytes for inspectTemplate.

getLocationId()

public String getLocationId()

Deprecated. This field has no effect.

string location_id = 8;

Returns
Type Description
String

The locationId.

getLocationIdBytes()

public ByteString getLocationIdBytes()

Deprecated. This field has no effect.

string location_id = 8;

Returns
Type Description
ByteString

The bytes for locationId.

getParent()

public String getParent()

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

string parent = 1 [(.google.api.resource_reference) = { ... }

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

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

string parent = 1 [(.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for parent.

getParserForType()

public Parser<RedactImageRequest> getParserForType()
Returns
Type Description
Parser<RedactImageRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasByteItem()

public boolean hasByteItem()

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

.google.privacy.dlp.v2.ByteContentItem byte_item = 7;

Returns
Type Description
boolean

Whether the byteItem field is set.

hasInspectConfig()

public boolean hasInspectConfig()

Configuration for the inspector.

.google.privacy.dlp.v2.InspectConfig inspect_config = 2;

Returns
Type Description
boolean

Whether the inspectConfig field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public RedactImageRequest.Builder newBuilderForType()
Returns
Type Description
RedactImageRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected RedactImageRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
RedactImageRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public RedactImageRequest.Builder toBuilder()
Returns
Type Description
RedactImageRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException