Class RedactImageRequest

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

Fields

BYTE_ITEM_FIELD_NUMBER

public static final int BYTE_ITEM_FIELD_NUMBER
Field Value
TypeDescription
int

IMAGE_REDACTION_CONFIGS_FIELD_NUMBER

public static final int IMAGE_REDACTION_CONFIGS_FIELD_NUMBER
Field Value
TypeDescription
int

INCLUDE_FINDINGS_FIELD_NUMBER

public static final int INCLUDE_FINDINGS_FIELD_NUMBER
Field Value
TypeDescription
int

INSPECT_CONFIG_FIELD_NUMBER

public static final int INSPECT_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

LOCATION_ID_FIELD_NUMBER

public static final int LOCATION_ID_FIELD_NUMBER
Field Value
TypeDescription
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
TypeDescription
int

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getByteItem()

public ByteContentItem getByteItem()

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

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

Returns
TypeDescription
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
TypeDescription
ByteContentItemOrBuilder

getDefaultInstance()

public static RedactImageRequest getDefaultInstance()
Returns
TypeDescription
RedactImageRequest

getDefaultInstanceForType()

public RedactImageRequest getDefaultInstanceForType()
Returns
TypeDescription
RedactImageRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

The includeFindings.

getInspectConfig()

public InspectConfig getInspectConfig()

Configuration for the inspector.

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

Returns
TypeDescription
InspectConfig

The inspectConfig.

getInspectConfigOrBuilder()

public InspectConfigOrBuilder getInspectConfigOrBuilder()

Configuration for the inspector.

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

Returns
TypeDescription
InspectConfigOrBuilder

getLocationId()

public String getLocationId()

Deprecated. This field has no effect.

string location_id = 8;

Returns
TypeDescription
String

The locationId.

getLocationIdBytes()

public ByteString getLocationIdBytes()

Deprecated. This field has no effect.

string location_id = 8;

Returns
TypeDescription
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:<br/> projects/<var>PROJECT_ID</var>/locations/<var>LOCATION_ID</var>
  • Projects scope, no location specified (defaults to global):<br/> projects/<var>PROJECT_ID</var> 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
TypeDescription
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:<br/> projects/<var>PROJECT_ID</var>/locations/<var>LOCATION_ID</var>
  • Projects scope, no location specified (defaults to global):<br/> projects/<var>PROJECT_ID</var> 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
TypeDescription
ByteString

The bytes for parent.

getParserForType()

public Parser<RedactImageRequest> getParserForType()
Returns
TypeDescription
Parser<RedactImageRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hasByteItem()

public boolean hasByteItem()

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

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

Returns
TypeDescription
boolean

Whether the byteItem field is set.

hasInspectConfig()

public boolean hasInspectConfig()

Configuration for the inspector.

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

Returns
TypeDescription
boolean

Whether the inspectConfig field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilder()

public static RedactImageRequest.Builder newBuilder()
Returns
TypeDescription
RedactImageRequest.Builder

newBuilder(RedactImageRequest prototype)

public static RedactImageRequest.Builder newBuilder(RedactImageRequest prototype)
Parameter
NameDescription
prototypeRedactImageRequest
Returns
TypeDescription
RedactImageRequest.Builder

newBuilderForType()

public RedactImageRequest.Builder newBuilderForType()
Returns
TypeDescription
RedactImageRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected RedactImageRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
RedactImageRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

parseDelimitedFrom(InputStream input)

public static RedactImageRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
RedactImageRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RedactImageRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RedactImageRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static RedactImageRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
RedactImageRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static RedactImageRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RedactImageRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static RedactImageRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
RedactImageRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static RedactImageRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RedactImageRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static RedactImageRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
RedactImageRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static RedactImageRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RedactImageRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static RedactImageRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
RedactImageRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RedactImageRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RedactImageRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static RedactImageRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
RedactImageRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static RedactImageRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RedactImageRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<RedactImageRequest> parser()
Returns
TypeDescription
Parser<RedactImageRequest>

toBuilder()

public RedactImageRequest.Builder toBuilder()
Returns
TypeDescription
RedactImageRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException