# Interface SearchEvaluationsRequestOrBuilder (0.213.0)

0.213.0 (latest) 0.211.0 0.208.0 0.207.0 0.205.0 0.203.0 0.202.0 0.201.0 0.200.0 0.198.0 0.196.0 0.195.0 0.194.0 0.193.0 0.192.0 0.190.0 0.188.0 0.187.0 0.184.0 0.183.0 0.182.0 0.180.0 0.179.0 0.178.0 0.177.0 0.176.0 0.175.0 0.174.0 0.173.0 0.172.0 0.171.0 0.169.0 0.168.0 0.167.0 0.166.0 0.165.0 0.164.0 0.163.0 0.162.0 0.161.0 0.160.0 0.159.0 0.157.0 0.156.0 0.155.0 0.154.0 0.153.0 0.152.0 0.151.0 0.150.0 0.149.0 0.148.0 0.147.0 0.144.0 0.143.0 0.142.0 0.141.0 0.140.0 0.139.0 0.138.0 0.137.0 0.136.0 0.135.0 0.134.0 0.133.0 0.132.0 0.131.0 0.129.0 0.128.0 0.127.0 0.126.0 0.125.0 0.124.0 0.123.7 0.122.11

    public interface SearchEvaluationsRequestOrBuilder extends MessageOrBuilder

## Implements

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

## Methods

### getFilter()

    public abstract String getFilter()

Optional. To search evaluations, you can filter by the following:

- evaluation\<span\>_\</span\>job.evaluation_job_id (the last part of EvaluationJob.name)
- evaluation\<span\>_\</span\>job.model_id (the \<var\>{model_name}\</var\> portion of EvaluationJob.modelVersion)
- evaluation\<span\>_\</span\>job.evaluation_job_run_time_start (Minimum threshold for the evaluationJobRunTime that created the evaluation)
- evaluation\<span\>_\</span\>job.evaluation_job_run_time_end (Maximum threshold for the evaluationJobRunTime that created the evaluation)
- evaluation\<span\>_\</span\>job.job_state (EvaluationJob.state)
- annotation\<span\>_\</span\>spec.display_name (the Evaluation contains a
  metric for the annotation spec with this
  displayName)

  To filter by multiple critiera, use the `AND` operator or the `OR`
  operator. The following examples shows a string that filters by several
  critiera:

  "evaluation\<span\>*\</span\>job.evaluation_job_id =
  \<var\>{evaluation_job_id}\</var\> AND evaluation\<span\>* \</span\>job.model_id =
  \<var\>{model_name}\</var\> AND
  evaluation\<span\>*\</span\>job.evaluation_job_run_time_start =
  \<var\>{timestamp_1}\</var\> AND
  evaluation\<span\>*\</span\>job.evaluation_job_run_time_end =
  \<var\>{timestamp_2}\</var\> AND annotation\<span\>_\</span\>spec.display_name =
  \<var\>{display_name}\</var\>"

`string filter = 2 [(.google.api.field_behavior) = OPTIONAL];`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | The filter. |

### getFilterBytes()

    public abstract ByteString getFilterBytes()

Optional. To search evaluations, you can filter by the following:

- evaluation\<span\>_\</span\>job.evaluation_job_id (the last part of EvaluationJob.name)
- evaluation\<span\>_\</span\>job.model_id (the \<var\>{model_name}\</var\> portion of EvaluationJob.modelVersion)
- evaluation\<span\>_\</span\>job.evaluation_job_run_time_start (Minimum threshold for the evaluationJobRunTime that created the evaluation)
- evaluation\<span\>_\</span\>job.evaluation_job_run_time_end (Maximum threshold for the evaluationJobRunTime that created the evaluation)
- evaluation\<span\>_\</span\>job.job_state (EvaluationJob.state)
- annotation\<span\>_\</span\>spec.display_name (the Evaluation contains a
  metric for the annotation spec with this
  displayName)

  To filter by multiple critiera, use the `AND` operator or the `OR`
  operator. The following examples shows a string that filters by several
  critiera:

  "evaluation\<span\>*\</span\>job.evaluation_job_id =
  \<var\>{evaluation_job_id}\</var\> AND evaluation\<span\>* \</span\>job.model_id =
  \<var\>{model_name}\</var\> AND
  evaluation\<span\>*\</span\>job.evaluation_job_run_time_start =
  \<var\>{timestamp_1}\</var\> AND
  evaluation\<span\>*\</span\>job.evaluation_job_run_time_end =
  \<var\>{timestamp_2}\</var\> AND annotation\<span\>_\</span\>spec.display_name =
  \<var\>{display_name}\</var\>"

`string filter = 2 [(.google.api.field_behavior) = OPTIONAL];`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | The bytes for filter. |

### getPageSize()

    public abstract int getPageSize()

Optional. Requested page size. Server may return fewer results than
requested. Default value is 100.

`int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];`

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

### getPageToken()

    public abstract String getPageToken()

Optional. A token identifying a page of results for the server to return.
Typically obtained by the
nextPageToken of the response
to a previous search request.

If you don't specify this field, the API call requests the first page of
the search.

`string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | The pageToken. |

### getPageTokenBytes()

    public abstract ByteString getPageTokenBytes()

Optional. A token identifying a page of results for the server to return.
Typically obtained by the
nextPageToken of the response
to a previous search request.

If you don't specify this field, the API call requests the first page of
the search.

`string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | The bytes for pageToken. |

### getParent()

    public abstract String getParent()

Required. Evaluation search parent (project ID). Format:
"projects/\<var\>{project_id}\</var\>"

`
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | The parent. |

### getParentBytes()

    public abstract ByteString getParentBytes()

Required. Evaluation search parent (project ID). Format:
"projects/\<var\>{project_id}\</var\>"

`
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | The bytes for parent. |