Class ListEvaluationsRequest.Builder (0.3.0)

public static final class ListEvaluationsRequest.Builder extends GeneratedMessage.Builder<ListEvaluationsRequest.Builder> implements ListEvaluationsRequestOrBuilder

Request message for EvaluationService.ListEvaluations.

Protobuf type google.cloud.ces.v1beta.ListEvaluationsRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

build()

public ListEvaluationsRequest build()
Returns
Type Description
ListEvaluationsRequest

buildPartial()

public ListEvaluationsRequest buildPartial()
Returns
Type Description
ListEvaluationsRequest

clear()

public ListEvaluationsRequest.Builder clear()
Returns
Type Description
ListEvaluationsRequest.Builder
Overrides

clearEvaluationFilter()

public ListEvaluationsRequest.Builder clearEvaluationFilter()

Optional. Filter to be applied on the evaluation when listing the evaluations. See https://google.aip.dev/160 for more details. Supported fields: evaluation_datasets

string evaluation_filter = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ListEvaluationsRequest.Builder

This builder for chaining.

clearEvaluationRunFilter()

public ListEvaluationsRequest.Builder clearEvaluationRunFilter()

Optional. Filter string for fields on the associated EvaluationRun resources. See https://google.aip.dev/160 for more details. Supported fields: create_time, initiated_by, app_version_display_name

string evaluation_run_filter = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ListEvaluationsRequest.Builder

This builder for chaining.

clearFilter() (deprecated)

public ListEvaluationsRequest.Builder clearFilter()

Deprecated. google.cloud.ces.v1beta.ListEvaluationsRequest.filter is deprecated. See google/cloud/ces/v1beta/evaluation_service.proto;l=729

Optional. Deprecated: Use evaluation_filter and evaluation_run_filter instead.

string filter = 4 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ListEvaluationsRequest.Builder

This builder for chaining.

clearLastTenResults()

public ListEvaluationsRequest.Builder clearLastTenResults()

Optional. Whether to include the last 10 evaluation results for each evaluation in the response.

bool last_ten_results = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ListEvaluationsRequest.Builder

This builder for chaining.

clearOrderBy()

public ListEvaluationsRequest.Builder clearOrderBy()

Optional. Field to sort by. Only "name" and "create_time", and "update_time" are supported. Time fields are ordered in descending order, and the name field is ordered in ascending order. If not included, "update_time" will be the default. See https://google.aip.dev/132#ordering for more details.

string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ListEvaluationsRequest.Builder

This builder for chaining.

clearPageSize()

public ListEvaluationsRequest.Builder clearPageSize()

Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

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

Returns
Type Description
ListEvaluationsRequest.Builder

This builder for chaining.

clearPageToken()

public ListEvaluationsRequest.Builder clearPageToken()

Optional. The next_page_token value returned from a previous list EvaluationService.ListEvaluations call.

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

Returns
Type Description
ListEvaluationsRequest.Builder

This builder for chaining.

clearParent()

public ListEvaluationsRequest.Builder clearParent()

Required. The resource name of the app to list evaluations from.

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

Returns
Type Description
ListEvaluationsRequest.Builder

This builder for chaining.

getDefaultInstanceForType()

public ListEvaluationsRequest getDefaultInstanceForType()
Returns
Type Description
ListEvaluationsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getEvaluationFilter()

public String getEvaluationFilter()

Optional. Filter to be applied on the evaluation when listing the evaluations. See https://google.aip.dev/160 for more details. Supported fields: evaluation_datasets

string evaluation_filter = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The evaluationFilter.

getEvaluationFilterBytes()

public ByteString getEvaluationFilterBytes()

Optional. Filter to be applied on the evaluation when listing the evaluations. See https://google.aip.dev/160 for more details. Supported fields: evaluation_datasets

string evaluation_filter = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for evaluationFilter.

getEvaluationRunFilter()

public String getEvaluationRunFilter()

Optional. Filter string for fields on the associated EvaluationRun resources. See https://google.aip.dev/160 for more details. Supported fields: create_time, initiated_by, app_version_display_name

string evaluation_run_filter = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The evaluationRunFilter.

getEvaluationRunFilterBytes()

public ByteString getEvaluationRunFilterBytes()

Optional. Filter string for fields on the associated EvaluationRun resources. See https://google.aip.dev/160 for more details. Supported fields: create_time, initiated_by, app_version_display_name

string evaluation_run_filter = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for evaluationRunFilter.

getFilter() (deprecated)

public String getFilter()

Deprecated. google.cloud.ces.v1beta.ListEvaluationsRequest.filter is deprecated. See google/cloud/ces/v1beta/evaluation_service.proto;l=729

Optional. Deprecated: Use evaluation_filter and evaluation_run_filter instead.

string filter = 4 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The filter.

getFilterBytes() (deprecated)

public ByteString getFilterBytes()

Deprecated. google.cloud.ces.v1beta.ListEvaluationsRequest.filter is deprecated. See google/cloud/ces/v1beta/evaluation_service.proto;l=729

Optional. Deprecated: Use evaluation_filter and evaluation_run_filter instead.

string filter = 4 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for filter.

getLastTenResults()

public boolean getLastTenResults()

Optional. Whether to include the last 10 evaluation results for each evaluation in the response.

bool last_ten_results = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The lastTenResults.

getOrderBy()

public String getOrderBy()

Optional. Field to sort by. Only "name" and "create_time", and "update_time" are supported. Time fields are ordered in descending order, and the name field is ordered in ascending order. If not included, "update_time" will be the default. See https://google.aip.dev/132#ordering for more details.

string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The orderBy.

getOrderByBytes()

public ByteString getOrderByBytes()

Optional. Field to sort by. Only "name" and "create_time", and "update_time" are supported. Time fields are ordered in descending order, and the name field is ordered in ascending order. If not included, "update_time" will be the default. See https://google.aip.dev/132#ordering for more details.

string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for orderBy.

getPageSize()

public int getPageSize()

Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

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

Returns
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

Optional. The next_page_token value returned from a previous list EvaluationService.ListEvaluations call.

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

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

Optional. The next_page_token value returned from a previous list EvaluationService.ListEvaluations call.

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

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public String getParent()

Required. The resource name of the app to list evaluations from.

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

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The resource name of the app to list evaluations from.

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

Returns
Type Description
ByteString

The bytes for parent.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ListEvaluationsRequest other)

public ListEvaluationsRequest.Builder mergeFrom(ListEvaluationsRequest other)
Parameter
Name Description
other ListEvaluationsRequest
Returns
Type Description
ListEvaluationsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListEvaluationsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListEvaluationsRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ListEvaluationsRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ListEvaluationsRequest.Builder
Overrides

setEvaluationFilter(String value)

public ListEvaluationsRequest.Builder setEvaluationFilter(String value)

Optional. Filter to be applied on the evaluation when listing the evaluations. See https://google.aip.dev/160 for more details. Supported fields: evaluation_datasets

string evaluation_filter = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The evaluationFilter to set.

Returns
Type Description
ListEvaluationsRequest.Builder

This builder for chaining.

setEvaluationFilterBytes(ByteString value)

public ListEvaluationsRequest.Builder setEvaluationFilterBytes(ByteString value)

Optional. Filter to be applied on the evaluation when listing the evaluations. See https://google.aip.dev/160 for more details. Supported fields: evaluation_datasets

string evaluation_filter = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for evaluationFilter to set.

Returns
Type Description
ListEvaluationsRequest.Builder

This builder for chaining.

setEvaluationRunFilter(String value)

public ListEvaluationsRequest.Builder setEvaluationRunFilter(String value)

Optional. Filter string for fields on the associated EvaluationRun resources. See https://google.aip.dev/160 for more details. Supported fields: create_time, initiated_by, app_version_display_name

string evaluation_run_filter = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The evaluationRunFilter to set.

Returns
Type Description
ListEvaluationsRequest.Builder

This builder for chaining.

setEvaluationRunFilterBytes(ByteString value)

public ListEvaluationsRequest.Builder setEvaluationRunFilterBytes(ByteString value)

Optional. Filter string for fields on the associated EvaluationRun resources. See https://google.aip.dev/160 for more details. Supported fields: create_time, initiated_by, app_version_display_name

string evaluation_run_filter = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for evaluationRunFilter to set.

Returns
Type Description
ListEvaluationsRequest.Builder

This builder for chaining.

setFilter(String value) (deprecated)

public ListEvaluationsRequest.Builder setFilter(String value)

Deprecated. google.cloud.ces.v1beta.ListEvaluationsRequest.filter is deprecated. See google/cloud/ces/v1beta/evaluation_service.proto;l=729

Optional. Deprecated: Use evaluation_filter and evaluation_run_filter instead.

string filter = 4 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The filter to set.

Returns
Type Description
ListEvaluationsRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value) (deprecated)

public ListEvaluationsRequest.Builder setFilterBytes(ByteString value)

Deprecated. google.cloud.ces.v1beta.ListEvaluationsRequest.filter is deprecated. See google/cloud/ces/v1beta/evaluation_service.proto;l=729

Optional. Deprecated: Use evaluation_filter and evaluation_run_filter instead.

string filter = 4 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for filter to set.

Returns
Type Description
ListEvaluationsRequest.Builder

This builder for chaining.

setLastTenResults(boolean value)

public ListEvaluationsRequest.Builder setLastTenResults(boolean value)

Optional. Whether to include the last 10 evaluation results for each evaluation in the response.

bool last_ten_results = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value boolean

The lastTenResults to set.

Returns
Type Description
ListEvaluationsRequest.Builder

This builder for chaining.

setOrderBy(String value)

public ListEvaluationsRequest.Builder setOrderBy(String value)

Optional. Field to sort by. Only "name" and "create_time", and "update_time" are supported. Time fields are ordered in descending order, and the name field is ordered in ascending order. If not included, "update_time" will be the default. See https://google.aip.dev/132#ordering for more details.

string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The orderBy to set.

Returns
Type Description
ListEvaluationsRequest.Builder

This builder for chaining.

setOrderByBytes(ByteString value)

public ListEvaluationsRequest.Builder setOrderByBytes(ByteString value)

Optional. Field to sort by. Only "name" and "create_time", and "update_time" are supported. Time fields are ordered in descending order, and the name field is ordered in ascending order. If not included, "update_time" will be the default. See https://google.aip.dev/132#ordering for more details.

string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for orderBy to set.

Returns
Type Description
ListEvaluationsRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListEvaluationsRequest.Builder setPageSize(int value)

Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

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

Parameter
Name Description
value int

The pageSize to set.

Returns
Type Description
ListEvaluationsRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListEvaluationsRequest.Builder setPageToken(String value)

Optional. The next_page_token value returned from a previous list EvaluationService.ListEvaluations call.

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

Parameter
Name Description
value String

The pageToken to set.

Returns
Type Description
ListEvaluationsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListEvaluationsRequest.Builder setPageTokenBytes(ByteString value)

Optional. The next_page_token value returned from a previous list EvaluationService.ListEvaluations call.

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

Parameter
Name Description
value ByteString

The bytes for pageToken to set.

Returns
Type Description
ListEvaluationsRequest.Builder

This builder for chaining.

setParent(String value)

public ListEvaluationsRequest.Builder setParent(String value)

Required. The resource name of the app to list evaluations from.

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

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
ListEvaluationsRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListEvaluationsRequest.Builder setParentBytes(ByteString value)

Required. The resource name of the app to list evaluations from.

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

Parameter
Name Description
value ByteString

The bytes for parent to set.

Returns
Type Description
ListEvaluationsRequest.Builder

This builder for chaining.