Class SdpRedactResult (0.36.0)

public final class SdpRedactResult extends GeneratedMessage implements SdpRedactResultOrBuilder

Sensitive Data Protection Redaction Result.

Protobuf type google.cloud.modelarmor.v1.SdpRedactResult

Static Fields

EXECUTION_STATE_FIELD_NUMBER

public static final int EXECUTION_STATE_FIELD_NUMBER
Field Value
Type Description
int

EXTRACTED_IMAGE_TEXT_FIELD_NUMBER

public static final int EXTRACTED_IMAGE_TEXT_FIELD_NUMBER
Field Value
Type Description
int

FINDINGS_FIELD_NUMBER

public static final int FINDINGS_FIELD_NUMBER
Field Value
Type Description
int

MATCH_STATE_FIELD_NUMBER

public static final int MATCH_STATE_FIELD_NUMBER
Field Value
Type Description
int

MESSAGE_ITEMS_FIELD_NUMBER

public static final int MESSAGE_ITEMS_FIELD_NUMBER
Field Value
Type Description
int

REDACTED_IMAGE_FIELD_NUMBER

public static final int REDACTED_IMAGE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SdpRedactResult getDefaultInstance()
Returns
Type Description
SdpRedactResult

getDescriptor()

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

newBuilder()

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

newBuilder(SdpRedactResult prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public SdpRedactResult getDefaultInstanceForType()
Returns
Type Description
SdpRedactResult

getExecutionState()

public FilterExecutionState getExecutionState()

Output only. Reports whether Sensitive Data Protection redaction was successfully executed or not.

.google.cloud.modelarmor.v1.FilterExecutionState execution_state = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
FilterExecutionState

The executionState.

getExecutionStateValue()

public int getExecutionStateValue()

Output only. Reports whether Sensitive Data Protection redaction was successfully executed or not.

.google.cloud.modelarmor.v1.FilterExecutionState execution_state = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for executionState.

getExtractedImageText()

public String getExtractedImageText()

The extracted text from the image.

string extracted_image_text = 6;

Returns
Type Description
String

The extractedImageText.

getExtractedImageTextBytes()

public ByteString getExtractedImageTextBytes()

The extracted text from the image.

string extracted_image_text = 6;

Returns
Type Description
ByteString

The bytes for extractedImageText.

getFindings(int index)

public SdpFinding getFindings(int index)

Output only. The findings. This field is populated in the response only when include_findings in the SDP template is set to true.

repeated .google.cloud.modelarmor.v1.SdpFinding findings = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
SdpFinding

getFindingsCount()

public int getFindingsCount()

Output only. The findings. This field is populated in the response only when include_findings in the SDP template is set to true.

repeated .google.cloud.modelarmor.v1.SdpFinding findings = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getFindingsList()

public List<SdpFinding> getFindingsList()

Output only. The findings. This field is populated in the response only when include_findings in the SDP template is set to true.

repeated .google.cloud.modelarmor.v1.SdpFinding findings = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<SdpFinding>

getFindingsOrBuilder(int index)

public SdpFindingOrBuilder getFindingsOrBuilder(int index)

Output only. The findings. This field is populated in the response only when include_findings in the SDP template is set to true.

repeated .google.cloud.modelarmor.v1.SdpFinding findings = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
SdpFindingOrBuilder

getFindingsOrBuilderList()

public List<? extends SdpFindingOrBuilder> getFindingsOrBuilderList()

Output only. The findings. This field is populated in the response only when include_findings in the SDP template is set to true.

repeated .google.cloud.modelarmor.v1.SdpFinding findings = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<? extends com.google.cloud.modelarmor.v1.SdpFindingOrBuilder>

getMatchState()

public FilterMatchState getMatchState()

Output only. Match state for Sensitive Data Protection Redaction. Value is MATCH_FOUND if content is redacted.

.google.cloud.modelarmor.v1.FilterMatchState match_state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
FilterMatchState

The matchState.

getMatchStateValue()

public int getMatchStateValue()

Output only. Match state for Sensitive Data Protection Redaction. Value is MATCH_FOUND if content is redacted.

.google.cloud.modelarmor.v1.FilterMatchState match_state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for matchState.

getMessageItems(int index)

public MessageItem getMessageItems(int index)

Output only. Optional messages corresponding to the result. A message can provide warnings or error details. For example, if execution state is skipped then this field provides related reason/explanation.

repeated .google.cloud.modelarmor.v1.MessageItem message_items = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
MessageItem

getMessageItemsCount()

public int getMessageItemsCount()

Output only. Optional messages corresponding to the result. A message can provide warnings or error details. For example, if execution state is skipped then this field provides related reason/explanation.

repeated .google.cloud.modelarmor.v1.MessageItem message_items = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getMessageItemsList()

public List<MessageItem> getMessageItemsList()

Output only. Optional messages corresponding to the result. A message can provide warnings or error details. For example, if execution state is skipped then this field provides related reason/explanation.

repeated .google.cloud.modelarmor.v1.MessageItem message_items = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<MessageItem>

getMessageItemsOrBuilder(int index)

public MessageItemOrBuilder getMessageItemsOrBuilder(int index)

Output only. Optional messages corresponding to the result. A message can provide warnings or error details. For example, if execution state is skipped then this field provides related reason/explanation.

repeated .google.cloud.modelarmor.v1.MessageItem message_items = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
MessageItemOrBuilder

getMessageItemsOrBuilderList()

public List<? extends MessageItemOrBuilder> getMessageItemsOrBuilderList()

Output only. Optional messages corresponding to the result. A message can provide warnings or error details. For example, if execution state is skipped then this field provides related reason/explanation.

repeated .google.cloud.modelarmor.v1.MessageItem message_items = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<? extends com.google.cloud.modelarmor.v1.MessageItemOrBuilder>

getParserForType()

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

getRedactedImage()

public ByteString getRedactedImage()

Output only. The redacted image. The type will be the same as the original image.

bytes redacted_image = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The redactedImage.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(AbstractMessage.BuilderParent parent)

protected SdpRedactResult.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
SdpRedactResult.Builder
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

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