# Interface RaiFilterResultOrBuilder (0.34.0)

0.34.0 (latest) 0.32.0 0.29.0 0.28.0 0.26.0 0.24.0 0.23.0 0.21.0 0.19.0 0.17.0 0.16.0 0.15.0 0.14.0 0.13.0 0.11.0 0.9.0 0.8.0 0.5.0 0.4.0 0.3.0 0.1.0

    public interface RaiFilterResultOrBuilder extends MessageOrBuilder

## Implements

[MessageOrBuilder](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.MessageOrBuilder.html)

## Methods

### containsRaiFilterTypeResults(String key)

    public abstract 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` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` |   |

### getExecutionState()

    public abstract 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** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-modelarmor/latest/com.google.cloud.modelarmor.v1.FilterExecutionState` | The executionState. |

### getExecutionStateValue()

    public abstract 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** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | The enum numeric value on the wire for executionState. |

### getMatchState()

    public abstract 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** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-modelarmor/latest/com.google.cloud.modelarmor.v1.FilterMatchState` | The matchState. |

### getMatchStateValue()

    public abstract 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** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | The enum numeric value on the wire for matchState. |

### getMessageItems(int index)

    public abstract 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` | `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-modelarmor/latest/com.google.cloud.modelarmor.v1.MessageItem` |   |

### getMessageItemsCount()

    public abstract 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** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` |   |

### getMessageItemsList()

    public abstract 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** |
| `https://docs.oracle.com/javase/8/docs/api/java/util/List.html<https://docs.cloud.google.com/java/docs/reference/google-cloud-modelarmor/latest/com.google.cloud.modelarmor.v1.MessageItem>` |   |

### getMessageItemsOrBuilder(int index)

    public abstract 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` | `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-modelarmor/latest/com.google.cloud.modelarmor.v1.MessageItemOrBuilder` |   |

### getMessageItemsOrBuilderList()

    public abstract 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** |
| `https://docs.oracle.com/javase/8/docs/api/java/util/List.html<? extends com.google.cloud.modelarmor.v1.MessageItemOrBuilder>` |   |

### getRaiFilterTypeResults() (deprecated)

    public abstract Map<String,RaiFilterResult.RaiFilterTypeResult> getRaiFilterTypeResults()

Use [#getRaiFilterTypeResultsMap()](https://docs.cloud.google.com/java/docs/reference/google-cloud-modelarmor/latest/com.google.cloud.modelarmor.v1.RaiFilterResultOrBuilder#com_google_cloud_modelarmor_v1_RaiFilterResultOrBuilder_getRaiFilterTypeResultsMap__) instead.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/util/Map.html<https://docs.oracle.com/javase/8/docs/api/java/lang/String.html,https://docs.cloud.google.com/java/docs/reference/google-cloud-modelarmor/latest/com.google.cloud.modelarmor.v1.RaiFilterResult.RaiFilterTypeResult>` |   |

### getRaiFilterTypeResultsCount()

    public abstract 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** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` |   |

### getRaiFilterTypeResultsMap()

    public abstract 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** |
| `https://docs.oracle.com/javase/8/docs/api/java/util/Map.html<https://docs.oracle.com/javase/8/docs/api/java/lang/String.html,https://docs.cloud.google.com/java/docs/reference/google-cloud-modelarmor/latest/com.google.cloud.modelarmor.v1.RaiFilterResult.RaiFilterTypeResult>` |   |

### getRaiFilterTypeResultsOrDefault(String key, RaiFilterResult.RaiFilterTypeResult defaultValue)

    public abstract 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` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` |
| `defaultValue` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-modelarmor/latest/com.google.cloud.modelarmor.v1.RaiFilterResult.RaiFilterTypeResult` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-modelarmor/latest/com.google.cloud.modelarmor.v1.RaiFilterResult.RaiFilterTypeResult` |   |

### getRaiFilterTypeResultsOrThrow(String key)

    public abstract 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` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-modelarmor/latest/com.google.cloud.modelarmor.v1.RaiFilterResult.RaiFilterTypeResult` |   |