Class SearchEvaluationsRequest.Builder (0.165.0) 

public static final class SearchEvaluationsRequest.Builder extends GeneratedMessageV3.Builder<SearchEvaluationsRequest.Builder> implements SearchEvaluationsRequestOrBuilder

Request message for SearchEvaluation.

Protobuf type google.cloud.datalabeling.v1beta1.SearchEvaluationsRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > SearchEvaluationsRequest.Builder

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SearchEvaluationsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
SearchEvaluationsRequest.Builder
Overrides

build()

public SearchEvaluationsRequest build()
Returns
Type Description
SearchEvaluationsRequest

buildPartial()

public SearchEvaluationsRequest buildPartial()
Returns
Type Description
SearchEvaluationsRequest

clear()

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

clearField(Descriptors.FieldDescriptor field)

public SearchEvaluationsRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
SearchEvaluationsRequest.Builder
Overrides

clearFilter()

public SearchEvaluationsRequest.Builder clearFilter()

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
SearchEvaluationsRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public SearchEvaluationsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
SearchEvaluationsRequest.Builder
Overrides

clearPageSize()

public SearchEvaluationsRequest.Builder clearPageSize()

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
SearchEvaluationsRequest.Builder

This builder for chaining.

clearPageToken()

public SearchEvaluationsRequest.Builder clearPageToken()

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
SearchEvaluationsRequest.Builder

This builder for chaining.

clearParent()

public SearchEvaluationsRequest.Builder clearParent()

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
SearchEvaluationsRequest.Builder

This builder for chaining.

clone()

public SearchEvaluationsRequest.Builder clone()
Returns
Type Description
SearchEvaluationsRequest.Builder
Overrides

getDefaultInstanceForType()

public SearchEvaluationsRequest getDefaultInstanceForType()
Returns
Type Description
SearchEvaluationsRequest

getDescriptorForType()

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

getFilter()

public 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
String

The filter.

getFilterBytes()

public 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
ByteString

The bytes for filter.

getPageSize()

public 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
int

The pageSize.

getPageToken()

public 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
String

The pageToken.

getPageTokenBytes()

public 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
ByteString

The bytes for pageToken.

getParent()

public 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
String

The parent.

getParentBytes()

public 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
ByteString

The bytes for parent.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(SearchEvaluationsRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SearchEvaluationsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
SearchEvaluationsRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public SearchEvaluationsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
SearchEvaluationsRequest.Builder
Overrides

setFilter(String value)

public SearchEvaluationsRequest.Builder setFilter(String value)

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];

Parameter
Name Description
value String

The filter to set.
Returns
Type Description
SearchEvaluationsRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public SearchEvaluationsRequest.Builder setFilterBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for filter to set.
Returns
Type Description
SearchEvaluationsRequest.Builder

This builder for chaining.

setPageSize(int value)

public SearchEvaluationsRequest.Builder setPageSize(int value)

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

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

Parameter
Name Description
value int

The pageSize to set.
Returns
Type Description
SearchEvaluationsRequest.Builder

This builder for chaining.

setPageToken(String value)

public SearchEvaluationsRequest.Builder setPageToken(String value)

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];

Parameter
Name Description
value String

The pageToken to set.
Returns
Type Description
SearchEvaluationsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public SearchEvaluationsRequest.Builder setPageTokenBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for pageToken to set.
Returns
Type Description
SearchEvaluationsRequest.Builder

This builder for chaining.

setParent(String value)

public SearchEvaluationsRequest.Builder setParent(String value)

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

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

Parameter
Name Description
value String

The parent to set.
Returns
Type Description
SearchEvaluationsRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public SearchEvaluationsRequest.Builder setParentBytes(ByteString value)

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

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
SearchEvaluationsRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public SearchEvaluationsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
SearchEvaluationsRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final SearchEvaluationsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
SearchEvaluationsRequest.Builder
Overrides