Class RedactImageRequest.Builder (3.49.0)

public static final class RedactImageRequest.Builder extends GeneratedMessageV3.Builder<RedactImageRequest.Builder> 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

Static Methods

getDescriptor()

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

Methods

addAllImageRedactionConfigs(Iterable<? extends RedactImageRequest.ImageRedactionConfig> values)

public RedactImageRequest.Builder addAllImageRedactionConfigs(Iterable<? extends RedactImageRequest.ImageRedactionConfig> values)

The configuration for specifying what content to redact from images.

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

Parameter
Name Description
values Iterable<? extends com.google.privacy.dlp.v2.RedactImageRequest.ImageRedactionConfig>
Returns
Type Description
RedactImageRequest.Builder

addImageRedactionConfigs(RedactImageRequest.ImageRedactionConfig value)

public RedactImageRequest.Builder addImageRedactionConfigs(RedactImageRequest.ImageRedactionConfig value)

The configuration for specifying what content to redact from images.

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

Parameter
Name Description
value RedactImageRequest.ImageRedactionConfig
Returns
Type Description
RedactImageRequest.Builder

addImageRedactionConfigs(RedactImageRequest.ImageRedactionConfig.Builder builderForValue)

public RedactImageRequest.Builder addImageRedactionConfigs(RedactImageRequest.ImageRedactionConfig.Builder builderForValue)

The configuration for specifying what content to redact from images.

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

Parameter
Name Description
builderForValue RedactImageRequest.ImageRedactionConfig.Builder
Returns
Type Description
RedactImageRequest.Builder

addImageRedactionConfigs(int index, RedactImageRequest.ImageRedactionConfig value)

public RedactImageRequest.Builder addImageRedactionConfigs(int index, RedactImageRequest.ImageRedactionConfig value)

The configuration for specifying what content to redact from images.

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

Parameters
Name Description
index int
value RedactImageRequest.ImageRedactionConfig
Returns
Type Description
RedactImageRequest.Builder

addImageRedactionConfigs(int index, RedactImageRequest.ImageRedactionConfig.Builder builderForValue)

public RedactImageRequest.Builder addImageRedactionConfigs(int index, RedactImageRequest.ImageRedactionConfig.Builder builderForValue)

The configuration for specifying what content to redact from images.

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

Parameters
Name Description
index int
builderForValue RedactImageRequest.ImageRedactionConfig.Builder
Returns
Type Description
RedactImageRequest.Builder

addImageRedactionConfigsBuilder()

public RedactImageRequest.ImageRedactionConfig.Builder addImageRedactionConfigsBuilder()

The configuration for specifying what content to redact from images.

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

Returns
Type Description
RedactImageRequest.ImageRedactionConfig.Builder

addImageRedactionConfigsBuilder(int index)

public RedactImageRequest.ImageRedactionConfig.Builder addImageRedactionConfigsBuilder(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.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public RedactImageRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
RedactImageRequest.Builder
Overrides

build()

public RedactImageRequest build()
Returns
Type Description
RedactImageRequest

buildPartial()

public RedactImageRequest buildPartial()
Returns
Type Description
RedactImageRequest

clear()

public RedactImageRequest.Builder clear()
Returns
Type Description
RedactImageRequest.Builder
Overrides

clearByteItem()

public RedactImageRequest.Builder clearByteItem()

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

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

Returns
Type Description
RedactImageRequest.Builder

clearField(Descriptors.FieldDescriptor field)

public RedactImageRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
RedactImageRequest.Builder
Overrides

clearImageRedactionConfigs()

public RedactImageRequest.Builder clearImageRedactionConfigs()

The configuration for specifying what content to redact from images.

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

Returns
Type Description
RedactImageRequest.Builder

clearIncludeFindings()

public RedactImageRequest.Builder clearIncludeFindings()

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

bool include_findings = 6;

Returns
Type Description
RedactImageRequest.Builder

This builder for chaining.

clearInspectConfig()

public RedactImageRequest.Builder clearInspectConfig()

Configuration for the inspector.

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

Returns
Type Description
RedactImageRequest.Builder

clearLocationId()

public RedactImageRequest.Builder clearLocationId()

Deprecated. This field has no effect.

string location_id = 8;

Returns
Type Description
RedactImageRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public RedactImageRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
RedactImageRequest.Builder
Overrides

clearParent()

public RedactImageRequest.Builder clearParent()

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
Type Description
RedactImageRequest.Builder

This builder for chaining.

clone()

public RedactImageRequest.Builder clone()
Returns
Type Description
RedactImageRequest.Builder
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.

getByteItemBuilder()

public ByteContentItem.Builder getByteItemBuilder()

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

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

Returns
Type Description
ByteContentItem.Builder

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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

getImageRedactionConfigsBuilder(int index)

public RedactImageRequest.ImageRedactionConfig.Builder getImageRedactionConfigsBuilder(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.Builder

getImageRedactionConfigsBuilderList()

public List<RedactImageRequest.ImageRedactionConfig.Builder> getImageRedactionConfigsBuilderList()

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<Builder>

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.

getInspectConfigBuilder()

public InspectConfig.Builder getInspectConfigBuilder()

Configuration for the inspector.

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

Returns
Type Description
InspectConfig.Builder

getInspectConfigOrBuilder()

public InspectConfigOrBuilder getInspectConfigOrBuilder()

Configuration for the inspector.

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

Returns
Type Description
InspectConfigOrBuilder

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:<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
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:<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
Type Description
ByteString

The bytes for parent.

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeByteItem(ByteContentItem value)

public RedactImageRequest.Builder mergeByteItem(ByteContentItem value)

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

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

Parameter
Name Description
value ByteContentItem
Returns
Type Description
RedactImageRequest.Builder

mergeFrom(RedactImageRequest other)

public RedactImageRequest.Builder mergeFrom(RedactImageRequest other)
Parameter
Name Description
other RedactImageRequest
Returns
Type Description
RedactImageRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public RedactImageRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RedactImageRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public RedactImageRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
RedactImageRequest.Builder
Overrides

mergeInspectConfig(InspectConfig value)

public RedactImageRequest.Builder mergeInspectConfig(InspectConfig value)

Configuration for the inspector.

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

Parameter
Name Description
value InspectConfig
Returns
Type Description
RedactImageRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final RedactImageRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
RedactImageRequest.Builder
Overrides

removeImageRedactionConfigs(int index)

public RedactImageRequest.Builder removeImageRedactionConfigs(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.Builder

setByteItem(ByteContentItem value)

public RedactImageRequest.Builder setByteItem(ByteContentItem value)

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

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

Parameter
Name Description
value ByteContentItem
Returns
Type Description
RedactImageRequest.Builder

setByteItem(ByteContentItem.Builder builderForValue)

public RedactImageRequest.Builder setByteItem(ByteContentItem.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue ByteContentItem.Builder
Returns
Type Description
RedactImageRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public RedactImageRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
RedactImageRequest.Builder
Overrides

setImageRedactionConfigs(int index, RedactImageRequest.ImageRedactionConfig value)

public RedactImageRequest.Builder setImageRedactionConfigs(int index, RedactImageRequest.ImageRedactionConfig value)

The configuration for specifying what content to redact from images.

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

Parameters
Name Description
index int
value RedactImageRequest.ImageRedactionConfig
Returns
Type Description
RedactImageRequest.Builder

setImageRedactionConfigs(int index, RedactImageRequest.ImageRedactionConfig.Builder builderForValue)

public RedactImageRequest.Builder setImageRedactionConfigs(int index, RedactImageRequest.ImageRedactionConfig.Builder builderForValue)

The configuration for specifying what content to redact from images.

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

Parameters
Name Description
index int
builderForValue RedactImageRequest.ImageRedactionConfig.Builder
Returns
Type Description
RedactImageRequest.Builder

setIncludeFindings(boolean value)

public RedactImageRequest.Builder setIncludeFindings(boolean value)

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

bool include_findings = 6;

Parameter
Name Description
value boolean

The includeFindings to set.

Returns
Type Description
RedactImageRequest.Builder

This builder for chaining.

setInspectConfig(InspectConfig value)

public RedactImageRequest.Builder setInspectConfig(InspectConfig value)

Configuration for the inspector.

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

Parameter
Name Description
value InspectConfig
Returns
Type Description
RedactImageRequest.Builder

setInspectConfig(InspectConfig.Builder builderForValue)

public RedactImageRequest.Builder setInspectConfig(InspectConfig.Builder builderForValue)

Configuration for the inspector.

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

Parameter
Name Description
builderForValue InspectConfig.Builder
Returns
Type Description
RedactImageRequest.Builder

setLocationId(String value)

public RedactImageRequest.Builder setLocationId(String value)

Deprecated. This field has no effect.

string location_id = 8;

Parameter
Name Description
value String

The locationId to set.

Returns
Type Description
RedactImageRequest.Builder

This builder for chaining.

setLocationIdBytes(ByteString value)

public RedactImageRequest.Builder setLocationIdBytes(ByteString value)

Deprecated. This field has no effect.

string location_id = 8;

Parameter
Name Description
value ByteString

The bytes for locationId to set.

Returns
Type Description
RedactImageRequest.Builder

This builder for chaining.

setParent(String value)

public RedactImageRequest.Builder setParent(String value)

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) = { ... }

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
RedactImageRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public RedactImageRequest.Builder setParentBytes(ByteString value)

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) = { ... }

Parameter
Name Description
value ByteString

The bytes for parent to set.

Returns
Type Description
RedactImageRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public RedactImageRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
RedactImageRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final RedactImageRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
RedactImageRequest.Builder
Overrides