public static final class SanitizationResult.Builder extends GeneratedMessageV3.Builder<SanitizationResult.Builder> implements SanitizationResultOrBuilderSanitization result after applying all the filters on input content.
 Protobuf type google.cloud.modelarmor.v1.SanitizationResult
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > SanitizationResult.BuilderImplements
SanitizationResultOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description | 
| Descriptor | |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public SanitizationResult.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description | 
| field | FieldDescriptor | 
| value | Object | 
| Returns | |
|---|---|
| Type | Description | 
| SanitizationResult.Builder | |
build()
public SanitizationResult build()| Returns | |
|---|---|
| Type | Description | 
| SanitizationResult | |
buildPartial()
public SanitizationResult buildPartial()| Returns | |
|---|---|
| Type | Description | 
| SanitizationResult | |
clear()
public SanitizationResult.Builder clear()| Returns | |
|---|---|
| Type | Description | 
| SanitizationResult.Builder | |
clearField(Descriptors.FieldDescriptor field)
public SanitizationResult.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description | 
| field | FieldDescriptor | 
| Returns | |
|---|---|
| Type | Description | 
| SanitizationResult.Builder | |
clearFilterMatchState()
public SanitizationResult.Builder clearFilterMatchState()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 | 
| SanitizationResult.Builder | This builder for chaining. | 
clearFilterResults()
public SanitizationResult.Builder clearFilterResults()| Returns | |
|---|---|
| Type | Description | 
| SanitizationResult.Builder | |
clearInvocationResult()
public SanitizationResult.Builder clearInvocationResult()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 | 
| SanitizationResult.Builder | This builder for chaining. | 
clearOneof(Descriptors.OneofDescriptor oneof)
public SanitizationResult.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description | 
| oneof | OneofDescriptor | 
| Returns | |
|---|---|
| Type | Description | 
| SanitizationResult.Builder | |
clearSanitizationMetadata()
public SanitizationResult.Builder clearSanitizationMetadata()Output only. Metadata related to Sanitization.
 
 .google.cloud.modelarmor.v1.SanitizationResult.SanitizationMetadata sanitization_metadata = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
 
| Returns | |
|---|---|
| Type | Description | 
| SanitizationResult.Builder | |
clone()
public SanitizationResult.Builder clone()| Returns | |
|---|---|
| Type | Description | 
| SanitizationResult.Builder | |
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 | 
| Returns | |
|---|---|
| Type | Description | 
| boolean | |
getDefaultInstanceForType()
public SanitizationResult getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description | 
| SanitizationResult | |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description | 
| Descriptor | |
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];
 
| Returns | |
|---|---|
| Type | Description | 
| FilterMatchState | The filterMatchState. | 
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()Use #getFilterResultsMap() instead.
| Returns | |
|---|---|
| Type | Description | 
| Map<String,FilterResult> | |
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];
 
| Returns | |
|---|---|
| Type | Description | 
| Map<String,FilterResult> | |
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];
 
| Parameters | |
|---|---|
| Name | Description | 
| key | String | 
| defaultValue | FilterResult | 
| Returns | |
|---|---|
| Type | Description | 
| FilterResult | |
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 | 
| Returns | |
|---|---|
| Type | Description | 
| FilterResult | |
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];
 
| Returns | |
|---|---|
| Type | Description | 
| InvocationResult | The invocationResult. | 
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. | 
getMutableFilterResults() (deprecated)
public Map<String,FilterResult> getMutableFilterResults()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description | 
| Map<String,FilterResult> | |
getSanitizationMetadata()
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];
 
| Returns | |
|---|---|
| Type | Description | 
| SanitizationResult.SanitizationMetadata | The sanitizationMetadata. | 
getSanitizationMetadataBuilder()
public SanitizationResult.SanitizationMetadata.Builder getSanitizationMetadataBuilder()Output only. Metadata related to Sanitization.
 
 .google.cloud.modelarmor.v1.SanitizationResult.SanitizationMetadata sanitization_metadata = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
 
| Returns | |
|---|---|
| Type | Description | 
| SanitizationResult.SanitizationMetadata.Builder | |
getSanitizationMetadataOrBuilder()
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];
 
| Returns | |
|---|---|
| Type | Description | 
| SanitizationResult.SanitizationMetadataOrBuilder | |
hasSanitizationMetadata()
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. | 
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description | 
| FieldAccessorTable | |
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description | 
| number | int | 
| Returns | |
|---|---|
| Type | Description | 
| com.google.protobuf.MapFieldReflectionAccessor | |
internalGetMutableMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description | 
| number | int | 
| Returns | |
|---|---|
| Type | Description | 
| com.google.protobuf.MapFieldReflectionAccessor | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description | 
| boolean | |
mergeFrom(SanitizationResult other)
public SanitizationResult.Builder mergeFrom(SanitizationResult other)| Parameter | |
|---|---|
| Name | Description | 
| other | SanitizationResult | 
| Returns | |
|---|---|
| Type | Description | 
| SanitizationResult.Builder | |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public SanitizationResult.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description | 
| input | CodedInputStream | 
| extensionRegistry | ExtensionRegistryLite | 
| Returns | |
|---|---|
| Type | Description | 
| SanitizationResult.Builder | |
| Exceptions | |
|---|---|
| Type | Description | 
| IOException | |
mergeFrom(Message other)
public SanitizationResult.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description | 
| other | Message | 
| Returns | |
|---|---|
| Type | Description | 
| SanitizationResult.Builder | |
mergeSanitizationMetadata(SanitizationResult.SanitizationMetadata value)
public SanitizationResult.Builder mergeSanitizationMetadata(SanitizationResult.SanitizationMetadata value)Output only. Metadata related to Sanitization.
 
 .google.cloud.modelarmor.v1.SanitizationResult.SanitizationMetadata sanitization_metadata = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
 
| Parameter | |
|---|---|
| Name | Description | 
| value | SanitizationResult.SanitizationMetadata | 
| Returns | |
|---|---|
| Type | Description | 
| SanitizationResult.Builder | |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final SanitizationResult.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description | 
| unknownFields | UnknownFieldSet | 
| Returns | |
|---|---|
| Type | Description | 
| SanitizationResult.Builder | |
putAllFilterResults(Map<String,FilterResult> values)
public SanitizationResult.Builder putAllFilterResults(Map<String,FilterResult> values)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 | 
| values | Map<String,FilterResult> | 
| Returns | |
|---|---|
| Type | Description | 
| SanitizationResult.Builder | |
putFilterResults(String key, FilterResult value)
public SanitizationResult.Builder putFilterResults(String key, FilterResult value)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];
 
| Parameters | |
|---|---|
| Name | Description | 
| key | String | 
| value | FilterResult | 
| Returns | |
|---|---|
| Type | Description | 
| SanitizationResult.Builder | |
putFilterResultsBuilderIfAbsent(String key)
public FilterResult.Builder putFilterResultsBuilderIfAbsent(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 | 
| Returns | |
|---|---|
| Type | Description | 
| FilterResult.Builder | |
removeFilterResults(String key)
public SanitizationResult.Builder removeFilterResults(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 | 
| Returns | |
|---|---|
| Type | Description | 
| SanitizationResult.Builder | |
setField(Descriptors.FieldDescriptor field, Object value)
public SanitizationResult.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description | 
| field | FieldDescriptor | 
| value | Object | 
| Returns | |
|---|---|
| Type | Description | 
| SanitizationResult.Builder | |
setFilterMatchState(FilterMatchState value)
public SanitizationResult.Builder setFilterMatchState(FilterMatchState value)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];
 
| Parameter | |
|---|---|
| Name | Description | 
| value | FilterMatchStateThe filterMatchState to set. | 
| Returns | |
|---|---|
| Type | Description | 
| SanitizationResult.Builder | This builder for chaining. | 
setFilterMatchStateValue(int value)
public SanitizationResult.Builder setFilterMatchStateValue(int value)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];
 
| Parameter | |
|---|---|
| Name | Description | 
| value | intThe enum numeric value on the wire for filterMatchState to set. | 
| Returns | |
|---|---|
| Type | Description | 
| SanitizationResult.Builder | This builder for chaining. | 
setInvocationResult(InvocationResult value)
public SanitizationResult.Builder setInvocationResult(InvocationResult value)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];
 
| Parameter | |
|---|---|
| Name | Description | 
| value | InvocationResultThe invocationResult to set. | 
| Returns | |
|---|---|
| Type | Description | 
| SanitizationResult.Builder | This builder for chaining. | 
setInvocationResultValue(int value)
public SanitizationResult.Builder setInvocationResultValue(int value)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];
 
| Parameter | |
|---|---|
| Name | Description | 
| value | intThe enum numeric value on the wire for invocationResult to set. | 
| Returns | |
|---|---|
| Type | Description | 
| SanitizationResult.Builder | This builder for chaining. | 
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public SanitizationResult.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description | 
| field | FieldDescriptor | 
| index | int | 
| value | Object | 
| Returns | |
|---|---|
| Type | Description | 
| SanitizationResult.Builder | |
setSanitizationMetadata(SanitizationResult.SanitizationMetadata value)
public SanitizationResult.Builder setSanitizationMetadata(SanitizationResult.SanitizationMetadata value)Output only. Metadata related to Sanitization.
 
 .google.cloud.modelarmor.v1.SanitizationResult.SanitizationMetadata sanitization_metadata = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
 
| Parameter | |
|---|---|
| Name | Description | 
| value | SanitizationResult.SanitizationMetadata | 
| Returns | |
|---|---|
| Type | Description | 
| SanitizationResult.Builder | |
setSanitizationMetadata(SanitizationResult.SanitizationMetadata.Builder builderForValue)
public SanitizationResult.Builder setSanitizationMetadata(SanitizationResult.SanitizationMetadata.Builder builderForValue)Output only. Metadata related to Sanitization.
 
 .google.cloud.modelarmor.v1.SanitizationResult.SanitizationMetadata sanitization_metadata = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
 
| Parameter | |
|---|---|
| Name | Description | 
| builderForValue | SanitizationResult.SanitizationMetadata.Builder | 
| Returns | |
|---|---|
| Type | Description | 
| SanitizationResult.Builder | |
setUnknownFields(UnknownFieldSet unknownFields)
public final SanitizationResult.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description | 
| unknownFields | UnknownFieldSet | 
| Returns | |
|---|---|
| Type | Description | 
| SanitizationResult.Builder | |