Class DataLabelingServiceGrpc.DataLabelingServiceFutureStub (0.141.0)

public static final class DataLabelingServiceGrpc.DataLabelingServiceFutureStub extends AbstractFutureStub<DataLabelingServiceGrpc.DataLabelingServiceFutureStub>

A stub to allow clients to do ListenableFuture-style rpc calls to service DataLabelingService.

Service for the AI Platform Data Labeling API.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractFutureStub > DataLabelingServiceGrpc.DataLabelingServiceFutureStub

Methods

build(Channel channel, CallOptions callOptions)

protected DataLabelingServiceGrpc.DataLabelingServiceFutureStub build(Channel channel, CallOptions callOptions)
Parameters
NameDescription
channelio.grpc.Channel
callOptionsio.grpc.CallOptions
Returns
TypeDescription
DataLabelingServiceGrpc.DataLabelingServiceFutureStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

createAnnotationSpecSet(CreateAnnotationSpecSetRequest request)

public ListenableFuture<AnnotationSpecSet> createAnnotationSpecSet(CreateAnnotationSpecSetRequest request)

Creates an annotation spec set by providing a set of labels.

Parameter
NameDescription
requestCreateAnnotationSpecSetRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<AnnotationSpecSet>

createDataset(CreateDatasetRequest request)

public ListenableFuture<Dataset> createDataset(CreateDatasetRequest request)

Creates dataset. If success return a Dataset resource.

Parameter
NameDescription
requestCreateDatasetRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Dataset>

createEvaluationJob(CreateEvaluationJobRequest request)

public ListenableFuture<EvaluationJob> createEvaluationJob(CreateEvaluationJobRequest request)

Creates an evaluation job.

Parameter
NameDescription
requestCreateEvaluationJobRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<EvaluationJob>

createInstruction(CreateInstructionRequest request)

public ListenableFuture<Operation> createInstruction(CreateInstructionRequest request)

Creates an instruction for how data should be labeled.

Parameter
NameDescription
requestCreateInstructionRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Operation>

deleteAnnotatedDataset(DeleteAnnotatedDatasetRequest request)

public ListenableFuture<Empty> deleteAnnotatedDataset(DeleteAnnotatedDatasetRequest request)

Deletes an annotated dataset by resource name.

Parameter
NameDescription
requestDeleteAnnotatedDatasetRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Empty>

deleteAnnotationSpecSet(DeleteAnnotationSpecSetRequest request)

public ListenableFuture<Empty> deleteAnnotationSpecSet(DeleteAnnotationSpecSetRequest request)

Deletes an annotation spec set by resource name.

Parameter
NameDescription
requestDeleteAnnotationSpecSetRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Empty>

deleteDataset(DeleteDatasetRequest request)

public ListenableFuture<Empty> deleteDataset(DeleteDatasetRequest request)

Deletes a dataset by resource name.

Parameter
NameDescription
requestDeleteDatasetRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Empty>

deleteEvaluationJob(DeleteEvaluationJobRequest request)

public ListenableFuture<Empty> deleteEvaluationJob(DeleteEvaluationJobRequest request)

Stops and deletes an evaluation job.

Parameter
NameDescription
requestDeleteEvaluationJobRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Empty>

deleteInstruction(DeleteInstructionRequest request)

public ListenableFuture<Empty> deleteInstruction(DeleteInstructionRequest request)

Deletes an instruction object by resource name.

Parameter
NameDescription
requestDeleteInstructionRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Empty>

exportData(ExportDataRequest request)

public ListenableFuture<Operation> exportData(ExportDataRequest request)

Exports data and annotations from dataset.

Parameter
NameDescription
requestExportDataRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Operation>

getAnnotatedDataset(GetAnnotatedDatasetRequest request)

public ListenableFuture<AnnotatedDataset> getAnnotatedDataset(GetAnnotatedDatasetRequest request)

Gets an annotated dataset by resource name.

Parameter
NameDescription
requestGetAnnotatedDatasetRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<AnnotatedDataset>

getAnnotationSpecSet(GetAnnotationSpecSetRequest request)

public ListenableFuture<AnnotationSpecSet> getAnnotationSpecSet(GetAnnotationSpecSetRequest request)

Gets an annotation spec set by resource name.

Parameter
NameDescription
requestGetAnnotationSpecSetRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<AnnotationSpecSet>

getDataItem(GetDataItemRequest request)

public ListenableFuture<DataItem> getDataItem(GetDataItemRequest request)

Gets a data item in a dataset by resource name. This API can be called after data are imported into dataset.

Parameter
NameDescription
requestGetDataItemRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<DataItem>

getDataset(GetDatasetRequest request)

public ListenableFuture<Dataset> getDataset(GetDatasetRequest request)

Gets dataset by resource name.

Parameter
NameDescription
requestGetDatasetRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Dataset>

getEvaluation(GetEvaluationRequest request)

public ListenableFuture<Evaluation> getEvaluation(GetEvaluationRequest request)

Gets an evaluation by resource name (to search, use projects.evaluations.search).

Parameter
NameDescription
requestGetEvaluationRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Evaluation>

getEvaluationJob(GetEvaluationJobRequest request)

public ListenableFuture<EvaluationJob> getEvaluationJob(GetEvaluationJobRequest request)

Gets an evaluation job by resource name.

Parameter
NameDescription
requestGetEvaluationJobRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<EvaluationJob>

getExample(GetExampleRequest request)

public ListenableFuture<Example> getExample(GetExampleRequest request)

Gets an example by resource name, including both data and annotation.

Parameter
NameDescription
requestGetExampleRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Example>

getInstruction(GetInstructionRequest request)

public ListenableFuture<Instruction> getInstruction(GetInstructionRequest request)

Gets an instruction by resource name.

Parameter
NameDescription
requestGetInstructionRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Instruction>

importData(ImportDataRequest request)

public ListenableFuture<Operation> importData(ImportDataRequest request)

Imports data into dataset based on source locations defined in request. It can be called multiple times for the same dataset. Each dataset can only have one long running operation running on it. For example, no labeling task (also long running operation) can be started while importing is still ongoing. Vice versa.

Parameter
NameDescription
requestImportDataRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Operation>

labelImage(LabelImageRequest request)

public ListenableFuture<Operation> labelImage(LabelImageRequest request)

Starts a labeling task for image. The type of image labeling task is configured by feature in the request.

Parameter
NameDescription
requestLabelImageRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Operation>

labelText(LabelTextRequest request)

public ListenableFuture<Operation> labelText(LabelTextRequest request)

Starts a labeling task for text. The type of text labeling task is configured by feature in the request.

Parameter
NameDescription
requestLabelTextRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Operation>

labelVideo(LabelVideoRequest request)

public ListenableFuture<Operation> labelVideo(LabelVideoRequest request)

Starts a labeling task for video. The type of video labeling task is configured by feature in the request.

Parameter
NameDescription
requestLabelVideoRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Operation>

listAnnotatedDatasets(ListAnnotatedDatasetsRequest request)

public ListenableFuture<ListAnnotatedDatasetsResponse> listAnnotatedDatasets(ListAnnotatedDatasetsRequest request)

Lists annotated datasets for a dataset. Pagination is supported.

Parameter
NameDescription
requestListAnnotatedDatasetsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListAnnotatedDatasetsResponse>

listAnnotationSpecSets(ListAnnotationSpecSetsRequest request)

public ListenableFuture<ListAnnotationSpecSetsResponse> listAnnotationSpecSets(ListAnnotationSpecSetsRequest request)

Lists annotation spec sets for a project. Pagination is supported.

Parameter
NameDescription
requestListAnnotationSpecSetsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListAnnotationSpecSetsResponse>

listDataItems(ListDataItemsRequest request)

public ListenableFuture<ListDataItemsResponse> listDataItems(ListDataItemsRequest request)

Lists data items in a dataset. This API can be called after data are imported into dataset. Pagination is supported.

Parameter
NameDescription
requestListDataItemsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListDataItemsResponse>

listDatasets(ListDatasetsRequest request)

public ListenableFuture<ListDatasetsResponse> listDatasets(ListDatasetsRequest request)

Lists datasets under a project. Pagination is supported.

Parameter
NameDescription
requestListDatasetsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListDatasetsResponse>

listEvaluationJobs(ListEvaluationJobsRequest request)

public ListenableFuture<ListEvaluationJobsResponse> listEvaluationJobs(ListEvaluationJobsRequest request)

Lists all evaluation jobs within a project with possible filters. Pagination is supported.

Parameter
NameDescription
requestListEvaluationJobsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListEvaluationJobsResponse>

listExamples(ListExamplesRequest request)

public ListenableFuture<ListExamplesResponse> listExamples(ListExamplesRequest request)

Lists examples in an annotated dataset. Pagination is supported.

Parameter
NameDescription
requestListExamplesRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListExamplesResponse>

listInstructions(ListInstructionsRequest request)

public ListenableFuture<ListInstructionsResponse> listInstructions(ListInstructionsRequest request)

Lists instructions for a project. Pagination is supported.

Parameter
NameDescription
requestListInstructionsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListInstructionsResponse>

pauseEvaluationJob(PauseEvaluationJobRequest request)

public ListenableFuture<Empty> pauseEvaluationJob(PauseEvaluationJobRequest request)

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

Parameter
NameDescription
requestPauseEvaluationJobRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Empty>

resumeEvaluationJob(ResumeEvaluationJobRequest request)

public ListenableFuture<Empty> resumeEvaluationJob(ResumeEvaluationJobRequest request)

Resumes a paused evaluation job. A deleted evaluation job can't be resumed. Resuming a running or scheduled evaluation job is a no-op.

Parameter
NameDescription
requestResumeEvaluationJobRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Empty>

searchEvaluations(SearchEvaluationsRequest request)

public ListenableFuture<SearchEvaluationsResponse> searchEvaluations(SearchEvaluationsRequest request)

Searches evaluations within a project.

Parameter
NameDescription
requestSearchEvaluationsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<SearchEvaluationsResponse>

searchExampleComparisons(SearchExampleComparisonsRequest request)

public ListenableFuture<SearchExampleComparisonsResponse> searchExampleComparisons(SearchExampleComparisonsRequest request)

Searches example comparisons from an evaluation. The return format is a list of example comparisons that show ground truth and prediction(s) for a single input. Search by providing an evaluation ID.

Parameter
NameDescription
requestSearchExampleComparisonsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<SearchExampleComparisonsResponse>

updateEvaluationJob(UpdateEvaluationJobRequest request)

public ListenableFuture<EvaluationJob> updateEvaluationJob(UpdateEvaluationJobRequest request)

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.

Parameter
NameDescription
requestUpdateEvaluationJobRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<EvaluationJob>