DataLabelingServiceClient (Google Cloud 0.119.0-alpha API)

java.lang.Object
- com.google.cloud.datalabeling.v1beta1.DataLabelingServiceClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable
```
@Generated(value="by gapic-generator")
 @BetaApi
public class DataLabelingServiceClient
extends Object
implements com.google.api.gax.core.BackgroundResource
```
Service Description:
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
```
 
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedParent = DataLabelingServiceClient.formatProjectName("[PROJECT]");
   Dataset dataset = Dataset.newBuilder().build();
   Dataset response = dataLabelingServiceClient.createDataset(formattedParent, dataset);
 }
 
 
```
Note: close() needs to be called on the dataLabelingServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of DataLabelingServiceSettings to create(). For example:
To customize credentials:
```
 
 DataLabelingServiceSettings dataLabelingServiceSettings =
     DataLabelingServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 DataLabelingServiceClient dataLabelingServiceClient =
     DataLabelingServiceClient.create(dataLabelingServiceSettings);
 
 
```
To customize the endpoint:
```
 
 DataLabelingServiceSettings dataLabelingServiceSettings =
     DataLabelingServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 DataLabelingServiceClient dataLabelingServiceClient =
     DataLabelingServiceClient.create(dataLabelingServiceSettings);
 
 
```

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`DataLabelingServiceClient.ListAnnotatedDatasetsFixedSizeCollection`
`static class`	`DataLabelingServiceClient.ListAnnotatedDatasetsPage`
`static class`	`DataLabelingServiceClient.ListAnnotatedDatasetsPagedResponse`
`static class`	`DataLabelingServiceClient.ListAnnotationSpecSetsFixedSizeCollection`
`static class`	`DataLabelingServiceClient.ListAnnotationSpecSetsPage`
`static class`	`DataLabelingServiceClient.ListAnnotationSpecSetsPagedResponse`
`static class`	`DataLabelingServiceClient.ListDataItemsFixedSizeCollection`
`static class`	`DataLabelingServiceClient.ListDataItemsPage`
`static class`	`DataLabelingServiceClient.ListDataItemsPagedResponse`
`static class`	`DataLabelingServiceClient.ListDatasetsFixedSizeCollection`
`static class`	`DataLabelingServiceClient.ListDatasetsPage`
`static class`	`DataLabelingServiceClient.ListDatasetsPagedResponse`
`static class`	`DataLabelingServiceClient.ListEvaluationJobsFixedSizeCollection`
`static class`	`DataLabelingServiceClient.ListEvaluationJobsPage`
`static class`	`DataLabelingServiceClient.ListEvaluationJobsPagedResponse`
`static class`	`DataLabelingServiceClient.ListExamplesFixedSizeCollection`
`static class`	`DataLabelingServiceClient.ListExamplesPage`
`static class`	`DataLabelingServiceClient.ListExamplesPagedResponse`
`static class`	`DataLabelingServiceClient.ListInstructionsFixedSizeCollection`
`static class`	`DataLabelingServiceClient.ListInstructionsPage`
`static class`	`DataLabelingServiceClient.ListInstructionsPagedResponse`
`static class`	`DataLabelingServiceClient.SearchEvaluationsFixedSizeCollection`
`static class`	`DataLabelingServiceClient.SearchEvaluationsPage`
`static class`	`DataLabelingServiceClient.SearchEvaluationsPagedResponse`
`static class`	`DataLabelingServiceClient.SearchExampleComparisonsFixedSizeCollection`
`static class`	`DataLabelingServiceClient.SearchExampleComparisonsPage`
`static class`	`DataLabelingServiceClient.SearchExampleComparisonsPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`DataLabelingServiceClient(DataLabelingServiceSettings settings)` Constructs an instance of DataLabelingServiceClient, using the given settings.
`protected`	`DataLabelingServiceClient(DataLabelingServiceStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`void`	`close()`
`static DataLabelingServiceClient`	`create()` Constructs an instance of DataLabelingServiceClient with default settings.
`static DataLabelingServiceClient`	`create(DataLabelingServiceSettings settings)` Constructs an instance of DataLabelingServiceClient, using the given settings.
`static DataLabelingServiceClient`	`create(DataLabelingServiceStub stub)` Constructs an instance of DataLabelingServiceClient, using the given stub for making calls.
`AnnotationSpecSet`	`createAnnotationSpecSet(CreateAnnotationSpecSetRequest request)` Creates an annotation spec set by providing a set of labels.
`AnnotationSpecSet`	`createAnnotationSpecSet(String parent, AnnotationSpecSet annotationSpecSet)` Creates an annotation spec set by providing a set of labels.
`com.google.api.gax.rpc.UnaryCallable<CreateAnnotationSpecSetRequest,AnnotationSpecSet>`	`createAnnotationSpecSetCallable()` Creates an annotation spec set by providing a set of labels.
`Dataset`	`createDataset(CreateDatasetRequest request)` Creates dataset.
`Dataset`	`createDataset(String parent, Dataset dataset)` Creates dataset.
`com.google.api.gax.rpc.UnaryCallable<CreateDatasetRequest,Dataset>`	`createDatasetCallable()` Creates dataset.
`EvaluationJob`	`createEvaluationJob(CreateEvaluationJobRequest request)` Creates an evaluation job.
`EvaluationJob`	`createEvaluationJob(String parent, EvaluationJob job)` Creates an evaluation job.
`com.google.api.gax.rpc.UnaryCallable<CreateEvaluationJobRequest,EvaluationJob>`	`createEvaluationJobCallable()` Creates an evaluation job.
`com.google.api.gax.longrunning.OperationFuture<Instruction,CreateInstructionMetadata>`	`createInstructionAsync(CreateInstructionRequest request)` Creates an instruction for how data should be labeled.
`com.google.api.gax.longrunning.OperationFuture<Instruction,CreateInstructionMetadata>`	`createInstructionAsync(String parent, Instruction instruction)` Creates an instruction for how data should be labeled.
`com.google.api.gax.rpc.UnaryCallable<CreateInstructionRequest,com.google.longrunning.Operation>`	`createInstructionCallable()` Creates an instruction for how data should be labeled.
`com.google.api.gax.rpc.OperationCallable<CreateInstructionRequest,Instruction,CreateInstructionMetadata>`	`createInstructionOperationCallable()` Creates an instruction for how data should be labeled.
`void`	`deleteAnnotatedDataset(DeleteAnnotatedDatasetRequest request)` Deletes an annotated dataset by resource name.
`com.google.api.gax.rpc.UnaryCallable<DeleteAnnotatedDatasetRequest,Empty>`	`deleteAnnotatedDatasetCallable()` Deletes an annotated dataset by resource name.
`void`	`deleteAnnotationSpecSet(DeleteAnnotationSpecSetRequest request)` Deletes an annotation spec set by resource name.
`void`	`deleteAnnotationSpecSet(String name)` Deletes an annotation spec set by resource name.
`com.google.api.gax.rpc.UnaryCallable<DeleteAnnotationSpecSetRequest,Empty>`	`deleteAnnotationSpecSetCallable()` Deletes an annotation spec set by resource name.
`void`	`deleteDataset(DeleteDatasetRequest request)` Deletes a dataset by resource name.
`void`	`deleteDataset(String name)` Deletes a dataset by resource name.
`com.google.api.gax.rpc.UnaryCallable<DeleteDatasetRequest,Empty>`	`deleteDatasetCallable()` Deletes a dataset by resource name.
`void`	`deleteEvaluationJob(DeleteEvaluationJobRequest request)` Stops and deletes an evaluation job.
`void`	`deleteEvaluationJob(String name)` Stops and deletes an evaluation job.
`com.google.api.gax.rpc.UnaryCallable<DeleteEvaluationJobRequest,Empty>`	`deleteEvaluationJobCallable()` Stops and deletes an evaluation job.
`void`	`deleteInstruction(DeleteInstructionRequest request)` Deletes an instruction object by resource name.
`void`	`deleteInstruction(String name)` Deletes an instruction object by resource name.
`com.google.api.gax.rpc.UnaryCallable<DeleteInstructionRequest,Empty>`	`deleteInstructionCallable()` Deletes an instruction object by resource name.
`com.google.api.gax.longrunning.OperationFuture<ExportDataOperationResponse,ExportDataOperationMetadata>`	`exportDataAsync(ExportDataRequest request)` Exports data and annotations from dataset.
`com.google.api.gax.longrunning.OperationFuture<ExportDataOperationResponse,ExportDataOperationMetadata>`	`exportDataAsync(String name, String annotatedDataset, String filter, OutputConfig outputConfig)` Exports data and annotations from dataset.
`com.google.api.gax.rpc.UnaryCallable<ExportDataRequest,com.google.longrunning.Operation>`	`exportDataCallable()` Exports data and annotations from dataset.
`com.google.api.gax.rpc.OperationCallable<ExportDataRequest,ExportDataOperationResponse,ExportDataOperationMetadata>`	`exportDataOperationCallable()` Exports data and annotations from dataset.
`static String`	`formatAnnotatedDatasetName(String project, String dataset, String annotatedDataset)` Deprecated. Use the `AnnotatedDatasetName` class instead.
`static String`	`formatAnnotationSpecSetName(String project, String annotationSpecSet)` Deprecated. Use the `AnnotationSpecSetName` class instead.
`static String`	`formatDataItemName(String project, String dataset, String dataItem)` Deprecated. Use the `DataItemName` class instead.
`static String`	`formatDatasetName(String project, String dataset)` Deprecated. Use the `DatasetName` class instead.
`static String`	`formatEvaluationJobName(String project, String evaluationJob)` Deprecated. Use the `EvaluationJobName` class instead.
`static String`	`formatEvaluationName(String project, String dataset, String evaluation)` Deprecated. Use the `EvaluationName` class instead.
`static String`	`formatExampleName(String project, String dataset, String annotatedDataset, String example)` Deprecated. Use the `ExampleName` class instead.
`static String`	`formatInstructionName(String project, String instruction)` Deprecated. Use the `InstructionName` class instead.
`static String`	`formatProjectName(String project)` Deprecated. Use the `ProjectName` class instead.
`AnnotatedDataset`	`getAnnotatedDataset(GetAnnotatedDatasetRequest request)` Gets an annotated dataset by resource name.
`AnnotatedDataset`	`getAnnotatedDataset(String name)` Gets an annotated dataset by resource name.
`com.google.api.gax.rpc.UnaryCallable<GetAnnotatedDatasetRequest,AnnotatedDataset>`	`getAnnotatedDatasetCallable()` Gets an annotated dataset by resource name.
`AnnotationSpecSet`	`getAnnotationSpecSet(GetAnnotationSpecSetRequest request)` Gets an annotation spec set by resource name.
`AnnotationSpecSet`	`getAnnotationSpecSet(String name)` Gets an annotation spec set by resource name.
`com.google.api.gax.rpc.UnaryCallable<GetAnnotationSpecSetRequest,AnnotationSpecSet>`	`getAnnotationSpecSetCallable()` Gets an annotation spec set by resource name.
`DataItem`	`getDataItem(GetDataItemRequest request)` Gets a data item in a dataset by resource name.
`DataItem`	`getDataItem(String name)` Gets a data item in a dataset by resource name.
`com.google.api.gax.rpc.UnaryCallable<GetDataItemRequest,DataItem>`	`getDataItemCallable()` Gets a data item in a dataset by resource name.
`Dataset`	`getDataset(GetDatasetRequest request)` Gets dataset by resource name.
`Dataset`	`getDataset(String name)` Gets dataset by resource name.
`com.google.api.gax.rpc.UnaryCallable<GetDatasetRequest,Dataset>`	`getDatasetCallable()` Gets dataset by resource name.
`Evaluation`	`getEvaluation(GetEvaluationRequest request)` Gets an evaluation by resource name.
`Evaluation`	`getEvaluation(String name)` Gets an evaluation by resource name.
`com.google.api.gax.rpc.UnaryCallable<GetEvaluationRequest,Evaluation>`	`getEvaluationCallable()` Gets an evaluation by resource name.
`EvaluationJob`	`getEvaluationJob(GetEvaluationJobRequest request)` Gets an evaluation job by resource name.
`EvaluationJob`	`getEvaluationJob(String name)` Gets an evaluation job by resource name.
`com.google.api.gax.rpc.UnaryCallable<GetEvaluationJobRequest,EvaluationJob>`	`getEvaluationJobCallable()` Gets an evaluation job by resource name.
`Example`	`getExample(GetExampleRequest request)` Gets an example by resource name, including both data and annotation.
`Example`	`getExample(String name, String filter)` Gets an example by resource name, including both data and annotation.
`com.google.api.gax.rpc.UnaryCallable<GetExampleRequest,Example>`	`getExampleCallable()` Gets an example by resource name, including both data and annotation.
`Instruction`	`getInstruction(GetInstructionRequest request)` Gets an instruction by resource name.
`Instruction`	`getInstruction(String name)` Gets an instruction by resource name.
`com.google.api.gax.rpc.UnaryCallable<GetInstructionRequest,Instruction>`	`getInstructionCallable()` Gets an instruction by resource name.
`com.google.longrunning.OperationsClient`	`getOperationsClient()` Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
`DataLabelingServiceSettings`	`getSettings()`
`DataLabelingServiceStub`	`getStub()`
`com.google.api.gax.longrunning.OperationFuture<ImportDataOperationResponse,ImportDataOperationMetadata>`	`importDataAsync(ImportDataRequest request)` Imports data into dataset based on source locations defined in request.
`com.google.api.gax.longrunning.OperationFuture<ImportDataOperationResponse,ImportDataOperationMetadata>`	`importDataAsync(String name, InputConfig inputConfig)` Imports data into dataset based on source locations defined in request.
`com.google.api.gax.rpc.UnaryCallable<ImportDataRequest,com.google.longrunning.Operation>`	`importDataCallable()` Imports data into dataset based on source locations defined in request.
`com.google.api.gax.rpc.OperationCallable<ImportDataRequest,ImportDataOperationResponse,ImportDataOperationMetadata>`	`importDataOperationCallable()` Imports data into dataset based on source locations defined in request.
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`com.google.api.gax.longrunning.OperationFuture<AnnotatedDataset,LabelOperationMetadata>`	`labelImageAsync(LabelImageRequest request)` Starts a labeling task for image.
`com.google.api.gax.longrunning.OperationFuture<AnnotatedDataset,LabelOperationMetadata>`	`labelImageAsync(String parent, HumanAnnotationConfig basicConfig, LabelImageRequest.Feature feature)` Starts a labeling task for image.
`com.google.api.gax.rpc.UnaryCallable<LabelImageRequest,com.google.longrunning.Operation>`	`labelImageCallable()` Starts a labeling task for image.
`com.google.api.gax.rpc.OperationCallable<LabelImageRequest,AnnotatedDataset,LabelOperationMetadata>`	`labelImageOperationCallable()` Starts a labeling task for image.
`com.google.api.gax.longrunning.OperationFuture<AnnotatedDataset,LabelOperationMetadata>`	`labelTextAsync(LabelTextRequest request)` Starts a labeling task for text.
`com.google.api.gax.longrunning.OperationFuture<AnnotatedDataset,LabelOperationMetadata>`	`labelTextAsync(String parent, HumanAnnotationConfig basicConfig, LabelTextRequest.Feature feature)` Starts a labeling task for text.
`com.google.api.gax.rpc.UnaryCallable<LabelTextRequest,com.google.longrunning.Operation>`	`labelTextCallable()` Starts a labeling task for text.
`com.google.api.gax.rpc.OperationCallable<LabelTextRequest,AnnotatedDataset,LabelOperationMetadata>`	`labelTextOperationCallable()` Starts a labeling task for text.
`com.google.api.gax.longrunning.OperationFuture<AnnotatedDataset,LabelOperationMetadata>`	`labelVideoAsync(LabelVideoRequest request)` Starts a labeling task for video.
`com.google.api.gax.longrunning.OperationFuture<AnnotatedDataset,LabelOperationMetadata>`	`labelVideoAsync(String parent, HumanAnnotationConfig basicConfig, LabelVideoRequest.Feature feature)` Starts a labeling task for video.
`com.google.api.gax.rpc.UnaryCallable<LabelVideoRequest,com.google.longrunning.Operation>`	`labelVideoCallable()` Starts a labeling task for video.
`com.google.api.gax.rpc.OperationCallable<LabelVideoRequest,AnnotatedDataset,LabelOperationMetadata>`	`labelVideoOperationCallable()` Starts a labeling task for video.
`DataLabelingServiceClient.ListAnnotatedDatasetsPagedResponse`	`listAnnotatedDatasets(ListAnnotatedDatasetsRequest request)` Lists annotated datasets for a dataset.
`DataLabelingServiceClient.ListAnnotatedDatasetsPagedResponse`	`listAnnotatedDatasets(String parent, String filter)` Lists annotated datasets for a dataset.
`com.google.api.gax.rpc.UnaryCallable<ListAnnotatedDatasetsRequest,ListAnnotatedDatasetsResponse>`	`listAnnotatedDatasetsCallable()` Lists annotated datasets for a dataset.
`com.google.api.gax.rpc.UnaryCallable<ListAnnotatedDatasetsRequest,DataLabelingServiceClient.ListAnnotatedDatasetsPagedResponse>`	`listAnnotatedDatasetsPagedCallable()` Lists annotated datasets for a dataset.
`DataLabelingServiceClient.ListAnnotationSpecSetsPagedResponse`	`listAnnotationSpecSets(ListAnnotationSpecSetsRequest request)` Lists annotation spec sets for a project.
`DataLabelingServiceClient.ListAnnotationSpecSetsPagedResponse`	`listAnnotationSpecSets(String parent, String filter)` Lists annotation spec sets for a project.
`com.google.api.gax.rpc.UnaryCallable<ListAnnotationSpecSetsRequest,ListAnnotationSpecSetsResponse>`	`listAnnotationSpecSetsCallable()` Lists annotation spec sets for a project.
`com.google.api.gax.rpc.UnaryCallable<ListAnnotationSpecSetsRequest,DataLabelingServiceClient.ListAnnotationSpecSetsPagedResponse>`	`listAnnotationSpecSetsPagedCallable()` Lists annotation spec sets for a project.
`DataLabelingServiceClient.ListDataItemsPagedResponse`	`listDataItems(ListDataItemsRequest request)` Lists data items in a dataset.
`DataLabelingServiceClient.ListDataItemsPagedResponse`	`listDataItems(String parent, String filter)` Lists data items in a dataset.
`com.google.api.gax.rpc.UnaryCallable<ListDataItemsRequest,ListDataItemsResponse>`	`listDataItemsCallable()` Lists data items in a dataset.
`com.google.api.gax.rpc.UnaryCallable<ListDataItemsRequest,DataLabelingServiceClient.ListDataItemsPagedResponse>`	`listDataItemsPagedCallable()` Lists data items in a dataset.
`DataLabelingServiceClient.ListDatasetsPagedResponse`	`listDatasets(ListDatasetsRequest request)` Lists datasets under a project.
`DataLabelingServiceClient.ListDatasetsPagedResponse`	`listDatasets(String parent, String filter)` Lists datasets under a project.
`com.google.api.gax.rpc.UnaryCallable<ListDatasetsRequest,ListDatasetsResponse>`	`listDatasetsCallable()` Lists datasets under a project.
`com.google.api.gax.rpc.UnaryCallable<ListDatasetsRequest,DataLabelingServiceClient.ListDatasetsPagedResponse>`	`listDatasetsPagedCallable()` Lists datasets under a project.
`DataLabelingServiceClient.ListEvaluationJobsPagedResponse`	`listEvaluationJobs(ListEvaluationJobsRequest request)` Lists all evaluation jobs within a project with possible filters.
`DataLabelingServiceClient.ListEvaluationJobsPagedResponse`	`listEvaluationJobs(String parent, String filter)` Lists all evaluation jobs within a project with possible filters.
`com.google.api.gax.rpc.UnaryCallable<ListEvaluationJobsRequest,ListEvaluationJobsResponse>`	`listEvaluationJobsCallable()` Lists all evaluation jobs within a project with possible filters.
`com.google.api.gax.rpc.UnaryCallable<ListEvaluationJobsRequest,DataLabelingServiceClient.ListEvaluationJobsPagedResponse>`	`listEvaluationJobsPagedCallable()` Lists all evaluation jobs within a project with possible filters.
`DataLabelingServiceClient.ListExamplesPagedResponse`	`listExamples(ListExamplesRequest request)` Lists examples in an annotated dataset.
`DataLabelingServiceClient.ListExamplesPagedResponse`	`listExamples(String parent, String filter)` Lists examples in an annotated dataset.
`com.google.api.gax.rpc.UnaryCallable<ListExamplesRequest,ListExamplesResponse>`	`listExamplesCallable()` Lists examples in an annotated dataset.
`com.google.api.gax.rpc.UnaryCallable<ListExamplesRequest,DataLabelingServiceClient.ListExamplesPagedResponse>`	`listExamplesPagedCallable()` Lists examples in an annotated dataset.
`DataLabelingServiceClient.ListInstructionsPagedResponse`	`listInstructions(ListInstructionsRequest request)` Lists instructions for a project.
`DataLabelingServiceClient.ListInstructionsPagedResponse`	`listInstructions(String parent, String filter)` Lists instructions for a project.
`com.google.api.gax.rpc.UnaryCallable<ListInstructionsRequest,ListInstructionsResponse>`	`listInstructionsCallable()` Lists instructions for a project.
`com.google.api.gax.rpc.UnaryCallable<ListInstructionsRequest,DataLabelingServiceClient.ListInstructionsPagedResponse>`	`listInstructionsPagedCallable()` Lists instructions for a project.
`static String`	`parseAnnotatedDatasetFromAnnotatedDatasetName(String annotatedDatasetName)` Deprecated. Use the `AnnotatedDatasetName` class instead.
`static String`	`parseAnnotatedDatasetFromExampleName(String exampleName)` Deprecated. Use the `ExampleName` class instead.
`static String`	`parseAnnotationSpecSetFromAnnotationSpecSetName(String annotationSpecSetName)` Deprecated. Use the `AnnotationSpecSetName` class instead.
`static String`	`parseDataItemFromDataItemName(String dataItemName)` Deprecated. Use the `DataItemName` class instead.
`static String`	`parseDatasetFromAnnotatedDatasetName(String annotatedDatasetName)` Deprecated. Use the `AnnotatedDatasetName` class instead.
`static String`	`parseDatasetFromDataItemName(String dataItemName)` Deprecated. Use the `DataItemName` class instead.
`static String`	`parseDatasetFromDatasetName(String datasetName)` Deprecated. Use the `DatasetName` class instead.
`static String`	`parseDatasetFromEvaluationName(String evaluationName)` Deprecated. Use the `EvaluationName` class instead.
`static String`	`parseDatasetFromExampleName(String exampleName)` Deprecated. Use the `ExampleName` class instead.
`static String`	`parseEvaluationFromEvaluationName(String evaluationName)` Deprecated. Use the `EvaluationName` class instead.
`static String`	`parseEvaluationJobFromEvaluationJobName(String evaluationJobName)` Deprecated. Use the `EvaluationJobName` class instead.
`static String`	`parseExampleFromExampleName(String exampleName)` Deprecated. Use the `ExampleName` class instead.
`static String`	`parseInstructionFromInstructionName(String instructionName)` Deprecated. Use the `InstructionName` class instead.
`static String`	`parseProjectFromAnnotatedDatasetName(String annotatedDatasetName)` Deprecated. Use the `AnnotatedDatasetName` class instead.
`static String`	`parseProjectFromAnnotationSpecSetName(String annotationSpecSetName)` Deprecated. Use the `AnnotationSpecSetName` class instead.
`static String`	`parseProjectFromDataItemName(String dataItemName)` Deprecated. Use the `DataItemName` class instead.
`static String`	`parseProjectFromDatasetName(String datasetName)` Deprecated. Use the `DatasetName` class instead.
`static String`	`parseProjectFromEvaluationJobName(String evaluationJobName)` Deprecated. Use the `EvaluationJobName` class instead.
`static String`	`parseProjectFromEvaluationName(String evaluationName)` Deprecated. Use the `EvaluationName` class instead.
`static String`	`parseProjectFromExampleName(String exampleName)` Deprecated. Use the `ExampleName` class instead.
`static String`	`parseProjectFromInstructionName(String instructionName)` Deprecated. Use the `InstructionName` class instead.
`static String`	`parseProjectFromProjectName(String projectName)` Deprecated. Use the `ProjectName` class instead.
`void`	`pauseEvaluationJob(PauseEvaluationJobRequest request)` Pauses an evaluation job.
`void`	`pauseEvaluationJob(String name)` Pauses an evaluation job.
`com.google.api.gax.rpc.UnaryCallable<PauseEvaluationJobRequest,Empty>`	`pauseEvaluationJobCallable()` Pauses an evaluation job.
`void`	`resumeEvaluationJob(ResumeEvaluationJobRequest request)` Resumes a paused evaluation job.
`void`	`resumeEvaluationJob(String name)` Resumes a paused evaluation job.
`com.google.api.gax.rpc.UnaryCallable<ResumeEvaluationJobRequest,Empty>`	`resumeEvaluationJobCallable()` Resumes a paused evaluation job.
`DataLabelingServiceClient.SearchEvaluationsPagedResponse`	`searchEvaluations(SearchEvaluationsRequest request)` Searchs evaluations within a project.
`DataLabelingServiceClient.SearchEvaluationsPagedResponse`	`searchEvaluations(String parent, String filter)` Searchs evaluations within a project.
`com.google.api.gax.rpc.UnaryCallable<SearchEvaluationsRequest,SearchEvaluationsResponse>`	`searchEvaluationsCallable()` Searchs evaluations within a project.
`com.google.api.gax.rpc.UnaryCallable<SearchEvaluationsRequest,DataLabelingServiceClient.SearchEvaluationsPagedResponse>`	`searchEvaluationsPagedCallable()` Searchs evaluations within a project.
`DataLabelingServiceClient.SearchExampleComparisonsPagedResponse`	`searchExampleComparisons(SearchExampleComparisonsRequest request)` Searchs example comparisons in evaluation, in format of examples of both ground truth and prediction(s).
`DataLabelingServiceClient.SearchExampleComparisonsPagedResponse`	`searchExampleComparisons(String parent)` Searchs example comparisons in evaluation, in format of examples of both ground truth and prediction(s).
`com.google.api.gax.rpc.UnaryCallable<SearchExampleComparisonsRequest,SearchExampleComparisonsResponse>`	`searchExampleComparisonsCallable()` Searchs example comparisons in evaluation, in format of examples of both ground truth and prediction(s).
`com.google.api.gax.rpc.UnaryCallable<SearchExampleComparisonsRequest,DataLabelingServiceClient.SearchExampleComparisonsPagedResponse>`	`searchExampleComparisonsPagedCallable()` Searchs example comparisons in evaluation, in format of examples of both ground truth and prediction(s).
`void`	`shutdown()`
`void`	`shutdownNow()`
`EvaluationJob`	`updateEvaluationJob(EvaluationJob evaluationJob, FieldMask updateMask)` Updates an evaluation job.
`EvaluationJob`	`updateEvaluationJob(UpdateEvaluationJobRequest request)` Updates an evaluation job.
`com.google.api.gax.rpc.UnaryCallable<UpdateEvaluationJobRequest,EvaluationJob>`	`updateEvaluationJobCallable()` Updates an evaluation job.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DataLabelingServiceClient
```
protected DataLabelingServiceClient(DataLabelingServiceSettings settings)
                             throws IOException
```
Constructs an instance of DataLabelingServiceClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Throws:

IOException

DataLabelingServiceClient

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
protected DataLabelingServiceClient(DataLabelingServiceStub stub)

Method Detail

formatAnnotatedDatasetName

@Deprecated
public static final String formatAnnotatedDatasetName(String project,
                                                                  String dataset,
                                                                  String annotatedDataset)

Deprecated. Use the AnnotatedDatasetName class instead.

Formats a string containing the fully-qualified path to represent a annotated_dataset resource.

formatAnnotationSpecSetName

@Deprecated
public static final String formatAnnotationSpecSetName(String project,
                                                                   String annotationSpecSet)

Deprecated. Use the AnnotationSpecSetName class instead.

Formats a string containing the fully-qualified path to represent a annotation_spec_set resource.

formatDataItemName

@Deprecated
public static final String formatDataItemName(String project,
                                                          String dataset,
                                                          String dataItem)

Deprecated. Use the DataItemName class instead.

Formats a string containing the fully-qualified path to represent a data_item resource.

formatDatasetName

@Deprecated
public static final String formatDatasetName(String project,
                                                         String dataset)

Deprecated. Use the DatasetName class instead.

Formats a string containing the fully-qualified path to represent a dataset resource.

formatEvaluationName

@Deprecated
public static final String formatEvaluationName(String project,
                                                            String dataset,
                                                            String evaluation)

Deprecated. Use the EvaluationName class instead.

Formats a string containing the fully-qualified path to represent a evaluation resource.

formatEvaluationJobName

@Deprecated
public static final String formatEvaluationJobName(String project,
                                                               String evaluationJob)

Deprecated. Use the EvaluationJobName class instead.

Formats a string containing the fully-qualified path to represent a evaluation_job resource.

formatExampleName

@Deprecated
public static final String formatExampleName(String project,
                                                         String dataset,
                                                         String annotatedDataset,
                                                         String example)

Deprecated. Use the ExampleName class instead.

Formats a string containing the fully-qualified path to represent a example resource.

formatInstructionName

@Deprecated
public static final String formatInstructionName(String project,
                                                             String instruction)

Deprecated. Use the InstructionName class instead.

Formats a string containing the fully-qualified path to represent a instruction resource.

formatProjectName
```
@Deprecated
public static final String formatProjectName(String project)
```
Deprecated. Use the ProjectName class instead.

Formats a string containing the fully-qualified path to represent a project resource.

parseProjectFromAnnotatedDatasetName
```
@Deprecated
public static final String parseProjectFromAnnotatedDatasetName(String annotatedDatasetName)
```
Deprecated. Use the AnnotatedDatasetName class instead.

Parses the project from the given fully-qualified path which represents a annotated_dataset resource.

parseDatasetFromAnnotatedDatasetName
```
@Deprecated
public static final String parseDatasetFromAnnotatedDatasetName(String annotatedDatasetName)
```
Deprecated. Use the AnnotatedDatasetName class instead.

Parses the dataset from the given fully-qualified path which represents a annotated_dataset resource.

parseAnnotatedDatasetFromAnnotatedDatasetName
```
@Deprecated
public static final String parseAnnotatedDatasetFromAnnotatedDatasetName(String annotatedDatasetName)
```
Deprecated. Use the AnnotatedDatasetName class instead.

Parses the annotated_dataset from the given fully-qualified path which represents a annotated_dataset resource.

parseProjectFromAnnotationSpecSetName
```
@Deprecated
public static final String parseProjectFromAnnotationSpecSetName(String annotationSpecSetName)
```
Deprecated. Use the AnnotationSpecSetName class instead.

Parses the project from the given fully-qualified path which represents a annotation_spec_set resource.

parseAnnotationSpecSetFromAnnotationSpecSetName
```
@Deprecated
public static final String parseAnnotationSpecSetFromAnnotationSpecSetName(String annotationSpecSetName)
```
Deprecated. Use the AnnotationSpecSetName class instead.

Parses the annotation_spec_set from the given fully-qualified path which represents a annotation_spec_set resource.

parseProjectFromDataItemName
```
@Deprecated
public static final String parseProjectFromDataItemName(String dataItemName)
```
Deprecated. Use the DataItemName class instead.

Parses the project from the given fully-qualified path which represents a data_item resource.

parseDatasetFromDataItemName
```
@Deprecated
public static final String parseDatasetFromDataItemName(String dataItemName)
```
Deprecated. Use the DataItemName class instead.

Parses the dataset from the given fully-qualified path which represents a data_item resource.

parseDataItemFromDataItemName
```
@Deprecated
public static final String parseDataItemFromDataItemName(String dataItemName)
```
Deprecated. Use the DataItemName class instead.

Parses the data_item from the given fully-qualified path which represents a data_item resource.

parseProjectFromDatasetName
```
@Deprecated
public static final String parseProjectFromDatasetName(String datasetName)
```
Deprecated. Use the DatasetName class instead.

Parses the project from the given fully-qualified path which represents a dataset resource.

parseDatasetFromDatasetName
```
@Deprecated
public static final String parseDatasetFromDatasetName(String datasetName)
```
Deprecated. Use the DatasetName class instead.

Parses the dataset from the given fully-qualified path which represents a dataset resource.

parseProjectFromEvaluationName
```
@Deprecated
public static final String parseProjectFromEvaluationName(String evaluationName)
```
Deprecated. Use the EvaluationName class instead.

Parses the project from the given fully-qualified path which represents a evaluation resource.

parseDatasetFromEvaluationName
```
@Deprecated
public static final String parseDatasetFromEvaluationName(String evaluationName)
```
Deprecated. Use the EvaluationName class instead.

Parses the dataset from the given fully-qualified path which represents a evaluation resource.

parseEvaluationFromEvaluationName
```
@Deprecated
public static final String parseEvaluationFromEvaluationName(String evaluationName)
```
Deprecated. Use the EvaluationName class instead.

Parses the evaluation from the given fully-qualified path which represents a evaluation resource.

parseProjectFromEvaluationJobName
```
@Deprecated
public static final String parseProjectFromEvaluationJobName(String evaluationJobName)
```
Deprecated. Use the EvaluationJobName class instead.

Parses the project from the given fully-qualified path which represents a evaluation_job resource.

parseEvaluationJobFromEvaluationJobName
```
@Deprecated
public static final String parseEvaluationJobFromEvaluationJobName(String evaluationJobName)
```
Deprecated. Use the EvaluationJobName class instead.

Parses the evaluation_job from the given fully-qualified path which represents a evaluation_job resource.

parseProjectFromExampleName
```
@Deprecated
public static final String parseProjectFromExampleName(String exampleName)
```
Deprecated. Use the ExampleName class instead.

Parses the project from the given fully-qualified path which represents a example resource.

parseDatasetFromExampleName
```
@Deprecated
public static final String parseDatasetFromExampleName(String exampleName)
```
Deprecated. Use the ExampleName class instead.

Parses the dataset from the given fully-qualified path which represents a example resource.

parseAnnotatedDatasetFromExampleName
```
@Deprecated
public static final String parseAnnotatedDatasetFromExampleName(String exampleName)
```
Deprecated. Use the ExampleName class instead.

Parses the annotated_dataset from the given fully-qualified path which represents a example resource.

parseExampleFromExampleName
```
@Deprecated
public static final String parseExampleFromExampleName(String exampleName)
```
Deprecated. Use the ExampleName class instead.

Parses the example from the given fully-qualified path which represents a example resource.

parseProjectFromInstructionName
```
@Deprecated
public static final String parseProjectFromInstructionName(String instructionName)
```
Deprecated. Use the InstructionName class instead.

Parses the project from the given fully-qualified path which represents a instruction resource.

parseInstructionFromInstructionName
```
@Deprecated
public static final String parseInstructionFromInstructionName(String instructionName)
```
Deprecated. Use the InstructionName class instead.

Parses the instruction from the given fully-qualified path which represents a instruction resource.

parseProjectFromProjectName
```
@Deprecated
public static final String parseProjectFromProjectName(String projectName)
```
Deprecated. Use the ProjectName class instead.

Parses the project from the given fully-qualified path which represents a project resource.

create

public static final DataLabelingServiceClient create()
                                              throws IOException

Constructs an instance of DataLabelingServiceClient with default settings.

Throws:: IOException

create
```
public static final DataLabelingServiceClient create(DataLabelingServiceSettings settings)
                                              throws IOException
```
Constructs an instance of DataLabelingServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Throws:

IOException

create

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public static final DataLabelingServiceClient create(DataLabelingServiceStub stub)

Constructs an instance of DataLabelingServiceClient, using the given stub for making calls. This is for advanced usage - prefer to use DataLabelingServiceSettings}.

getSettings

public final DataLabelingServiceSettings getSettings()

getStub

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public DataLabelingServiceStub getStub()

getOperationsClient

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final com.google.longrunning.OperationsClient getOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

createDataset

public final Dataset createDataset(String parent,
                                   Dataset dataset)

Creates dataset. If success return a Dataset resource.

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedParent = DataLabelingServiceClient.formatProjectName("[PROJECT]");
   Dataset dataset = Dataset.newBuilder().build();
   Dataset response = dataLabelingServiceClient.createDataset(formattedParent, dataset);
 }

Parameters:: parent - Required. Dataset resource parent, format: projects/{project_id}; dataset - Required. The dataset to be created.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

createDataset

public final Dataset createDataset(CreateDatasetRequest request)

Creates dataset. If success return a Dataset resource.

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedParent = DataLabelingServiceClient.formatProjectName("[PROJECT]");
   Dataset dataset = Dataset.newBuilder().build();
   CreateDatasetRequest request = CreateDatasetRequest.newBuilder()
     .setParent(formattedParent)
     .setDataset(dataset)
     .build();
   Dataset response = dataLabelingServiceClient.createDataset(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

createDatasetCallable

public final com.google.api.gax.rpc.UnaryCallable<CreateDatasetRequest,Dataset> createDatasetCallable()

Creates dataset. If success return a Dataset resource.

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedParent = DataLabelingServiceClient.formatProjectName("[PROJECT]");
   Dataset dataset = Dataset.newBuilder().build();
   CreateDatasetRequest request = CreateDatasetRequest.newBuilder()
     .setParent(formattedParent)
     .setDataset(dataset)
     .build();
   ApiFuture<Dataset> future = dataLabelingServiceClient.createDatasetCallable().futureCall(request);
   // Do something
   Dataset response = future.get();
 }

getDataset

public final Dataset getDataset(String name)

Gets dataset by resource name.

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedName = DataLabelingServiceClient.formatDatasetName("[PROJECT]", "[DATASET]");
   Dataset response = dataLabelingServiceClient.getDataset(formattedName);
 }

Parameters:: name - Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getDataset

public final Dataset getDataset(GetDatasetRequest request)

Gets dataset by resource name.

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedName = DataLabelingServiceClient.formatDatasetName("[PROJECT]", "[DATASET]");
   GetDatasetRequest request = GetDatasetRequest.newBuilder()
     .setName(formattedName)
     .build();
   Dataset response = dataLabelingServiceClient.getDataset(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getDatasetCallable

public final com.google.api.gax.rpc.UnaryCallable<GetDatasetRequest,Dataset> getDatasetCallable()

Gets dataset by resource name.

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedName = DataLabelingServiceClient.formatDatasetName("[PROJECT]", "[DATASET]");
   GetDatasetRequest request = GetDatasetRequest.newBuilder()
     .setName(formattedName)
     .build();
   ApiFuture<Dataset> future = dataLabelingServiceClient.getDatasetCallable().futureCall(request);
   // Do something
   Dataset response = future.get();
 }

listDatasets

public final DataLabelingServiceClient.ListDatasetsPagedResponse listDatasets(String parent,
                                                                              String filter)

Lists datasets under a project. Pagination is supported.

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedParent = DataLabelingServiceClient.formatProjectName("[PROJECT]");
   String filter = "";
   for (Dataset element : dataLabelingServiceClient.listDatasets(formattedParent, filter).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: parent - Required. Dataset resource parent, format: projects/{project_id}; filter - Optional. Filter on dataset is not supported at this moment.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listDatasets

public final DataLabelingServiceClient.ListDatasetsPagedResponse listDatasets(ListDatasetsRequest request)

Lists datasets under a project. Pagination is supported.

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedParent = DataLabelingServiceClient.formatProjectName("[PROJECT]");
   ListDatasetsRequest request = ListDatasetsRequest.newBuilder()
     .setParent(formattedParent)
     .build();
   for (Dataset element : dataLabelingServiceClient.listDatasets(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listDatasetsPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListDatasetsRequest,DataLabelingServiceClient.ListDatasetsPagedResponse> listDatasetsPagedCallable()

Lists datasets under a project. Pagination is supported.

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedParent = DataLabelingServiceClient.formatProjectName("[PROJECT]");
   ListDatasetsRequest request = ListDatasetsRequest.newBuilder()
     .setParent(formattedParent)
     .build();
   ApiFuture<ListDatasetsPagedResponse> future = dataLabelingServiceClient.listDatasetsPagedCallable().futureCall(request);
   // Do something
   for (Dataset element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

listDatasetsCallable

public final com.google.api.gax.rpc.UnaryCallable<ListDatasetsRequest,ListDatasetsResponse> listDatasetsCallable()

Lists datasets under a project. Pagination is supported.

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedParent = DataLabelingServiceClient.formatProjectName("[PROJECT]");
   ListDatasetsRequest request = ListDatasetsRequest.newBuilder()
     .setParent(formattedParent)
     .build();
   while (true) {
     ListDatasetsResponse response = dataLabelingServiceClient.listDatasetsCallable().call(request);
     for (Dataset element : response.getDatasetsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

deleteDataset

public final void deleteDataset(String name)

Deletes a dataset by resource name.

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedName = DataLabelingServiceClient.formatDatasetName("[PROJECT]", "[DATASET]");
   dataLabelingServiceClient.deleteDataset(formattedName);
 }

Parameters:: name - Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

deleteDataset

public final void deleteDataset(DeleteDatasetRequest request)

Deletes a dataset by resource name.

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedName = DataLabelingServiceClient.formatDatasetName("[PROJECT]", "[DATASET]");
   DeleteDatasetRequest request = DeleteDatasetRequest.newBuilder()
     .setName(formattedName)
     .build();
   dataLabelingServiceClient.deleteDataset(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

deleteDatasetCallable

public final com.google.api.gax.rpc.UnaryCallable<DeleteDatasetRequest,Empty> deleteDatasetCallable()

Deletes a dataset by resource name.

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedName = DataLabelingServiceClient.formatDatasetName("[PROJECT]", "[DATASET]");
   DeleteDatasetRequest request = DeleteDatasetRequest.newBuilder()
     .setName(formattedName)
     .build();
   ApiFuture<Void> future = dataLabelingServiceClient.deleteDatasetCallable().futureCall(request);
   // Do something
   future.get();
 }

importDataAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final com.google.api.gax.longrunning.OperationFuture<ImportDataOperationResponse,ImportDataOperationMetadata> importDataAsync(String name,
                                                                                                                                                                                                                                               InputConfig inputConfig)

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.

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedName = DataLabelingServiceClient.formatDatasetName("[PROJECT]", "[DATASET]");
   InputConfig inputConfig = InputConfig.newBuilder().build();
   ImportDataOperationResponse response = dataLabelingServiceClient.importDataAsync(formattedName, inputConfig).get();
 }

Parameters:: name - Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}; inputConfig - Required. Specify the input source of the data.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

importDataAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final com.google.api.gax.longrunning.OperationFuture<ImportDataOperationResponse,ImportDataOperationMetadata> importDataAsync(ImportDataRequest request)

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedName = DataLabelingServiceClient.formatDatasetName("[PROJECT]", "[DATASET]");
   InputConfig inputConfig = InputConfig.newBuilder().build();
   ImportDataRequest request = ImportDataRequest.newBuilder()
     .setName(formattedName)
     .setInputConfig(inputConfig)
     .build();
   ImportDataOperationResponse response = dataLabelingServiceClient.importDataAsync(request).get();
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

importDataOperationCallable

@BetaApi(value="The surface for use by generated code is not stable yet and may change in the future.")
public final com.google.api.gax.rpc.OperationCallable<ImportDataRequest,ImportDataOperationResponse,ImportDataOperationMetadata> importDataOperationCallable()

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedName = DataLabelingServiceClient.formatDatasetName("[PROJECT]", "[DATASET]");
   InputConfig inputConfig = InputConfig.newBuilder().build();
   ImportDataRequest request = ImportDataRequest.newBuilder()
     .setName(formattedName)
     .setInputConfig(inputConfig)
     .build();
   OperationFuture<ImportDataOperationResponse, ImportDataOperationMetadata> future = dataLabelingServiceClient.importDataOperationCallable().futureCall(request);
   // Do something
   ImportDataOperationResponse response = future.get();
 }

importDataCallable

public final com.google.api.gax.rpc.UnaryCallable<ImportDataRequest,com.google.longrunning.Operation> importDataCallable()

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedName = DataLabelingServiceClient.formatDatasetName("[PROJECT]", "[DATASET]");
   InputConfig inputConfig = InputConfig.newBuilder().build();
   ImportDataRequest request = ImportDataRequest.newBuilder()
     .setName(formattedName)
     .setInputConfig(inputConfig)
     .build();
   ApiFuture<Operation> future = dataLabelingServiceClient.importDataCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }

exportDataAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final com.google.api.gax.longrunning.OperationFuture<ExportDataOperationResponse,ExportDataOperationMetadata> exportDataAsync(String name,
                                                                                                                                                                                                                                               String annotatedDataset,
                                                                                                                                                                                                                                               String filter,
                                                                                                                                                                                                                                               OutputConfig outputConfig)

Exports data and annotations from dataset.

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedName = DataLabelingServiceClient.formatDatasetName("[PROJECT]", "[DATASET]");
   String annotatedDataset = "";
   String filter = "";
   OutputConfig outputConfig = OutputConfig.newBuilder().build();
   ExportDataOperationResponse response = dataLabelingServiceClient.exportDataAsync(formattedName, annotatedDataset, filter, outputConfig).get();
 }

Parameters:: name - Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}; annotatedDataset - Required. Annotated dataset resource name. DataItem in Dataset and their annotations in specified annotated dataset will be exported. It's in format of projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}; filter - Optional. Filter is not supported at this moment.; outputConfig - Required. Specify the output destination.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

exportDataAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final com.google.api.gax.longrunning.OperationFuture<ExportDataOperationResponse,ExportDataOperationMetadata> exportDataAsync(ExportDataRequest request)

Exports data and annotations from dataset.

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedName = DataLabelingServiceClient.formatDatasetName("[PROJECT]", "[DATASET]");
   String annotatedDataset = "";
   OutputConfig outputConfig = OutputConfig.newBuilder().build();
   ExportDataRequest request = ExportDataRequest.newBuilder()
     .setName(formattedName)
     .setAnnotatedDataset(annotatedDataset)
     .setOutputConfig(outputConfig)
     .build();
   ExportDataOperationResponse response = dataLabelingServiceClient.exportDataAsync(request).get();
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

exportDataOperationCallable

@BetaApi(value="The surface for use by generated code is not stable yet and may change in the future.")
public final com.google.api.gax.rpc.OperationCallable<ExportDataRequest,ExportDataOperationResponse,ExportDataOperationMetadata> exportDataOperationCallable()

Exports data and annotations from dataset.

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedName = DataLabelingServiceClient.formatDatasetName("[PROJECT]", "[DATASET]");
   String annotatedDataset = "";
   OutputConfig outputConfig = OutputConfig.newBuilder().build();
   ExportDataRequest request = ExportDataRequest.newBuilder()
     .setName(formattedName)
     .setAnnotatedDataset(annotatedDataset)
     .setOutputConfig(outputConfig)
     .build();
   OperationFuture<ExportDataOperationResponse, ExportDataOperationMetadata> future = dataLabelingServiceClient.exportDataOperationCallable().futureCall(request);
   // Do something
   ExportDataOperationResponse response = future.get();
 }

exportDataCallable

public final com.google.api.gax.rpc.UnaryCallable<ExportDataRequest,com.google.longrunning.Operation> exportDataCallable()

Exports data and annotations from dataset.

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedName = DataLabelingServiceClient.formatDatasetName("[PROJECT]", "[DATASET]");
   String annotatedDataset = "";
   OutputConfig outputConfig = OutputConfig.newBuilder().build();
   ExportDataRequest request = ExportDataRequest.newBuilder()
     .setName(formattedName)
     .setAnnotatedDataset(annotatedDataset)
     .setOutputConfig(outputConfig)
     .build();
   ApiFuture<Operation> future = dataLabelingServiceClient.exportDataCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }

getDataItem

public final DataItem getDataItem(String name)

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

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedName = DataLabelingServiceClient.formatDataItemName("[PROJECT]", "[DATASET]", "[DATA_ITEM]");
   DataItem response = dataLabelingServiceClient.getDataItem(formattedName);
 }

Parameters:: name - Required. The name of the data item to get, format: projects/{project_id}/datasets/{dataset_id}/dataItems/{data_item_id}
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getDataItem

public final 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.

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedName = DataLabelingServiceClient.formatDataItemName("[PROJECT]", "[DATASET]", "[DATA_ITEM]");
   GetDataItemRequest request = GetDataItemRequest.newBuilder()
     .setName(formattedName)
     .build();
   DataItem response = dataLabelingServiceClient.getDataItem(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getDataItemCallable

public final com.google.api.gax.rpc.UnaryCallable<GetDataItemRequest,DataItem> getDataItemCallable()

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

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedName = DataLabelingServiceClient.formatDataItemName("[PROJECT]", "[DATASET]", "[DATA_ITEM]");
   GetDataItemRequest request = GetDataItemRequest.newBuilder()
     .setName(formattedName)
     .build();
   ApiFuture<DataItem> future = dataLabelingServiceClient.getDataItemCallable().futureCall(request);
   // Do something
   DataItem response = future.get();
 }

listDataItems

public final DataLabelingServiceClient.ListDataItemsPagedResponse listDataItems(String parent,
                                                                                String filter)

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

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedParent = DataLabelingServiceClient.formatDatasetName("[PROJECT]", "[DATASET]");
   String filter = "";
   for (DataItem element : dataLabelingServiceClient.listDataItems(formattedParent, filter).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: parent - Required. Name of the dataset to list data items, format: projects/{project_id}/datasets/{dataset_id}; filter - Optional. Filter is not supported at this moment.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listDataItems

public final DataLabelingServiceClient.ListDataItemsPagedResponse listDataItems(ListDataItemsRequest request)

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

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedParent = DataLabelingServiceClient.formatDatasetName("[PROJECT]", "[DATASET]");
   ListDataItemsRequest request = ListDataItemsRequest.newBuilder()
     .setParent(formattedParent)
     .build();
   for (DataItem element : dataLabelingServiceClient.listDataItems(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listDataItemsPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListDataItemsRequest,DataLabelingServiceClient.ListDataItemsPagedResponse> listDataItemsPagedCallable()

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

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedParent = DataLabelingServiceClient.formatDatasetName("[PROJECT]", "[DATASET]");
   ListDataItemsRequest request = ListDataItemsRequest.newBuilder()
     .setParent(formattedParent)
     .build();
   ApiFuture<ListDataItemsPagedResponse> future = dataLabelingServiceClient.listDataItemsPagedCallable().futureCall(request);
   // Do something
   for (DataItem element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

listDataItemsCallable

public final com.google.api.gax.rpc.UnaryCallable<ListDataItemsRequest,ListDataItemsResponse> listDataItemsCallable()

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

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedParent = DataLabelingServiceClient.formatDatasetName("[PROJECT]", "[DATASET]");
   ListDataItemsRequest request = ListDataItemsRequest.newBuilder()
     .setParent(formattedParent)
     .build();
   while (true) {
     ListDataItemsResponse response = dataLabelingServiceClient.listDataItemsCallable().call(request);
     for (DataItem element : response.getDataItemsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

getAnnotatedDataset

public final AnnotatedDataset getAnnotatedDataset(String name)

Gets an annotated dataset by resource name.

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedName = DataLabelingServiceClient.formatAnnotatedDatasetName("[PROJECT]", "[DATASET]", "[ANNOTATED_DATASET]");
   AnnotatedDataset response = dataLabelingServiceClient.getAnnotatedDataset(formattedName);
 }

Parameters:: name - Required. Name of the annotated dataset to get, format: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getAnnotatedDataset

public final AnnotatedDataset getAnnotatedDataset(GetAnnotatedDatasetRequest request)

Gets an annotated dataset by resource name.

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedName = DataLabelingServiceClient.formatAnnotatedDatasetName("[PROJECT]", "[DATASET]", "[ANNOTATED_DATASET]");
   GetAnnotatedDatasetRequest request = GetAnnotatedDatasetRequest.newBuilder()
     .setName(formattedName)
     .build();
   AnnotatedDataset response = dataLabelingServiceClient.getAnnotatedDataset(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getAnnotatedDatasetCallable

public final com.google.api.gax.rpc.UnaryCallable<GetAnnotatedDatasetRequest,AnnotatedDataset> getAnnotatedDatasetCallable()

Gets an annotated dataset by resource name.

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedName = DataLabelingServiceClient.formatAnnotatedDatasetName("[PROJECT]", "[DATASET]", "[ANNOTATED_DATASET]");
   GetAnnotatedDatasetRequest request = GetAnnotatedDatasetRequest.newBuilder()
     .setName(formattedName)
     .build();
   ApiFuture<AnnotatedDataset> future = dataLabelingServiceClient.getAnnotatedDatasetCallable().futureCall(request);
   // Do something
   AnnotatedDataset response = future.get();
 }

listAnnotatedDatasets

public final DataLabelingServiceClient.ListAnnotatedDatasetsPagedResponse listAnnotatedDatasets(String parent,
                                                                                                String filter)

Lists annotated datasets for a dataset. Pagination is supported.

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedParent = DataLabelingServiceClient.formatDatasetName("[PROJECT]", "[DATASET]");
   String filter = "";
   for (AnnotatedDataset element : dataLabelingServiceClient.listAnnotatedDatasets(formattedParent, filter).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: parent - Required. Name of the dataset to list annotated datasets, format: projects/{project_id}/datasets/{dataset_id}; filter - Optional. Filter is not supported at this moment.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listAnnotatedDatasets

public final DataLabelingServiceClient.ListAnnotatedDatasetsPagedResponse listAnnotatedDatasets(ListAnnotatedDatasetsRequest request)

Lists annotated datasets for a dataset. Pagination is supported.

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedParent = DataLabelingServiceClient.formatDatasetName("[PROJECT]", "[DATASET]");
   ListAnnotatedDatasetsRequest request = ListAnnotatedDatasetsRequest.newBuilder()
     .setParent(formattedParent)
     .build();
   for (AnnotatedDataset element : dataLabelingServiceClient.listAnnotatedDatasets(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listAnnotatedDatasetsPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListAnnotatedDatasetsRequest,DataLabelingServiceClient.ListAnnotatedDatasetsPagedResponse> listAnnotatedDatasetsPagedCallable()

Lists annotated datasets for a dataset. Pagination is supported.

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedParent = DataLabelingServiceClient.formatDatasetName("[PROJECT]", "[DATASET]");
   ListAnnotatedDatasetsRequest request = ListAnnotatedDatasetsRequest.newBuilder()
     .setParent(formattedParent)
     .build();
   ApiFuture<ListAnnotatedDatasetsPagedResponse> future = dataLabelingServiceClient.listAnnotatedDatasetsPagedCallable().futureCall(request);
   // Do something
   for (AnnotatedDataset element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

listAnnotatedDatasetsCallable

public final com.google.api.gax.rpc.UnaryCallable<ListAnnotatedDatasetsRequest,ListAnnotatedDatasetsResponse> listAnnotatedDatasetsCallable()

Lists annotated datasets for a dataset. Pagination is supported.

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedParent = DataLabelingServiceClient.formatDatasetName("[PROJECT]", "[DATASET]");
   ListAnnotatedDatasetsRequest request = ListAnnotatedDatasetsRequest.newBuilder()
     .setParent(formattedParent)
     .build();
   while (true) {
     ListAnnotatedDatasetsResponse response = dataLabelingServiceClient.listAnnotatedDatasetsCallable().call(request);
     for (AnnotatedDataset element : response.getAnnotatedDatasetsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

labelImageAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final com.google.api.gax.longrunning.OperationFuture<AnnotatedDataset,LabelOperationMetadata> labelImageAsync(String parent,
                                                                                                                                                                                                                               HumanAnnotationConfig basicConfig,
                                                                                                                                                                                                                               LabelImageRequest.Feature feature)

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

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedParent = DataLabelingServiceClient.formatDatasetName("[PROJECT]", "[DATASET]");
   HumanAnnotationConfig basicConfig = HumanAnnotationConfig.newBuilder().build();
   LabelImageRequest.Feature feature = LabelImageRequest.Feature.FEATURE_UNSPECIFIED;
   AnnotatedDataset response = dataLabelingServiceClient.labelImageAsync(formattedParent, basicConfig, feature).get();
 }

Parameters:: parent - Required. Name of the dataset to request labeling task, format: projects/{project_id}/datasets/{dataset_id}; basicConfig - Required. Basic human annotation config.; feature - Required. The type of image labeling task.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

labelImageAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final com.google.api.gax.longrunning.OperationFuture<AnnotatedDataset,LabelOperationMetadata> labelImageAsync(LabelImageRequest request)

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

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedParent = DataLabelingServiceClient.formatDatasetName("[PROJECT]", "[DATASET]");
   HumanAnnotationConfig basicConfig = HumanAnnotationConfig.newBuilder().build();
   LabelImageRequest.Feature feature = LabelImageRequest.Feature.FEATURE_UNSPECIFIED;
   LabelImageRequest request = LabelImageRequest.newBuilder()
     .setParent(formattedParent)
     .setBasicConfig(basicConfig)
     .setFeature(feature)
     .build();
   AnnotatedDataset response = dataLabelingServiceClient.labelImageAsync(request).get();
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

labelImageOperationCallable

@BetaApi(value="The surface for use by generated code is not stable yet and may change in the future.")
public final com.google.api.gax.rpc.OperationCallable<LabelImageRequest,AnnotatedDataset,LabelOperationMetadata> labelImageOperationCallable()

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

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedParent = DataLabelingServiceClient.formatDatasetName("[PROJECT]", "[DATASET]");
   HumanAnnotationConfig basicConfig = HumanAnnotationConfig.newBuilder().build();
   LabelImageRequest.Feature feature = LabelImageRequest.Feature.FEATURE_UNSPECIFIED;
   LabelImageRequest request = LabelImageRequest.newBuilder()
     .setParent(formattedParent)
     .setBasicConfig(basicConfig)
     .setFeature(feature)
     .build();
   OperationFuture<AnnotatedDataset, LabelOperationMetadata> future = dataLabelingServiceClient.labelImageOperationCallable().futureCall(request);
   // Do something
   AnnotatedDataset response = future.get();
 }

labelImageCallable

public final com.google.api.gax.rpc.UnaryCallable<LabelImageRequest,com.google.longrunning.Operation> labelImageCallable()

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

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedParent = DataLabelingServiceClient.formatDatasetName("[PROJECT]", "[DATASET]");
   HumanAnnotationConfig basicConfig = HumanAnnotationConfig.newBuilder().build();
   LabelImageRequest.Feature feature = LabelImageRequest.Feature.FEATURE_UNSPECIFIED;
   LabelImageRequest request = LabelImageRequest.newBuilder()
     .setParent(formattedParent)
     .setBasicConfig(basicConfig)
     .setFeature(feature)
     .build();
   ApiFuture<Operation> future = dataLabelingServiceClient.labelImageCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }

labelVideoAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final com.google.api.gax.longrunning.OperationFuture<AnnotatedDataset,LabelOperationMetadata> labelVideoAsync(String parent,
                                                                                                                                                                                                                               HumanAnnotationConfig basicConfig,
                                                                                                                                                                                                                               LabelVideoRequest.Feature feature)

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

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedParent = DataLabelingServiceClient.formatDatasetName("[PROJECT]", "[DATASET]");
   HumanAnnotationConfig basicConfig = HumanAnnotationConfig.newBuilder().build();
   LabelVideoRequest.Feature feature = LabelVideoRequest.Feature.FEATURE_UNSPECIFIED;
   AnnotatedDataset response = dataLabelingServiceClient.labelVideoAsync(formattedParent, basicConfig, feature).get();
 }

Parameters:: parent - Required. Name of the dataset to request labeling task, format: projects/{project_id}/datasets/{dataset_id}; basicConfig - Required. Basic human annotation config.; feature - Required. The type of video labeling task.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

labelVideoAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final com.google.api.gax.longrunning.OperationFuture<AnnotatedDataset,LabelOperationMetadata> labelVideoAsync(LabelVideoRequest request)

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

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedParent = DataLabelingServiceClient.formatDatasetName("[PROJECT]", "[DATASET]");
   HumanAnnotationConfig basicConfig = HumanAnnotationConfig.newBuilder().build();
   LabelVideoRequest.Feature feature = LabelVideoRequest.Feature.FEATURE_UNSPECIFIED;
   LabelVideoRequest request = LabelVideoRequest.newBuilder()
     .setParent(formattedParent)
     .setBasicConfig(basicConfig)
     .setFeature(feature)
     .build();
   AnnotatedDataset response = dataLabelingServiceClient.labelVideoAsync(request).get();
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

labelVideoOperationCallable

@BetaApi(value="The surface for use by generated code is not stable yet and may change in the future.")
public final com.google.api.gax.rpc.OperationCallable<LabelVideoRequest,AnnotatedDataset,LabelOperationMetadata> labelVideoOperationCallable()

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

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedParent = DataLabelingServiceClient.formatDatasetName("[PROJECT]", "[DATASET]");
   HumanAnnotationConfig basicConfig = HumanAnnotationConfig.newBuilder().build();
   LabelVideoRequest.Feature feature = LabelVideoRequest.Feature.FEATURE_UNSPECIFIED;
   LabelVideoRequest request = LabelVideoRequest.newBuilder()
     .setParent(formattedParent)
     .setBasicConfig(basicConfig)
     .setFeature(feature)
     .build();
   OperationFuture<AnnotatedDataset, LabelOperationMetadata> future = dataLabelingServiceClient.labelVideoOperationCallable().futureCall(request);
   // Do something
   AnnotatedDataset response = future.get();
 }

labelVideoCallable

public final com.google.api.gax.rpc.UnaryCallable<LabelVideoRequest,com.google.longrunning.Operation> labelVideoCallable()

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

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedParent = DataLabelingServiceClient.formatDatasetName("[PROJECT]", "[DATASET]");
   HumanAnnotationConfig basicConfig = HumanAnnotationConfig.newBuilder().build();
   LabelVideoRequest.Feature feature = LabelVideoRequest.Feature.FEATURE_UNSPECIFIED;
   LabelVideoRequest request = LabelVideoRequest.newBuilder()
     .setParent(formattedParent)
     .setBasicConfig(basicConfig)
     .setFeature(feature)
     .build();
   ApiFuture<Operation> future = dataLabelingServiceClient.labelVideoCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }

labelTextAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final com.google.api.gax.longrunning.OperationFuture<AnnotatedDataset,LabelOperationMetadata> labelTextAsync(String parent,
                                                                                                                                                                                                                              HumanAnnotationConfig basicConfig,
                                                                                                                                                                                                                              LabelTextRequest.Feature feature)

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

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedParent = DataLabelingServiceClient.formatDatasetName("[PROJECT]", "[DATASET]");
   HumanAnnotationConfig basicConfig = HumanAnnotationConfig.newBuilder().build();
   LabelTextRequest.Feature feature = LabelTextRequest.Feature.FEATURE_UNSPECIFIED;
   AnnotatedDataset response = dataLabelingServiceClient.labelTextAsync(formattedParent, basicConfig, feature).get();
 }

Parameters:: parent - Required. Name of the data set to request labeling task, format: projects/{project_id}/datasets/{dataset_id}; basicConfig - Required. Basic human annotation config.; feature - Required. The type of text labeling task.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

labelTextAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final com.google.api.gax.longrunning.OperationFuture<AnnotatedDataset,LabelOperationMetadata> labelTextAsync(LabelTextRequest request)

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

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedParent = DataLabelingServiceClient.formatDatasetName("[PROJECT]", "[DATASET]");
   HumanAnnotationConfig basicConfig = HumanAnnotationConfig.newBuilder().build();
   LabelTextRequest.Feature feature = LabelTextRequest.Feature.FEATURE_UNSPECIFIED;
   LabelTextRequest request = LabelTextRequest.newBuilder()
     .setParent(formattedParent)
     .setBasicConfig(basicConfig)
     .setFeature(feature)
     .build();
   AnnotatedDataset response = dataLabelingServiceClient.labelTextAsync(request).get();
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

labelTextOperationCallable

@BetaApi(value="The surface for use by generated code is not stable yet and may change in the future.")
public final com.google.api.gax.rpc.OperationCallable<LabelTextRequest,AnnotatedDataset,LabelOperationMetadata> labelTextOperationCallable()

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

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedParent = DataLabelingServiceClient.formatDatasetName("[PROJECT]", "[DATASET]");
   HumanAnnotationConfig basicConfig = HumanAnnotationConfig.newBuilder().build();
   LabelTextRequest.Feature feature = LabelTextRequest.Feature.FEATURE_UNSPECIFIED;
   LabelTextRequest request = LabelTextRequest.newBuilder()
     .setParent(formattedParent)
     .setBasicConfig(basicConfig)
     .setFeature(feature)
     .build();
   OperationFuture<AnnotatedDataset, LabelOperationMetadata> future = dataLabelingServiceClient.labelTextOperationCallable().futureCall(request);
   // Do something
   AnnotatedDataset response = future.get();
 }

labelTextCallable

public final com.google.api.gax.rpc.UnaryCallable<LabelTextRequest,com.google.longrunning.Operation> labelTextCallable()

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

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedParent = DataLabelingServiceClient.formatDatasetName("[PROJECT]", "[DATASET]");
   HumanAnnotationConfig basicConfig = HumanAnnotationConfig.newBuilder().build();
   LabelTextRequest.Feature feature = LabelTextRequest.Feature.FEATURE_UNSPECIFIED;
   LabelTextRequest request = LabelTextRequest.newBuilder()
     .setParent(formattedParent)
     .setBasicConfig(basicConfig)
     .setFeature(feature)
     .build();
   ApiFuture<Operation> future = dataLabelingServiceClient.labelTextCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }

getExample
```
public final Example getExample(String name,
                                String filter)
```
Gets an example by resource name, including both data and annotation.
Sample code:
```
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedName = DataLabelingServiceClient.formatExampleName("[PROJECT]", "[DATASET]", "[ANNOTATED_DATASET]", "[EXAMPLE]");
   String filter = "";
   Example response = dataLabelingServiceClient.getExample(formattedName, filter);
 }
 
```
Parameters:

name - Required. Name of example, format: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}/examples/{example_id}

filter - Optional. An expression for filtering Examples. Filter by annotation_spec.display_name is supported. Format "annotation_spec.display_name = {display_name}"

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getExample

public final Example getExample(GetExampleRequest request)

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

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedName = DataLabelingServiceClient.formatExampleName("[PROJECT]", "[DATASET]", "[ANNOTATED_DATASET]", "[EXAMPLE]");
   GetExampleRequest request = GetExampleRequest.newBuilder()
     .setName(formattedName)
     .build();
   Example response = dataLabelingServiceClient.getExample(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getExampleCallable

public final com.google.api.gax.rpc.UnaryCallable<GetExampleRequest,Example> getExampleCallable()

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

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedName = DataLabelingServiceClient.formatExampleName("[PROJECT]", "[DATASET]", "[ANNOTATED_DATASET]", "[EXAMPLE]");
   GetExampleRequest request = GetExampleRequest.newBuilder()
     .setName(formattedName)
     .build();
   ApiFuture<Example> future = dataLabelingServiceClient.getExampleCallable().futureCall(request);
   // Do something
   Example response = future.get();
 }

listExamples

public final DataLabelingServiceClient.ListExamplesPagedResponse listExamples(String parent,
                                                                              String filter)

Lists examples in an annotated dataset. Pagination is supported.

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedParent = DataLabelingServiceClient.formatAnnotatedDatasetName("[PROJECT]", "[DATASET]", "[ANNOTATED_DATASET]");
   String filter = "";
   for (Example element : dataLabelingServiceClient.listExamples(formattedParent, filter).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: parent - Required. Example resource parent.; filter - Optional. An expression for filtering Examples. For annotated datasets that have annotation spec set, filter by annotation_spec.display_name is supported. Format "annotation_spec.display_name = {display_name}"
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listExamples

public final DataLabelingServiceClient.ListExamplesPagedResponse listExamples(ListExamplesRequest request)

Lists examples in an annotated dataset. Pagination is supported.

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedParent = DataLabelingServiceClient.formatAnnotatedDatasetName("[PROJECT]", "[DATASET]", "[ANNOTATED_DATASET]");
   ListExamplesRequest request = ListExamplesRequest.newBuilder()
     .setParent(formattedParent)
     .build();
   for (Example element : dataLabelingServiceClient.listExamples(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listExamplesPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListExamplesRequest,DataLabelingServiceClient.ListExamplesPagedResponse> listExamplesPagedCallable()

Lists examples in an annotated dataset. Pagination is supported.

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedParent = DataLabelingServiceClient.formatAnnotatedDatasetName("[PROJECT]", "[DATASET]", "[ANNOTATED_DATASET]");
   ListExamplesRequest request = ListExamplesRequest.newBuilder()
     .setParent(formattedParent)
     .build();
   ApiFuture<ListExamplesPagedResponse> future = dataLabelingServiceClient.listExamplesPagedCallable().futureCall(request);
   // Do something
   for (Example element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

listExamplesCallable

public final com.google.api.gax.rpc.UnaryCallable<ListExamplesRequest,ListExamplesResponse> listExamplesCallable()

Lists examples in an annotated dataset. Pagination is supported.

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedParent = DataLabelingServiceClient.formatAnnotatedDatasetName("[PROJECT]", "[DATASET]", "[ANNOTATED_DATASET]");
   ListExamplesRequest request = ListExamplesRequest.newBuilder()
     .setParent(formattedParent)
     .build();
   while (true) {
     ListExamplesResponse response = dataLabelingServiceClient.listExamplesCallable().call(request);
     for (Example element : response.getExamplesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

createAnnotationSpecSet

public final AnnotationSpecSet createAnnotationSpecSet(String parent,
                                                       AnnotationSpecSet annotationSpecSet)

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

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedParent = DataLabelingServiceClient.formatProjectName("[PROJECT]");
   AnnotationSpecSet annotationSpecSet = AnnotationSpecSet.newBuilder().build();
   AnnotationSpecSet response = dataLabelingServiceClient.createAnnotationSpecSet(formattedParent, annotationSpecSet);
 }

Parameters:: parent - Required. AnnotationSpecSet resource parent, format: projects/{project_id}; annotationSpecSet - Required. Annotation spec set to create. Annotation specs must be included. Only one annotation spec will be accepted for annotation specs with same display_name.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

createAnnotationSpecSet

public final AnnotationSpecSet createAnnotationSpecSet(CreateAnnotationSpecSetRequest request)

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

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedParent = DataLabelingServiceClient.formatProjectName("[PROJECT]");
   AnnotationSpecSet annotationSpecSet = AnnotationSpecSet.newBuilder().build();
   CreateAnnotationSpecSetRequest request = CreateAnnotationSpecSetRequest.newBuilder()
     .setParent(formattedParent)
     .setAnnotationSpecSet(annotationSpecSet)
     .build();
   AnnotationSpecSet response = dataLabelingServiceClient.createAnnotationSpecSet(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

createAnnotationSpecSetCallable

public final com.google.api.gax.rpc.UnaryCallable<CreateAnnotationSpecSetRequest,AnnotationSpecSet> createAnnotationSpecSetCallable()

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

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedParent = DataLabelingServiceClient.formatProjectName("[PROJECT]");
   AnnotationSpecSet annotationSpecSet = AnnotationSpecSet.newBuilder().build();
   CreateAnnotationSpecSetRequest request = CreateAnnotationSpecSetRequest.newBuilder()
     .setParent(formattedParent)
     .setAnnotationSpecSet(annotationSpecSet)
     .build();
   ApiFuture<AnnotationSpecSet> future = dataLabelingServiceClient.createAnnotationSpecSetCallable().futureCall(request);
   // Do something
   AnnotationSpecSet response = future.get();
 }

getAnnotationSpecSet

public final AnnotationSpecSet getAnnotationSpecSet(String name)

Gets an annotation spec set by resource name.

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedName = DataLabelingServiceClient.formatAnnotationSpecSetName("[PROJECT]", "[ANNOTATION_SPEC_SET]");
   AnnotationSpecSet response = dataLabelingServiceClient.getAnnotationSpecSet(formattedName);
 }

Parameters:: name - Required. AnnotationSpecSet resource name, format: projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getAnnotationSpecSet

public final AnnotationSpecSet getAnnotationSpecSet(GetAnnotationSpecSetRequest request)

Gets an annotation spec set by resource name.

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedName = DataLabelingServiceClient.formatAnnotationSpecSetName("[PROJECT]", "[ANNOTATION_SPEC_SET]");
   GetAnnotationSpecSetRequest request = GetAnnotationSpecSetRequest.newBuilder()
     .setName(formattedName)
     .build();
   AnnotationSpecSet response = dataLabelingServiceClient.getAnnotationSpecSet(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getAnnotationSpecSetCallable

public final com.google.api.gax.rpc.UnaryCallable<GetAnnotationSpecSetRequest,AnnotationSpecSet> getAnnotationSpecSetCallable()

Gets an annotation spec set by resource name.

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedName = DataLabelingServiceClient.formatAnnotationSpecSetName("[PROJECT]", "[ANNOTATION_SPEC_SET]");
   GetAnnotationSpecSetRequest request = GetAnnotationSpecSetRequest.newBuilder()
     .setName(formattedName)
     .build();
   ApiFuture<AnnotationSpecSet> future = dataLabelingServiceClient.getAnnotationSpecSetCallable().futureCall(request);
   // Do something
   AnnotationSpecSet response = future.get();
 }

listAnnotationSpecSets

public final DataLabelingServiceClient.ListAnnotationSpecSetsPagedResponse listAnnotationSpecSets(String parent,
                                                                                                  String filter)

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

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedParent = DataLabelingServiceClient.formatProjectName("[PROJECT]");
   String filter = "";
   for (AnnotationSpecSet element : dataLabelingServiceClient.listAnnotationSpecSets(formattedParent, filter).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: parent - Required. Parent of AnnotationSpecSet resource, format: projects/{project_id}; filter - Optional. Filter is not supported at this moment.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listAnnotationSpecSets

public final DataLabelingServiceClient.ListAnnotationSpecSetsPagedResponse listAnnotationSpecSets(ListAnnotationSpecSetsRequest request)

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

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedParent = DataLabelingServiceClient.formatProjectName("[PROJECT]");
   ListAnnotationSpecSetsRequest request = ListAnnotationSpecSetsRequest.newBuilder()
     .setParent(formattedParent)
     .build();
   for (AnnotationSpecSet element : dataLabelingServiceClient.listAnnotationSpecSets(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listAnnotationSpecSetsPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListAnnotationSpecSetsRequest,DataLabelingServiceClient.ListAnnotationSpecSetsPagedResponse> listAnnotationSpecSetsPagedCallable()

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

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedParent = DataLabelingServiceClient.formatProjectName("[PROJECT]");
   ListAnnotationSpecSetsRequest request = ListAnnotationSpecSetsRequest.newBuilder()
     .setParent(formattedParent)
     .build();
   ApiFuture<ListAnnotationSpecSetsPagedResponse> future = dataLabelingServiceClient.listAnnotationSpecSetsPagedCallable().futureCall(request);
   // Do something
   for (AnnotationSpecSet element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

listAnnotationSpecSetsCallable

public final com.google.api.gax.rpc.UnaryCallable<ListAnnotationSpecSetsRequest,ListAnnotationSpecSetsResponse> listAnnotationSpecSetsCallable()

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

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedParent = DataLabelingServiceClient.formatProjectName("[PROJECT]");
   ListAnnotationSpecSetsRequest request = ListAnnotationSpecSetsRequest.newBuilder()
     .setParent(formattedParent)
     .build();
   while (true) {
     ListAnnotationSpecSetsResponse response = dataLabelingServiceClient.listAnnotationSpecSetsCallable().call(request);
     for (AnnotationSpecSet element : response.getAnnotationSpecSetsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

deleteAnnotationSpecSet

public final void deleteAnnotationSpecSet(String name)

Deletes an annotation spec set by resource name.

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedName = DataLabelingServiceClient.formatAnnotationSpecSetName("[PROJECT]", "[ANNOTATION_SPEC_SET]");
   dataLabelingServiceClient.deleteAnnotationSpecSet(formattedName);
 }

Parameters:: name - Required. AnnotationSpec resource name, format: `projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}`.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

deleteAnnotationSpecSet

public final void deleteAnnotationSpecSet(DeleteAnnotationSpecSetRequest request)

Deletes an annotation spec set by resource name.

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedName = DataLabelingServiceClient.formatAnnotationSpecSetName("[PROJECT]", "[ANNOTATION_SPEC_SET]");
   DeleteAnnotationSpecSetRequest request = DeleteAnnotationSpecSetRequest.newBuilder()
     .setName(formattedName)
     .build();
   dataLabelingServiceClient.deleteAnnotationSpecSet(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

deleteAnnotationSpecSetCallable

public final com.google.api.gax.rpc.UnaryCallable<DeleteAnnotationSpecSetRequest,Empty> deleteAnnotationSpecSetCallable()

Deletes an annotation spec set by resource name.

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedName = DataLabelingServiceClient.formatAnnotationSpecSetName("[PROJECT]", "[ANNOTATION_SPEC_SET]");
   DeleteAnnotationSpecSetRequest request = DeleteAnnotationSpecSetRequest.newBuilder()
     .setName(formattedName)
     .build();
   ApiFuture<Void> future = dataLabelingServiceClient.deleteAnnotationSpecSetCallable().futureCall(request);
   // Do something
   future.get();
 }

createInstructionAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final com.google.api.gax.longrunning.OperationFuture<Instruction,CreateInstructionMetadata> createInstructionAsync(String parent,
                                                                                                                                                                                                                                    Instruction instruction)

Creates an instruction for how data should be labeled.

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedParent = DataLabelingServiceClient.formatProjectName("[PROJECT]");
   Instruction instruction = Instruction.newBuilder().build();
   Instruction response = dataLabelingServiceClient.createInstructionAsync(formattedParent, instruction).get();
 }

Parameters:: parent - Required. Instruction resource parent, format: projects/{project_id}; instruction - Required. Instruction of how to perform the labeling task.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

createInstructionAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final com.google.api.gax.longrunning.OperationFuture<Instruction,CreateInstructionMetadata> createInstructionAsync(CreateInstructionRequest request)

Creates an instruction for how data should be labeled.

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedParent = DataLabelingServiceClient.formatProjectName("[PROJECT]");
   Instruction instruction = Instruction.newBuilder().build();
   CreateInstructionRequest request = CreateInstructionRequest.newBuilder()
     .setParent(formattedParent)
     .setInstruction(instruction)
     .build();
   Instruction response = dataLabelingServiceClient.createInstructionAsync(request).get();
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

createInstructionOperationCallable

@BetaApi(value="The surface for use by generated code is not stable yet and may change in the future.")
public final com.google.api.gax.rpc.OperationCallable<CreateInstructionRequest,Instruction,CreateInstructionMetadata> createInstructionOperationCallable()

Creates an instruction for how data should be labeled.

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedParent = DataLabelingServiceClient.formatProjectName("[PROJECT]");
   Instruction instruction = Instruction.newBuilder().build();
   CreateInstructionRequest request = CreateInstructionRequest.newBuilder()
     .setParent(formattedParent)
     .setInstruction(instruction)
     .build();
   OperationFuture<Instruction, CreateInstructionMetadata> future = dataLabelingServiceClient.createInstructionOperationCallable().futureCall(request);
   // Do something
   Instruction response = future.get();
 }

createInstructionCallable

public final com.google.api.gax.rpc.UnaryCallable<CreateInstructionRequest,com.google.longrunning.Operation> createInstructionCallable()

Creates an instruction for how data should be labeled.

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedParent = DataLabelingServiceClient.formatProjectName("[PROJECT]");
   Instruction instruction = Instruction.newBuilder().build();
   CreateInstructionRequest request = CreateInstructionRequest.newBuilder()
     .setParent(formattedParent)
     .setInstruction(instruction)
     .build();
   ApiFuture<Operation> future = dataLabelingServiceClient.createInstructionCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }

getInstruction

public final Instruction getInstruction(String name)

Gets an instruction by resource name.

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedName = DataLabelingServiceClient.formatInstructionName("[PROJECT]", "[INSTRUCTION]");
   Instruction response = dataLabelingServiceClient.getInstruction(formattedName);
 }

Parameters:: name - Required. Instruction resource name, format: projects/{project_id}/instructions/{instruction_id}
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getInstruction

public final Instruction getInstruction(GetInstructionRequest request)

Gets an instruction by resource name.

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedName = DataLabelingServiceClient.formatInstructionName("[PROJECT]", "[INSTRUCTION]");
   GetInstructionRequest request = GetInstructionRequest.newBuilder()
     .setName(formattedName)
     .build();
   Instruction response = dataLabelingServiceClient.getInstruction(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getInstructionCallable

public final com.google.api.gax.rpc.UnaryCallable<GetInstructionRequest,Instruction> getInstructionCallable()

Gets an instruction by resource name.

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedName = DataLabelingServiceClient.formatInstructionName("[PROJECT]", "[INSTRUCTION]");
   GetInstructionRequest request = GetInstructionRequest.newBuilder()
     .setName(formattedName)
     .build();
   ApiFuture<Instruction> future = dataLabelingServiceClient.getInstructionCallable().futureCall(request);
   // Do something
   Instruction response = future.get();
 }

listInstructions

public final DataLabelingServiceClient.ListInstructionsPagedResponse listInstructions(String parent,
                                                                                      String filter)

Lists instructions for a project. Pagination is supported.

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedParent = DataLabelingServiceClient.formatProjectName("[PROJECT]");
   String filter = "";
   for (Instruction element : dataLabelingServiceClient.listInstructions(formattedParent, filter).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: parent - Required. Instruction resource parent, format: projects/{project_id}; filter - Optional. Filter is not supported at this moment.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listInstructions

public final DataLabelingServiceClient.ListInstructionsPagedResponse listInstructions(ListInstructionsRequest request)

Lists instructions for a project. Pagination is supported.

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedParent = DataLabelingServiceClient.formatProjectName("[PROJECT]");
   ListInstructionsRequest request = ListInstructionsRequest.newBuilder()
     .setParent(formattedParent)
     .build();
   for (Instruction element : dataLabelingServiceClient.listInstructions(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listInstructionsPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListInstructionsRequest,DataLabelingServiceClient.ListInstructionsPagedResponse> listInstructionsPagedCallable()

Lists instructions for a project. Pagination is supported.

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedParent = DataLabelingServiceClient.formatProjectName("[PROJECT]");
   ListInstructionsRequest request = ListInstructionsRequest.newBuilder()
     .setParent(formattedParent)
     .build();
   ApiFuture<ListInstructionsPagedResponse> future = dataLabelingServiceClient.listInstructionsPagedCallable().futureCall(request);
   // Do something
   for (Instruction element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

listInstructionsCallable

public final com.google.api.gax.rpc.UnaryCallable<ListInstructionsRequest,ListInstructionsResponse> listInstructionsCallable()

Lists instructions for a project. Pagination is supported.

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedParent = DataLabelingServiceClient.formatProjectName("[PROJECT]");
   ListInstructionsRequest request = ListInstructionsRequest.newBuilder()
     .setParent(formattedParent)
     .build();
   while (true) {
     ListInstructionsResponse response = dataLabelingServiceClient.listInstructionsCallable().call(request);
     for (Instruction element : response.getInstructionsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

deleteInstruction

public final void deleteInstruction(String name)

Deletes an instruction object by resource name.

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedName = DataLabelingServiceClient.formatInstructionName("[PROJECT]", "[INSTRUCTION]");
   dataLabelingServiceClient.deleteInstruction(formattedName);
 }

Parameters:: name - Required. Instruction resource name, format: projects/{project_id}/instructions/{instruction_id}
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

deleteInstruction

public final void deleteInstruction(DeleteInstructionRequest request)

Deletes an instruction object by resource name.

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedName = DataLabelingServiceClient.formatInstructionName("[PROJECT]", "[INSTRUCTION]");
   DeleteInstructionRequest request = DeleteInstructionRequest.newBuilder()
     .setName(formattedName)
     .build();
   dataLabelingServiceClient.deleteInstruction(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

deleteInstructionCallable

public final com.google.api.gax.rpc.UnaryCallable<DeleteInstructionRequest,Empty> deleteInstructionCallable()

Deletes an instruction object by resource name.

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedName = DataLabelingServiceClient.formatInstructionName("[PROJECT]", "[INSTRUCTION]");
   DeleteInstructionRequest request = DeleteInstructionRequest.newBuilder()
     .setName(formattedName)
     .build();
   ApiFuture<Void> future = dataLabelingServiceClient.deleteInstructionCallable().futureCall(request);
   // Do something
   future.get();
 }

getEvaluation

public final Evaluation getEvaluation(String name)

Gets an evaluation by resource name.

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedName = DataLabelingServiceClient.formatEvaluationName("[PROJECT]", "[DATASET]", "[EVALUATION]");
   Evaluation response = dataLabelingServiceClient.getEvaluation(formattedName);
 }

Parameters:: name - Required. Name of the evaluation. Format: 'projects/{project_id}/datasets/{dataset_id}/evaluations/{evaluation_id}'
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getEvaluation

public final Evaluation getEvaluation(GetEvaluationRequest request)

Gets an evaluation by resource name.

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedName = DataLabelingServiceClient.formatEvaluationName("[PROJECT]", "[DATASET]", "[EVALUATION]");
   GetEvaluationRequest request = GetEvaluationRequest.newBuilder()
     .setName(formattedName)
     .build();
   Evaluation response = dataLabelingServiceClient.getEvaluation(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getEvaluationCallable

public final com.google.api.gax.rpc.UnaryCallable<GetEvaluationRequest,Evaluation> getEvaluationCallable()

Gets an evaluation by resource name.

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedName = DataLabelingServiceClient.formatEvaluationName("[PROJECT]", "[DATASET]", "[EVALUATION]");
   GetEvaluationRequest request = GetEvaluationRequest.newBuilder()
     .setName(formattedName)
     .build();
   ApiFuture<Evaluation> future = dataLabelingServiceClient.getEvaluationCallable().futureCall(request);
   // Do something
   Evaluation response = future.get();
 }

searchEvaluations

public final DataLabelingServiceClient.SearchEvaluationsPagedResponse searchEvaluations(String parent,
                                                                                        String filter)

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

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedParent = DataLabelingServiceClient.formatProjectName("[PROJECT]");
   String filter = "";
   for (Evaluation element : dataLabelingServiceClient.searchEvaluations(formattedParent, filter).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: parent - Required. Evaluation search parent. Format: projects/{project_id}; filter - Optional. Support filtering by model id, job state, start and end time. Format: "evaluation_job.evaluation_job_id = {evaluation_job_id} AND evaluation_job.evaluation_job_run_time_start = {timestamp} AND evaluation_job.evaluation_job_run_time_end = {timestamp} AND annotation_spec.display_name = {display_name}"
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

searchEvaluations

public final DataLabelingServiceClient.SearchEvaluationsPagedResponse searchEvaluations(SearchEvaluationsRequest request)

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

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedParent = DataLabelingServiceClient.formatProjectName("[PROJECT]");
   String filter = "";
   SearchEvaluationsRequest request = SearchEvaluationsRequest.newBuilder()
     .setParent(formattedParent)
     .setFilter(filter)
     .build();
   for (Evaluation element : dataLabelingServiceClient.searchEvaluations(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

searchEvaluationsPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<SearchEvaluationsRequest,DataLabelingServiceClient.SearchEvaluationsPagedResponse> searchEvaluationsPagedCallable()

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

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedParent = DataLabelingServiceClient.formatProjectName("[PROJECT]");
   String filter = "";
   SearchEvaluationsRequest request = SearchEvaluationsRequest.newBuilder()
     .setParent(formattedParent)
     .setFilter(filter)
     .build();
   ApiFuture<SearchEvaluationsPagedResponse> future = dataLabelingServiceClient.searchEvaluationsPagedCallable().futureCall(request);
   // Do something
   for (Evaluation element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

searchEvaluationsCallable

public final com.google.api.gax.rpc.UnaryCallable<SearchEvaluationsRequest,SearchEvaluationsResponse> searchEvaluationsCallable()

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

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedParent = DataLabelingServiceClient.formatProjectName("[PROJECT]");
   String filter = "";
   SearchEvaluationsRequest request = SearchEvaluationsRequest.newBuilder()
     .setParent(formattedParent)
     .setFilter(filter)
     .build();
   while (true) {
     SearchEvaluationsResponse response = dataLabelingServiceClient.searchEvaluationsCallable().call(request);
     for (Evaluation element : response.getEvaluationsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

searchExampleComparisons

public final DataLabelingServiceClient.SearchExampleComparisonsPagedResponse searchExampleComparisons(String parent)

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.

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedParent = DataLabelingServiceClient.formatEvaluationName("[PROJECT]", "[DATASET]", "[EVALUATION]");
   for (SearchExampleComparisonsResponse.ExampleComparison element : dataLabelingServiceClient.searchExampleComparisons(formattedParent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: parent - Required. Name of the Evaluation resource to search example comparison from. Format: projects/{project_id}/datasets/{dataset_id}/evaluations/{evaluation_id}
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

searchExampleComparisons

public final DataLabelingServiceClient.SearchExampleComparisonsPagedResponse 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.

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedParent = DataLabelingServiceClient.formatEvaluationName("[PROJECT]", "[DATASET]", "[EVALUATION]");
   SearchExampleComparisonsRequest request = SearchExampleComparisonsRequest.newBuilder()
     .setParent(formattedParent)
     .build();
   for (SearchExampleComparisonsResponse.ExampleComparison element : dataLabelingServiceClient.searchExampleComparisons(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

searchExampleComparisonsPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<SearchExampleComparisonsRequest,DataLabelingServiceClient.SearchExampleComparisonsPagedResponse> searchExampleComparisonsPagedCallable()

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.

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedParent = DataLabelingServiceClient.formatEvaluationName("[PROJECT]", "[DATASET]", "[EVALUATION]");
   SearchExampleComparisonsRequest request = SearchExampleComparisonsRequest.newBuilder()
     .setParent(formattedParent)
     .build();
   ApiFuture<SearchExampleComparisonsPagedResponse> future = dataLabelingServiceClient.searchExampleComparisonsPagedCallable().futureCall(request);
   // Do something
   for (SearchExampleComparisonsResponse.ExampleComparison element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

searchExampleComparisonsCallable

public final com.google.api.gax.rpc.UnaryCallable<SearchExampleComparisonsRequest,SearchExampleComparisonsResponse> searchExampleComparisonsCallable()

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.

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedParent = DataLabelingServiceClient.formatEvaluationName("[PROJECT]", "[DATASET]", "[EVALUATION]");
   SearchExampleComparisonsRequest request = SearchExampleComparisonsRequest.newBuilder()
     .setParent(formattedParent)
     .build();
   while (true) {
     SearchExampleComparisonsResponse response = dataLabelingServiceClient.searchExampleComparisonsCallable().call(request);
     for (SearchExampleComparisonsResponse.ExampleComparison element : response.getExampleComparisonsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

createEvaluationJob

public final EvaluationJob createEvaluationJob(String parent,
                                               EvaluationJob job)

Creates an evaluation job.

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedParent = DataLabelingServiceClient.formatProjectName("[PROJECT]");
   EvaluationJob job = EvaluationJob.newBuilder().build();
   EvaluationJob response = dataLabelingServiceClient.createEvaluationJob(formattedParent, job);
 }

Parameters:: parent - Required. Evaluation job resource parent, format: projects/{project_id}.; job - Required. The evaluation job to create.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

createEvaluationJob

public final EvaluationJob createEvaluationJob(CreateEvaluationJobRequest request)

Creates an evaluation job.

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedParent = DataLabelingServiceClient.formatProjectName("[PROJECT]");
   EvaluationJob job = EvaluationJob.newBuilder().build();
   CreateEvaluationJobRequest request = CreateEvaluationJobRequest.newBuilder()
     .setParent(formattedParent)
     .setJob(job)
     .build();
   EvaluationJob response = dataLabelingServiceClient.createEvaluationJob(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

createEvaluationJobCallable

public final com.google.api.gax.rpc.UnaryCallable<CreateEvaluationJobRequest,EvaluationJob> createEvaluationJobCallable()

Creates an evaluation job.

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedParent = DataLabelingServiceClient.formatProjectName("[PROJECT]");
   EvaluationJob job = EvaluationJob.newBuilder().build();
   CreateEvaluationJobRequest request = CreateEvaluationJobRequest.newBuilder()
     .setParent(formattedParent)
     .setJob(job)
     .build();
   ApiFuture<EvaluationJob> future = dataLabelingServiceClient.createEvaluationJobCallable().futureCall(request);
   // Do something
   EvaluationJob response = future.get();
 }

updateEvaluationJob

public final EvaluationJob updateEvaluationJob(EvaluationJob evaluationJob,
                                               FieldMask updateMask)

Updates an evaluation job.

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   EvaluationJob evaluationJob = EvaluationJob.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   EvaluationJob response = dataLabelingServiceClient.updateEvaluationJob(evaluationJob, updateMask);
 }

Parameters:: evaluationJob - Required. Evaluation job that is going to be updated.; updateMask - Optional. Mask for which field in evaluation_job should be updated.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

updateEvaluationJob

public final EvaluationJob updateEvaluationJob(UpdateEvaluationJobRequest request)

Updates an evaluation job.

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   EvaluationJob evaluationJob = EvaluationJob.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   UpdateEvaluationJobRequest request = UpdateEvaluationJobRequest.newBuilder()
     .setEvaluationJob(evaluationJob)
     .setUpdateMask(updateMask)
     .build();
   EvaluationJob response = dataLabelingServiceClient.updateEvaluationJob(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

updateEvaluationJobCallable

public final com.google.api.gax.rpc.UnaryCallable<UpdateEvaluationJobRequest,EvaluationJob> updateEvaluationJobCallable()

Updates an evaluation job.

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   EvaluationJob evaluationJob = EvaluationJob.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   UpdateEvaluationJobRequest request = UpdateEvaluationJobRequest.newBuilder()
     .setEvaluationJob(evaluationJob)
     .setUpdateMask(updateMask)
     .build();
   ApiFuture<EvaluationJob> future = dataLabelingServiceClient.updateEvaluationJobCallable().futureCall(request);
   // Do something
   EvaluationJob response = future.get();
 }

getEvaluationJob

public final EvaluationJob getEvaluationJob(String name)

Gets an evaluation job by resource name.

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedName = DataLabelingServiceClient.formatEvaluationJobName("[PROJECT]", "[EVALUATION_JOB]");
   EvaluationJob response = dataLabelingServiceClient.getEvaluationJob(formattedName);
 }

Parameters:: name - Required. Name of the evaluation job. Format: 'projects/{project_id}/evaluationJobs/{evaluation_job_id}'
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getEvaluationJob

public final EvaluationJob getEvaluationJob(GetEvaluationJobRequest request)

Gets an evaluation job by resource name.

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedName = DataLabelingServiceClient.formatEvaluationJobName("[PROJECT]", "[EVALUATION_JOB]");
   GetEvaluationJobRequest request = GetEvaluationJobRequest.newBuilder()
     .setName(formattedName)
     .build();
   EvaluationJob response = dataLabelingServiceClient.getEvaluationJob(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getEvaluationJobCallable

public final com.google.api.gax.rpc.UnaryCallable<GetEvaluationJobRequest,EvaluationJob> getEvaluationJobCallable()

Gets an evaluation job by resource name.

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedName = DataLabelingServiceClient.formatEvaluationJobName("[PROJECT]", "[EVALUATION_JOB]");
   GetEvaluationJobRequest request = GetEvaluationJobRequest.newBuilder()
     .setName(formattedName)
     .build();
   ApiFuture<EvaluationJob> future = dataLabelingServiceClient.getEvaluationJobCallable().futureCall(request);
   // Do something
   EvaluationJob response = future.get();
 }

pauseEvaluationJob
```
public final void pauseEvaluationJob(String name)
```
Pauses an evaluation job. Pausing a evaluation job that is already in PAUSED state will be a no-op.
Sample code:
```
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedName = DataLabelingServiceClient.formatEvaluationJobName("[PROJECT]", "[EVALUATION_JOB]");
   dataLabelingServiceClient.pauseEvaluationJob(formattedName);
 }
 
```
Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

pauseEvaluationJob

public final void pauseEvaluationJob(PauseEvaluationJobRequest request)

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

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedName = DataLabelingServiceClient.formatEvaluationJobName("[PROJECT]", "[EVALUATION_JOB]");
   PauseEvaluationJobRequest request = PauseEvaluationJobRequest.newBuilder()
     .setName(formattedName)
     .build();
   dataLabelingServiceClient.pauseEvaluationJob(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

pauseEvaluationJobCallable

public final com.google.api.gax.rpc.UnaryCallable<PauseEvaluationJobRequest,Empty> pauseEvaluationJobCallable()

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

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedName = DataLabelingServiceClient.formatEvaluationJobName("[PROJECT]", "[EVALUATION_JOB]");
   PauseEvaluationJobRequest request = PauseEvaluationJobRequest.newBuilder()
     .setName(formattedName)
     .build();
   ApiFuture<Void> future = dataLabelingServiceClient.pauseEvaluationJobCallable().futureCall(request);
   // Do something
   future.get();
 }

resumeEvaluationJob
```
public final void resumeEvaluationJob(String name)
```
Resumes a paused evaluation job. Deleted evaluation job can't be resumed. Resuming a running evaluation job will be a no-op.
Sample code:
```
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedName = DataLabelingServiceClient.formatEvaluationJobName("[PROJECT]", "[EVALUATION_JOB]");
   dataLabelingServiceClient.resumeEvaluationJob(formattedName);
 }
 
```
Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

resumeEvaluationJob

public final void 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.

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedName = DataLabelingServiceClient.formatEvaluationJobName("[PROJECT]", "[EVALUATION_JOB]");
   ResumeEvaluationJobRequest request = ResumeEvaluationJobRequest.newBuilder()
     .setName(formattedName)
     .build();
   dataLabelingServiceClient.resumeEvaluationJob(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

resumeEvaluationJobCallable

public final com.google.api.gax.rpc.UnaryCallable<ResumeEvaluationJobRequest,Empty> resumeEvaluationJobCallable()

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

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedName = DataLabelingServiceClient.formatEvaluationJobName("[PROJECT]", "[EVALUATION_JOB]");
   ResumeEvaluationJobRequest request = ResumeEvaluationJobRequest.newBuilder()
     .setName(formattedName)
     .build();
   ApiFuture<Void> future = dataLabelingServiceClient.resumeEvaluationJobCallable().futureCall(request);
   // Do something
   future.get();
 }

deleteEvaluationJob

public final void deleteEvaluationJob(String name)

Stops and deletes an evaluation job.

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedName = DataLabelingServiceClient.formatEvaluationJobName("[PROJECT]", "[EVALUATION_JOB]");
   dataLabelingServiceClient.deleteEvaluationJob(formattedName);
 }

Parameters:: name - Required. Name of the evaluation job that is going to be deleted. Format: 'projects/{project_id}/evaluationJobs/{evaluation_job_id}'
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

deleteEvaluationJob

public final void deleteEvaluationJob(DeleteEvaluationJobRequest request)

Stops and deletes an evaluation job.

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedName = DataLabelingServiceClient.formatEvaluationJobName("[PROJECT]", "[EVALUATION_JOB]");
   DeleteEvaluationJobRequest request = DeleteEvaluationJobRequest.newBuilder()
     .setName(formattedName)
     .build();
   dataLabelingServiceClient.deleteEvaluationJob(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

deleteEvaluationJobCallable

public final com.google.api.gax.rpc.UnaryCallable<DeleteEvaluationJobRequest,Empty> deleteEvaluationJobCallable()

Stops and deletes an evaluation job.

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedName = DataLabelingServiceClient.formatEvaluationJobName("[PROJECT]", "[EVALUATION_JOB]");
   DeleteEvaluationJobRequest request = DeleteEvaluationJobRequest.newBuilder()
     .setName(formattedName)
     .build();
   ApiFuture<Void> future = dataLabelingServiceClient.deleteEvaluationJobCallable().futureCall(request);
   // Do something
   future.get();
 }

listEvaluationJobs

public final DataLabelingServiceClient.ListEvaluationJobsPagedResponse listEvaluationJobs(String parent,
                                                                                          String filter)

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

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedParent = DataLabelingServiceClient.formatProjectName("[PROJECT]");
   String filter = "";
   for (EvaluationJob element : dataLabelingServiceClient.listEvaluationJobs(formattedParent, filter).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: parent - Required. Evaluation resource parent. Format: "projects/{project_id}"; filter - Optional. Only support filter by model id and job state. Format: "evaluation_job.model_id = {model_id} AND evaluation_job.state = {EvaluationJob::State}"
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listEvaluationJobs

public final DataLabelingServiceClient.ListEvaluationJobsPagedResponse listEvaluationJobs(ListEvaluationJobsRequest request)

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

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedParent = DataLabelingServiceClient.formatProjectName("[PROJECT]");
   String filter = "";
   ListEvaluationJobsRequest request = ListEvaluationJobsRequest.newBuilder()
     .setParent(formattedParent)
     .setFilter(filter)
     .build();
   for (EvaluationJob element : dataLabelingServiceClient.listEvaluationJobs(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listEvaluationJobsPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListEvaluationJobsRequest,DataLabelingServiceClient.ListEvaluationJobsPagedResponse> listEvaluationJobsPagedCallable()

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

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedParent = DataLabelingServiceClient.formatProjectName("[PROJECT]");
   String filter = "";
   ListEvaluationJobsRequest request = ListEvaluationJobsRequest.newBuilder()
     .setParent(formattedParent)
     .setFilter(filter)
     .build();
   ApiFuture<ListEvaluationJobsPagedResponse> future = dataLabelingServiceClient.listEvaluationJobsPagedCallable().futureCall(request);
   // Do something
   for (EvaluationJob element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

listEvaluationJobsCallable

public final com.google.api.gax.rpc.UnaryCallable<ListEvaluationJobsRequest,ListEvaluationJobsResponse> listEvaluationJobsCallable()

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

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String formattedParent = DataLabelingServiceClient.formatProjectName("[PROJECT]");
   String filter = "";
   ListEvaluationJobsRequest request = ListEvaluationJobsRequest.newBuilder()
     .setParent(formattedParent)
     .setFilter(filter)
     .build();
   while (true) {
     ListEvaluationJobsResponse response = dataLabelingServiceClient.listEvaluationJobsCallable().call(request);
     for (EvaluationJob element : response.getEvaluationJobsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

deleteAnnotatedDataset

public final void deleteAnnotatedDataset(DeleteAnnotatedDatasetRequest request)

Deletes an annotated dataset by resource name.

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   DeleteAnnotatedDatasetRequest request = DeleteAnnotatedDatasetRequest.newBuilder().build();
   dataLabelingServiceClient.deleteAnnotatedDataset(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

deleteAnnotatedDatasetCallable

public final com.google.api.gax.rpc.UnaryCallable<DeleteAnnotatedDatasetRequest,Empty> deleteAnnotatedDatasetCallable()

Deletes an annotated dataset by resource name.

Sample code:


 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   DeleteAnnotatedDatasetRequest request = DeleteAnnotatedDatasetRequest.newBuilder().build();
   ApiFuture<Void> future = dataLabelingServiceClient.deleteAnnotatedDatasetCallable().futureCall(request);
   // Do something
   future.get();
 }

close
```
public final void close()
```
Specified by:

close in interface AutoCloseable

shutdown
```
public void shutdown()
```
Specified by:

shutdown in interface com.google.api.gax.core.BackgroundResource

isShutdown
```
public boolean isShutdown()
```
Specified by:

isShutdown in interface com.google.api.gax.core.BackgroundResource

isTerminated
```
public boolean isTerminated()
```
Specified by:

isTerminated in interface com.google.api.gax.core.BackgroundResource

shutdownNow
```
public void shutdownNow()
```
Specified by:

shutdownNow in interface com.google.api.gax.core.BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:: awaitTermination in interface com.google.api.gax.core.BackgroundResource
Throws:: InterruptedException

Class DataLabelingServiceClient

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DataLabelingServiceClient

DataLabelingServiceClient

Method Detail

formatAnnotatedDatasetName

formatAnnotationSpecSetName

formatDataItemName

formatDatasetName

formatEvaluationName

formatEvaluationJobName

formatExampleName

formatInstructionName

formatProjectName

parseProjectFromAnnotatedDatasetName

parseDatasetFromAnnotatedDatasetName

parseAnnotatedDatasetFromAnnotatedDatasetName

parseProjectFromAnnotationSpecSetName

parseAnnotationSpecSetFromAnnotationSpecSetName

parseProjectFromDataItemName

parseDatasetFromDataItemName

parseDataItemFromDataItemName

parseProjectFromDatasetName

parseDatasetFromDatasetName

parseProjectFromEvaluationName

parseDatasetFromEvaluationName

parseEvaluationFromEvaluationName

parseProjectFromEvaluationJobName

parseEvaluationJobFromEvaluationJobName

parseProjectFromExampleName

parseDatasetFromExampleName

parseAnnotatedDatasetFromExampleName

parseExampleFromExampleName

parseProjectFromInstructionName

parseInstructionFromInstructionName

parseProjectFromProjectName

create

create

create

getSettings

getStub

getOperationsClient

createDataset

createDataset

createDatasetCallable

getDataset

getDataset

getDatasetCallable

listDatasets

listDatasets

listDatasetsPagedCallable

listDatasetsCallable

deleteDataset

deleteDataset

deleteDatasetCallable

importDataAsync

importDataAsync

importDataOperationCallable

importDataCallable

exportDataAsync

exportDataAsync

exportDataOperationCallable

exportDataCallable

getDataItem

getDataItem

getDataItemCallable

listDataItems

listDataItems

listDataItemsPagedCallable

listDataItemsCallable

getAnnotatedDataset

getAnnotatedDataset

getAnnotatedDatasetCallable

listAnnotatedDatasets

listAnnotatedDatasets

listAnnotatedDatasetsPagedCallable