Google Cloud Datalabeling V1beta1 Client - Class ListEvaluationJobsRequest (0.5.5)

Version 0.5.5

• 0.5.6 (latest)
• 0.5.5
• 0.4.2
• 0.3.1
• 0.2.0
• 0.1.14

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Reference documentation and code samples for the Google Cloud Datalabeling V1beta1 Client class ListEvaluationJobsRequest.

Request message for ListEvaluationJobs.

Generated from protobuf message google.cloud.datalabeling.v1beta1.ListEvaluationJobsRequest

Namespace

Google \ Cloud \ DataLabeling \ V1beta1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ parent	string Required. Evaluation job resource parent. Format: "projects/{project_id}"
↳ filter	string Optional. You can filter the jobs to list by model_id (also known as model_name, as described in EvaluationJob.modelVersion) or by evaluation job state (as described in EvaluationJob.state). To filter by both criteria, use the AND operator or the OR operator. For example, you can use the following string for your filter: "evaluationjob.model_id = {model_name} AND evaluationjob.state = {evaluation_job_state}"
↳ page_size	int Optional. Requested page size. Server may return fewer results than requested. Default value is 100.
↳ page_token	string Optional. A token identifying a page of results for the server to return. Typically obtained by the nextPageToken in the response to the previous request. The request returns the first page if this is empty.

getParent

Required. Evaluation job resource parent. Format: "projects/{project_id}"

Returns
Type	Description
string

setParent

Required. Evaluation job resource parent. Format: "projects/{project_id}"

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getFilter

Optional. You can filter the jobs to list by model_id (also known as model_name, as described in EvaluationJob.modelVersion) or by evaluation job state (as described in EvaluationJob.state). To filter by both criteria, use the AND operator or the OR operator. For example, you can use the following string for your filter: "evaluationjob.model_id = {model_name} AND evaluationjob.state = {evaluation_job_state}"

Returns
Type	Description
string

setFilter

Optional. You can filter the jobs to list by model_id (also known as model_name, as described in EvaluationJob.modelVersion) or by evaluation job state (as described in EvaluationJob.state). To filter by both criteria, use the AND operator or the OR operator. For example, you can use the following string for your filter: "evaluationjob.model_id = {model_name} AND evaluationjob.state = {evaluation_job_state}"

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getPageSize

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

Returns
Type	Description
int

setPageSize

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

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getPageToken

Optional. A token identifying a page of results for the server to return.

Typically obtained by the nextPageToken in the response to the previous request. The request returns the first page if this is empty.

Returns
Type	Description
string

setPageToken

Optional. A token identifying a page of results for the server to return.

Typically obtained by the nextPageToken in the response to the previous request. The request returns the first page if this is empty.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

static::build

Parameters
Name	Description
parent	string Required. Evaluation job resource parent. Format: "projects/{project_id}" Please see Google\Cloud\DataLabeling\V1beta1\DataLabelingServiceClient::projectName() for help formatting this field.
filter	string Optional. You can filter the jobs to list by model_id (also known as model_name, as described in EvaluationJob.modelVersion) or by evaluation job state (as described in EvaluationJob.state). To filter by both criteria, use the AND operator or the OR operator. For example, you can use the following string for your filter: "evaluationjob.model_id = {model_name} AND evaluationjob.state = {evaluation_job_state}"

Returns
Type	Description
Google\Cloud\DataLabeling\V1beta1\ListEvaluationJobsRequest