Class DataLabelingServiceClient (0.134.0)

public class DataLabelingServiceClient implements BackgroundResource

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().

The surface of this class includes several types of Java methods for each of the API's methods:

  1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
  2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
  3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of DataLabelingServiceSettings to create(). For example:

To customize credentials:


 // 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

Implements

BackgroundResource

Static Methods

create()

public static final DataLabelingServiceClient create()

Constructs an instance of DataLabelingServiceClient with default settings.

Returns
TypeDescription
DataLabelingServiceClient
Exceptions
TypeDescription
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
NameDescription
settingsDataLabelingServiceSettings
Returns
TypeDescription
DataLabelingServiceClient
Exceptions
TypeDescription
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
NameDescription
stubDataLabelingServiceStub
Returns
TypeDescription
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
NameDescription
settingsDataLabelingServiceSettings

DataLabelingServiceClient(DataLabelingServiceStub stub)

protected DataLabelingServiceClient(DataLabelingServiceStub stub)
Parameter
NameDescription
stubDataLabelingServiceStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
NameDescription
durationlong
unitTimeUnit
Returns
TypeDescription
boolean
Exceptions
TypeDescription
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
NameDescription
requestCreateAnnotationSpecSetRequest

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

Returns
TypeDescription
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
NameDescription
parentProjectName

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

annotationSpecSetAnnotationSpecSet

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
TypeDescription
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
NameDescription
parentString

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

annotationSpecSetAnnotationSpecSet

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
TypeDescription
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
TypeDescription
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
NameDescription
requestCreateDatasetRequest

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

Returns
TypeDescription
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
NameDescription
parentProjectName

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

datasetDataset

Required. The dataset to be created.

Returns
TypeDescription
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
NameDescription
parentString

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

datasetDataset

Required. The dataset to be created.

Returns
TypeDescription
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
TypeDescription
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
NameDescription
requestCreateEvaluationJobRequest

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

Returns
TypeDescription
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
NameDescription
parentProjectName

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

jobEvaluationJob

Required. The evaluation job to create.

Returns
TypeDescription
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
NameDescription
parentString

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

jobEvaluationJob

Required. The evaluation job to create.

Returns
TypeDescription
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
TypeDescription
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
NameDescription
requestCreateInstructionRequest

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

Returns
TypeDescription
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
NameDescription
parentProjectName

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

instructionInstruction

Required. Instruction of how to perform the labeling task.

Returns
TypeDescription
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
NameDescription
parentString

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

instructionInstruction

Required. Instruction of how to perform the labeling task.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
requestDeleteAnnotatedDatasetRequest

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
TypeDescription
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
NameDescription
nameAnnotationSpecSetName

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
NameDescription
requestDeleteAnnotationSpecSetRequest

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
NameDescription
nameString

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
TypeDescription
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
NameDescription
nameDatasetName

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
NameDescription
requestDeleteDatasetRequest

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
NameDescription
nameString

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
TypeDescription
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
NameDescription
requestDeleteEvaluationJobRequest

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
NameDescription
nameEvaluationJobName

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
NameDescription
nameString

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
TypeDescription
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
NameDescription
requestDeleteInstructionRequest

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
NameDescription
nameInstructionName

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
NameDescription
nameString

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
TypeDescription
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
NameDescription
nameDatasetName

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

annotatedDatasetAnnotatedDatasetName

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}

filterString

Optional. Filter is not supported at this moment.

outputConfigOutputConfig

Required. Specify the output destination.

Returns
TypeDescription
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
NameDescription
nameDatasetName

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

annotatedDatasetString

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}

filterString

Optional. Filter is not supported at this moment.

outputConfigOutputConfig

Required. Specify the output destination.

Returns
TypeDescription
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
NameDescription
requestExportDataRequest

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

Returns
TypeDescription
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
NameDescription
nameString

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

annotatedDatasetAnnotatedDatasetName

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}

filterString

Optional. Filter is not supported at this moment.

outputConfigOutputConfig

Required. Specify the output destination.

Returns
TypeDescription
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
NameDescription
nameString

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

annotatedDatasetString

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}

filterString

Optional. Filter is not supported at this moment.

outputConfigOutputConfig

Required. Specify the output destination.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
nameAnnotatedDatasetName

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

Returns
TypeDescription
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
NameDescription
requestGetAnnotatedDatasetRequest

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

Returns
TypeDescription
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
NameDescription
nameString

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

Returns
TypeDescription
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
TypeDescription
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
NameDescription
nameAnnotationSpecSetName

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

Returns
TypeDescription
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
NameDescription
requestGetAnnotationSpecSetRequest

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

Returns
TypeDescription
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
NameDescription
nameString

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

Returns
TypeDescription
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
TypeDescription
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
NameDescription
nameDataItemName

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

Returns
TypeDescription
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
NameDescription
requestGetDataItemRequest

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

Returns
TypeDescription
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
NameDescription
nameString

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

Returns
TypeDescription
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
TypeDescription
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
NameDescription
nameDatasetName

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

Returns
TypeDescription
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
NameDescription
requestGetDatasetRequest

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

Returns
TypeDescription
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
NameDescription
nameString

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

Returns
TypeDescription
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
TypeDescription
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
NameDescription
nameEvaluationName

Required. Name of the evaluation. Format:

"projects/<var>{project_id}</var>/datasets/<var>{dataset_id}</var>/evaluations/<var>{evaluation_id}</var>'

Returns
TypeDescription
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
NameDescription
requestGetEvaluationRequest

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

Returns
TypeDescription
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
NameDescription
nameString

Required. Name of the evaluation. Format:

"projects/<var>{project_id}</var>/datasets/<var>{dataset_id}</var>/evaluations/<var>{evaluation_id}</var>'

Returns
TypeDescription
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
TypeDescription
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
NameDescription
nameEvaluationJobName

Required. Name of the evaluation job. Format:

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

Returns
TypeDescription
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
NameDescription
requestGetEvaluationJobRequest

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

Returns
TypeDescription
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
NameDescription
nameString

Required. Name of the evaluation job. Format:

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

Returns
TypeDescription
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
TypeDescription
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
NameDescription
nameExampleName

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

filterString

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

Returns
TypeDescription
Example

getExample(GetExampleRequest request)

public final Example getExample(GetExampleRequest request)

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

Sample code: