public final class SearchEvaluationsRequest extends GeneratedMessageV3 implements SearchEvaluationsRequestOrBuilder
Request message for SearchEvaluation.
Protobuf type google.cloud.datalabeling.v1beta1.SearchEvaluationsRequest
Static Fields
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
Field Value
PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static SearchEvaluationsRequest getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static SearchEvaluationsRequest.Builder newBuilder()
Returns
newBuilder(SearchEvaluationsRequest prototype)
public static SearchEvaluationsRequest.Builder newBuilder(SearchEvaluationsRequest prototype)
Parameter
Returns
public static SearchEvaluationsRequest parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static SearchEvaluationsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static SearchEvaluationsRequest parseFrom(byte[] data)
Parameter
| Name | Description |
data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static SearchEvaluationsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static SearchEvaluationsRequest parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SearchEvaluationsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static SearchEvaluationsRequest parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static SearchEvaluationsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static SearchEvaluationsRequest parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static SearchEvaluationsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static SearchEvaluationsRequest parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static SearchEvaluationsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<SearchEvaluationsRequest> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstanceForType()
public SearchEvaluationsRequest getDefaultInstanceForType()
Returns
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];
| 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];
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];
| 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];
| 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];
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) = { ... }
| 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) = { ... }
getParserForType()
public Parser<SearchEvaluationsRequest> getParserForType()
Returns
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public SearchEvaluationsRequest.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected SearchEvaluationsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public SearchEvaluationsRequest.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
