com.google.cloud.datalabeling.v1beta1

Class DataLabelingServiceGrpc.DataLabelingServiceFutureStub

java.lang.Object

io.grpc.stub.AbstractStub<DataLabelingServiceGrpc.DataLabelingServiceFutureStub>

com.google.cloud.datalabeling.v1beta1.DataLabelingServiceGrpc.DataLabelingServiceFutureStub

Enclosing class:

DataLabelingServiceGrpc

public static final class DataLabelingServiceGrpc.DataLabelingServiceFutureStub
extends io.grpc.stub.AbstractStub<DataLabelingServiceGrpc.DataLabelingServiceFutureStub>

Method Summary

Modifier and Type	Method and Description
protected DataLabelingServiceGrpc.DataLabelingServiceFutureStub	build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
com.google.common.util.concurrent.ListenableFuture<AnnotationSpecSet>	createAnnotationSpecSet(CreateAnnotationSpecSetRequest request) Creates an annotation spec set by providing a set of labels.
com.google.common.util.concurrent.ListenableFuture<Dataset>	createDataset(CreateDatasetRequest request) Creates dataset.
com.google.common.util.concurrent.ListenableFuture<EvaluationJob>	createEvaluationJob(CreateEvaluationJobRequest request) Creates an evaluation job.
com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation>	createInstruction(CreateInstructionRequest request) Creates an instruction for how data should be labeled.
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty>	deleteAnnotatedDataset(DeleteAnnotatedDatasetRequest request) Deletes an annotated dataset by resource name.
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty>	deleteAnnotationSpecSet(DeleteAnnotationSpecSetRequest request) Deletes an annotation spec set by resource name.
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty>	deleteDataset(DeleteDatasetRequest request) Deletes a dataset by resource name.
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty>	deleteEvaluationJob(DeleteEvaluationJobRequest request) Stops and deletes an evaluation job.
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty>	deleteInstruction(DeleteInstructionRequest request) Deletes an instruction object by resource name.
com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation>	exportData(ExportDataRequest request) Exports data and annotations from dataset.
com.google.common.util.concurrent.ListenableFuture<AnnotatedDataset>	getAnnotatedDataset(GetAnnotatedDatasetRequest request) Gets an annotated dataset by resource name.
com.google.common.util.concurrent.ListenableFuture<AnnotationSpecSet>	getAnnotationSpecSet(GetAnnotationSpecSetRequest request) Gets an annotation spec set by resource name.
com.google.common.util.concurrent.ListenableFuture<DataItem>	getDataItem(GetDataItemRequest request) Gets a data item in a dataset by resource name.
com.google.common.util.concurrent.ListenableFuture<Dataset>	getDataset(GetDatasetRequest request) Gets dataset by resource name.
com.google.common.util.concurrent.ListenableFuture<Evaluation>	getEvaluation(GetEvaluationRequest request) Gets an evaluation by resource name.
com.google.common.util.concurrent.ListenableFuture<EvaluationJob>	getEvaluationJob(GetEvaluationJobRequest request) Gets an evaluation job by resource name.
com.google.common.util.concurrent.ListenableFuture<Example>	getExample(GetExampleRequest request) Gets an example by resource name, including both data and annotation.
com.google.common.util.concurrent.ListenableFuture<Instruction>	getInstruction(GetInstructionRequest request) Gets an instruction by resource name.
com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation>	importData(ImportDataRequest request) Imports data into dataset based on source locations defined in request.
com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation>	labelImage(LabelImageRequest request) Starts a labeling task for image.
com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation>	labelText(LabelTextRequest request) Starts a labeling task for text.
com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation>	labelVideo(LabelVideoRequest request) Starts a labeling task for video.
com.google.common.util.concurrent.ListenableFuture<ListAnnotatedDatasetsResponse>	listAnnotatedDatasets(ListAnnotatedDatasetsRequest request) Lists annotated datasets for a dataset.
com.google.common.util.concurrent.ListenableFuture<ListAnnotationSpecSetsResponse>	listAnnotationSpecSets(ListAnnotationSpecSetsRequest request) Lists annotation spec sets for a project.
com.google.common.util.concurrent.ListenableFuture<ListDataItemsResponse>	listDataItems(ListDataItemsRequest request) Lists data items in a dataset.
com.google.common.util.concurrent.ListenableFuture<ListDatasetsResponse>	listDatasets(ListDatasetsRequest request) Lists datasets under a project.
com.google.common.util.concurrent.ListenableFuture<ListEvaluationJobsResponse>	listEvaluationJobs(ListEvaluationJobsRequest request) Lists all evaluation jobs within a project with possible filters.
com.google.common.util.concurrent.ListenableFuture<ListExamplesResponse>	listExamples(ListExamplesRequest request) Lists examples in an annotated dataset.
com.google.common.util.concurrent.ListenableFuture<ListInstructionsResponse>	listInstructions(ListInstructionsRequest request) Lists instructions for a project.
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty>	pauseEvaluationJob(PauseEvaluationJobRequest request) Pauses an evaluation job.
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty>	resumeEvaluationJob(ResumeEvaluationJobRequest request) Resumes a paused evaluation job.
com.google.common.util.concurrent.ListenableFuture<SearchEvaluationsResponse>	searchEvaluations(SearchEvaluationsRequest request) Searchs evaluations within a project.
com.google.common.util.concurrent.ListenableFuture<SearchExampleComparisonsResponse>	searchExampleComparisons(SearchExampleComparisonsRequest request) Searchs example comparisons in evaluation, in format of examples of both ground truth and prediction(s).
com.google.common.util.concurrent.ListenableFuture<EvaluationJob>	updateEvaluationJob(UpdateEvaluationJobRequest request) Updates an evaluation job.

Methods inherited from class io.grpc.stub.AbstractStub

getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, withExecutor, withInterceptors, withMaxInboundMessageSize, withMaxOutboundMessageSize, withOption, withWaitForReady

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

build

protected DataLabelingServiceGrpc.DataLabelingServiceFutureStub build(io.grpc.Channel channel,
                                                                      io.grpc.CallOptions callOptions)

Specified by:

build in class io.grpc.stub.AbstractStub<DataLabelingServiceGrpc.DataLabelingServiceFutureStub>

createDataset

public com.google.common.util.concurrent.ListenableFuture<Dataset> createDataset(CreateDatasetRequest request)

 Creates dataset. If success return a Dataset resource.
 

getDataset

public com.google.common.util.concurrent.ListenableFuture<Dataset> getDataset(GetDatasetRequest request)

 Gets dataset by resource name.
 

listDatasets

public com.google.common.util.concurrent.ListenableFuture<ListDatasetsResponse> listDatasets(ListDatasetsRequest request)

 Lists datasets under a project. Pagination is supported.
 

deleteDataset

public com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> deleteDataset(DeleteDatasetRequest request)

 Deletes a dataset by resource name.
 

importData

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.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.
 

exportData

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> exportData(ExportDataRequest request)

 Exports data and annotations from dataset.
 

getDataItem

public com.google.common.util.concurrent.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.
 

listDataItems

public com.google.common.util.concurrent.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.
 

getAnnotatedDataset

public com.google.common.util.concurrent.ListenableFuture<AnnotatedDataset> getAnnotatedDataset(GetAnnotatedDatasetRequest request)

 Gets an annotated dataset by resource name.
 

listAnnotatedDatasets

public com.google.common.util.concurrent.ListenableFuture<ListAnnotatedDatasetsResponse> listAnnotatedDatasets(ListAnnotatedDatasetsRequest request)

 Lists annotated datasets for a dataset. Pagination is supported.
 

deleteAnnotatedDataset

public com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> deleteAnnotatedDataset(DeleteAnnotatedDatasetRequest request)

 Deletes an annotated dataset by resource name.
 

labelImage

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> labelImage(LabelImageRequest request)

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

labelVideo

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> labelVideo(LabelVideoRequest request)

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

labelText

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> labelText(LabelTextRequest request)

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

getExample

public com.google.common.util.concurrent.ListenableFuture<Example> getExample(GetExampleRequest request)

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

listExamples

public com.google.common.util.concurrent.ListenableFuture<ListExamplesResponse> listExamples(ListExamplesRequest request)

 Lists examples in an annotated dataset. Pagination is supported.
 

createAnnotationSpecSet

public com.google.common.util.concurrent.ListenableFuture<AnnotationSpecSet> createAnnotationSpecSet(CreateAnnotationSpecSetRequest request)

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

getAnnotationSpecSet

public com.google.common.util.concurrent.ListenableFuture<AnnotationSpecSet> getAnnotationSpecSet(GetAnnotationSpecSetRequest request)

 Gets an annotation spec set by resource name.
 

listAnnotationSpecSets

public com.google.common.util.concurrent.ListenableFuture<ListAnnotationSpecSetsResponse> listAnnotationSpecSets(ListAnnotationSpecSetsRequest request)

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

deleteAnnotationSpecSet

public com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> deleteAnnotationSpecSet(DeleteAnnotationSpecSetRequest request)

 Deletes an annotation spec set by resource name.
 

createInstruction

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation> createInstruction(CreateInstructionRequest request)

 Creates an instruction for how data should be labeled.
 

getInstruction

public com.google.common.util.concurrent.ListenableFuture<Instruction> getInstruction(GetInstructionRequest request)

 Gets an instruction by resource name.
 

listInstructions

public com.google.common.util.concurrent.ListenableFuture<ListInstructionsResponse> listInstructions(ListInstructionsRequest request)

 Lists instructions for a project. Pagination is supported.
 

deleteInstruction

public com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> deleteInstruction(DeleteInstructionRequest request)

 Deletes an instruction object by resource name.
 

getEvaluation

public com.google.common.util.concurrent.ListenableFuture<Evaluation> getEvaluation(GetEvaluationRequest request)

 Gets an evaluation by resource name.
 

searchEvaluations

public com.google.common.util.concurrent.ListenableFuture<SearchEvaluationsResponse> searchEvaluations(SearchEvaluationsRequest request)

 Searchs evaluations within a project. Supported filter: evaluation_job,
 evaluation_time.
 

searchExampleComparisons

public com.google.common.util.concurrent.ListenableFuture<SearchExampleComparisonsResponse> searchExampleComparisons(SearchExampleComparisonsRequest request)

 Searchs example comparisons in evaluation, in format of examples
 of both ground truth and prediction(s). It is represented as a search with
 evaluation id.
 

createEvaluationJob

public com.google.common.util.concurrent.ListenableFuture<EvaluationJob> createEvaluationJob(CreateEvaluationJobRequest request)

 Creates an evaluation job.
 

updateEvaluationJob

public com.google.common.util.concurrent.ListenableFuture<EvaluationJob> updateEvaluationJob(UpdateEvaluationJobRequest request)

 Updates an evaluation job.
 

getEvaluationJob

public com.google.common.util.concurrent.ListenableFuture<EvaluationJob> getEvaluationJob(GetEvaluationJobRequest request)

 Gets an evaluation job by resource name.
 

pauseEvaluationJob

public com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> pauseEvaluationJob(PauseEvaluationJobRequest request)

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

resumeEvaluationJob

public com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> resumeEvaluationJob(ResumeEvaluationJobRequest request)

 Resumes a paused evaluation job. Deleted evaluation job can't be resumed.
 Resuming a running evaluation job will be a no-op.
 

deleteEvaluationJob

public com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> deleteEvaluationJob(DeleteEvaluationJobRequest request)

 Stops and deletes an evaluation job.
 

listEvaluationJobs

public com.google.common.util.concurrent.ListenableFuture<ListEvaluationJobsResponse> listEvaluationJobs(ListEvaluationJobsRequest request)

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