public final class SanitizationResult extends GeneratedMessageV3 implements SanitizationResultOrBuilder
Sanitization result after applying all the filters on input content.
Protobuf type google.cloud.modelarmor.v1.SanitizationResult
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
FILTER_MATCH_STATE_FIELD_NUMBER
public static final int FILTER_MATCH_STATE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
FILTER_RESULTS_FIELD_NUMBER
public static final int FILTER_RESULTS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
INVOCATION_RESULT_FIELD_NUMBER
public static final int INVOCATION_RESULT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int SANITIZATION_METADATA_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static SanitizationResult getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static SanitizationResult.Builder newBuilder()
newBuilder(SanitizationResult prototype)
public static SanitizationResult.Builder newBuilder(SanitizationResult prototype)
public static SanitizationResult parseDelimitedFrom(InputStream input)
public static SanitizationResult parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static SanitizationResult parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static SanitizationResult parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static SanitizationResult parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SanitizationResult parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SanitizationResult parseFrom(CodedInputStream input)
public static SanitizationResult parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static SanitizationResult parseFrom(InputStream input)
public static SanitizationResult parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static SanitizationResult parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static SanitizationResult parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<SanitizationResult> parser()
Methods
containsFilterResults(String key)
public boolean containsFilterResults(String key)
Output only. Results for all filters where the key is the filter name -
either of "csam", "malicious_uris", "rai", "pi_and_jailbreak" ,"sdp".
map<string, .google.cloud.modelarmor.v1.FilterResult> filter_results = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter |
| Name |
Description |
key |
String
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public SanitizationResult getDefaultInstanceForType()
getFilterMatchState()
public FilterMatchState getFilterMatchState()
Output only. Overall filter match state for Sanitization.
The state can have below two values.
1) NO_MATCH_FOUND: No filters in configuration satisfy matching criteria.
In other words, input passed all filters.
2) MATCH_FOUND: At least one filter in configuration satisfies matching.
In other words, input did not pass one or more filters.
.google.cloud.modelarmor.v1.FilterMatchState filter_match_state = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
getFilterMatchStateValue()
public int getFilterMatchStateValue()
Output only. Overall filter match state for Sanitization.
The state can have below two values.
1) NO_MATCH_FOUND: No filters in configuration satisfy matching criteria.
In other words, input passed all filters.
2) MATCH_FOUND: At least one filter in configuration satisfies matching.
In other words, input did not pass one or more filters.
.google.cloud.modelarmor.v1.FilterMatchState filter_match_state = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
int |
The enum numeric value on the wire for filterMatchState.
|
getFilterResults() (deprecated)
public Map<String,FilterResult> getFilterResults()
getFilterResultsCount()
public int getFilterResultsCount()
Output only. Results for all filters where the key is the filter name -
either of "csam", "malicious_uris", "rai", "pi_and_jailbreak" ,"sdp".
map<string, .google.cloud.modelarmor.v1.FilterResult> filter_results = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
int |
|
getFilterResultsMap()
public Map<String,FilterResult> getFilterResultsMap()
Output only. Results for all filters where the key is the filter name -
either of "csam", "malicious_uris", "rai", "pi_and_jailbreak" ,"sdp".
map<string, .google.cloud.modelarmor.v1.FilterResult> filter_results = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
getFilterResultsOrDefault(String key, FilterResult defaultValue)
public FilterResult getFilterResultsOrDefault(String key, FilterResult defaultValue)
Output only. Results for all filters where the key is the filter name -
either of "csam", "malicious_uris", "rai", "pi_and_jailbreak" ,"sdp".
map<string, .google.cloud.modelarmor.v1.FilterResult> filter_results = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
getFilterResultsOrThrow(String key)
public FilterResult getFilterResultsOrThrow(String key)
Output only. Results for all filters where the key is the filter name -
either of "csam", "malicious_uris", "rai", "pi_and_jailbreak" ,"sdp".
map<string, .google.cloud.modelarmor.v1.FilterResult> filter_results = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter |
| Name |
Description |
key |
String
|
getInvocationResult()
public InvocationResult getInvocationResult()
Output only. A field indicating the outcome of the invocation, irrespective
of match status. It can have the following three values: SUCCESS: All
filters were executed successfully. PARTIAL: Some filters were skipped or
failed execution. FAILURE: All filters were skipped or failed execution.
.google.cloud.modelarmor.v1.InvocationResult invocation_result = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
getInvocationResultValue()
public int getInvocationResultValue()
Output only. A field indicating the outcome of the invocation, irrespective
of match status. It can have the following three values: SUCCESS: All
filters were executed successfully. PARTIAL: Some filters were skipped or
failed execution. FAILURE: All filters were skipped or failed execution.
.google.cloud.modelarmor.v1.InvocationResult invocation_result = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
int |
The enum numeric value on the wire for invocationResult.
|
getParserForType()
public Parser<SanitizationResult> getParserForType()
Overrides
public SanitizationResult.SanitizationMetadata getSanitizationMetadata()
Output only. Metadata related to Sanitization.
.google.cloud.modelarmor.v1.SanitizationResult.SanitizationMetadata sanitization_metadata = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
public SanitizationResult.SanitizationMetadataOrBuilder getSanitizationMetadataOrBuilder()
Output only. Metadata related to Sanitization.
.google.cloud.modelarmor.v1.SanitizationResult.SanitizationMetadata sanitization_metadata = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
public boolean hasSanitizationMetadata()
Output only. Metadata related to Sanitization.
.google.cloud.modelarmor.v1.SanitizationResult.SanitizationMetadata sanitization_metadata = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
boolean |
Whether the sanitizationMetadata field is set.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
| Parameter |
| Name |
Description |
number |
int
|
| Returns |
| Type |
Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public SanitizationResult.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected SanitizationResult.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public SanitizationResult.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
