public static final class RaiFilterResult.Builder extends GeneratedMessage.Builder<RaiFilterResult.Builder> implements RaiFilterResultOrBuilderResponsible AI Result.
Protobuf type google.cloud.modelarmor.v1.RaiFilterResult
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > RaiFilterResult.BuilderImplements
RaiFilterResultOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllMessageItems(Iterable<? extends MessageItem> values)
public RaiFilterResult.Builder addAllMessageItems(Iterable<? extends MessageItem> values)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;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<? extends com.google.cloud.modelarmor.v1.MessageItem> |
| Returns | |
|---|---|
| Type | Description |
RaiFilterResult.Builder |
|
addMessageItems(MessageItem value)
public RaiFilterResult.Builder addMessageItems(MessageItem value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
MessageItem |
| Returns | |
|---|---|
| Type | Description |
RaiFilterResult.Builder |
|
addMessageItems(MessageItem.Builder builderForValue)
public RaiFilterResult.Builder addMessageItems(MessageItem.Builder builderForValue)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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
MessageItem.Builder |
| Returns | |
|---|---|
| Type | Description |
RaiFilterResult.Builder |
|
addMessageItems(int index, MessageItem value)
public RaiFilterResult.Builder addMessageItems(int index, MessageItem value)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;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
MessageItem |
| Returns | |
|---|---|
| Type | Description |
RaiFilterResult.Builder |
|
addMessageItems(int index, MessageItem.Builder builderForValue)
public RaiFilterResult.Builder addMessageItems(int index, MessageItem.Builder builderForValue)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;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
MessageItem.Builder |
| Returns | |
|---|---|
| Type | Description |
RaiFilterResult.Builder |
|
addMessageItemsBuilder()
public MessageItem.Builder addMessageItemsBuilder()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;
| Returns | |
|---|---|
| Type | Description |
MessageItem.Builder |
|
addMessageItemsBuilder(int index)
public MessageItem.Builder addMessageItemsBuilder(int index)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;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
MessageItem.Builder |
|
build()
public RaiFilterResult build()| Returns | |
|---|---|
| Type | Description |
RaiFilterResult |
|
buildPartial()
public RaiFilterResult buildPartial()| Returns | |
|---|---|
| Type | Description |
RaiFilterResult |
|
clear()
public RaiFilterResult.Builder clear()| Returns | |
|---|---|
| Type | Description |
RaiFilterResult.Builder |
|
clearExecutionState()
public RaiFilterResult.Builder clearExecutionState()Output only. Reports whether the RAI filter was successfully executed or not.
.google.cloud.modelarmor.v1.FilterExecutionState execution_state = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
RaiFilterResult.Builder |
This builder for chaining. |
clearMatchState()
public RaiFilterResult.Builder clearMatchState()Output only. Overall filter match state for RAI. Value is MATCH_FOUND if at least one RAI filter confidence level is equal to or higher than the confidence level defined in configuration.
.google.cloud.modelarmor.v1.FilterMatchState match_state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
RaiFilterResult.Builder |
This builder for chaining. |
clearMessageItems()
public RaiFilterResult.Builder clearMessageItems()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;
| Returns | |
|---|---|
| Type | Description |
RaiFilterResult.Builder |
|
clearRaiFilterTypeResults()
public RaiFilterResult.Builder clearRaiFilterTypeResults()| Returns | |
|---|---|
| Type | Description |
RaiFilterResult.Builder |
|
containsRaiFilterTypeResults(String key)
public boolean containsRaiFilterTypeResults(String key)The map of RAI filter results where key is RAI filter type - either of "sexually_explicit", "hate_speech", "harassment", "dangerous".
map<string, .google.cloud.modelarmor.v1.RaiFilterResult.RaiFilterTypeResult> rai_filter_type_results = 4;
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getDefaultInstanceForType()
public RaiFilterResult getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
RaiFilterResult |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getExecutionState()
public FilterExecutionState getExecutionState()Output only. Reports whether the RAI filter 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 the RAI filter 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. |
getMatchState()
public FilterMatchState getMatchState()Output only. Overall filter match state for RAI. Value is MATCH_FOUND if at least one RAI filter confidence level is equal to or higher than the confidence level defined in configuration.
.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. Overall filter match state for RAI. Value is MATCH_FOUND if at least one RAI filter confidence level is equal to or higher than the confidence level defined in configuration.
.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)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;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
MessageItem |
|
getMessageItemsBuilder(int index)
public MessageItem.Builder getMessageItemsBuilder(int index)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;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
MessageItem.Builder |
|
getMessageItemsBuilderList()
public List<MessageItem.Builder> getMessageItemsBuilderList()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;
| Returns | |
|---|---|
| Type | Description |
List<Builder> |
|
getMessageItemsCount()
public int getMessageItemsCount()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;
| Returns | |
|---|---|
| Type | Description |
int |
|
getMessageItemsList()
public List<MessageItem> getMessageItemsList()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;
| Returns | |
|---|---|
| Type | Description |
List<MessageItem> |
|
getMessageItemsOrBuilder(int index)
public MessageItemOrBuilder getMessageItemsOrBuilder(int index)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;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
MessageItemOrBuilder |
|
getMessageItemsOrBuilderList()
public List<? extends MessageItemOrBuilder> getMessageItemsOrBuilderList()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;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.modelarmor.v1.MessageItemOrBuilder> |
|
getMutableRaiFilterTypeResults() (deprecated)
public Map<String,RaiFilterResult.RaiFilterTypeResult> getMutableRaiFilterTypeResults()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,RaiFilterTypeResult> |
|
getRaiFilterTypeResults() (deprecated)
public Map<String,RaiFilterResult.RaiFilterTypeResult> getRaiFilterTypeResults()Use #getRaiFilterTypeResultsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,RaiFilterTypeResult> |
|
getRaiFilterTypeResultsCount()
public int getRaiFilterTypeResultsCount()The map of RAI filter results where key is RAI filter type - either of "sexually_explicit", "hate_speech", "harassment", "dangerous".
map<string, .google.cloud.modelarmor.v1.RaiFilterResult.RaiFilterTypeResult> rai_filter_type_results = 4;
| Returns | |
|---|---|
| Type | Description |
int |
|
getRaiFilterTypeResultsMap()
public Map<String,RaiFilterResult.RaiFilterTypeResult> getRaiFilterTypeResultsMap()The map of RAI filter results where key is RAI filter type - either of "sexually_explicit", "hate_speech", "harassment", "dangerous".
map<string, .google.cloud.modelarmor.v1.RaiFilterResult.RaiFilterTypeResult> rai_filter_type_results = 4;
| Returns | |
|---|---|
| Type | Description |
Map<String,RaiFilterTypeResult> |
|
getRaiFilterTypeResultsOrDefault(String key, RaiFilterResult.RaiFilterTypeResult defaultValue)
public RaiFilterResult.RaiFilterTypeResult getRaiFilterTypeResultsOrDefault(String key, RaiFilterResult.RaiFilterTypeResult defaultValue)The map of RAI filter results where key is RAI filter type - either of "sexually_explicit", "hate_speech", "harassment", "dangerous".
map<string, .google.cloud.modelarmor.v1.RaiFilterResult.RaiFilterTypeResult> rai_filter_type_results = 4;
| Parameters | |
|---|---|
| Name | Description |
key |
String |
defaultValue |
RaiFilterResult.RaiFilterTypeResult |
| Returns | |
|---|---|
| Type | Description |
RaiFilterResult.RaiFilterTypeResult |
|
getRaiFilterTypeResultsOrThrow(String key)
public RaiFilterResult.RaiFilterTypeResult getRaiFilterTypeResultsOrThrow(String key)The map of RAI filter results where key is RAI filter type - either of "sexually_explicit", "hate_speech", "harassment", "dangerous".
map<string, .google.cloud.modelarmor.v1.RaiFilterResult.RaiFilterTypeResult> rai_filter_type_results = 4;
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
RaiFilterResult.RaiFilterTypeResult |
|
internalGetFieldAccessorTable()
protected GeneratedMessage.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(RaiFilterResult other)
public RaiFilterResult.Builder mergeFrom(RaiFilterResult other)| Parameter | |
|---|---|
| Name | Description |
other |
RaiFilterResult |
| Returns | |
|---|---|
| Type | Description |
RaiFilterResult.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public RaiFilterResult.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
RaiFilterResult.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public RaiFilterResult.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
RaiFilterResult.Builder |
|
putAllRaiFilterTypeResults(Map<String,RaiFilterResult.RaiFilterTypeResult> values)
public RaiFilterResult.Builder putAllRaiFilterTypeResults(Map<String,RaiFilterResult.RaiFilterTypeResult> values)The map of RAI filter results where key is RAI filter type - either of "sexually_explicit", "hate_speech", "harassment", "dangerous".
map<string, .google.cloud.modelarmor.v1.RaiFilterResult.RaiFilterTypeResult> rai_filter_type_results = 4;
| Parameter | |
|---|---|
| Name | Description |
values |
Map<String,RaiFilterTypeResult> |
| Returns | |
|---|---|
| Type | Description |
RaiFilterResult.Builder |
|
putRaiFilterTypeResults(String key, RaiFilterResult.RaiFilterTypeResult value)
public RaiFilterResult.Builder putRaiFilterTypeResults(String key, RaiFilterResult.RaiFilterTypeResult value)The map of RAI filter results where key is RAI filter type - either of "sexually_explicit", "hate_speech", "harassment", "dangerous".
map<string, .google.cloud.modelarmor.v1.RaiFilterResult.RaiFilterTypeResult> rai_filter_type_results = 4;
| Parameters | |
|---|---|
| Name | Description |
key |
String |
value |
RaiFilterResult.RaiFilterTypeResult |
| Returns | |
|---|---|
| Type | Description |
RaiFilterResult.Builder |
|
putRaiFilterTypeResultsBuilderIfAbsent(String key)
public RaiFilterResult.RaiFilterTypeResult.Builder putRaiFilterTypeResultsBuilderIfAbsent(String key)The map of RAI filter results where key is RAI filter type - either of "sexually_explicit", "hate_speech", "harassment", "dangerous".
map<string, .google.cloud.modelarmor.v1.RaiFilterResult.RaiFilterTypeResult> rai_filter_type_results = 4;
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
RaiFilterResult.RaiFilterTypeResult.Builder |
|
removeMessageItems(int index)
public RaiFilterResult.Builder removeMessageItems(int index)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;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
RaiFilterResult.Builder |
|
removeRaiFilterTypeResults(String key)
public RaiFilterResult.Builder removeRaiFilterTypeResults(String key)The map of RAI filter results where key is RAI filter type - either of "sexually_explicit", "hate_speech", "harassment", "dangerous".
map<string, .google.cloud.modelarmor.v1.RaiFilterResult.RaiFilterTypeResult> rai_filter_type_results = 4;
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
RaiFilterResult.Builder |
|
setExecutionState(FilterExecutionState value)
public RaiFilterResult.Builder setExecutionState(FilterExecutionState value)Output only. Reports whether the RAI filter was successfully executed or not.
.google.cloud.modelarmor.v1.FilterExecutionState execution_state = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
FilterExecutionStateThe executionState to set. |
| Returns | |
|---|---|
| Type | Description |
RaiFilterResult.Builder |
This builder for chaining. |
setExecutionStateValue(int value)
public RaiFilterResult.Builder setExecutionStateValue(int value)Output only. Reports whether the RAI filter was successfully executed or not.
.google.cloud.modelarmor.v1.FilterExecutionState execution_state = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for executionState to set. |
| Returns | |
|---|---|
| Type | Description |
RaiFilterResult.Builder |
This builder for chaining. |
setMatchState(FilterMatchState value)
public RaiFilterResult.Builder setMatchState(FilterMatchState value)Output only. Overall filter match state for RAI. Value is MATCH_FOUND if at least one RAI filter confidence level is equal to or higher than the confidence level defined in configuration.
.google.cloud.modelarmor.v1.FilterMatchState match_state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
FilterMatchStateThe matchState to set. |
| Returns | |
|---|---|
| Type | Description |
RaiFilterResult.Builder |
This builder for chaining. |
setMatchStateValue(int value)
public RaiFilterResult.Builder setMatchStateValue(int value)Output only. Overall filter match state for RAI. Value is MATCH_FOUND if at least one RAI filter confidence level is equal to or higher than the confidence level defined in configuration.
.google.cloud.modelarmor.v1.FilterMatchState match_state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for matchState to set. |
| Returns | |
|---|---|
| Type | Description |
RaiFilterResult.Builder |
This builder for chaining. |
setMessageItems(int index, MessageItem value)
public RaiFilterResult.Builder setMessageItems(int index, MessageItem value)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;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
MessageItem |
| Returns | |
|---|---|
| Type | Description |
RaiFilterResult.Builder |
|
setMessageItems(int index, MessageItem.Builder builderForValue)
public RaiFilterResult.Builder setMessageItems(int index, MessageItem.Builder builderForValue)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;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
MessageItem.Builder |
| Returns | |
|---|---|
| Type | Description |
RaiFilterResult.Builder |
|