Class DataLabelingServiceClient (0.172.0)

GitHub RepositoryProduct ReferenceREST DocumentationRPC Documentation

Service Description: Service for the AI Platform Data Labeling API.

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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   Dataset dataset = Dataset.newBuilder().build();
   Dataset response = dataLabelingServiceClient.createDataset(parent, 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().

Methods
Method Description Method Variants

CreateDataset

Creates dataset. If success return a Dataset resource.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createDataset(CreateDatasetRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • createDataset(ProjectName parent, Dataset dataset)

  • createDataset(String parent, Dataset dataset)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createDatasetCallable()

GetDataset

Gets dataset by resource name.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getDataset(GetDatasetRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getDataset(DatasetName name)

  • getDataset(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getDatasetCallable()

ListDatasets

Lists datasets under a project. Pagination is supported.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listDatasets(ListDatasetsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listDatasets(ProjectName parent, String filter)

  • listDatasets(String parent, String filter)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listDatasetsPagedCallable()

  • listDatasetsCallable()

DeleteDataset

Deletes a dataset by resource name.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteDataset(DeleteDatasetRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • deleteDataset(DatasetName name)

  • deleteDataset(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteDatasetCallable()

ImportData

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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • importDataAsync(ImportDataRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • importDataAsync(DatasetName name, InputConfig inputConfig)

  • importDataAsync(String name, InputConfig inputConfig)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • importDataOperationCallable()

  • importDataCallable()

ExportData

Exports data and annotations from dataset.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • exportDataAsync(ExportDataRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • exportDataAsync(DatasetName name, AnnotatedDatasetName annotatedDataset, String filter, OutputConfig outputConfig)

  • exportDataAsync(DatasetName name, String annotatedDataset, String filter, OutputConfig outputConfig)

  • exportDataAsync(String name, AnnotatedDatasetName annotatedDataset, String filter, OutputConfig outputConfig)

  • exportDataAsync(String name, String annotatedDataset, String filter, OutputConfig outputConfig)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • exportDataOperationCallable()

  • exportDataCallable()

GetDataItem

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getDataItem(GetDataItemRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getDataItem(DataItemName name)

  • getDataItem(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getDataItemCallable()

ListDataItems

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listDataItems(ListDataItemsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listDataItems(DatasetName parent, String filter)

  • listDataItems(String parent, String filter)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listDataItemsPagedCallable()

  • listDataItemsCallable()

GetAnnotatedDataset

Gets an annotated dataset by resource name.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getAnnotatedDataset(GetAnnotatedDatasetRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getAnnotatedDataset(AnnotatedDatasetName name)

  • getAnnotatedDataset(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getAnnotatedDatasetCallable()

ListAnnotatedDatasets

Lists annotated datasets for a dataset. Pagination is supported.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listAnnotatedDatasets(ListAnnotatedDatasetsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listAnnotatedDatasets(DatasetName parent, String filter)

  • listAnnotatedDatasets(String parent, String filter)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listAnnotatedDatasetsPagedCallable()

  • listAnnotatedDatasetsCallable()

DeleteAnnotatedDataset

Deletes an annotated dataset by resource name.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteAnnotatedDataset(DeleteAnnotatedDatasetRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteAnnotatedDatasetCallable()

LabelImage

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • labelImageAsync(LabelImageRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • labelImageAsync(DatasetName parent, HumanAnnotationConfig basicConfig, LabelImageRequest.Feature feature)

  • labelImageAsync(String parent, HumanAnnotationConfig basicConfig, LabelImageRequest.Feature feature)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • labelImageOperationCallable()

  • labelImageCallable()

LabelVideo

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • labelVideoAsync(LabelVideoRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • labelVideoAsync(DatasetName parent, HumanAnnotationConfig basicConfig, LabelVideoRequest.Feature feature)

  • labelVideoAsync(String parent, HumanAnnotationConfig basicConfig, LabelVideoRequest.Feature feature)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • labelVideoOperationCallable()

  • labelVideoCallable()

LabelText

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • labelTextAsync(LabelTextRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • labelTextAsync(DatasetName parent, HumanAnnotationConfig basicConfig, LabelTextRequest.Feature feature)

  • labelTextAsync(String parent, HumanAnnotationConfig basicConfig, LabelTextRequest.Feature feature)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • labelTextOperationCallable()

  • labelTextCallable()

GetExample

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getExample(GetExampleRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getExample(ExampleName name, String filter)

  • getExample(String name, String filter)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getExampleCallable()

ListExamples

Lists examples in an annotated dataset. Pagination is supported.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listExamples(ListExamplesRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listExamples(AnnotatedDatasetName parent, String filter)

  • listExamples(String parent, String filter)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listExamplesPagedCallable()

  • listExamplesCallable()

CreateAnnotationSpecSet

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createAnnotationSpecSet(CreateAnnotationSpecSetRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • createAnnotationSpecSet(ProjectName parent, AnnotationSpecSet annotationSpecSet)

  • createAnnotationSpecSet(String parent, AnnotationSpecSet annotationSpecSet)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createAnnotationSpecSetCallable()

GetAnnotationSpecSet

Gets an annotation spec set by resource name.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getAnnotationSpecSet(GetAnnotationSpecSetRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getAnnotationSpecSet(AnnotationSpecSetName name)

  • getAnnotationSpecSet(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getAnnotationSpecSetCallable()

ListAnnotationSpecSets

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listAnnotationSpecSets(ListAnnotationSpecSetsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listAnnotationSpecSets(ProjectName parent, String filter)

  • listAnnotationSpecSets(String parent, String filter)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listAnnotationSpecSetsPagedCallable()

  • listAnnotationSpecSetsCallable()

DeleteAnnotationSpecSet

Deletes an annotation spec set by resource name.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteAnnotationSpecSet(DeleteAnnotationSpecSetRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • deleteAnnotationSpecSet(AnnotationSpecSetName name)

  • deleteAnnotationSpecSet(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteAnnotationSpecSetCallable()

CreateInstruction

Creates an instruction for how data should be labeled.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createInstructionAsync(CreateInstructionRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • createInstructionAsync(ProjectName parent, Instruction instruction)

  • createInstructionAsync(String parent, Instruction instruction)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createInstructionOperationCallable()

  • createInstructionCallable()

GetInstruction

Gets an instruction by resource name.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getInstruction(GetInstructionRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getInstruction(InstructionName name)

  • getInstruction(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getInstructionCallable()

ListInstructions

Lists instructions for a project. Pagination is supported.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listInstructions(ListInstructionsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listInstructions(ProjectName parent, String filter)

  • listInstructions(String parent, String filter)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listInstructionsPagedCallable()

  • listInstructionsCallable()

DeleteInstruction

Deletes an instruction object by resource name.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteInstruction(DeleteInstructionRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • deleteInstruction(InstructionName name)

  • deleteInstruction(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteInstructionCallable()

GetEvaluation

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getEvaluation(GetEvaluationRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getEvaluation(EvaluationName name)

  • getEvaluation(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getEvaluationCallable()

SearchEvaluations

Searches evaluations within a project.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • searchEvaluations(SearchEvaluationsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • searchEvaluations(EvaluationName parent, String filter)

  • searchEvaluations(String parent, String filter)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • searchEvaluationsPagedCallable()

  • searchEvaluationsCallable()

SearchExampleComparisons

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • searchExampleComparisons(SearchExampleComparisonsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • searchExampleComparisons(EvaluationName parent)

  • searchExampleComparisons(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • searchExampleComparisonsPagedCallable()

  • searchExampleComparisonsCallable()

CreateEvaluationJob

Creates an evaluation job.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createEvaluationJob(CreateEvaluationJobRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • createEvaluationJob(ProjectName parent, EvaluationJob job)

  • createEvaluationJob(String parent, EvaluationJob job)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createEvaluationJobCallable()

UpdateEvaluationJob

Updates an evaluation job. You can only update certain fields of the job's EvaluationJobConfig: humanAnnotationConfig.instruction, exampleCount, and exampleSamplePercentage.

If you want to change any other aspect of the evaluation job, you must delete the job and create a new one.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateEvaluationJob(UpdateEvaluationJobRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • updateEvaluationJob(EvaluationJob evaluationJob, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateEvaluationJobCallable()

GetEvaluationJob

Gets an evaluation job by resource name.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getEvaluationJob(GetEvaluationJobRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getEvaluationJob(EvaluationJobName name)

  • getEvaluationJob(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getEvaluationJobCallable()

PauseEvaluationJob

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • pauseEvaluationJob(PauseEvaluationJobRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • pauseEvaluationJob(EvaluationJobName name)

  • pauseEvaluationJob(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • pauseEvaluationJobCallable()

ResumeEvaluationJob

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • resumeEvaluationJob(ResumeEvaluationJobRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • resumeEvaluationJob(EvaluationJobName name)

  • resumeEvaluationJob(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • resumeEvaluationJobCallable()

DeleteEvaluationJob

Stops and deletes an evaluation job.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteEvaluationJob(DeleteEvaluationJobRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • deleteEvaluationJob(EvaluationJobName name)

  • deleteEvaluationJob(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteEvaluationJobCallable()

ListEvaluationJobs

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listEvaluationJobs(ListEvaluationJobsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listEvaluationJobs(ProjectName parent, String filter)

  • listEvaluationJobs(String parent, String filter)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listEvaluationJobsPagedCallable()

  • listEvaluationJobsCallable()

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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 DataLabelingServiceSettings dataLabelingServiceSettings =
     DataLabelingServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 DataLabelingServiceClient dataLabelingServiceClient =
     DataLabelingServiceClient.create(dataLabelingServiceSettings);

To customize the endpoint:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 DataLabelingServiceSettings dataLabelingServiceSettings =
     DataLabelingServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 DataLabelingServiceClient dataLabelingServiceClient =
     DataLabelingServiceClient.create(dataLabelingServiceSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

Inheritance

java.lang.Object > DataLabelingServiceClient

Static Methods

create()

public static final DataLabelingServiceClient create()

Constructs an instance of DataLabelingServiceClient with default settings.

Returns
Type Description
DataLabelingServiceClient
Exceptions
Type Description
IOException

create(DataLabelingServiceSettings settings)

public static final DataLabelingServiceClient create(DataLabelingServiceSettings settings)

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.

Parameter
Name Description
settings DataLabelingServiceSettings
Returns
Type Description
DataLabelingServiceClient
Exceptions
Type Description
IOException

create(DataLabelingServiceStub stub)

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 using create(DataLabelingServiceSettings).

Parameter
Name Description
stub DataLabelingServiceStub
Returns
Type Description
DataLabelingServiceClient

Constructors

DataLabelingServiceClient(DataLabelingServiceSettings settings)

protected DataLabelingServiceClient(DataLabelingServiceSettings settings)

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.

Parameter
Name Description
settings DataLabelingServiceSettings

DataLabelingServiceClient(DataLabelingServiceStub stub)

protected DataLabelingServiceClient(DataLabelingServiceStub stub)
Parameter
Name Description
stub DataLabelingServiceStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
Name Description
duration long
unit TimeUnit
Returns
Type Description
boolean
Exceptions
Type Description
InterruptedException

close()

public final void close()

createAnnotationSpecSet(CreateAnnotationSpecSetRequest request)

public final AnnotationSpecSet createAnnotationSpecSet(CreateAnnotationSpecSetRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   CreateAnnotationSpecSetRequest request =
       CreateAnnotationSpecSetRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setAnnotationSpecSet(AnnotationSpecSet.newBuilder().build())
           .build();
   AnnotationSpecSet response = dataLabelingServiceClient.createAnnotationSpecSet(request);
 }
Parameter
Name Description
request CreateAnnotationSpecSetRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
AnnotationSpecSet

createAnnotationSpecSet(ProjectName parent, AnnotationSpecSet annotationSpecSet)

public final AnnotationSpecSet createAnnotationSpecSet(ProjectName parent, AnnotationSpecSet annotationSpecSet)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   AnnotationSpecSet annotationSpecSet = AnnotationSpecSet.newBuilder().build();
   AnnotationSpecSet response =
       dataLabelingServiceClient.createAnnotationSpecSet(parent, annotationSpecSet);
 }
Parameters
Name Description
parent ProjectName

Required. AnnotationSpecSet resource parent, format: projects/{project_id}
annotationSpecSet 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.
Returns
Type Description
AnnotationSpecSet

createAnnotationSpecSet(String parent, AnnotationSpecSet annotationSpecSet)

public final AnnotationSpecSet createAnnotationSpecSet(String parent, AnnotationSpecSet annotationSpecSet)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String parent = ProjectName.of("[PROJECT]").toString();
   AnnotationSpecSet annotationSpecSet = AnnotationSpecSet.newBuilder().build();
   AnnotationSpecSet response =
       dataLabelingServiceClient.createAnnotationSpecSet(parent, annotationSpecSet);
 }
Parameters
Name Description
parent String

Required. AnnotationSpecSet resource parent, format: projects/{project_id}
annotationSpecSet 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.
Returns
Type Description
AnnotationSpecSet

createAnnotationSpecSetCallable()

public final UnaryCallable<CreateAnnotationSpecSetRequest,AnnotationSpecSet> createAnnotationSpecSetCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   CreateAnnotationSpecSetRequest request =
       CreateAnnotationSpecSetRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setAnnotationSpecSet(AnnotationSpecSet.newBuilder().build())
           .build();
   ApiFuture<AnnotationSpecSet> future =
       dataLabelingServiceClient.createAnnotationSpecSetCallable().futureCall(request);
   // Do something.
   AnnotationSpecSet response = future.get();
 }
Returns
Type Description
UnaryCallable<CreateAnnotationSpecSetRequest,AnnotationSpecSet>

createDataset(CreateDatasetRequest request)

public final Dataset createDataset(CreateDatasetRequest request)

Creates dataset. If success return a Dataset resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   CreateDatasetRequest request =
       CreateDatasetRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setDataset(Dataset.newBuilder().build())
           .build();
   Dataset response = dataLabelingServiceClient.createDataset(request);
 }
Parameter
Name Description
request CreateDatasetRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
Dataset

createDataset(ProjectName parent, Dataset dataset)

public final Dataset createDataset(ProjectName parent, Dataset dataset)

Creates dataset. If success return a Dataset resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   Dataset dataset = Dataset.newBuilder().build();
   Dataset response = dataLabelingServiceClient.createDataset(parent, dataset);
 }
Parameters
Name Description
parent ProjectName

Required. Dataset resource parent, format: projects/{project_id}
dataset Dataset

Required. The dataset to be created.
Returns
Type Description
Dataset

createDataset(String parent, Dataset dataset)

public final Dataset createDataset(String parent, Dataset dataset)

Creates dataset. If success return a Dataset resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String parent = ProjectName.of("[PROJECT]").toString();
   Dataset dataset = Dataset.newBuilder().build();
   Dataset response = dataLabelingServiceClient.createDataset(parent, dataset);
 }
Parameters
Name Description
parent String

Required. Dataset resource parent, format: projects/{project_id}
dataset Dataset

Required. The dataset to be created.
Returns
Type Description
Dataset

createDatasetCallable()

public final UnaryCallable<CreateDatasetRequest,Dataset> createDatasetCallable()

Creates dataset. If success return a Dataset resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   CreateDatasetRequest request =
       CreateDatasetRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setDataset(Dataset.newBuilder().build())
           .build();
   ApiFuture<Dataset> future =
       dataLabelingServiceClient.createDatasetCallable().futureCall(request);
   // Do something.
   Dataset response = future.get();
 }
Returns
Type Description
UnaryCallable<CreateDatasetRequest,Dataset>

createEvaluationJob(CreateEvaluationJobRequest request)

public final EvaluationJob createEvaluationJob(CreateEvaluationJobRequest request)

Creates an evaluation job.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   CreateEvaluationJobRequest request =
       CreateEvaluationJobRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setJob(EvaluationJob.newBuilder().build())
           .build();
   EvaluationJob response = dataLabelingServiceClient.createEvaluationJob(request);
 }
Parameter
Name Description
request CreateEvaluationJobRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
EvaluationJob

createEvaluationJob(ProjectName parent, EvaluationJob job)

public final EvaluationJob createEvaluationJob(ProjectName parent, EvaluationJob job)

Creates an evaluation job.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   EvaluationJob job = EvaluationJob.newBuilder().build();
   EvaluationJob response = dataLabelingServiceClient.createEvaluationJob(parent, job);
 }
Parameters
Name Description
parent ProjectName

Required. Evaluation job resource parent. Format: "projects/<var>{project_id}</var>"
job EvaluationJob

Required. The evaluation job to create.
Returns
Type Description
EvaluationJob

createEvaluationJob(String parent, EvaluationJob job)

public final EvaluationJob createEvaluationJob(String parent, EvaluationJob job)

Creates an evaluation job.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String parent = ProjectName.of("[PROJECT]").toString();
   EvaluationJob job = EvaluationJob.newBuilder().build();
   EvaluationJob response = dataLabelingServiceClient.createEvaluationJob(parent, job);
 }
Parameters
Name Description
parent String

Required. Evaluation job resource parent. Format: "projects/<var>{project_id}</var>"
job EvaluationJob

Required. The evaluation job to create.
Returns
Type Description
EvaluationJob

createEvaluationJobCallable()

public final UnaryCallable<CreateEvaluationJobRequest,EvaluationJob> createEvaluationJobCallable()

Creates an evaluation job.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   CreateEvaluationJobRequest request =
       CreateEvaluationJobRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setJob(EvaluationJob.newBuilder().build())
           .build();
   ApiFuture<EvaluationJob> future =
       dataLabelingServiceClient.createEvaluationJobCallable().futureCall(request);
   // Do something.
   EvaluationJob response = future.get();
 }
Returns
Type Description
UnaryCallable<CreateEvaluationJobRequest,EvaluationJob>

createInstructionAsync(CreateInstructionRequest request)

public final OperationFuture<Instruction,CreateInstructionMetadata> createInstructionAsync(CreateInstructionRequest request)

Creates an instruction for how data should be labeled.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   CreateInstructionRequest request =
       CreateInstructionRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setInstruction(Instruction.newBuilder().build())
           .build();
   Instruction response = dataLabelingServiceClient.createInstructionAsync(request).get();
 }
Parameter
Name Description
request CreateInstructionRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<Instruction,CreateInstructionMetadata>

createInstructionAsync(ProjectName parent, Instruction instruction)

public final OperationFuture<Instruction,CreateInstructionMetadata> createInstructionAsync(ProjectName parent, Instruction instruction)

Creates an instruction for how data should be labeled.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   Instruction instruction = Instruction.newBuilder().build();
   Instruction response =
       dataLabelingServiceClient.createInstructionAsync(parent, instruction).get();
 }
Parameters
Name Description
parent ProjectName

Required. Instruction resource parent, format: projects/{project_id}
instruction Instruction

Required. Instruction of how to perform the labeling task.
Returns
Type Description
OperationFuture<Instruction,CreateInstructionMetadata>

createInstructionAsync(String parent, Instruction instruction)

public final OperationFuture<Instruction,CreateInstructionMetadata> createInstructionAsync(String parent, Instruction instruction)

Creates an instruction for how data should be labeled.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String parent = ProjectName.of("[PROJECT]").toString();
   Instruction instruction = Instruction.newBuilder().build();
   Instruction response =
       dataLabelingServiceClient.createInstructionAsync(parent, instruction).get();
 }
Parameters
Name Description
parent String

Required. Instruction resource parent, format: projects/{project_id}
instruction Instruction

Required. Instruction of how to perform the labeling task.
Returns
Type Description
OperationFuture<Instruction,CreateInstructionMetadata>

createInstructionCallable()

public final UnaryCallable<CreateInstructionRequest,Operation> createInstructionCallable()

Creates an instruction for how data should be labeled.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   CreateInstructionRequest request =
       CreateInstructionRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setInstruction(Instruction.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       dataLabelingServiceClient.createInstructionCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<CreateInstructionRequest,Operation>

createInstructionOperationCallable()

public final OperationCallable<CreateInstructionRequest,Instruction,CreateInstructionMetadata> createInstructionOperationCallable()

Creates an instruction for how data should be labeled.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   CreateInstructionRequest request =
       CreateInstructionRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setInstruction(Instruction.newBuilder().build())
           .build();
   OperationFuture<Instruction, CreateInstructionMetadata> future =
       dataLabelingServiceClient.createInstructionOperationCallable().futureCall(request);
   // Do something.
   Instruction response = future.get();
 }
Returns
Type Description
OperationCallable<CreateInstructionRequest,Instruction,CreateInstructionMetadata>

deleteAnnotatedDataset(DeleteAnnotatedDatasetRequest request)

public final void deleteAnnotatedDataset(DeleteAnnotatedDatasetRequest request)

Deletes an annotated dataset by resource name.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   DeleteAnnotatedDatasetRequest request =
       DeleteAnnotatedDatasetRequest.newBuilder()
           .setName(
               AnnotatedDatasetName.of("[PROJECT]", "[DATASET]", "[ANNOTATED_DATASET]")
                   .toString())
           .build();
   dataLabelingServiceClient.deleteAnnotatedDataset(request);
 }
Parameter
Name Description
request DeleteAnnotatedDatasetRequest

The request object containing all of the parameters for the API call.

deleteAnnotatedDatasetCallable()

public final UnaryCallable<DeleteAnnotatedDatasetRequest,Empty> deleteAnnotatedDatasetCallable()

Deletes an annotated dataset by resource name.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   DeleteAnnotatedDatasetRequest request =
       DeleteAnnotatedDatasetRequest.newBuilder()
           .setName(
               AnnotatedDatasetName.of("[PROJECT]", "[DATASET]", "[ANNOTATED_DATASET]")
                   .toString())
           .build();
   ApiFuture<Empty> future =
       dataLabelingServiceClient.deleteAnnotatedDatasetCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
UnaryCallable<DeleteAnnotatedDatasetRequest,Empty>

deleteAnnotationSpecSet(AnnotationSpecSetName name)

public final void deleteAnnotationSpecSet(AnnotationSpecSetName name)

Deletes an annotation spec set by resource name.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   AnnotationSpecSetName name = AnnotationSpecSetName.of("[PROJECT]", "[ANNOTATION_SPEC_SET]");
   dataLabelingServiceClient.deleteAnnotationSpecSet(name);
 }
Parameter
Name Description
name AnnotationSpecSetName

Required. AnnotationSpec resource name, format: projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}.

deleteAnnotationSpecSet(DeleteAnnotationSpecSetRequest request)

public final void deleteAnnotationSpecSet(DeleteAnnotationSpecSetRequest request)

Deletes an annotation spec set by resource name.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   DeleteAnnotationSpecSetRequest request =
       DeleteAnnotationSpecSetRequest.newBuilder()
           .setName(AnnotationSpecSetName.of("[PROJECT]", "[ANNOTATION_SPEC_SET]").toString())
           .build();
   dataLabelingServiceClient.deleteAnnotationSpecSet(request);
 }
Parameter
Name Description
request DeleteAnnotationSpecSetRequest

The request object containing all of the parameters for the API call.

deleteAnnotationSpecSet(String name)

public final void deleteAnnotationSpecSet(String name)

Deletes an annotation spec set by resource name.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String name = AnnotationSpecSetName.of("[PROJECT]", "[ANNOTATION_SPEC_SET]").toString();
   dataLabelingServiceClient.deleteAnnotationSpecSet(name);
 }
Parameter
Name Description
name String

Required. AnnotationSpec resource name, format: projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}.

deleteAnnotationSpecSetCallable()

public final UnaryCallable<DeleteAnnotationSpecSetRequest,Empty> deleteAnnotationSpecSetCallable()

Deletes an annotation spec set by resource name.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   DeleteAnnotationSpecSetRequest request =
       DeleteAnnotationSpecSetRequest.newBuilder()
           .setName(AnnotationSpecSetName.of("[PROJECT]", "[ANNOTATION_SPEC_SET]").toString())
           .build();
   ApiFuture<Empty> future =
       dataLabelingServiceClient.deleteAnnotationSpecSetCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
UnaryCallable<DeleteAnnotationSpecSetRequest,Empty>

deleteDataset(DatasetName name)

public final void deleteDataset(DatasetName name)

Deletes a dataset by resource name.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   DatasetName name = DatasetName.of("[PROJECT]", "[DATASET]");
   dataLabelingServiceClient.deleteDataset(name);
 }
Parameter
Name Description
name DatasetName

Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}

deleteDataset(DeleteDatasetRequest request)

public final void deleteDataset(DeleteDatasetRequest request)

Deletes a dataset by resource name.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   DeleteDatasetRequest request =
       DeleteDatasetRequest.newBuilder()
           .setName(DatasetName.of("[PROJECT]", "[DATASET]").toString())
           .build();
   dataLabelingServiceClient.deleteDataset(request);
 }
Parameter
Name Description
request DeleteDatasetRequest

The request object containing all of the parameters for the API call.

deleteDataset(String name)

public final void deleteDataset(String name)

Deletes a dataset by resource name.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String name = DatasetName.of("[PROJECT]", "[DATASET]").toString();
   dataLabelingServiceClient.deleteDataset(name);
 }
Parameter
Name Description
name String

Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}

deleteDatasetCallable()

public final UnaryCallable<DeleteDatasetRequest,Empty> deleteDatasetCallable()

Deletes a dataset by resource name.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   DeleteDatasetRequest request =
       DeleteDatasetRequest.newBuilder()
           .setName(DatasetName.of("[PROJECT]", "[DATASET]").toString())
           .build();
   ApiFuture<Empty> future =
       dataLabelingServiceClient.deleteDatasetCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
UnaryCallable<DeleteDatasetRequest,Empty>

deleteEvaluationJob(DeleteEvaluationJobRequest request)

public final void deleteEvaluationJob(DeleteEvaluationJobRequest request)

Stops and deletes an evaluation job.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   DeleteEvaluationJobRequest request =
       DeleteEvaluationJobRequest.newBuilder()
           .setName(EvaluationJobName.of("[PROJECT]", "[EVALUATION_JOB]").toString())
           .build();
   dataLabelingServiceClient.deleteEvaluationJob(request);
 }
Parameter
Name Description
request DeleteEvaluationJobRequest

The request object containing all of the parameters for the API call.

deleteEvaluationJob(EvaluationJobName name)

public final void deleteEvaluationJob(EvaluationJobName name)

Stops and deletes an evaluation job.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   EvaluationJobName name = EvaluationJobName.of("[PROJECT]", "[EVALUATION_JOB]");
   dataLabelingServiceClient.deleteEvaluationJob(name);
 }
Parameter
Name Description
name EvaluationJobName

Required. Name of the evaluation job that is going to be deleted. Format:

"projects/<var>{project_id}</var>/evaluationJobs/<var>{evaluation_job_id}</var>"

deleteEvaluationJob(String name)

public final void deleteEvaluationJob(String name)

Stops and deletes an evaluation job.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String name = EvaluationJobName.of("[PROJECT]", "[EVALUATION_JOB]").toString();
   dataLabelingServiceClient.deleteEvaluationJob(name);
 }
Parameter
Name Description
name String

Required. Name of the evaluation job that is going to be deleted. Format:

"projects/<var>{project_id}</var>/evaluationJobs/<var>{evaluation_job_id}</var>"

deleteEvaluationJobCallable()

public final UnaryCallable<DeleteEvaluationJobRequest,Empty> deleteEvaluationJobCallable()

Stops and deletes an evaluation job.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   DeleteEvaluationJobRequest request =
       DeleteEvaluationJobRequest.newBuilder()
           .setName(EvaluationJobName.of("[PROJECT]", "[EVALUATION_JOB]").toString())
           .build();
   ApiFuture<Empty> future =
       dataLabelingServiceClient.deleteEvaluationJobCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
UnaryCallable<DeleteEvaluationJobRequest,Empty>

deleteInstruction(DeleteInstructionRequest request)

public final void deleteInstruction(DeleteInstructionRequest request)

Deletes an instruction object by resource name.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   DeleteInstructionRequest request =
       DeleteInstructionRequest.newBuilder()
           .setName(InstructionName.of("[PROJECT]", "[INSTRUCTION]").toString())
           .build();
   dataLabelingServiceClient.deleteInstruction(request);
 }
Parameter
Name Description
request DeleteInstructionRequest

The request object containing all of the parameters for the API call.

deleteInstruction(InstructionName name)

public final void deleteInstruction(InstructionName name)

Deletes an instruction object by resource name.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   InstructionName name = InstructionName.of("[PROJECT]", "[INSTRUCTION]");
   dataLabelingServiceClient.deleteInstruction(name);
 }
Parameter
Name Description
name InstructionName

Required. Instruction resource name, format: projects/{project_id}/instructions/{instruction_id}

deleteInstruction(String name)

public final void deleteInstruction(String name)

Deletes an instruction object by resource name.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String name = InstructionName.of("[PROJECT]", "[INSTRUCTION]").toString();
   dataLabelingServiceClient.deleteInstruction(name);
 }
Parameter
Name Description
name String

Required. Instruction resource name, format: projects/{project_id}/instructions/{instruction_id}

deleteInstructionCallable()

public final UnaryCallable<DeleteInstructionRequest,Empty> deleteInstructionCallable()

Deletes an instruction object by resource name.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   DeleteInstructionRequest request =
       DeleteInstructionRequest.newBuilder()
           .setName(InstructionName.of("[PROJECT]", "[INSTRUCTION]").toString())
           .build();
   ApiFuture<Empty> future =
       dataLabelingServiceClient.deleteInstructionCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
UnaryCallable<DeleteInstructionRequest,Empty>

exportDataAsync(DatasetName name, AnnotatedDatasetName annotatedDataset, String filter, OutputConfig outputConfig)

public final OperationFuture<ExportDataOperationResponse,ExportDataOperationMetadata> exportDataAsync(DatasetName name, AnnotatedDatasetName annotatedDataset, String filter, OutputConfig outputConfig)

Exports data and annotations from dataset.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   DatasetName name = DatasetName.of("[PROJECT]", "[DATASET]");
   AnnotatedDatasetName annotatedDataset =
       AnnotatedDatasetName.of("[PROJECT]", "[DATASET]", "[ANNOTATED_DATASET]");
   String filter = "filter-1274492040";
   OutputConfig outputConfig = OutputConfig.newBuilder().build();
   ExportDataOperationResponse response =
       dataLabelingServiceClient
           .exportDataAsync(name, annotatedDataset, filter, outputConfig)
           .get();
 }
Parameters
Name Description
name DatasetName

Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}
annotatedDataset AnnotatedDatasetName

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 String

Optional. Filter is not supported at this moment.
outputConfig OutputConfig

Required. Specify the output destination.
Returns
Type Description
OperationFuture<ExportDataOperationResponse,ExportDataOperationMetadata>

exportDataAsync(DatasetName name, String annotatedDataset, String filter, OutputConfig outputConfig)

public final OperationFuture<ExportDataOperationResponse,ExportDataOperationMetadata> exportDataAsync(DatasetName name, String annotatedDataset, String filter, OutputConfig outputConfig)

Exports data and annotations from dataset.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   DatasetName name = DatasetName.of("[PROJECT]", "[DATASET]");
   String annotatedDataset =
       AnnotatedDatasetName.of("[PROJECT]", "[DATASET]", "[ANNOTATED_DATASET]").toString();
   String filter = "filter-1274492040";
   OutputConfig outputConfig = OutputConfig.newBuilder().build();
   ExportDataOperationResponse response =
       dataLabelingServiceClient
           .exportDataAsync(name, annotatedDataset, filter, outputConfig)
           .get();
 }
Parameters
Name Description
name DatasetName

Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}
annotatedDataset String

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 String

Optional. Filter is not supported at this moment.
outputConfig OutputConfig

Required. Specify the output destination.
Returns
Type Description
OperationFuture<ExportDataOperationResponse,ExportDataOperationMetadata>

exportDataAsync(ExportDataRequest request)

public final OperationFuture<ExportDataOperationResponse,ExportDataOperationMetadata> exportDataAsync(ExportDataRequest request)

Exports data and annotations from dataset.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   ExportDataRequest request =
       ExportDataRequest.newBuilder()
           .setName(DatasetName.of("[PROJECT]", "[DATASET]").toString())
           .setAnnotatedDataset(
               AnnotatedDatasetName.of("[PROJECT]", "[DATASET]", "[ANNOTATED_DATASET]")
                   .toString())
           .setFilter("filter-1274492040")
           .setOutputConfig(OutputConfig.newBuilder().build())
           .setUserEmailAddress("userEmailAddress-1844787165")
           .build();
   ExportDataOperationResponse response =
       dataLabelingServiceClient.exportDataAsync(request).get();
 }
Parameter
Name Description
request ExportDataRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<ExportDataOperationResponse,ExportDataOperationMetadata>

exportDataAsync(String name, AnnotatedDatasetName annotatedDataset, String filter, OutputConfig outputConfig)

public final OperationFuture<ExportDataOperationResponse,ExportDataOperationMetadata> exportDataAsync(String name, AnnotatedDatasetName annotatedDataset, String filter, OutputConfig outputConfig)

Exports data and annotations from dataset.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String name = DatasetName.of("[PROJECT]", "[DATASET]").toString();
   AnnotatedDatasetName annotatedDataset =
       AnnotatedDatasetName.of("[PROJECT]", "[DATASET]", "[ANNOTATED_DATASET]");
   String filter = "filter-1274492040";
   OutputConfig outputConfig = OutputConfig.newBuilder().build();
   ExportDataOperationResponse response =
       dataLabelingServiceClient
           .exportDataAsync(name, annotatedDataset, filter, outputConfig)
           .get();
 }
Parameters
Name Description
name String

Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}
annotatedDataset AnnotatedDatasetName

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 String

Optional. Filter is not supported at this moment.
outputConfig OutputConfig

Required. Specify the output destination.
Returns
Type Description
OperationFuture<ExportDataOperationResponse,ExportDataOperationMetadata>

exportDataAsync(String name, String annotatedDataset, String filter, OutputConfig outputConfig)

public final OperationFuture<ExportDataOperationResponse,ExportDataOperationMetadata> exportDataAsync(String name, String annotatedDataset, String filter, OutputConfig outputConfig)

Exports data and annotations from dataset.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String name = DatasetName.of("[PROJECT]", "[DATASET]").toString();
   String annotatedDataset =
       AnnotatedDatasetName.of("[PROJECT]", "[DATASET]", "[ANNOTATED_DATASET]").toString();
   String filter = "filter-1274492040";
   OutputConfig outputConfig = OutputConfig.newBuilder().build();
   ExportDataOperationResponse response =
       dataLabelingServiceClient
           .exportDataAsync(name, annotatedDataset, filter, outputConfig)
           .get();
 }
Parameters
Name Description
name String

Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}
annotatedDataset String

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 String

Optional. Filter is not supported at this moment.
outputConfig OutputConfig

Required. Specify the output destination.
Returns
Type Description
OperationFuture<ExportDataOperationResponse,ExportDataOperationMetadata>

exportDataCallable()

public final UnaryCallable<ExportDataRequest,Operation> exportDataCallable()

Exports data and annotations from dataset.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   ExportDataRequest request =
       ExportDataRequest.newBuilder()
           .setName(DatasetName.of("[PROJECT]", "[DATASET]").toString())
           .setAnnotatedDataset(
               AnnotatedDatasetName.of("[PROJECT]", "[DATASET]", "[ANNOTATED_DATASET]")
                   .toString())
           .setFilter("filter-1274492040")
           .setOutputConfig(OutputConfig.newBuilder().build())
           .setUserEmailAddress("userEmailAddress-1844787165")
           .build();
   ApiFuture<Operation> future =
       dataLabelingServiceClient.exportDataCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<ExportDataRequest,Operation>

exportDataOperationCallable()

public final OperationCallable<ExportDataRequest,ExportDataOperationResponse,ExportDataOperationMetadata> exportDataOperationCallable()

Exports data and annotations from dataset.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   ExportDataRequest request =
       ExportDataRequest.newBuilder()
           .setName(DatasetName.of("[PROJECT]", "[DATASET]").toString())
           .setAnnotatedDataset(
               AnnotatedDatasetName.of("[PROJECT]", "[DATASET]", "[ANNOTATED_DATASET]")
                   .toString())
           .setFilter("filter-1274492040")
           .setOutputConfig(OutputConfig.newBuilder().build())
           .setUserEmailAddress("userEmailAddress-1844787165")
           .build();
   OperationFuture<ExportDataOperationResponse, ExportDataOperationMetadata> future =
       dataLabelingServiceClient.exportDataOperationCallable().futureCall(request);
   // Do something.
   ExportDataOperationResponse response = future.get();
 }
Returns
Type Description
OperationCallable<ExportDataRequest,ExportDataOperationResponse,ExportDataOperationMetadata>

getAnnotatedDataset(AnnotatedDatasetName name)

public final AnnotatedDataset getAnnotatedDataset(AnnotatedDatasetName name)

Gets an annotated dataset by resource name.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   AnnotatedDatasetName name =
       AnnotatedDatasetName.of("[PROJECT]", "[DATASET]", "[ANNOTATED_DATASET]");
   AnnotatedDataset response = dataLabelingServiceClient.getAnnotatedDataset(name);
 }
Parameter
Name Description
name AnnotatedDatasetName

Required. Name of the annotated dataset to get, format: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}
Returns
Type Description
AnnotatedDataset

getAnnotatedDataset(GetAnnotatedDatasetRequest request)

public final AnnotatedDataset getAnnotatedDataset(GetAnnotatedDatasetRequest request)

Gets an annotated dataset by resource name.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   GetAnnotatedDatasetRequest request =
       GetAnnotatedDatasetRequest.newBuilder()
           .setName(
               AnnotatedDatasetName.of("[PROJECT]", "[DATASET]", "[ANNOTATED_DATASET]")
                   .toString())
           .build();
   AnnotatedDataset response = dataLabelingServiceClient.getAnnotatedDataset(request);
 }
Parameter
Name Description
request GetAnnotatedDatasetRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
AnnotatedDataset

getAnnotatedDataset(String name)

public final AnnotatedDataset getAnnotatedDataset(String name)

Gets an annotated dataset by resource name.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String name =
       AnnotatedDatasetName.of("[PROJECT]", "[DATASET]", "[ANNOTATED_DATASET]").toString();
   AnnotatedDataset response = dataLabelingServiceClient.getAnnotatedDataset(name);
 }
Parameter
Name Description
name String

Required. Name of the annotated dataset to get, format: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}
Returns
Type Description
AnnotatedDataset

getAnnotatedDatasetCallable()

public final UnaryCallable<GetAnnotatedDatasetRequest,AnnotatedDataset> getAnnotatedDatasetCallable()

Gets an annotated dataset by resource name.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   GetAnnotatedDatasetRequest request =
       GetAnnotatedDatasetRequest.newBuilder()
           .setName(
               AnnotatedDatasetName.of("[PROJECT]", "[DATASET]", "[ANNOTATED_DATASET]")
                   .toString())
           .build();
   ApiFuture<AnnotatedDataset> future =
       dataLabelingServiceClient.getAnnotatedDatasetCallable().futureCall(request);
   // Do something.
   AnnotatedDataset response = future.get();
 }
Returns
Type Description
UnaryCallable<GetAnnotatedDatasetRequest,AnnotatedDataset>

getAnnotationSpecSet(AnnotationSpecSetName name)

public final AnnotationSpecSet getAnnotationSpecSet(AnnotationSpecSetName name)

Gets an annotation spec set by resource name.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   AnnotationSpecSetName name = AnnotationSpecSetName.of("[PROJECT]", "[ANNOTATION_SPEC_SET]");
   AnnotationSpecSet response = dataLabelingServiceClient.getAnnotationSpecSet(name);
 }
Parameter
Name Description
name AnnotationSpecSetName

Required. AnnotationSpecSet resource name, format: projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}
Returns
Type Description
AnnotationSpecSet

getAnnotationSpecSet(GetAnnotationSpecSetRequest request)

public final AnnotationSpecSet getAnnotationSpecSet(GetAnnotationSpecSetRequest request)

Gets an annotation spec set by resource name.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   GetAnnotationSpecSetRequest request =
       GetAnnotationSpecSetRequest.newBuilder()
           .setName(AnnotationSpecSetName.of("[PROJECT]", "[ANNOTATION_SPEC_SET]").toString())
           .build();
   AnnotationSpecSet response = dataLabelingServiceClient.getAnnotationSpecSet(request);
 }
Parameter
Name Description
request GetAnnotationSpecSetRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
AnnotationSpecSet

getAnnotationSpecSet(String name)

public final AnnotationSpecSet getAnnotationSpecSet(String name)

Gets an annotation spec set by resource name.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String name = AnnotationSpecSetName.of("[PROJECT]", "[ANNOTATION_SPEC_SET]").toString();
   AnnotationSpecSet response = dataLabelingServiceClient.getAnnotationSpecSet(name);
 }
Parameter
Name Description
name String

Required. AnnotationSpecSet resource name, format: projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}
Returns
Type Description
AnnotationSpecSet

getAnnotationSpecSetCallable()

public final UnaryCallable<GetAnnotationSpecSetRequest,AnnotationSpecSet> getAnnotationSpecSetCallable()

Gets an annotation spec set by resource name.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   GetAnnotationSpecSetRequest request =
       GetAnnotationSpecSetRequest.newBuilder()
           .setName(AnnotationSpecSetName.of("[PROJECT]", "[ANNOTATION_SPEC_SET]").toString())
           .build();
   ApiFuture<AnnotationSpecSet> future =
       dataLabelingServiceClient.getAnnotationSpecSetCallable().futureCall(request);
   // Do something.
   AnnotationSpecSet response = future.get();
 }
Returns
Type Description
UnaryCallable<GetAnnotationSpecSetRequest,AnnotationSpecSet>

getDataItem(DataItemName name)

public final DataItem getDataItem(DataItemName name)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   DataItemName name = DataItemName.of("[PROJECT]", "[DATASET]", "[DATA_ITEM]");
   DataItem response = dataLabelingServiceClient.getDataItem(name);
 }
Parameter
Name Description
name DataItemName

Required. The name of the data item to get, format: projects/{project_id}/datasets/{dataset_id}/dataItems/{data_item_id}
Returns
Type Description
DataItem

getDataItem(GetDataItemRequest request)

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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   GetDataItemRequest request =
       GetDataItemRequest.newBuilder()
           .setName(DataItemName.of("[PROJECT]", "[DATASET]", "[DATA_ITEM]").toString())
           .build();
   DataItem response = dataLabelingServiceClient.getDataItem(request);
 }
Parameter
Name Description
request GetDataItemRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
DataItem

getDataItem(String name)

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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String name = DataItemName.of("[PROJECT]", "[DATASET]", "[DATA_ITEM]").toString();
   DataItem response = dataLabelingServiceClient.getDataItem(name);
 }
Parameter
Name Description
name String

Required. The name of the data item to get, format: projects/{project_id}/datasets/{dataset_id}/dataItems/{data_item_id}
Returns
Type Description
DataItem

getDataItemCallable()

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


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   GetDataItemRequest request =
       GetDataItemRequest.newBuilder()
           .setName(DataItemName.of("[PROJECT]", "[DATASET]", "[DATA_ITEM]").toString())
           .build();
   ApiFuture<DataItem> future =
       dataLabelingServiceClient.getDataItemCallable().futureCall(request);
   // Do something.
   DataItem response = future.get();
 }
Returns
Type Description
UnaryCallable<GetDataItemRequest,DataItem>

getDataset(DatasetName name)

public final Dataset getDataset(DatasetName name)

Gets dataset by resource name.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   DatasetName name = DatasetName.of("[PROJECT]", "[DATASET]");
   Dataset response = dataLabelingServiceClient.getDataset(name);
 }
Parameter
Name Description
name DatasetName

Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}
Returns
Type Description
Dataset

getDataset(GetDatasetRequest request)

public final Dataset getDataset(GetDatasetRequest request)

Gets dataset by resource name.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   GetDatasetRequest request =
       GetDatasetRequest.newBuilder()
           .setName(DatasetName.of("[PROJECT]", "[DATASET]").toString())
           .build();
   Dataset response = dataLabelingServiceClient.getDataset(request);
 }
Parameter
Name Description
request GetDatasetRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
Dataset

getDataset(String name)

public final Dataset getDataset(String name)

Gets dataset by resource name.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String name = DatasetName.of("[PROJECT]", "[DATASET]").toString();
   Dataset response = dataLabelingServiceClient.getDataset(name);
 }
Parameter
Name Description
name String

Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}
Returns
Type Description
Dataset

getDatasetCallable()

public final UnaryCallable<GetDatasetRequest,Dataset> getDatasetCallable()

Gets dataset by resource name.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   GetDatasetRequest request =
       GetDatasetRequest.newBuilder()
           .setName(DatasetName.of("[PROJECT]", "[DATASET]").toString())
           .build();
   ApiFuture<Dataset> future =
       dataLabelingServiceClient.getDatasetCallable().futureCall(request);
   // Do something.
   Dataset response = future.get();
 }
Returns
Type Description
UnaryCallable<GetDatasetRequest,Dataset>

getEvaluation(EvaluationName name)

public final Evaluation getEvaluation(EvaluationName name)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   EvaluationName name = EvaluationName.of("[PROJECT]", "[DATASET]", "[EVALUATION]");
   Evaluation response = dataLabelingServiceClient.getEvaluation(name);
 }
Parameter
Name Description
name EvaluationName

Required. Name of the evaluation. Format:

"projects/<var>{project_id}</var>/datasets/<var>{dataset_id}</var>/evaluations/<var>{evaluation_id}</var>'
Returns
Type Description
Evaluation

getEvaluation(GetEvaluationRequest request)

public final Evaluation getEvaluation(GetEvaluationRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   GetEvaluationRequest request =
       GetEvaluationRequest.newBuilder()
           .setName(EvaluationName.of("[PROJECT]", "[DATASET]", "[EVALUATION]").toString())
           .build();
   Evaluation response = dataLabelingServiceClient.getEvaluation(request);
 }
Parameter
Name Description
request GetEvaluationRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
Evaluation

getEvaluation(String name)

public final Evaluation getEvaluation(String name)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String name = EvaluationName.of("[PROJECT]", "[DATASET]", "[EVALUATION]").toString();
   Evaluation response = dataLabelingServiceClient.getEvaluation(name);
 }
Parameter
Name Description
name String

Required. Name of the evaluation. Format:

"projects/<var>{project_id}</var>/datasets/<var>{dataset_id}</var>/evaluations/<var>{evaluation_id}</var>'
Returns
Type Description
Evaluation

getEvaluationCallable()

public final UnaryCallable<GetEvaluationRequest,Evaluation> getEvaluationCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   GetEvaluationRequest request =
       GetEvaluationRequest.newBuilder()
           .setName(EvaluationName.of("[PROJECT]", "[DATASET]", "[EVALUATION]").toString())
           .build();
   ApiFuture<Evaluation> future =
       dataLabelingServiceClient.getEvaluationCallable().futureCall(request);
   // Do something.
   Evaluation response = future.get();
 }
Returns
Type Description
UnaryCallable<GetEvaluationRequest,Evaluation>

getEvaluationJob(EvaluationJobName name)

public final EvaluationJob getEvaluationJob(EvaluationJobName name)

Gets an evaluation job by resource name.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   EvaluationJobName name = EvaluationJobName.of("[PROJECT]", "[EVALUATION_JOB]");
   EvaluationJob response = dataLabelingServiceClient.getEvaluationJob(name);
 }
Parameter
Name Description
name EvaluationJobName

Required. Name of the evaluation job. Format:

"projects/<var>{project_id}</var>/evaluationJobs/<var>{evaluation_job_id}</var>"
Returns
Type Description
EvaluationJob

getEvaluationJob(GetEvaluationJobRequest request)

public final EvaluationJob getEvaluationJob(GetEvaluationJobRequest request)

Gets an evaluation job by resource name.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   GetEvaluationJobRequest request =
       GetEvaluationJobRequest.newBuilder()
           .setName(EvaluationJobName.of("[PROJECT]", "[EVALUATION_JOB]").toString())
           .build();
   EvaluationJob response = dataLabelingServiceClient.getEvaluationJob(request);
 }
Parameter
Name Description
request GetEvaluationJobRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
EvaluationJob

getEvaluationJob(String name)

public final EvaluationJob getEvaluationJob(String name)

Gets an evaluation job by resource name.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String name = EvaluationJobName.of("[PROJECT]", "[EVALUATION_JOB]").toString();
   EvaluationJob response = dataLabelingServiceClient.getEvaluationJob(name);
 }
Parameter
Name Description
name String

Required. Name of the evaluation job. Format:

"projects/<var>{project_id}</var>/evaluationJobs/<var>{evaluation_job_id}</var>"
Returns
Type Description
EvaluationJob

getEvaluationJobCallable()

public final UnaryCallable<GetEvaluationJobRequest,EvaluationJob> getEvaluationJobCallable()

Gets an evaluation job by resource name.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   GetEvaluationJobRequest request =
       GetEvaluationJobRequest.newBuilder()
           .setName(EvaluationJobName.of("[PROJECT]", "[EVALUATION_JOB]").toString())
           .build();
   ApiFuture<EvaluationJob> future =
       dataLabelingServiceClient.getEvaluationJobCallable().futureCall(request);
   // Do something.
   EvaluationJob response = future.get();
 }
Returns
Type Description
UnaryCallable<GetEvaluationJobRequest,EvaluationJob>

getExample(ExampleName name, String filter)

public final Example getExample(ExampleName name, String filter)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   ExampleName name =
       ExampleName.of("[PROJECT]", "[DATASET]", "[ANNOTATED_DATASET]", "[EXAMPLE]");
   String filter = "filter-1274492040";
   Example response = dataLabelingServiceClient.getExample(name, filter);
 }
Parameters
Name Description
name ExampleName

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

Optional. An expression for filtering Examples. Filter by annotation_spec.display_name is supported. Format "annotation_spec.display_name = {display_name}"
Returns
Type Description
Example

getExample(GetExampleRequest request)

public final Example getExample(GetExampleRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   GetExampleRequest request =
       GetExampleRequest.newBuilder()
           .setName(
               ExampleName.of("[PROJECT]", "[DATASET]", "[ANNOTATED_DATASET]", "[EXAMPLE]")
                   .toString())
           .setFilter("filter-1274492040")
           .build();
   Example response = dataLabelingServiceClient.getExample(request);
 }
Parameter
Name Description
request GetExampleRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
Example

getExample(String name, String filter)

public final Example getExample(String name, String filter)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String name =
       ExampleName.of("[PROJECT]", "[DATASET]", "[ANNOTATED_DATASET]", "[EXAMPLE]").toString();
   String filter = "filter-1274492040";
   Example response = dataLabelingServiceClient.getExample(name, filter);
 }
Parameters
Name Description
name String

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

Optional. An expression for filtering Examples. Filter by annotation_spec.display_name is supported. Format "annotation_spec.display_name = {display_name}"
Returns
Type Description
Example

getExampleCallable()

public final UnaryCallable<GetExampleRequest,Example> getExampleCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   GetExampleRequest request =
       GetExampleRequest.newBuilder()
           .setName(
               ExampleName.of("[PROJECT]", "[DATASET]", "[ANNOTATED_DATASET]", "[EXAMPLE]")
                   .toString())
           .setFilter("filter-1274492040")
           .build();
   ApiFuture<Example> future =
       dataLabelingServiceClient.getExampleCallable().futureCall(request);
   // Do something.
   Example response = future.get();
 }
Returns
Type Description
UnaryCallable<GetExampleRequest,Example>

getInstruction(GetInstructionRequest request)

public final Instruction getInstruction(GetInstructionRequest request)

Gets an instruction by resource name.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   GetInstructionRequest request =
       GetInstructionRequest.newBuilder()
           .setName(InstructionName.of("[PROJECT]", "[INSTRUCTION]").toString())
           .build();
   Instruction response = dataLabelingServiceClient.getInstruction(request);
 }
Parameter
Name Description
request GetInstructionRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
Instruction

getInstruction(InstructionName name)

public final Instruction getInstruction(InstructionName name)

Gets an instruction by resource name.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   InstructionName name = InstructionName.of("[PROJECT]", "[INSTRUCTION]");
   Instruction response = dataLabelingServiceClient.getInstruction(name);
 }
Parameter
Name Description
name InstructionName

Required. Instruction resource name, format: projects/{project_id}/instructions/{instruction_id}
Returns
Type Description
Instruction

getInstruction(String name)

public final Instruction getInstruction(String name)

Gets an instruction by resource name.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String name = InstructionName.of("[PROJECT]", "[INSTRUCTION]").toString();
   Instruction response = dataLabelingServiceClient.getInstruction(name);
 }
Parameter
Name Description
name String

Required. Instruction resource name, format: projects/{project_id}/instructions/{instruction_id}
Returns
Type Description
Instruction

getInstructionCallable()

public final UnaryCallable<GetInstructionRequest,Instruction> getInstructionCallable()

Gets an instruction by resource name.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   GetInstructionRequest request =
       GetInstructionRequest.newBuilder()
           .setName(InstructionName.of("[PROJECT]", "[INSTRUCTION]").toString())
           .build();
   ApiFuture<Instruction> future =
       dataLabelingServiceClient.getInstructionCallable().futureCall(request);
   // Do something.
   Instruction response = future.get();
 }
Returns
Type Description
UnaryCallable<GetInstructionRequest,Instruction>

getOperationsClient()

public final OperationsClient getOperationsClient()

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

Returns
Type Description
OperationsClient

getSettings()

public final DataLabelingServiceSettings getSettings()
Returns
Type Description
DataLabelingServiceSettings

getStub()

public DataLabelingServiceStub getStub()
Returns
Type Description
DataLabelingServiceStub

importDataAsync(DatasetName name, InputConfig inputConfig)

public final OperationFuture<ImportDataOperationResponse,ImportDataOperationMetadata> importDataAsync(DatasetName 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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   DatasetName name = DatasetName.of("[PROJECT]", "[DATASET]");
   InputConfig inputConfig = InputConfig.newBuilder().build();
   ImportDataOperationResponse response =
       dataLabelingServiceClient.importDataAsync(name, inputConfig).get();
 }
Parameters
Name Description
name DatasetName

Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}
inputConfig InputConfig

Required. Specify the input source of the data.
Returns
Type Description
OperationFuture<ImportDataOperationResponse,ImportDataOperationMetadata>

importDataAsync(ImportDataRequest request)

public final OperationFuture<ImportDataOperationResponse,ImportDataOperationMetadata> importDataAsync(ImportDataRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   ImportDataRequest request =
       ImportDataRequest.newBuilder()
           .setName(DatasetName.of("[PROJECT]", "[DATASET]").toString())
           .setInputConfig(InputConfig.newBuilder().build())
           .setUserEmailAddress("userEmailAddress-1844787165")
           .build();
   ImportDataOperationResponse response =
       dataLabelingServiceClient.importDataAsync(request).get();
 }
Parameter
Name Description
request ImportDataRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<ImportDataOperationResponse,ImportDataOperationMetadata>

importDataAsync(String name, InputConfig inputConfig)

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


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String name = DatasetName.of("[PROJECT]", "[DATASET]").toString();
   InputConfig inputConfig = InputConfig.newBuilder().build();
   ImportDataOperationResponse response =
       dataLabelingServiceClient.importDataAsync(name, inputConfig).get();
 }
Parameters
Name Description
name String

Required. Dataset resource name, format: projects/{project_id}/datasets/{dataset_id}
inputConfig InputConfig

Required. Specify the input source of the data.
Returns
Type Description
OperationFuture<ImportDataOperationResponse,ImportDataOperationMetadata>

importDataCallable()

public final UnaryCallable<ImportDataRequest,Operation> importDataCallable()

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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   ImportDataRequest request =
       ImportDataRequest.newBuilder()
           .setName(DatasetName.of("[PROJECT]", "[DATASET]").toString())
           .setInputConfig(InputConfig.newBuilder().build())
           .setUserEmailAddress("userEmailAddress-1844787165")
           .build();
   ApiFuture<Operation> future =
       dataLabelingServiceClient.importDataCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<ImportDataRequest,Operation>

importDataOperationCallable()

public final OperationCallable<ImportDataRequest,ImportDataOperationResponse,ImportDataOperationMetadata> importDataOperationCallable()

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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   ImportDataRequest request =
       ImportDataRequest.newBuilder()
           .setName(DatasetName.of("[PROJECT]", "[DATASET]").toString())
           .setInputConfig(InputConfig.newBuilder().build())
           .setUserEmailAddress("userEmailAddress-1844787165")
           .build();
   OperationFuture<ImportDataOperationResponse, ImportDataOperationMetadata> future =
       dataLabelingServiceClient.importDataOperationCallable().futureCall(request);
   // Do something.
   ImportDataOperationResponse response = future.get();
 }
Returns
Type Description
OperationCallable<ImportDataRequest,ImportDataOperationResponse,ImportDataOperationMetadata>

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

labelImageAsync(DatasetName parent, HumanAnnotationConfig basicConfig, LabelImageRequest.Feature feature)

public final OperationFuture<AnnotatedDataset,LabelOperationMetadata> labelImageAsync(DatasetName 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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   DatasetName parent = DatasetName.of("[PROJECT]", "[DATASET]");
   HumanAnnotationConfig basicConfig = HumanAnnotationConfig.newBuilder().build();
   LabelImageRequest.Feature feature = LabelImageRequest.Feature.forNumber(0);
   AnnotatedDataset response =
       dataLabelingServiceClient.labelImageAsync(parent, basicConfig, feature).get();
 }
Parameters
Name Description
parent DatasetName

Required. Name of the dataset to request labeling task, format: projects/{project_id}/datasets/{dataset_id}
basicConfig HumanAnnotationConfig

Required. Basic human annotation config.
feature LabelImageRequest.Feature

Required. The type of image labeling task.
Returns
Type Description
OperationFuture<AnnotatedDataset,LabelOperationMetadata>

labelImageAsync(LabelImageRequest request)

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


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   LabelImageRequest request =
       LabelImageRequest.newBuilder()
           .setParent(DatasetName.of("[PROJECT]", "[DATASET]").toString())
           .setBasicConfig(HumanAnnotationConfig.newBuilder().build())
           .build();
   AnnotatedDataset response = dataLabelingServiceClient.labelImageAsync(request).get();
 }
Parameter
Name Description
request LabelImageRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<AnnotatedDataset,LabelOperationMetadata>

labelImageAsync(String parent, HumanAnnotationConfig basicConfig, LabelImageRequest.Feature feature)

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


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String parent = DatasetName.of("[PROJECT]", "[DATASET]").toString();
   HumanAnnotationConfig basicConfig = HumanAnnotationConfig.newBuilder().build();
   LabelImageRequest.Feature feature = LabelImageRequest.Feature.forNumber(0);
   AnnotatedDataset response =
       dataLabelingServiceClient.labelImageAsync(parent, basicConfig, feature).get();
 }
Parameters
Name Description
parent String

Required. Name of the dataset to request labeling task, format: projects/{project_id}/datasets/{dataset_id}
basicConfig HumanAnnotationConfig

Required. Basic human annotation config.
feature LabelImageRequest.Feature

Required. The type of image labeling task.
Returns
Type Description
OperationFuture<AnnotatedDataset,LabelOperationMetadata>

labelImageCallable()

public final UnaryCallable<LabelImageRequest,Operation> labelImageCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   LabelImageRequest request =
       LabelImageRequest.newBuilder()
           .setParent(DatasetName.of("[PROJECT]", "[DATASET]").toString())
           .setBasicConfig(HumanAnnotationConfig.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       dataLabelingServiceClient.labelImageCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<LabelImageRequest,Operation>

labelImageOperationCallable()

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


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   LabelImageRequest request =
       LabelImageRequest.newBuilder()
           .setParent(DatasetName.of("[PROJECT]", "[DATASET]").toString())
           .setBasicConfig(HumanAnnotationConfig.newBuilder().build())
           .build();
   OperationFuture<AnnotatedDataset, LabelOperationMetadata> future =
       dataLabelingServiceClient.labelImageOperationCallable().futureCall(request);
   // Do something.
   AnnotatedDataset response = future.get();
 }
Returns
Type Description
OperationCallable<LabelImageRequest,AnnotatedDataset,LabelOperationMetadata>

labelTextAsync(DatasetName parent, HumanAnnotationConfig basicConfig, LabelTextRequest.Feature feature)

public final OperationFuture<AnnotatedDataset,LabelOperationMetadata> labelTextAsync(DatasetName 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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   DatasetName parent = DatasetName.of("[PROJECT]", "[DATASET]");
   HumanAnnotationConfig basicConfig = HumanAnnotationConfig.newBuilder().build();
   LabelTextRequest.Feature feature = LabelTextRequest.Feature.forNumber(0);
   AnnotatedDataset response =
       dataLabelingServiceClient.labelTextAsync(parent, basicConfig, feature).get();
 }
Parameters
Name Description
parent DatasetName

Required. Name of the data set to request labeling task, format: projects/{project_id}/datasets/{dataset_id}
basicConfig HumanAnnotationConfig

Required. Basic human annotation config.
feature LabelTextRequest.Feature

Required. The type of text labeling task.
Returns
Type Description
OperationFuture<AnnotatedDataset,LabelOperationMetadata>

labelTextAsync(LabelTextRequest request)

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


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   LabelTextRequest request =
       LabelTextRequest.newBuilder()
           .setParent(DatasetName.of("[PROJECT]", "[DATASET]").toString())
           .setBasicConfig(HumanAnnotationConfig.newBuilder().build())
           .build();
   AnnotatedDataset response = dataLabelingServiceClient.labelTextAsync(request).get();
 }
Parameter
Name Description
request LabelTextRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<AnnotatedDataset,LabelOperationMetadata>

labelTextAsync(String parent, HumanAnnotationConfig basicConfig, LabelTextRequest.Feature feature)

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


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String parent = DatasetName.of("[PROJECT]", "[DATASET]").toString();
   HumanAnnotationConfig basicConfig = HumanAnnotationConfig.newBuilder().build();
   LabelTextRequest.Feature feature = LabelTextRequest.Feature.forNumber(0);
   AnnotatedDataset response =
       dataLabelingServiceClient.labelTextAsync(parent, basicConfig, feature).get();
 }
Parameters
Name Description
parent String

Required. Name of the data set to request labeling task, format: projects/{project_id}/datasets/{dataset_id}
basicConfig HumanAnnotationConfig

Required. Basic human annotation config.
feature LabelTextRequest.Feature

Required. The type of text labeling task.
Returns
Type Description
OperationFuture<AnnotatedDataset,LabelOperationMetadata>

labelTextCallable()

public final UnaryCallable<LabelTextRequest,Operation> labelTextCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   LabelTextRequest request =
       LabelTextRequest.newBuilder()
           .setParent(DatasetName.of("[PROJECT]", "[DATASET]").toString())
           .setBasicConfig(HumanAnnotationConfig.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       dataLabelingServiceClient.labelTextCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<LabelTextRequest,Operation>

labelTextOperationCallable()

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


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   LabelTextRequest request =
       LabelTextRequest.newBuilder()
           .setParent(DatasetName.of("[PROJECT]", "[DATASET]").toString())
           .setBasicConfig(HumanAnnotationConfig.newBuilder().build())
           .build();
   OperationFuture<AnnotatedDataset, LabelOperationMetadata> future =
       dataLabelingServiceClient.labelTextOperationCallable().futureCall(request);
   // Do something.
   AnnotatedDataset response = future.get();
 }
Returns
Type Description
OperationCallable<LabelTextRequest,AnnotatedDataset,LabelOperationMetadata>

labelVideoAsync(DatasetName parent, HumanAnnotationConfig basicConfig, LabelVideoRequest.Feature feature)

public final OperationFuture<AnnotatedDataset,LabelOperationMetadata> labelVideoAsync(DatasetName 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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   DatasetName parent = DatasetName.of("[PROJECT]", "[DATASET]");
   HumanAnnotationConfig basicConfig = HumanAnnotationConfig.newBuilder().build();
   LabelVideoRequest.Feature feature = LabelVideoRequest.Feature.forNumber(0);
   AnnotatedDataset response =
       dataLabelingServiceClient.labelVideoAsync(parent, basicConfig, feature).get();
 }
Parameters
Name Description
parent DatasetName

Required. Name of the dataset to request labeling task, format: projects/{project_id}/datasets/{dataset_id}
basicConfig HumanAnnotationConfig

Required. Basic human annotation config.
feature LabelVideoRequest.Feature

Required. The type of video labeling task.
Returns
Type Description
OperationFuture<AnnotatedDataset,LabelOperationMetadata>

labelVideoAsync(LabelVideoRequest request)

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


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   LabelVideoRequest request =
       LabelVideoRequest.newBuilder()
           .setParent(DatasetName.of("[PROJECT]", "[DATASET]").toString())
           .setBasicConfig(HumanAnnotationConfig.newBuilder().build())
           .build();
   AnnotatedDataset response = dataLabelingServiceClient.labelVideoAsync(request).get();
 }
Parameter
Name Description
request LabelVideoRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<AnnotatedDataset,LabelOperationMetadata>

labelVideoAsync(String parent, HumanAnnotationConfig basicConfig, LabelVideoRequest.Feature feature)

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


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String parent = DatasetName.of("[PROJECT]", "[DATASET]").toString();
   HumanAnnotationConfig basicConfig = HumanAnnotationConfig.newBuilder().build();
   LabelVideoRequest.Feature feature = LabelVideoRequest.Feature.forNumber(0);
   AnnotatedDataset response =
       dataLabelingServiceClient.labelVideoAsync(parent, basicConfig, feature).get();
 }
Parameters
Name Description
parent String

Required. Name of the dataset to request labeling task, format: projects/{project_id}/datasets/{dataset_id}
basicConfig HumanAnnotationConfig

Required. Basic human annotation config.
feature LabelVideoRequest.Feature

Required. The type of video labeling task.
Returns
Type Description
OperationFuture<AnnotatedDataset,LabelOperationMetadata>

labelVideoCallable()

public final UnaryCallable<LabelVideoRequest,Operation> labelVideoCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   LabelVideoRequest request =
       LabelVideoRequest.newBuilder()
           .setParent(DatasetName.of("[PROJECT]", "[DATASET]").toString())
           .setBasicConfig(HumanAnnotationConfig.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       dataLabelingServiceClient.labelVideoCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<LabelVideoRequest,Operation>

labelVideoOperationCallable()

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


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   LabelVideoRequest request =
       LabelVideoRequest.newBuilder()
           .setParent(DatasetName.of("[PROJECT]", "[DATASET]").toString())
           .setBasicConfig(HumanAnnotationConfig.newBuilder().build())
           .build();
   OperationFuture<AnnotatedDataset, LabelOperationMetadata> future =
       dataLabelingServiceClient.labelVideoOperationCallable().futureCall(request);
   // Do something.
   AnnotatedDataset response = future.get();
 }
Returns
Type Description
OperationCallable<LabelVideoRequest,AnnotatedDataset,LabelOperationMetadata>

listAnnotatedDatasets(DatasetName parent, String filter)

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

Lists annotated datasets for a dataset. Pagination is supported.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   DatasetName parent = DatasetName.of("[PROJECT]", "[DATASET]");
   String filter = "filter-1274492040";
   for (AnnotatedDataset element :
       dataLabelingServiceClient.listAnnotatedDatasets(parent, filter).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameters
Name Description
parent DatasetName

Required. Name of the dataset to list annotated datasets, format: projects/{project_id}/datasets/{dataset_id}
filter String

Optional. Filter is not supported at this moment.
Returns
Type Description
DataLabelingServiceClient.ListAnnotatedDatasetsPagedResponse

listAnnotatedDatasets(ListAnnotatedDatasetsRequest request)

public final DataLabelingServiceClient.ListAnnotatedDatasetsPagedResponse listAnnotatedDatasets(ListAnnotatedDatasetsRequest request)

Lists annotated datasets for a dataset. Pagination is supported.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   ListAnnotatedDatasetsRequest request =
       ListAnnotatedDatasetsRequest.newBuilder()
           .setParent(DatasetName.of("[PROJECT]", "[DATASET]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (AnnotatedDataset element :
       dataLabelingServiceClient.listAnnotatedDatasets(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request ListAnnotatedDatasetsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
DataLabelingServiceClient.ListAnnotatedDatasetsPagedResponse

listAnnotatedDatasets(String parent, String filter)

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

Lists annotated datasets for a dataset. Pagination is supported.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String parent = DatasetName.of("[PROJECT]", "[DATASET]").toString();
   String filter = "filter-1274492040";
   for (AnnotatedDataset element :
       dataLabelingServiceClient.listAnnotatedDatasets(parent, filter).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameters
Name Description
parent String

Required. Name of the dataset to list annotated datasets, format: projects/{project_id}/datasets/{dataset_id}
filter String

Optional. Filter is not supported at this moment.
Returns
Type Description
DataLabelingServiceClient.ListAnnotatedDatasetsPagedResponse

listAnnotatedDatasetsCallable()

public final UnaryCallable<ListAnnotatedDatasetsRequest,ListAnnotatedDatasetsResponse> listAnnotatedDatasetsCallable()

Lists annotated datasets for a dataset. Pagination is supported.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   ListAnnotatedDatasetsRequest request =
       ListAnnotatedDatasetsRequest.newBuilder()
           .setParent(DatasetName.of("[PROJECT]", "[DATASET]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .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;
     }
   }
 }
Returns
Type Description
UnaryCallable<ListAnnotatedDatasetsRequest,ListAnnotatedDatasetsResponse>

listAnnotatedDatasetsPagedCallable()

public final UnaryCallable<ListAnnotatedDatasetsRequest,DataLabelingServiceClient.ListAnnotatedDatasetsPagedResponse> listAnnotatedDatasetsPagedCallable()

Lists annotated datasets for a dataset. Pagination is supported.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   ListAnnotatedDatasetsRequest request =
       ListAnnotatedDatasetsRequest.newBuilder()
           .setParent(DatasetName.of("[PROJECT]", "[DATASET]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<AnnotatedDataset> future =
       dataLabelingServiceClient.listAnnotatedDatasetsPagedCallable().futureCall(request);
   // Do something.
   for (AnnotatedDataset element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListAnnotatedDatasetsRequest,ListAnnotatedDatasetsPagedResponse>

listAnnotationSpecSets(ListAnnotationSpecSetsRequest request)

public final DataLabelingServiceClient.ListAnnotationSpecSetsPagedResponse listAnnotationSpecSets(ListAnnotationSpecSetsRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   ListAnnotationSpecSetsRequest request =
       ListAnnotationSpecSetsRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (AnnotationSpecSet element :
       dataLabelingServiceClient.listAnnotationSpecSets(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request ListAnnotationSpecSetsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
DataLabelingServiceClient.ListAnnotationSpecSetsPagedResponse

listAnnotationSpecSets(ProjectName parent, String filter)

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

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   String filter = "filter-1274492040";
   for (AnnotationSpecSet element :
       dataLabelingServiceClient.listAnnotationSpecSets(parent, filter).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameters
Name Description
parent ProjectName

Required. Parent of AnnotationSpecSet resource, format: projects/{project_id}
filter String

Optional. Filter is not supported at this moment.
Returns
Type Description
DataLabelingServiceClient.ListAnnotationSpecSetsPagedResponse

listAnnotationSpecSets(String parent, String filter)

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

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String parent = ProjectName.of("[PROJECT]").toString();
   String filter = "filter-1274492040";
   for (AnnotationSpecSet element :
       dataLabelingServiceClient.listAnnotationSpecSets(parent, filter).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameters
Name Description
parent String

Required. Parent of AnnotationSpecSet resource, format: projects/{project_id}
filter String

Optional. Filter is not supported at this moment.
Returns
Type Description
DataLabelingServiceClient.ListAnnotationSpecSetsPagedResponse

listAnnotationSpecSetsCallable()

public final UnaryCallable<ListAnnotationSpecSetsRequest,ListAnnotationSpecSetsResponse> listAnnotationSpecSetsCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   ListAnnotationSpecSetsRequest request =
       ListAnnotationSpecSetsRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .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;
     }
   }
 }
Returns
Type Description
UnaryCallable<ListAnnotationSpecSetsRequest,ListAnnotationSpecSetsResponse>

listAnnotationSpecSetsPagedCallable()

public final UnaryCallable<ListAnnotationSpecSetsRequest,DataLabelingServiceClient.ListAnnotationSpecSetsPagedResponse> listAnnotationSpecSetsPagedCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   ListAnnotationSpecSetsRequest request =
       ListAnnotationSpecSetsRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<AnnotationSpecSet> future =
       dataLabelingServiceClient.listAnnotationSpecSetsPagedCallable().futureCall(request);
   // Do something.
   for (AnnotationSpecSet element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListAnnotationSpecSetsRequest,ListAnnotationSpecSetsPagedResponse>

listDataItems(DatasetName parent, String filter)

public final DataLabelingServiceClient.ListDataItemsPagedResponse listDataItems(DatasetName 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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   DatasetName parent = DatasetName.of("[PROJECT]", "[DATASET]");
   String filter = "filter-1274492040";
   for (DataItem element :
       dataLabelingServiceClient.listDataItems(parent, filter).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameters
Name Description
parent DatasetName

Required. Name of the dataset to list data items, format: projects/{project_id}/datasets/{dataset_id}
filter String

Optional. Filter is not supported at this moment.
Returns
Type Description
DataLabelingServiceClient.ListDataItemsPagedResponse

listDataItems(ListDataItemsRequest request)

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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   ListDataItemsRequest request =
       ListDataItemsRequest.newBuilder()
           .setParent(DatasetName.of("[PROJECT]", "[DATASET]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (DataItem element : dataLabelingServiceClient.listDataItems(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request ListDataItemsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
DataLabelingServiceClient.ListDataItemsPagedResponse

listDataItems(String parent, String filter)

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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String parent = DatasetName.of("[PROJECT]", "[DATASET]").toString();
   String filter = "filter-1274492040";
   for (DataItem element :
       dataLabelingServiceClient.listDataItems(parent, filter).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameters
Name Description
parent String

Required. Name of the dataset to list data items, format: projects/{project_id}/datasets/{dataset_id}
filter String

Optional. Filter is not supported at this moment.
Returns
Type Description
DataLabelingServiceClient.ListDataItemsPagedResponse

listDataItemsCallable()

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


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   ListDataItemsRequest request =
       ListDataItemsRequest.newBuilder()
           .setParent(DatasetName.of("[PROJECT]", "[DATASET]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .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;
     }
   }
 }
Returns
Type Description
UnaryCallable<ListDataItemsRequest,ListDataItemsResponse>

listDataItemsPagedCallable()

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


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   ListDataItemsRequest request =
       ListDataItemsRequest.newBuilder()
           .setParent(DatasetName.of("[PROJECT]", "[DATASET]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<DataItem> future =
       dataLabelingServiceClient.listDataItemsPagedCallable().futureCall(request);
   // Do something.
   for (DataItem element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListDataItemsRequest,ListDataItemsPagedResponse>

listDatasets(ListDatasetsRequest request)

public final DataLabelingServiceClient.ListDatasetsPagedResponse listDatasets(ListDatasetsRequest request)

Lists datasets under a project. Pagination is supported.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   ListDatasetsRequest request =
       ListDatasetsRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Dataset element : dataLabelingServiceClient.listDatasets(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request ListDatasetsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
DataLabelingServiceClient.ListDatasetsPagedResponse

listDatasets(ProjectName parent, String filter)

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

Lists datasets under a project. Pagination is supported.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   String filter = "filter-1274492040";
   for (Dataset element : dataLabelingServiceClient.listDatasets(parent, filter).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameters
Name Description
parent ProjectName

Required. Dataset resource parent, format: projects/{project_id}
filter String

Optional. Filter on dataset is not supported at this moment.
Returns
Type Description
DataLabelingServiceClient.ListDatasetsPagedResponse

listDatasets(String parent, String filter)

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

Lists datasets under a project. Pagination is supported.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String parent = ProjectName.of("[PROJECT]").toString();
   String filter = "filter-1274492040";
   for (Dataset element : dataLabelingServiceClient.listDatasets(parent, filter).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameters
Name Description
parent String

Required. Dataset resource parent, format: projects/{project_id}
filter String

Optional. Filter on dataset is not supported at this moment.
Returns
Type Description
DataLabelingServiceClient.ListDatasetsPagedResponse

listDatasetsCallable()

public final UnaryCallable<ListDatasetsRequest,ListDatasetsResponse> listDatasetsCallable()

Lists datasets under a project. Pagination is supported.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   ListDatasetsRequest request =
       ListDatasetsRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .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;
     }
   }
 }
Returns
Type Description
UnaryCallable<ListDatasetsRequest,ListDatasetsResponse>

listDatasetsPagedCallable()

public final UnaryCallable<ListDatasetsRequest,DataLabelingServiceClient.ListDatasetsPagedResponse> listDatasetsPagedCallable()

Lists datasets under a project. Pagination is supported.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   ListDatasetsRequest request =
       ListDatasetsRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Dataset> future =
       dataLabelingServiceClient.listDatasetsPagedCallable().futureCall(request);
   // Do something.
   for (Dataset element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListDatasetsRequest,ListDatasetsPagedResponse>

listEvaluationJobs(ListEvaluationJobsRequest request)

public final DataLabelingServiceClient.ListEvaluationJobsPagedResponse listEvaluationJobs(ListEvaluationJobsRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   ListEvaluationJobsRequest request =
       ListEvaluationJobsRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (EvaluationJob element :
       dataLabelingServiceClient.listEvaluationJobs(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request ListEvaluationJobsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
DataLabelingServiceClient.ListEvaluationJobsPagedResponse

listEvaluationJobs(ProjectName parent, String filter)

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

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   String filter = "filter-1274492040";
   for (EvaluationJob element :
       dataLabelingServiceClient.listEvaluationJobs(parent, filter).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameters
Name Description
parent ProjectName

Required. Evaluation job resource parent. Format: "projects/<var>{project_id}</var>"
filter String

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

listEvaluationJobs(String parent, String filter)

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

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String parent = ProjectName.of("[PROJECT]").toString();
   String filter = "filter-1274492040";
   for (EvaluationJob element :
       dataLabelingServiceClient.listEvaluationJobs(parent, filter).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameters
Name Description
parent String

Required. Evaluation job resource parent. Format: "projects/<var>{project_id}</var>"
filter String

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

listEvaluationJobsCallable()

public final UnaryCallable<ListEvaluationJobsRequest,ListEvaluationJobsResponse> listEvaluationJobsCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   ListEvaluationJobsRequest request =
       ListEvaluationJobsRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .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;
     }
   }
 }
Returns
Type Description
UnaryCallable<ListEvaluationJobsRequest,ListEvaluationJobsResponse>

listEvaluationJobsPagedCallable()

public final UnaryCallable<ListEvaluationJobsRequest,DataLabelingServiceClient.ListEvaluationJobsPagedResponse> listEvaluationJobsPagedCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   ListEvaluationJobsRequest request =
       ListEvaluationJobsRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<EvaluationJob> future =
       dataLabelingServiceClient.listEvaluationJobsPagedCallable().futureCall(request);
   // Do something.
   for (EvaluationJob element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListEvaluationJobsRequest,ListEvaluationJobsPagedResponse>

listExamples(AnnotatedDatasetName parent, String filter)

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

Lists examples in an annotated dataset. Pagination is supported.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   AnnotatedDatasetName parent =
       AnnotatedDatasetName.of("[PROJECT]", "[DATASET]", "[ANNOTATED_DATASET]");
   String filter = "filter-1274492040";
   for (Example element : dataLabelingServiceClient.listExamples(parent, filter).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameters
Name Description
parent AnnotatedDatasetName

Required. Example resource parent.
filter String

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}"
Returns
Type Description
DataLabelingServiceClient.ListExamplesPagedResponse

listExamples(ListExamplesRequest request)

public final DataLabelingServiceClient.ListExamplesPagedResponse listExamples(ListExamplesRequest request)

Lists examples in an annotated dataset. Pagination is supported.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   ListExamplesRequest request =
       ListExamplesRequest.newBuilder()
           .setParent(
               AnnotatedDatasetName.of("[PROJECT]", "[DATASET]", "[ANNOTATED_DATASET]")
                   .toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Example element : dataLabelingServiceClient.listExamples(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request ListExamplesRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
DataLabelingServiceClient.ListExamplesPagedResponse

listExamples(String parent, String filter)

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

Lists examples in an annotated dataset. Pagination is supported.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String parent =
       AnnotatedDatasetName.of("[PROJECT]", "[DATASET]", "[ANNOTATED_DATASET]").toString();
   String filter = "filter-1274492040";
   for (Example element : dataLabelingServiceClient.listExamples(parent, filter).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameters
Name Description
parent String

Required. Example resource parent.
filter String

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}"
Returns
Type Description
DataLabelingServiceClient.ListExamplesPagedResponse

listExamplesCallable()

public final UnaryCallable<ListExamplesRequest,ListExamplesResponse> listExamplesCallable()

Lists examples in an annotated dataset. Pagination is supported.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   ListExamplesRequest request =
       ListExamplesRequest.newBuilder()
           .setParent(
               AnnotatedDatasetName.of("[PROJECT]", "[DATASET]", "[ANNOTATED_DATASET]")
                   .toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .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;
     }
   }
 }
Returns
Type Description
UnaryCallable<ListExamplesRequest,ListExamplesResponse>

listExamplesPagedCallable()

public final UnaryCallable<ListExamplesRequest,DataLabelingServiceClient.ListExamplesPagedResponse> listExamplesPagedCallable()

Lists examples in an annotated dataset. Pagination is supported.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   ListExamplesRequest request =
       ListExamplesRequest.newBuilder()
           .setParent(
               AnnotatedDatasetName.of("[PROJECT]", "[DATASET]", "[ANNOTATED_DATASET]")
                   .toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Example> future =
       dataLabelingServiceClient.listExamplesPagedCallable().futureCall(request);
   // Do something.
   for (Example element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListExamplesRequest,ListExamplesPagedResponse>

listInstructions(ListInstructionsRequest request)

public final DataLabelingServiceClient.ListInstructionsPagedResponse listInstructions(ListInstructionsRequest request)

Lists instructions for a project. Pagination is supported.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   ListInstructionsRequest request =
       ListInstructionsRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Instruction element : dataLabelingServiceClient.listInstructions(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request ListInstructionsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
DataLabelingServiceClient.ListInstructionsPagedResponse

listInstructions(ProjectName parent, String filter)

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

Lists instructions for a project. Pagination is supported.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   String filter = "filter-1274492040";
   for (Instruction element :
       dataLabelingServiceClient.listInstructions(parent, filter).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameters
Name Description
parent ProjectName

Required. Instruction resource parent, format: projects/{project_id}
filter String

Optional. Filter is not supported at this moment.
Returns
Type Description
DataLabelingServiceClient.ListInstructionsPagedResponse

listInstructions(String parent, String filter)

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

Lists instructions for a project. Pagination is supported.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String parent = ProjectName.of("[PROJECT]").toString();
   String filter = "filter-1274492040";
   for (Instruction element :
       dataLabelingServiceClient.listInstructions(parent, filter).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameters
Name Description
parent String

Required. Instruction resource parent, format: projects/{project_id}
filter String

Optional. Filter is not supported at this moment.
Returns
Type Description
DataLabelingServiceClient.ListInstructionsPagedResponse

listInstructionsCallable()

public final UnaryCallable<ListInstructionsRequest,ListInstructionsResponse> listInstructionsCallable()

Lists instructions for a project. Pagination is supported.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   ListInstructionsRequest request =
       ListInstructionsRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .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;
     }
   }
 }
Returns
Type Description
UnaryCallable<ListInstructionsRequest,ListInstructionsResponse>

listInstructionsPagedCallable()

public final UnaryCallable<ListInstructionsRequest,DataLabelingServiceClient.ListInstructionsPagedResponse> listInstructionsPagedCallable()

Lists instructions for a project. Pagination is supported.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   ListInstructionsRequest request =
       ListInstructionsRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Instruction> future =
       dataLabelingServiceClient.listInstructionsPagedCallable().futureCall(request);
   // Do something.
   for (Instruction element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListInstructionsRequest,ListInstructionsPagedResponse>

pauseEvaluationJob(EvaluationJobName name)

public final void pauseEvaluationJob(EvaluationJobName name)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   EvaluationJobName name = EvaluationJobName.of("[PROJECT]", "[EVALUATION_JOB]");
   dataLabelingServiceClient.pauseEvaluationJob(name);
 }
Parameter
Name Description
name EvaluationJobName

Required. Name of the evaluation job that is going to be paused. Format:

"projects/<var>{project_id}</var>/evaluationJobs/<var>{evaluation_job_id}</var>"

pauseEvaluationJob(PauseEvaluationJobRequest request)

public final void pauseEvaluationJob(PauseEvaluationJobRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   PauseEvaluationJobRequest request =
       PauseEvaluationJobRequest.newBuilder()
           .setName(EvaluationJobName.of("[PROJECT]", "[EVALUATION_JOB]").toString())
           .build();
   dataLabelingServiceClient.pauseEvaluationJob(request);
 }
Parameter
Name Description
request PauseEvaluationJobRequest

The request object containing all of the parameters for the API call.

pauseEvaluationJob(String name)

public final void pauseEvaluationJob(String name)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String name = EvaluationJobName.of("[PROJECT]", "[EVALUATION_JOB]").toString();
   dataLabelingServiceClient.pauseEvaluationJob(name);
 }
Parameter
Name Description
name String

Required. Name of the evaluation job that is going to be paused. Format:

"projects/<var>{project_id}</var>/evaluationJobs/<var>{evaluation_job_id}</var>"

pauseEvaluationJobCallable()

public final UnaryCallable<PauseEvaluationJobRequest,Empty> pauseEvaluationJobCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   PauseEvaluationJobRequest request =
       PauseEvaluationJobRequest.newBuilder()
           .setName(EvaluationJobName.of("[PROJECT]", "[EVALUATION_JOB]").toString())
           .build();
   ApiFuture<Empty> future =
       dataLabelingServiceClient.pauseEvaluationJobCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
UnaryCallable<PauseEvaluationJobRequest,Empty>

resumeEvaluationJob(EvaluationJobName name)

public final void resumeEvaluationJob(EvaluationJobName name)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   EvaluationJobName name = EvaluationJobName.of("[PROJECT]", "[EVALUATION_JOB]");
   dataLabelingServiceClient.resumeEvaluationJob(name);
 }
Parameter
Name Description
name EvaluationJobName

Required. Name of the evaluation job that is going to be resumed. Format:

"projects/<var>{project_id}</var>/evaluationJobs/<var>{evaluation_job_id}</var>"

resumeEvaluationJob(ResumeEvaluationJobRequest request)

public final void resumeEvaluationJob(ResumeEvaluationJobRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   ResumeEvaluationJobRequest request =
       ResumeEvaluationJobRequest.newBuilder()
           .setName(EvaluationJobName.of("[PROJECT]", "[EVALUATION_JOB]").toString())
           .build();
   dataLabelingServiceClient.resumeEvaluationJob(request);
 }
Parameter
Name Description
request ResumeEvaluationJobRequest

The request object containing all of the parameters for the API call.

resumeEvaluationJob(String name)

public final void resumeEvaluationJob(String name)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String name = EvaluationJobName.of("[PROJECT]", "[EVALUATION_JOB]").toString();
   dataLabelingServiceClient.resumeEvaluationJob(name);
 }
Parameter
Name Description
name String

Required. Name of the evaluation job that is going to be resumed. Format:

"projects/<var>{project_id}</var>/evaluationJobs/<var>{evaluation_job_id}</var>"

resumeEvaluationJobCallable()

public final UnaryCallable<ResumeEvaluationJobRequest,Empty> resumeEvaluationJobCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   ResumeEvaluationJobRequest request =
       ResumeEvaluationJobRequest.newBuilder()
           .setName(EvaluationJobName.of("[PROJECT]", "[EVALUATION_JOB]").toString())
           .build();
   ApiFuture<Empty> future =
       dataLabelingServiceClient.resumeEvaluationJobCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
UnaryCallable<ResumeEvaluationJobRequest,Empty>

searchEvaluations(EvaluationName parent, String filter)

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

Searches evaluations within a project.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   EvaluationName parent = EvaluationName.of("[PROJECT]", "[DATASET]", "[EVALUATION]");
   String filter = "filter-1274492040";
   for (Evaluation element :
       dataLabelingServiceClient.searchEvaluations(parent, filter).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameters
Name Description
parent EvaluationName

Required. Evaluation search parent (project ID). Format: "projects/<var>{project_id}</var>"
filter String

Optional. To search evaluations, you can filter by the following:

  • evaluation<span></span>job.evaluation_job_id (the last part of EvaluationJob.name)
  • evaluation<span>
    • </span>job.model_id (the <var>{model_name}</var> portion of EvaluationJob.modelVersion)
  • evaluation<span></span>job.evaluation_job_run_time_start (Minimum threshold for the evaluationJobRunTime that created the evaluation)
  • evaluation<span>
    • </span>job.evaluation_job_run_time_end (Maximum threshold for the evaluationJobRunTime that created the evaluation)
  • evaluation<span></span>job.job_state (EvaluationJob.state)
  • annotation<span>
    • </span>spec.display_name (the Evaluation contains a metric for the annotation spec with this displayName)

To filter by multiple critiera, use the AND operator or the OR operator. The following examples shows a string that filters by several critiera:

"evaluation<span></span>job.evaluation_job_id = <var>{evaluation_job_id}</var> AND evaluation<span></span>job.model_id = <var>{model_name}</var> AND evaluation<span></span>job.evaluation_job_run_time_start = <var>{timestamp_1}</var> AND evaluation<span></span>job.evaluation_job_run_time_end = <var>{timestamp_2}</var> AND annotation<span>_</span>spec.display_name = <var>{display_name}</var>"
Returns
Type Description
DataLabelingServiceClient.SearchEvaluationsPagedResponse

searchEvaluations(SearchEvaluationsRequest request)

public final DataLabelingServiceClient.SearchEvaluationsPagedResponse searchEvaluations(SearchEvaluationsRequest request)

Searches evaluations within a project.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   SearchEvaluationsRequest request =
       SearchEvaluationsRequest.newBuilder()
           .setParent(EvaluationName.of("[PROJECT]", "[DATASET]", "[EVALUATION]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Evaluation element : dataLabelingServiceClient.searchEvaluations(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request SearchEvaluationsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
DataLabelingServiceClient.SearchEvaluationsPagedResponse

searchEvaluations(String parent, String filter)

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

Searches evaluations within a project.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String parent = EvaluationName.of("[PROJECT]", "[DATASET]", "[EVALUATION]").toString();
   String filter = "filter-1274492040";
   for (Evaluation element :
       dataLabelingServiceClient.searchEvaluations(parent, filter).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameters
Name Description
parent String

Required. Evaluation search parent (project ID). Format: "projects/<var>{project_id}</var>"
filter String

Optional. To search evaluations, you can filter by the following:

  • evaluation<span></span>job.evaluation_job_id (the last part of EvaluationJob.name)
  • evaluation<span>
    • </span>job.model_id (the <var>{model_name}</var> portion of EvaluationJob.modelVersion)
  • evaluation<span></span>job.evaluation_job_run_time_start (Minimum threshold for the evaluationJobRunTime that created the evaluation)
  • evaluation<span>
    • </span>job.evaluation_job_run_time_end (Maximum threshold for the evaluationJobRunTime that created the evaluation)
  • evaluation<span></span>job.job_state (EvaluationJob.state)
  • annotation<span>
    • </span>spec.display_name (the Evaluation contains a metric for the annotation spec with this displayName)

To filter by multiple critiera, use the AND operator or the OR operator. The following examples shows a string that filters by several critiera:

"evaluation<span></span>job.evaluation_job_id = <var>{evaluation_job_id}</var> AND evaluation<span></span>job.model_id = <var>{model_name}</var> AND evaluation<span></span>job.evaluation_job_run_time_start = <var>{timestamp_1}</var> AND evaluation<span></span>job.evaluation_job_run_time_end = <var>{timestamp_2}</var> AND annotation<span>_</span>spec.display_name = <var>{display_name}</var>"
Returns
Type Description
DataLabelingServiceClient.SearchEvaluationsPagedResponse

searchEvaluationsCallable()

public final UnaryCallable<SearchEvaluationsRequest,SearchEvaluationsResponse> searchEvaluationsCallable()

Searches evaluations within a project.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   SearchEvaluationsRequest request =
       SearchEvaluationsRequest.newBuilder()
           .setParent(EvaluationName.of("[PROJECT]", "[DATASET]", "[EVALUATION]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .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;
     }
   }
 }
Returns
Type Description
UnaryCallable<SearchEvaluationsRequest,SearchEvaluationsResponse>

searchEvaluationsPagedCallable()

public final UnaryCallable<SearchEvaluationsRequest,DataLabelingServiceClient.SearchEvaluationsPagedResponse> searchEvaluationsPagedCallable()

Searches evaluations within a project.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   SearchEvaluationsRequest request =
       SearchEvaluationsRequest.newBuilder()
           .setParent(EvaluationName.of("[PROJECT]", "[DATASET]", "[EVALUATION]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Evaluation> future =
       dataLabelingServiceClient.searchEvaluationsPagedCallable().futureCall(request);
   // Do something.
   for (Evaluation element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<SearchEvaluationsRequest,SearchEvaluationsPagedResponse>

searchExampleComparisons(EvaluationName parent)

public final DataLabelingServiceClient.SearchExampleComparisonsPagedResponse searchExampleComparisons(EvaluationName parent)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   EvaluationName parent = EvaluationName.of("[PROJECT]", "[DATASET]", "[EVALUATION]");
   for (SearchExampleComparisonsResponse.ExampleComparison element :
       dataLabelingServiceClient.searchExampleComparisons(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent EvaluationName

Required. Name of the Evaluation resource to search for example comparisons from. Format:

"projects/<var>{project_id}</var>/datasets/<var>{dataset_id}</var>/evaluations/<var>{evaluation_id}</var>"
Returns
Type Description
DataLabelingServiceClient.SearchExampleComparisonsPagedResponse

searchExampleComparisons(SearchExampleComparisonsRequest request)

public final DataLabelingServiceClient.SearchExampleComparisonsPagedResponse searchExampleComparisons(SearchExampleComparisonsRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   SearchExampleComparisonsRequest request =
       SearchExampleComparisonsRequest.newBuilder()
           .setParent(EvaluationName.of("[PROJECT]", "[DATASET]", "[EVALUATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (SearchExampleComparisonsResponse.ExampleComparison element :
       dataLabelingServiceClient.searchExampleComparisons(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request SearchExampleComparisonsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
DataLabelingServiceClient.SearchExampleComparisonsPagedResponse

searchExampleComparisons(String parent)

public final DataLabelingServiceClient.SearchExampleComparisonsPagedResponse searchExampleComparisons(String parent)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   String parent = EvaluationName.of("[PROJECT]", "[DATASET]", "[EVALUATION]").toString();
   for (SearchExampleComparisonsResponse.ExampleComparison element :
       dataLabelingServiceClient.searchExampleComparisons(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent String

Required. Name of the Evaluation resource to search for example comparisons from. Format:

"projects/<var>{project_id}</var>/datasets/<var>{dataset_id}</var>/evaluations/<var>{evaluation_id}</var>"
Returns
Type Description
DataLabelingServiceClient.SearchExampleComparisonsPagedResponse

searchExampleComparisonsCallable()

public final UnaryCallable<SearchExampleComparisonsRequest,SearchExampleComparisonsResponse> searchExampleComparisonsCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   SearchExampleComparisonsRequest request =
       SearchExampleComparisonsRequest.newBuilder()
           .setParent(EvaluationName.of("[PROJECT]", "[DATASET]", "[EVALUATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .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;
     }
   }
 }
Returns
Type Description
UnaryCallable<SearchExampleComparisonsRequest,SearchExampleComparisonsResponse>

searchExampleComparisonsPagedCallable()

public final UnaryCallable<SearchExampleComparisonsRequest,DataLabelingServiceClient.SearchExampleComparisonsPagedResponse> searchExampleComparisonsPagedCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   SearchExampleComparisonsRequest request =
       SearchExampleComparisonsRequest.newBuilder()
           .setParent(EvaluationName.of("[PROJECT]", "[DATASET]", "[EVALUATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<SearchExampleComparisonsResponse.ExampleComparison> future =
       dataLabelingServiceClient.searchExampleComparisonsPagedCallable().futureCall(request);
   // Do something.
   for (SearchExampleComparisonsResponse.ExampleComparison element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<SearchExampleComparisonsRequest,SearchExampleComparisonsPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateEvaluationJob(EvaluationJob evaluationJob, FieldMask updateMask)

public final EvaluationJob updateEvaluationJob(EvaluationJob evaluationJob, FieldMask updateMask)

Updates an evaluation job. You can only update certain fields of the job's EvaluationJobConfig: humanAnnotationConfig.instruction, exampleCount, and exampleSamplePercentage.

If you want to change any other aspect of the evaluation job, you must delete the job and create a new one.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   EvaluationJob evaluationJob = EvaluationJob.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   EvaluationJob response =
       dataLabelingServiceClient.updateEvaluationJob(evaluationJob, updateMask);
 }
Parameters
Name Description
evaluationJob EvaluationJob

Required. Evaluation job that is going to be updated.
updateMask FieldMask

Optional. Mask for which fields to update. You can only provide the following fields:

  • evaluationJobConfig.humanAnnotationConfig.instruction
  • evaluationJobConfig.exampleCount
  • evaluationJobConfig.exampleSamplePercentage

You can provide more than one of these fields by separating them with commas.
Returns
Type Description
EvaluationJob

updateEvaluationJob(UpdateEvaluationJobRequest request)

public final EvaluationJob updateEvaluationJob(UpdateEvaluationJobRequest request)

Updates an evaluation job. You can only update certain fields of the job's EvaluationJobConfig: humanAnnotationConfig.instruction, exampleCount, and exampleSamplePercentage.

If you want to change any other aspect of the evaluation job, you must delete the job and create a new one.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   UpdateEvaluationJobRequest request =
       UpdateEvaluationJobRequest.newBuilder()
           .setEvaluationJob(EvaluationJob.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   EvaluationJob response = dataLabelingServiceClient.updateEvaluationJob(request);
 }
Parameter
Name Description
request UpdateEvaluationJobRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
EvaluationJob

updateEvaluationJobCallable()

public final UnaryCallable<UpdateEvaluationJobRequest,EvaluationJob> updateEvaluationJobCallable()

Updates an evaluation job. You can only update certain fields of the job's EvaluationJobConfig: humanAnnotationConfig.instruction, exampleCount, and exampleSamplePercentage.

If you want to change any other aspect of the evaluation job, you must delete the job and create a new one.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataLabelingServiceClient dataLabelingServiceClient = DataLabelingServiceClient.create()) {
   UpdateEvaluationJobRequest request =
       UpdateEvaluationJobRequest.newBuilder()
           .setEvaluationJob(EvaluationJob.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<EvaluationJob> future =
       dataLabelingServiceClient.updateEvaluationJobCallable().futureCall(request);
   // Do something.
   EvaluationJob response = future.get();
 }
Returns
Type Description
UnaryCallable<UpdateEvaluationJobRequest,EvaluationJob>