class ProjectsEvaluationJobs extends Resource (View source)

The "evaluationJobs" collection of methods.

Typical usage is:

 $datalabelingService = new Google\Service\DataLabeling(...);
 $evaluationJobs = $datalabelingService->projects_evaluationJobs;

Methods

create(string $parent, GoogleCloudDatalabelingV1beta1CreateEvaluationJobRequest $postBody, array $optParams = [])

Creates an evaluation job. (evaluationJobs.create)

delete(string $name, array $optParams = [])

Stops and deletes an evaluation job. (evaluationJobs.delete)

get(string $name, array $optParams = [])

Gets an evaluation job by resource name. (evaluationJobs.get)

listProjectsEvaluationJobs(string $parent, array $optParams = [])

Lists all evaluation jobs within a project with possible filters. Pagination is supported. (evaluationJobs.listProjectsEvaluationJobs)

patch(string $name, GoogleCloudDatalabelingV1beta1EvaluationJob $postBody, array $optParams = [])

Updates an evaluation job. You can only update certain fields of the job's EvaluationJobConfig: humanAnnotationConfig.instruction, exampleCount, and exampleSamplePercentage. If you want to change any other aspect of the evaluation job, you must delete the job and create a new one.

pause(string $name, GoogleCloudDatalabelingV1beta1PauseEvaluationJobRequest $postBody, array $optParams = [])

Pauses an evaluation job. Pausing an evaluation job that is already in a PAUSED state is a no-op. (evaluationJobs.pause)

resume(string $name, GoogleCloudDatalabelingV1beta1ResumeEvaluationJobRequest $postBody, array $optParams = [])

Resumes a paused evaluation job. A deleted evaluation job can't be resumed.

Details

GoogleCloudDatalabelingV1beta1EvaluationJob create(string $parent, GoogleCloudDatalabelingV1beta1CreateEvaluationJobRequest $postBody, array $optParams = [])

Creates an evaluation job. (evaluationJobs.create)

Parameters

string $parent

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

GoogleCloudDatalabelingV1beta1CreateEvaluationJobRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudDatalabelingV1beta1EvaluationJob

Exceptions

Exception

GoogleProtobufEmpty delete(string $name, array $optParams = [])

Stops and deletes an evaluation job. (evaluationJobs.delete)

Parameters

string $name

Required. Name of the evaluation job that is going to be deleted. Format: "projects/{project_id}/evaluationJobs/{evaluation_job_id}"

array $optParams

Optional parameters.

Return Value

GoogleProtobufEmpty

Exceptions

Exception

GoogleCloudDatalabelingV1beta1EvaluationJob get(string $name, array $optParams = [])

Gets an evaluation job by resource name. (evaluationJobs.get)

Parameters

string $name

Required. Name of the evaluation job. Format: "projects/{project_id} /evaluationJobs/{evaluation_job_id}"

array $optParams

Optional parameters.

Return Value

GoogleCloudDatalabelingV1beta1EvaluationJob

Exceptions

Exception

GoogleCloudDatalabelingV1beta1ListEvaluationJobsResponse listProjectsEvaluationJobs(string $parent, array $optParams = [])

Lists all evaluation jobs within a project with possible filters. Pagination is supported. (evaluationJobs.listProjectsEvaluationJobs)

Parameters

string $parent

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

array $optParams

Optional parameters.

Return Value

GoogleCloudDatalabelingV1beta1ListEvaluationJobsResponse

Exceptions

Exception

GoogleCloudDatalabelingV1beta1EvaluationJob patch(string $name, GoogleCloudDatalabelingV1beta1EvaluationJob $postBody, array $optParams = [])

Updates an evaluation job. You can only update certain fields of the job's EvaluationJobConfig: humanAnnotationConfig.instruction, exampleCount, and exampleSamplePercentage. If you want to change any other aspect of the evaluation job, you must delete the job and create a new one.

(evaluationJobs.patch)

Parameters

string $name

Output only. After you create a job, Data Labeling Service assigns a name to the job with the following format: "projects/{project_id}/evaluationJobs/ {evaluation_job_id}"

GoogleCloudDatalabelingV1beta1EvaluationJob $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudDatalabelingV1beta1EvaluationJob

Exceptions

Exception

GoogleProtobufEmpty pause(string $name, GoogleCloudDatalabelingV1beta1PauseEvaluationJobRequest $postBody, array $optParams = [])

Pauses an evaluation job. Pausing an evaluation job that is already in a PAUSED state is a no-op. (evaluationJobs.pause)

Parameters

string $name

Required. Name of the evaluation job that is going to be paused. Format: "projects/{project_id}/evaluationJobs/{evaluation_job_id}"

GoogleCloudDatalabelingV1beta1PauseEvaluationJobRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleProtobufEmpty

Exceptions

Exception

GoogleProtobufEmpty resume(string $name, GoogleCloudDatalabelingV1beta1ResumeEvaluationJobRequest $postBody, array $optParams = [])

Resumes a paused evaluation job. A deleted evaluation job can't be resumed.

Resuming a running or scheduled evaluation job is a no-op. (evaluationJobs.resume)

Parameters

string $name

Required. Name of the evaluation job that is going to be resumed. Format: "projects/{project_id}/evaluationJobs/{evaluation_job_id}"

GoogleCloudDatalabelingV1beta1ResumeEvaluationJobRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleProtobufEmpty

Exceptions

Exception