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: - * - *
{@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);
- * }
- * }
- *
- * 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(). - * - *
| 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. - *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. - *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. - *
|
- *
GetDataset |
- * Gets dataset by resource name. |
- *
- * Request object method variants only take one parameter, a request object, which must be constructed before the call. - *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. - *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. - *
|
- *
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. - *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. - *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. - *
|
- *
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. - *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. - *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. - *
|
- *
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. - *
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. - *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. - *
|
- *
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. - *
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. - *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. - *
|
- *
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. - *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. - *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. - *
|
- *
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. - *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. - *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. - *
|
- *
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. - *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. - *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. - *
|
- *
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. - *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. - *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. - *
|
- *
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. - *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. - *
|
- *
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. - *
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. - *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. - *
|
- *
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. - *
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. - *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. - *
|
- *
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. - *
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. - *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. - *
|
- *
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. - *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. - *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. - *
|
- *
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. - *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. - *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. - *
|
- *
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. - *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. - *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. - *
|
- *
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. - *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. - *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. - *
|
- *
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. - *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. - *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. - *
|
- *
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. - *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. - *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. - *
|
- *
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. - *
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. - *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. - *
|
- *
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. - *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. - *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. - *
|
- *
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. - *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. - *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. - *
|
- *
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. - *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. - *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. - *
|
- *
GetEvaluation |
- * Gets an evaluation by resource name (to search, use [projects.evaluations.search][google.cloud.datalabeling.v1beta1.DataLabelingService.SearchEvaluations]). |
- *
- * Request object method variants only take one parameter, a request object, which must be constructed before the call. - *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. - *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. - *
|
- *
SearchEvaluations |
- * Searches [evaluations][google.cloud.datalabeling.v1beta1.Evaluation] within a project. |
- *
- * Request object method variants only take one parameter, a request object, which must be constructed before the call. - *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. - *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. - *
|
- *
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. - *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. - *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. - *
|
- *
CreateEvaluationJob |
- * Creates an evaluation job. |
- *
- * Request object method variants only take one parameter, a request object, which must be constructed before the call. - *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. - *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. - *
|
- *
UpdateEvaluationJob |
- * Updates an evaluation job. You can only update certain fields of the job's [EvaluationJobConfig][google.cloud.datalabeling.v1beta1.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. - *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. - *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. - *
|
- *
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. - *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. - *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. - *
|
- *
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. - *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. - *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. - *
|
- *
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. - *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. - *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. - *
|
- *
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. - *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. - *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. - *
|
- *
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. - *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. - *
Callable method variants take no parameters and return 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: - * - *
{@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
- * DataLabelingServiceSettings dataLabelingServiceSettings =
- * DataLabelingServiceSettings.newBuilder()
- * .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
- * .build();
- * DataLabelingServiceClient dataLabelingServiceClient =
- * DataLabelingServiceClient.create(dataLabelingServiceSettings);
- * }
- *
- * To customize the endpoint: - * - *
{@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
- * 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. - */ -@NullMarked -@BetaApi -@Generated("by gapic-generator-java") -public class DataLabelingServiceClient implements BackgroundResource { - private final @Nullable DataLabelingServiceSettings settings; - private final DataLabelingServiceStub stub; - private final OperationsClient operationsClient; - - /** Constructs an instance of DataLabelingServiceClient with default settings. */ - public static final DataLabelingServiceClient create() throws IOException { - return create(DataLabelingServiceSettings.newBuilder().build()); - } - - /** - * 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. - */ - public static final DataLabelingServiceClient create(DataLabelingServiceSettings settings) - throws IOException { - return new DataLabelingServiceClient(settings); - } - - /** - * Constructs an instance of DataLabelingServiceClient, using the given stub for making calls. - * This is for advanced usage - prefer using create(DataLabelingServiceSettings). - */ - public static final DataLabelingServiceClient create(DataLabelingServiceStub stub) { - return new DataLabelingServiceClient(stub); - } - - /** - * 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. - */ - protected DataLabelingServiceClient(DataLabelingServiceSettings settings) throws IOException { - this.settings = settings; - this.stub = ((DataLabelingServiceStubSettings) settings.getStubSettings()).createStub(); - this.operationsClient = OperationsClient.create(this.stub.getOperationsStub()); - } - - protected DataLabelingServiceClient(DataLabelingServiceStub stub) { - this.settings = null; - this.stub = stub; - this.operationsClient = OperationsClient.create(this.stub.getOperationsStub()); - } - - public final @Nullable DataLabelingServiceSettings getSettings() { - return settings; - } - - public DataLabelingServiceStub getStub() { - return stub; - } - - /** - * Returns the OperationsClient that can be used to query the status of a long-running operation - * returned by another API method call. - */ - public final OperationsClient getOperationsClient() { - return operationsClient; - } - - // AUTO-GENERATED DOCUMENTATION AND METHOD. - /** - * Creates dataset. If success return a Dataset resource. - * - *
Sample code: - * - *
{@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);
- * }
- * }
- *
- * @param parent Required. Dataset resource parent, format: projects/{project_id}
- * @param dataset Required. The dataset to be created.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final Dataset createDataset(@Nullable ProjectName parent, Dataset dataset) {
- CreateDatasetRequest request =
- CreateDatasetRequest.newBuilder()
- .setParent(parent == null ? null : parent.toString())
- .setDataset(dataset)
- .build();
- return createDataset(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Creates dataset. If success return a Dataset resource.
- *
- * Sample code: - * - *
{@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);
- * }
- * }
- *
- * @param parent Required. Dataset resource parent, format: projects/{project_id}
- * @param dataset Required. The dataset to be created.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final Dataset createDataset(String parent, Dataset dataset) {
- CreateDatasetRequest request =
- CreateDatasetRequest.newBuilder().setParent(parent).setDataset(dataset).build();
- return createDataset(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Creates dataset. If success return a Dataset resource.
- *
- * Sample code: - * - *
{@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);
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final Dataset createDataset(CreateDatasetRequest request) {
- return createDatasetCallable().call(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Creates dataset. If success return a Dataset resource.
- *
- * Sample code: - * - *
{@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 future =
- * dataLabelingServiceClient.createDatasetCallable().futureCall(request);
- * // Do something.
- * Dataset response = future.get();
- * }
- * }
- */
- public final UnaryCallableSample code: - * - *
{@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);
- * }
- * }
- *
- * @param name Required. Dataset resource name, format:
- * projects/{project_id}/datasets/{dataset_id}
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final Dataset getDataset(@Nullable DatasetName name) {
- GetDatasetRequest request =
- GetDatasetRequest.newBuilder().setName(name == null ? null : name.toString()).build();
- return getDataset(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Gets dataset by resource name.
- *
- * Sample code: - * - *
{@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);
- * }
- * }
- *
- * @param name Required. Dataset resource name, format:
- * projects/{project_id}/datasets/{dataset_id}
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final Dataset getDataset(String name) {
- GetDatasetRequest request = GetDatasetRequest.newBuilder().setName(name).build();
- return getDataset(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Gets dataset by resource name.
- *
- * Sample code: - * - *
{@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);
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final Dataset getDataset(GetDatasetRequest request) {
- return getDatasetCallable().call(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Gets dataset by resource name.
- *
- * Sample code: - * - *
{@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 future =
- * dataLabelingServiceClient.getDatasetCallable().futureCall(request);
- * // Do something.
- * Dataset response = future.get();
- * }
- * }
- */
- public final UnaryCallableSample code: - * - *
{@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);
- * }
- * }
- * }
- *
- * @param parent Required. Dataset resource parent, format: projects/{project_id}
- * @param filter Optional. Filter on dataset is not supported at this moment.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final ListDatasetsPagedResponse listDatasets(@Nullable ProjectName parent, String filter) {
- ListDatasetsRequest request =
- ListDatasetsRequest.newBuilder()
- .setParent(parent == null ? null : parent.toString())
- .setFilter(filter)
- .build();
- return listDatasets(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Lists datasets under a project. Pagination is supported.
- *
- * Sample code: - * - *
{@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);
- * }
- * }
- * }
- *
- * @param parent Required. Dataset resource parent, format: projects/{project_id}
- * @param filter Optional. Filter on dataset is not supported at this moment.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final ListDatasetsPagedResponse listDatasets(String parent, String filter) {
- ListDatasetsRequest request =
- ListDatasetsRequest.newBuilder().setParent(parent).setFilter(filter).build();
- return listDatasets(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Lists datasets under a project. Pagination is supported.
- *
- * Sample code: - * - *
{@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);
- * }
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final ListDatasetsPagedResponse listDatasets(ListDatasetsRequest request) {
- return listDatasetsPagedCallable().call(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Lists datasets under a project. Pagination is supported.
- *
- * Sample code: - * - *
{@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 future =
- * dataLabelingServiceClient.listDatasetsPagedCallable().futureCall(request);
- * // Do something.
- * for (Dataset element : future.get().iterateAll()) {
- * // doThingsWith(element);
- * }
- * }
- * }
- */
- public final UnaryCallableSample code: - * - *
{@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;
- * }
- * }
- * }
- * }
- */
- public final UnaryCallableSample code: - * - *
{@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);
- * }
- * }
- *
- * @param name Required. Dataset resource name, format:
- * projects/{project_id}/datasets/{dataset_id}
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final void deleteDataset(@Nullable DatasetName name) {
- DeleteDatasetRequest request =
- DeleteDatasetRequest.newBuilder().setName(name == null ? null : name.toString()).build();
- deleteDataset(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Deletes a dataset by resource name.
- *
- * Sample code: - * - *
{@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);
- * }
- * }
- *
- * @param name Required. Dataset resource name, format:
- * projects/{project_id}/datasets/{dataset_id}
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final void deleteDataset(String name) {
- DeleteDatasetRequest request = DeleteDatasetRequest.newBuilder().setName(name).build();
- deleteDataset(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Deletes a dataset by resource name.
- *
- * Sample code: - * - *
{@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);
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final void deleteDataset(DeleteDatasetRequest request) {
- deleteDatasetCallable().call(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Deletes a dataset by resource name.
- *
- * Sample code: - * - *
{@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 future =
- * dataLabelingServiceClient.deleteDatasetCallable().futureCall(request);
- * // Do something.
- * future.get();
- * }
- * }
- */
- public final UnaryCallableSample code: - * - *
{@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();
- * }
- * }
- *
- * @param name Required. Dataset resource name, format:
- * projects/{project_id}/datasets/{dataset_id}
- * @param inputConfig Required. Specify the input source of the data.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final OperationFutureSample code: - * - *
{@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();
- * }
- * }
- *
- * @param name Required. Dataset resource name, format:
- * projects/{project_id}/datasets/{dataset_id}
- * @param inputConfig Required. Specify the input source of the data.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final OperationFutureSample code: - * - *
{@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();
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final OperationFutureSample code: - * - *
{@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 future =
- * dataLabelingServiceClient.importDataOperationCallable().futureCall(request);
- * // Do something.
- * ImportDataOperationResponse response = future.get();
- * }
- * }
- */
- public final OperationCallable<
- ImportDataRequest, ImportDataOperationResponse, ImportDataOperationMetadata>
- importDataOperationCallable() {
- return stub.importDataOperationCallable();
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * 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: - * - *
{@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 future =
- * dataLabelingServiceClient.importDataCallable().futureCall(request);
- * // Do something.
- * Operation response = future.get();
- * }
- * }
- */
- public final UnaryCallableSample code: - * - *
{@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();
- * }
- * }
- *
- * @param name Required. Dataset resource name, format:
- * projects/{project_id}/datasets/{dataset_id}
- * @param annotatedDataset Required. Annotated dataset resource name. DataItem in Dataset and
- * their annotations in specified annotated dataset will be exported. It's in format of
- * projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}
- * @param filter Optional. Filter is not supported at this moment.
- * @param outputConfig Required. Specify the output destination.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final OperationFutureSample code: - * - *
{@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();
- * }
- * }
- *
- * @param name Required. Dataset resource name, format:
- * projects/{project_id}/datasets/{dataset_id}
- * @param annotatedDataset Required. Annotated dataset resource name. DataItem in Dataset and
- * their annotations in specified annotated dataset will be exported. It's in format of
- * projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}
- * @param filter Optional. Filter is not supported at this moment.
- * @param outputConfig Required. Specify the output destination.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final OperationFutureSample code: - * - *
{@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();
- * }
- * }
- *
- * @param name Required. Dataset resource name, format:
- * projects/{project_id}/datasets/{dataset_id}
- * @param annotatedDataset Required. Annotated dataset resource name. DataItem in Dataset and
- * their annotations in specified annotated dataset will be exported. It's in format of
- * projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}
- * @param filter Optional. Filter is not supported at this moment.
- * @param outputConfig Required. Specify the output destination.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final OperationFutureSample code: - * - *
{@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();
- * }
- * }
- *
- * @param name Required. Dataset resource name, format:
- * projects/{project_id}/datasets/{dataset_id}
- * @param annotatedDataset Required. Annotated dataset resource name. DataItem in Dataset and
- * their annotations in specified annotated dataset will be exported. It's in format of
- * projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}
- * @param filter Optional. Filter is not supported at this moment.
- * @param outputConfig Required. Specify the output destination.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final OperationFutureSample code: - * - *
{@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();
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final OperationFutureSample code: - * - *
{@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 future =
- * dataLabelingServiceClient.exportDataOperationCallable().futureCall(request);
- * // Do something.
- * ExportDataOperationResponse response = future.get();
- * }
- * }
- */
- public final OperationCallable<
- ExportDataRequest, ExportDataOperationResponse, ExportDataOperationMetadata>
- exportDataOperationCallable() {
- return stub.exportDataOperationCallable();
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Exports data and annotations from dataset.
- *
- * Sample code: - * - *
{@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 future =
- * dataLabelingServiceClient.exportDataCallable().futureCall(request);
- * // Do something.
- * Operation response = future.get();
- * }
- * }
- */
- public final UnaryCallableSample code: - * - *
{@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);
- * }
- * }
- *
- * @param name Required. The name of the data item to get, format:
- * projects/{project_id}/datasets/{dataset_id}/dataItems/{data_item_id}
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final DataItem getDataItem(@Nullable DataItemName name) {
- GetDataItemRequest request =
- GetDataItemRequest.newBuilder().setName(name == null ? null : name.toString()).build();
- return getDataItem(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Gets a data item in a dataset by resource name. This API can be called after data are imported
- * into dataset.
- *
- * Sample code: - * - *
{@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);
- * }
- * }
- *
- * @param name Required. The name of the data item to get, format:
- * projects/{project_id}/datasets/{dataset_id}/dataItems/{data_item_id}
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final DataItem getDataItem(String name) {
- GetDataItemRequest request = GetDataItemRequest.newBuilder().setName(name).build();
- return getDataItem(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Gets a data item in a dataset by resource name. This API can be called after data are imported
- * into dataset.
- *
- * Sample code: - * - *
{@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);
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final DataItem getDataItem(GetDataItemRequest request) {
- return getDataItemCallable().call(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Gets a data item in a dataset by resource name. This API can be called after data are imported
- * into dataset.
- *
- * Sample code: - * - *
{@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 future =
- * dataLabelingServiceClient.getDataItemCallable().futureCall(request);
- * // Do something.
- * DataItem response = future.get();
- * }
- * }
- */
- public final UnaryCallableSample code: - * - *
{@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);
- * }
- * }
- * }
- *
- * @param parent Required. Name of the dataset to list data items, format:
- * projects/{project_id}/datasets/{dataset_id}
- * @param filter Optional. Filter is not supported at this moment.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final ListDataItemsPagedResponse listDataItems(
- @Nullable DatasetName parent, String filter) {
- ListDataItemsRequest request =
- ListDataItemsRequest.newBuilder()
- .setParent(parent == null ? null : parent.toString())
- .setFilter(filter)
- .build();
- return listDataItems(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Lists data items in a dataset. This API can be called after data are imported into dataset.
- * Pagination is supported.
- *
- * Sample code: - * - *
{@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);
- * }
- * }
- * }
- *
- * @param parent Required. Name of the dataset to list data items, format:
- * projects/{project_id}/datasets/{dataset_id}
- * @param filter Optional. Filter is not supported at this moment.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final ListDataItemsPagedResponse listDataItems(String parent, String filter) {
- ListDataItemsRequest request =
- ListDataItemsRequest.newBuilder().setParent(parent).setFilter(filter).build();
- return listDataItems(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Lists data items in a dataset. This API can be called after data are imported into dataset.
- * Pagination is supported.
- *
- * Sample code: - * - *
{@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);
- * }
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final ListDataItemsPagedResponse listDataItems(ListDataItemsRequest request) {
- return listDataItemsPagedCallable().call(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Lists data items in a dataset. This API can be called after data are imported into dataset.
- * Pagination is supported.
- *
- * Sample code: - * - *
{@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 future =
- * dataLabelingServiceClient.listDataItemsPagedCallable().futureCall(request);
- * // Do something.
- * for (DataItem element : future.get().iterateAll()) {
- * // doThingsWith(element);
- * }
- * }
- * }
- */
- public final UnaryCallableSample code: - * - *
{@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;
- * }
- * }
- * }
- * }
- */
- public final UnaryCallableSample code: - * - *
{@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);
- * }
- * }
- *
- * @param name Required. Name of the annotated dataset to get, format:
- * projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final AnnotatedDataset getAnnotatedDataset(@Nullable AnnotatedDatasetName name) {
- GetAnnotatedDatasetRequest request =
- GetAnnotatedDatasetRequest.newBuilder()
- .setName(name == null ? null : name.toString())
- .build();
- return getAnnotatedDataset(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Gets an annotated dataset by resource name.
- *
- * Sample code: - * - *
{@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);
- * }
- * }
- *
- * @param name Required. Name of the annotated dataset to get, format:
- * projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final AnnotatedDataset getAnnotatedDataset(String name) {
- GetAnnotatedDatasetRequest request =
- GetAnnotatedDatasetRequest.newBuilder().setName(name).build();
- return getAnnotatedDataset(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Gets an annotated dataset by resource name.
- *
- * Sample code: - * - *
{@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);
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final AnnotatedDataset getAnnotatedDataset(GetAnnotatedDatasetRequest request) {
- return getAnnotatedDatasetCallable().call(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Gets an annotated dataset by resource name.
- *
- * Sample code: - * - *
{@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 future =
- * dataLabelingServiceClient.getAnnotatedDatasetCallable().futureCall(request);
- * // Do something.
- * AnnotatedDataset response = future.get();
- * }
- * }
- */
- public final UnaryCallableSample code: - * - *
{@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);
- * }
- * }
- * }
- *
- * @param parent Required. Name of the dataset to list annotated datasets, format:
- * projects/{project_id}/datasets/{dataset_id}
- * @param filter Optional. Filter is not supported at this moment.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final ListAnnotatedDatasetsPagedResponse listAnnotatedDatasets(
- @Nullable DatasetName parent, String filter) {
- ListAnnotatedDatasetsRequest request =
- ListAnnotatedDatasetsRequest.newBuilder()
- .setParent(parent == null ? null : parent.toString())
- .setFilter(filter)
- .build();
- return listAnnotatedDatasets(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Lists annotated datasets for a dataset. Pagination is supported.
- *
- * Sample code: - * - *
{@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);
- * }
- * }
- * }
- *
- * @param parent Required. Name of the dataset to list annotated datasets, format:
- * projects/{project_id}/datasets/{dataset_id}
- * @param filter Optional. Filter is not supported at this moment.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final ListAnnotatedDatasetsPagedResponse listAnnotatedDatasets(
- String parent, String filter) {
- ListAnnotatedDatasetsRequest request =
- ListAnnotatedDatasetsRequest.newBuilder().setParent(parent).setFilter(filter).build();
- return listAnnotatedDatasets(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Lists annotated datasets for a dataset. Pagination is supported.
- *
- * Sample code: - * - *
{@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);
- * }
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final ListAnnotatedDatasetsPagedResponse listAnnotatedDatasets(
- ListAnnotatedDatasetsRequest request) {
- return listAnnotatedDatasetsPagedCallable().call(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Lists annotated datasets for a dataset. Pagination is supported.
- *
- * Sample code: - * - *
{@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 future =
- * dataLabelingServiceClient.listAnnotatedDatasetsPagedCallable().futureCall(request);
- * // Do something.
- * for (AnnotatedDataset element : future.get().iterateAll()) {
- * // doThingsWith(element);
- * }
- * }
- * }
- */
- public final UnaryCallableSample code: - * - *
{@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;
- * }
- * }
- * }
- * }
- */
- public final UnaryCallableSample code: - * - *
{@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);
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final void deleteAnnotatedDataset(DeleteAnnotatedDatasetRequest request) {
- deleteAnnotatedDatasetCallable().call(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Deletes an annotated dataset by resource name.
- *
- * Sample code: - * - *
{@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 future =
- * dataLabelingServiceClient.deleteAnnotatedDatasetCallable().futureCall(request);
- * // Do something.
- * future.get();
- * }
- * }
- */
- public final UnaryCallableSample code: - * - *
{@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();
- * }
- * }
- *
- * @param parent Required. Name of the dataset to request labeling task, format:
- * projects/{project_id}/datasets/{dataset_id}
- * @param basicConfig Required. Basic human annotation config.
- * @param feature Required. The type of image labeling task.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final OperationFutureSample code: - * - *
{@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();
- * }
- * }
- *
- * @param parent Required. Name of the dataset to request labeling task, format:
- * projects/{project_id}/datasets/{dataset_id}
- * @param basicConfig Required. Basic human annotation config.
- * @param feature Required. The type of image labeling task.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final OperationFutureSample code: - * - *
{@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();
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final OperationFutureSample code: - * - *
{@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 future =
- * dataLabelingServiceClient.labelImageOperationCallable().futureCall(request);
- * // Do something.
- * AnnotatedDataset response = future.get();
- * }
- * }
- */
- public final OperationCallableSample code: - * - *
{@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 future =
- * dataLabelingServiceClient.labelImageCallable().futureCall(request);
- * // Do something.
- * Operation response = future.get();
- * }
- * }
- */
- public final UnaryCallableSample code: - * - *
{@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();
- * }
- * }
- *
- * @param parent Required. Name of the dataset to request labeling task, format:
- * projects/{project_id}/datasets/{dataset_id}
- * @param basicConfig Required. Basic human annotation config.
- * @param feature Required. The type of video labeling task.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final OperationFutureSample code: - * - *
{@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();
- * }
- * }
- *
- * @param parent Required. Name of the dataset to request labeling task, format:
- * projects/{project_id}/datasets/{dataset_id}
- * @param basicConfig Required. Basic human annotation config.
- * @param feature Required. The type of video labeling task.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final OperationFutureSample code: - * - *
{@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();
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final OperationFutureSample code: - * - *
{@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 future =
- * dataLabelingServiceClient.labelVideoOperationCallable().futureCall(request);
- * // Do something.
- * AnnotatedDataset response = future.get();
- * }
- * }
- */
- public final OperationCallableSample code: - * - *
{@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 future =
- * dataLabelingServiceClient.labelVideoCallable().futureCall(request);
- * // Do something.
- * Operation response = future.get();
- * }
- * }
- */
- public final UnaryCallableSample code: - * - *
{@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();
- * }
- * }
- *
- * @param parent Required. Name of the data set to request labeling task, format:
- * projects/{project_id}/datasets/{dataset_id}
- * @param basicConfig Required. Basic human annotation config.
- * @param feature Required. The type of text labeling task.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final OperationFutureSample code: - * - *
{@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();
- * }
- * }
- *
- * @param parent Required. Name of the data set to request labeling task, format:
- * projects/{project_id}/datasets/{dataset_id}
- * @param basicConfig Required. Basic human annotation config.
- * @param feature Required. The type of text labeling task.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final OperationFutureSample code: - * - *
{@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();
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final OperationFutureSample code: - * - *
{@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 future =
- * dataLabelingServiceClient.labelTextOperationCallable().futureCall(request);
- * // Do something.
- * AnnotatedDataset response = future.get();
- * }
- * }
- */
- public final OperationCallableSample code: - * - *
{@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 future =
- * dataLabelingServiceClient.labelTextCallable().futureCall(request);
- * // Do something.
- * Operation response = future.get();
- * }
- * }
- */
- public final UnaryCallableSample code: - * - *
{@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);
- * }
- * }
- *
- * @param name Required. Name of example, format:
- * projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/
- * {annotated_dataset_id}/examples/{example_id}
- * @param filter Optional. An expression for filtering Examples. Filter by
- * annotation_spec.display_name is supported. Format "annotation_spec.display_name =
- * {display_name}"
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final Example getExample(@Nullable ExampleName name, String filter) {
- GetExampleRequest request =
- GetExampleRequest.newBuilder()
- .setName(name == null ? null : name.toString())
- .setFilter(filter)
- .build();
- return getExample(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Gets an example by resource name, including both data and annotation.
- *
- * Sample code: - * - *
{@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);
- * }
- * }
- *
- * @param name Required. Name of example, format:
- * projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/
- * {annotated_dataset_id}/examples/{example_id}
- * @param filter Optional. An expression for filtering Examples. Filter by
- * annotation_spec.display_name is supported. Format "annotation_spec.display_name =
- * {display_name}"
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final Example getExample(String name, String filter) {
- GetExampleRequest request =
- GetExampleRequest.newBuilder().setName(name).setFilter(filter).build();
- return getExample(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Gets an example by resource name, including both data and annotation.
- *
- * Sample code: - * - *
{@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);
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final Example getExample(GetExampleRequest request) {
- return getExampleCallable().call(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Gets an example by resource name, including both data and annotation.
- *
- * Sample code: - * - *
{@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 future =
- * dataLabelingServiceClient.getExampleCallable().futureCall(request);
- * // Do something.
- * Example response = future.get();
- * }
- * }
- */
- public final UnaryCallableSample code: - * - *
{@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);
- * }
- * }
- * }
- *
- * @param parent Required. Example resource parent.
- * @param filter Optional. An expression for filtering Examples. For annotated datasets that have
- * annotation spec set, filter by annotation_spec.display_name is supported. Format
- * "annotation_spec.display_name = {display_name}"
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final ListExamplesPagedResponse listExamples(
- @Nullable AnnotatedDatasetName parent, String filter) {
- ListExamplesRequest request =
- ListExamplesRequest.newBuilder()
- .setParent(parent == null ? null : parent.toString())
- .setFilter(filter)
- .build();
- return listExamples(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Lists examples in an annotated dataset. Pagination is supported.
- *
- * Sample code: - * - *
{@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);
- * }
- * }
- * }
- *
- * @param parent Required. Example resource parent.
- * @param filter Optional. An expression for filtering Examples. For annotated datasets that have
- * annotation spec set, filter by annotation_spec.display_name is supported. Format
- * "annotation_spec.display_name = {display_name}"
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final ListExamplesPagedResponse listExamples(String parent, String filter) {
- ListExamplesRequest request =
- ListExamplesRequest.newBuilder().setParent(parent).setFilter(filter).build();
- return listExamples(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Lists examples in an annotated dataset. Pagination is supported.
- *
- * Sample code: - * - *
{@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);
- * }
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final ListExamplesPagedResponse listExamples(ListExamplesRequest request) {
- return listExamplesPagedCallable().call(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Lists examples in an annotated dataset. Pagination is supported.
- *
- * Sample code: - * - *
{@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 future =
- * dataLabelingServiceClient.listExamplesPagedCallable().futureCall(request);
- * // Do something.
- * for (Example element : future.get().iterateAll()) {
- * // doThingsWith(element);
- * }
- * }
- * }
- */
- public final UnaryCallableSample code: - * - *
{@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;
- * }
- * }
- * }
- * }
- */
- public final UnaryCallableSample code: - * - *
{@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);
- * }
- * }
- *
- * @param parent Required. AnnotationSpecSet resource parent, format: projects/{project_id}
- * @param annotationSpecSet Required. Annotation spec set to create. Annotation specs must be
- * included. Only one annotation spec will be accepted for annotation specs with same
- * display_name.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final AnnotationSpecSet createAnnotationSpecSet(
- @Nullable ProjectName parent, AnnotationSpecSet annotationSpecSet) {
- CreateAnnotationSpecSetRequest request =
- CreateAnnotationSpecSetRequest.newBuilder()
- .setParent(parent == null ? null : parent.toString())
- .setAnnotationSpecSet(annotationSpecSet)
- .build();
- return createAnnotationSpecSet(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Creates an annotation spec set by providing a set of labels.
- *
- * Sample code: - * - *
{@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);
- * }
- * }
- *
- * @param parent Required. AnnotationSpecSet resource parent, format: projects/{project_id}
- * @param annotationSpecSet Required. Annotation spec set to create. Annotation specs must be
- * included. Only one annotation spec will be accepted for annotation specs with same
- * display_name.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final AnnotationSpecSet createAnnotationSpecSet(
- String parent, AnnotationSpecSet annotationSpecSet) {
- CreateAnnotationSpecSetRequest request =
- CreateAnnotationSpecSetRequest.newBuilder()
- .setParent(parent)
- .setAnnotationSpecSet(annotationSpecSet)
- .build();
- return createAnnotationSpecSet(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Creates an annotation spec set by providing a set of labels.
- *
- * Sample code: - * - *
{@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);
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final AnnotationSpecSet createAnnotationSpecSet(CreateAnnotationSpecSetRequest request) {
- return createAnnotationSpecSetCallable().call(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Creates an annotation spec set by providing a set of labels.
- *
- * Sample code: - * - *
{@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 future =
- * dataLabelingServiceClient.createAnnotationSpecSetCallable().futureCall(request);
- * // Do something.
- * AnnotationSpecSet response = future.get();
- * }
- * }
- */
- public final UnaryCallableSample code: - * - *
{@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);
- * }
- * }
- *
- * @param name Required. AnnotationSpecSet resource name, format:
- * projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final AnnotationSpecSet getAnnotationSpecSet(@Nullable AnnotationSpecSetName name) {
- GetAnnotationSpecSetRequest request =
- GetAnnotationSpecSetRequest.newBuilder()
- .setName(name == null ? null : name.toString())
- .build();
- return getAnnotationSpecSet(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Gets an annotation spec set by resource name.
- *
- * Sample code: - * - *
{@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);
- * }
- * }
- *
- * @param name Required. AnnotationSpecSet resource name, format:
- * projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final AnnotationSpecSet getAnnotationSpecSet(String name) {
- GetAnnotationSpecSetRequest request =
- GetAnnotationSpecSetRequest.newBuilder().setName(name).build();
- return getAnnotationSpecSet(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Gets an annotation spec set by resource name.
- *
- * Sample code: - * - *
{@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);
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final AnnotationSpecSet getAnnotationSpecSet(GetAnnotationSpecSetRequest request) {
- return getAnnotationSpecSetCallable().call(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Gets an annotation spec set by resource name.
- *
- * Sample code: - * - *
{@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 future =
- * dataLabelingServiceClient.getAnnotationSpecSetCallable().futureCall(request);
- * // Do something.
- * AnnotationSpecSet response = future.get();
- * }
- * }
- */
- public final UnaryCallableSample code: - * - *
{@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);
- * }
- * }
- * }
- *
- * @param parent Required. Parent of AnnotationSpecSet resource, format: projects/{project_id}
- * @param filter Optional. Filter is not supported at this moment.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final ListAnnotationSpecSetsPagedResponse listAnnotationSpecSets(
- @Nullable ProjectName parent, String filter) {
- ListAnnotationSpecSetsRequest request =
- ListAnnotationSpecSetsRequest.newBuilder()
- .setParent(parent == null ? null : parent.toString())
- .setFilter(filter)
- .build();
- return listAnnotationSpecSets(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Lists annotation spec sets for a project. Pagination is supported.
- *
- * Sample code: - * - *
{@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);
- * }
- * }
- * }
- *
- * @param parent Required. Parent of AnnotationSpecSet resource, format: projects/{project_id}
- * @param filter Optional. Filter is not supported at this moment.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final ListAnnotationSpecSetsPagedResponse listAnnotationSpecSets(
- String parent, String filter) {
- ListAnnotationSpecSetsRequest request =
- ListAnnotationSpecSetsRequest.newBuilder().setParent(parent).setFilter(filter).build();
- return listAnnotationSpecSets(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Lists annotation spec sets for a project. Pagination is supported.
- *
- * Sample code: - * - *
{@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);
- * }
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final ListAnnotationSpecSetsPagedResponse listAnnotationSpecSets(
- ListAnnotationSpecSetsRequest request) {
- return listAnnotationSpecSetsPagedCallable().call(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Lists annotation spec sets for a project. Pagination is supported.
- *
- * Sample code: - * - *
{@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 future =
- * dataLabelingServiceClient.listAnnotationSpecSetsPagedCallable().futureCall(request);
- * // Do something.
- * for (AnnotationSpecSet element : future.get().iterateAll()) {
- * // doThingsWith(element);
- * }
- * }
- * }
- */
- public final UnaryCallableSample code: - * - *
{@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;
- * }
- * }
- * }
- * }
- */
- public final UnaryCallableSample code: - * - *
{@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);
- * }
- * }
- *
- * @param name Required. AnnotationSpec resource name, format:
- * `projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}`.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final void deleteAnnotationSpecSet(@Nullable AnnotationSpecSetName name) {
- DeleteAnnotationSpecSetRequest request =
- DeleteAnnotationSpecSetRequest.newBuilder()
- .setName(name == null ? null : name.toString())
- .build();
- deleteAnnotationSpecSet(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Deletes an annotation spec set by resource name.
- *
- * Sample code: - * - *
{@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);
- * }
- * }
- *
- * @param name Required. AnnotationSpec resource name, format:
- * `projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}`.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final void deleteAnnotationSpecSet(String name) {
- DeleteAnnotationSpecSetRequest request =
- DeleteAnnotationSpecSetRequest.newBuilder().setName(name).build();
- deleteAnnotationSpecSet(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Deletes an annotation spec set by resource name.
- *
- * Sample code: - * - *
{@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);
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final void deleteAnnotationSpecSet(DeleteAnnotationSpecSetRequest request) {
- deleteAnnotationSpecSetCallable().call(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Deletes an annotation spec set by resource name.
- *
- * Sample code: - * - *
{@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 future =
- * dataLabelingServiceClient.deleteAnnotationSpecSetCallable().futureCall(request);
- * // Do something.
- * future.get();
- * }
- * }
- */
- public final UnaryCallableSample code: - * - *
{@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();
- * }
- * }
- *
- * @param parent Required. Instruction resource parent, format: projects/{project_id}
- * @param instruction Required. Instruction of how to perform the labeling task.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final OperationFutureSample code: - * - *
{@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();
- * }
- * }
- *
- * @param parent Required. Instruction resource parent, format: projects/{project_id}
- * @param instruction Required. Instruction of how to perform the labeling task.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final OperationFutureSample code: - * - *
{@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();
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final OperationFutureSample code: - * - *
{@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 future =
- * dataLabelingServiceClient.createInstructionOperationCallable().futureCall(request);
- * // Do something.
- * Instruction response = future.get();
- * }
- * }
- */
- public final OperationCallableSample code: - * - *
{@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 future =
- * dataLabelingServiceClient.createInstructionCallable().futureCall(request);
- * // Do something.
- * Operation response = future.get();
- * }
- * }
- */
- public final UnaryCallableSample code: - * - *
{@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);
- * }
- * }
- *
- * @param name Required. Instruction resource name, format:
- * projects/{project_id}/instructions/{instruction_id}
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final Instruction getInstruction(@Nullable InstructionName name) {
- GetInstructionRequest request =
- GetInstructionRequest.newBuilder().setName(name == null ? null : name.toString()).build();
- return getInstruction(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Gets an instruction by resource name.
- *
- * Sample code: - * - *
{@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);
- * }
- * }
- *
- * @param name Required. Instruction resource name, format:
- * projects/{project_id}/instructions/{instruction_id}
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final Instruction getInstruction(String name) {
- GetInstructionRequest request = GetInstructionRequest.newBuilder().setName(name).build();
- return getInstruction(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Gets an instruction by resource name.
- *
- * Sample code: - * - *
{@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);
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final Instruction getInstruction(GetInstructionRequest request) {
- return getInstructionCallable().call(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Gets an instruction by resource name.
- *
- * Sample code: - * - *
{@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 future =
- * dataLabelingServiceClient.getInstructionCallable().futureCall(request);
- * // Do something.
- * Instruction response = future.get();
- * }
- * }
- */
- public final UnaryCallableSample code: - * - *
{@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);
- * }
- * }
- * }
- *
- * @param parent Required. Instruction resource parent, format: projects/{project_id}
- * @param filter Optional. Filter is not supported at this moment.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final ListInstructionsPagedResponse listInstructions(
- @Nullable ProjectName parent, String filter) {
- ListInstructionsRequest request =
- ListInstructionsRequest.newBuilder()
- .setParent(parent == null ? null : parent.toString())
- .setFilter(filter)
- .build();
- return listInstructions(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Lists instructions for a project. Pagination is supported.
- *
- * Sample code: - * - *
{@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);
- * }
- * }
- * }
- *
- * @param parent Required. Instruction resource parent, format: projects/{project_id}
- * @param filter Optional. Filter is not supported at this moment.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final ListInstructionsPagedResponse listInstructions(String parent, String filter) {
- ListInstructionsRequest request =
- ListInstructionsRequest.newBuilder().setParent(parent).setFilter(filter).build();
- return listInstructions(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Lists instructions for a project. Pagination is supported.
- *
- * Sample code: - * - *
{@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);
- * }
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final ListInstructionsPagedResponse listInstructions(ListInstructionsRequest request) {
- return listInstructionsPagedCallable().call(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Lists instructions for a project. Pagination is supported.
- *
- * Sample code: - * - *
{@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 future =
- * dataLabelingServiceClient.listInstructionsPagedCallable().futureCall(request);
- * // Do something.
- * for (Instruction element : future.get().iterateAll()) {
- * // doThingsWith(element);
- * }
- * }
- * }
- */
- public final UnaryCallableSample code: - * - *
{@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;
- * }
- * }
- * }
- * }
- */
- public final UnaryCallableSample code: - * - *
{@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);
- * }
- * }
- *
- * @param name Required. Instruction resource name, format:
- * projects/{project_id}/instructions/{instruction_id}
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final void deleteInstruction(@Nullable InstructionName name) {
- DeleteInstructionRequest request =
- DeleteInstructionRequest.newBuilder()
- .setName(name == null ? null : name.toString())
- .build();
- deleteInstruction(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Deletes an instruction object by resource name.
- *
- * Sample code: - * - *
{@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);
- * }
- * }
- *
- * @param name Required. Instruction resource name, format:
- * projects/{project_id}/instructions/{instruction_id}
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final void deleteInstruction(String name) {
- DeleteInstructionRequest request = DeleteInstructionRequest.newBuilder().setName(name).build();
- deleteInstruction(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Deletes an instruction object by resource name.
- *
- * Sample code: - * - *
{@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);
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final void deleteInstruction(DeleteInstructionRequest request) {
- deleteInstructionCallable().call(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Deletes an instruction object by resource name.
- *
- * Sample code: - * - *
{@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 future =
- * dataLabelingServiceClient.deleteInstructionCallable().futureCall(request);
- * // Do something.
- * future.get();
- * }
- * }
- */
- public final UnaryCallableSample code: - * - *
{@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);
- * }
- * }
- *
- * @param name Required. Name of the evaluation. Format:
- * "projects/<var>{project_id}</var>/datasets/<var>{dataset_id}</var>/evaluations/<var>{evaluation_id}</var>' - * @throws com.google.api.gax.rpc.ApiException if the remote call fails - */ - public final Evaluation getEvaluation(@Nullable EvaluationName name) { - GetEvaluationRequest request = - GetEvaluationRequest.newBuilder().setName(name == null ? null : name.toString()).build(); - return getEvaluation(request); - } - - // AUTO-GENERATED DOCUMENTATION AND METHOD. - /** - * Gets an evaluation by resource name (to search, use - * [projects.evaluations.search][google.cloud.datalabeling.v1beta1.DataLabelingService.SearchEvaluations]). - * - *
Sample code: - * - *
{@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);
- * }
- * }
- *
- * @param name Required. Name of the evaluation. Format:
- * "projects/<var>{project_id}</var>/datasets/<var>{dataset_id}</var>/evaluations/<var>{evaluation_id}</var>' - * @throws com.google.api.gax.rpc.ApiException if the remote call fails - */ - public final Evaluation getEvaluation(String name) { - GetEvaluationRequest request = GetEvaluationRequest.newBuilder().setName(name).build(); - return getEvaluation(request); - } - - // AUTO-GENERATED DOCUMENTATION AND METHOD. - /** - * Gets an evaluation by resource name (to search, use - * [projects.evaluations.search][google.cloud.datalabeling.v1beta1.DataLabelingService.SearchEvaluations]). - * - *
Sample code: - * - *
{@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);
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final Evaluation getEvaluation(GetEvaluationRequest request) {
- return getEvaluationCallable().call(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Gets an evaluation by resource name (to search, use
- * [projects.evaluations.search][google.cloud.datalabeling.v1beta1.DataLabelingService.SearchEvaluations]).
- *
- * Sample code: - * - *
{@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 future =
- * dataLabelingServiceClient.getEvaluationCallable().futureCall(request);
- * // Do something.
- * Evaluation response = future.get();
- * }
- * }
- */
- public final UnaryCallableSample code: - * - *
{@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);
- * }
- * }
- * }
- *
- * @param parent Required. Evaluation search parent (project ID). Format:
- * "projects/<var>{project_id}</var>"
- * @param filter Optional. To search evaluations, you can filter by the following:
- * 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>" - * @throws com.google.api.gax.rpc.ApiException if the remote call fails - */ - public final SearchEvaluationsPagedResponse searchEvaluations( - @Nullable EvaluationName parent, String filter) { - SearchEvaluationsRequest request = - SearchEvaluationsRequest.newBuilder() - .setParent(parent == null ? null : parent.toString()) - .setFilter(filter) - .build(); - return searchEvaluations(request); - } - - // AUTO-GENERATED DOCUMENTATION AND METHOD. - /** - * Searches [evaluations][google.cloud.datalabeling.v1beta1.Evaluation] within a project. - * - *
Sample code: - * - *
{@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);
- * }
- * }
- * }
- *
- * @param parent Required. Evaluation search parent (project ID). Format:
- * "projects/<var>{project_id}</var>"
- * @param filter Optional. To search evaluations, you can filter by the following:
- * 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>" - * @throws com.google.api.gax.rpc.ApiException if the remote call fails - */ - public final SearchEvaluationsPagedResponse searchEvaluations(String parent, String filter) { - SearchEvaluationsRequest request = - SearchEvaluationsRequest.newBuilder().setParent(parent).setFilter(filter).build(); - return searchEvaluations(request); - } - - // AUTO-GENERATED DOCUMENTATION AND METHOD. - /** - * Searches [evaluations][google.cloud.datalabeling.v1beta1.Evaluation] within a project. - * - *
Sample code: - * - *
{@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);
- * }
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final SearchEvaluationsPagedResponse searchEvaluations(SearchEvaluationsRequest request) {
- return searchEvaluationsPagedCallable().call(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Searches [evaluations][google.cloud.datalabeling.v1beta1.Evaluation] within a project.
- *
- * Sample code: - * - *
{@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 future =
- * dataLabelingServiceClient.searchEvaluationsPagedCallable().futureCall(request);
- * // Do something.
- * for (Evaluation element : future.get().iterateAll()) {
- * // doThingsWith(element);
- * }
- * }
- * }
- */
- public final UnaryCallableSample code: - * - *
{@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;
- * }
- * }
- * }
- * }
- */
- public final UnaryCallableSample code: - * - *
{@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);
- * }
- * }
- * }
- *
- * @param parent Required. Name of the [Evaluation][google.cloud.datalabeling.v1beta1.Evaluation]
- * resource to search for example comparisons from. Format:
- * "projects/<var>{project_id}</var>/datasets/<var>{dataset_id}</var>/evaluations/<var>{evaluation_id}</var>" - * @throws com.google.api.gax.rpc.ApiException if the remote call fails - */ - public final SearchExampleComparisonsPagedResponse searchExampleComparisons( - @Nullable EvaluationName parent) { - SearchExampleComparisonsRequest request = - SearchExampleComparisonsRequest.newBuilder() - .setParent(parent == null ? null : parent.toString()) - .build(); - return searchExampleComparisons(request); - } - - // AUTO-GENERATED DOCUMENTATION AND METHOD. - /** - * 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: - * - *
{@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);
- * }
- * }
- * }
- *
- * @param parent Required. Name of the [Evaluation][google.cloud.datalabeling.v1beta1.Evaluation]
- * resource to search for example comparisons from. Format:
- * "projects/<var>{project_id}</var>/datasets/<var>{dataset_id}</var>/evaluations/<var>{evaluation_id}</var>" - * @throws com.google.api.gax.rpc.ApiException if the remote call fails - */ - public final SearchExampleComparisonsPagedResponse searchExampleComparisons(String parent) { - SearchExampleComparisonsRequest request = - SearchExampleComparisonsRequest.newBuilder().setParent(parent).build(); - return searchExampleComparisons(request); - } - - // AUTO-GENERATED DOCUMENTATION AND METHOD. - /** - * 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: - * - *
{@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);
- * }
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final SearchExampleComparisonsPagedResponse searchExampleComparisons(
- SearchExampleComparisonsRequest request) {
- return searchExampleComparisonsPagedCallable().call(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * 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: - * - *
{@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 future =
- * dataLabelingServiceClient.searchExampleComparisonsPagedCallable().futureCall(request);
- * // Do something.
- * for (SearchExampleComparisonsResponse.ExampleComparison element : future.get().iterateAll()) {
- * // doThingsWith(element);
- * }
- * }
- * }
- */
- public final UnaryCallableSample code: - * - *
{@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;
- * }
- * }
- * }
- * }
- */
- public final UnaryCallableSample code: - * - *
{@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);
- * }
- * }
- *
- * @param parent Required. Evaluation job resource parent. Format:
- * "projects/<var>{project_id}</var>"
- * @param job Required. The evaluation job to create.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final EvaluationJob createEvaluationJob(@Nullable ProjectName parent, EvaluationJob job) {
- CreateEvaluationJobRequest request =
- CreateEvaluationJobRequest.newBuilder()
- .setParent(parent == null ? null : parent.toString())
- .setJob(job)
- .build();
- return createEvaluationJob(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Creates an evaluation job.
- *
- * Sample code: - * - *
{@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);
- * }
- * }
- *
- * @param parent Required. Evaluation job resource parent. Format:
- * "projects/<var>{project_id}</var>"
- * @param job Required. The evaluation job to create.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final EvaluationJob createEvaluationJob(String parent, EvaluationJob job) {
- CreateEvaluationJobRequest request =
- CreateEvaluationJobRequest.newBuilder().setParent(parent).setJob(job).build();
- return createEvaluationJob(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Creates an evaluation job.
- *
- * Sample code: - * - *
{@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);
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final EvaluationJob createEvaluationJob(CreateEvaluationJobRequest request) {
- return createEvaluationJobCallable().call(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Creates an evaluation job.
- *
- * Sample code: - * - *
{@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 future =
- * dataLabelingServiceClient.createEvaluationJobCallable().futureCall(request);
- * // Do something.
- * EvaluationJob response = future.get();
- * }
- * }
- */
- public final UnaryCallableIf you want to change any other aspect of the evaluation job, you must delete the job and - * create a new one. - * - *
Sample code: - * - *
{@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);
- * }
- * }
- *
- * @param evaluationJob Required. Evaluation job that is going to be updated.
- * @param updateMask Optional. Mask for which fields to update. You can only provide the following
- * fields:
- * You can provide more than one of these fields by separating them with commas. - * @throws com.google.api.gax.rpc.ApiException if the remote call fails - */ - public final EvaluationJob updateEvaluationJob( - EvaluationJob evaluationJob, FieldMask updateMask) { - UpdateEvaluationJobRequest request = - UpdateEvaluationJobRequest.newBuilder() - .setEvaluationJob(evaluationJob) - .setUpdateMask(updateMask) - .build(); - return updateEvaluationJob(request); - } - - // AUTO-GENERATED DOCUMENTATION AND METHOD. - /** - * Updates an evaluation job. You can only update certain fields of the job's - * [EvaluationJobConfig][google.cloud.datalabeling.v1beta1.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: - * - *
{@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);
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final EvaluationJob updateEvaluationJob(UpdateEvaluationJobRequest request) {
- return updateEvaluationJobCallable().call(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Updates an evaluation job. You can only update certain fields of the job's
- * [EvaluationJobConfig][google.cloud.datalabeling.v1beta1.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: - * - *
{@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 future =
- * dataLabelingServiceClient.updateEvaluationJobCallable().futureCall(request);
- * // Do something.
- * EvaluationJob response = future.get();
- * }
- * }
- */
- public final UnaryCallableSample code: - * - *
{@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);
- * }
- * }
- *
- * @param name Required. Name of the evaluation job. Format:
- * "projects/<var>{project_id}</var>/evaluationJobs/<var>{evaluation_job_id}</var>" - * @throws com.google.api.gax.rpc.ApiException if the remote call fails - */ - public final EvaluationJob getEvaluationJob(@Nullable EvaluationJobName name) { - GetEvaluationJobRequest request = - GetEvaluationJobRequest.newBuilder().setName(name == null ? null : name.toString()).build(); - return getEvaluationJob(request); - } - - // AUTO-GENERATED DOCUMENTATION AND METHOD. - /** - * Gets an evaluation job by resource name. - * - *
Sample code: - * - *
{@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);
- * }
- * }
- *
- * @param name Required. Name of the evaluation job. Format:
- * "projects/<var>{project_id}</var>/evaluationJobs/<var>{evaluation_job_id}</var>" - * @throws com.google.api.gax.rpc.ApiException if the remote call fails - */ - public final EvaluationJob getEvaluationJob(String name) { - GetEvaluationJobRequest request = GetEvaluationJobRequest.newBuilder().setName(name).build(); - return getEvaluationJob(request); - } - - // AUTO-GENERATED DOCUMENTATION AND METHOD. - /** - * Gets an evaluation job by resource name. - * - *
Sample code: - * - *
{@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);
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final EvaluationJob getEvaluationJob(GetEvaluationJobRequest request) {
- return getEvaluationJobCallable().call(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Gets an evaluation job by resource name.
- *
- * Sample code: - * - *
{@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 future =
- * dataLabelingServiceClient.getEvaluationJobCallable().futureCall(request);
- * // Do something.
- * EvaluationJob response = future.get();
- * }
- * }
- */
- public final UnaryCallableSample code: - * - *
{@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);
- * }
- * }
- *
- * @param name Required. Name of the evaluation job that is going to be paused. Format:
- * "projects/<var>{project_id}</var>/evaluationJobs/<var>{evaluation_job_id}</var>" - * @throws com.google.api.gax.rpc.ApiException if the remote call fails - */ - public final void pauseEvaluationJob(@Nullable EvaluationJobName name) { - PauseEvaluationJobRequest request = - PauseEvaluationJobRequest.newBuilder() - .setName(name == null ? null : name.toString()) - .build(); - pauseEvaluationJob(request); - } - - // AUTO-GENERATED DOCUMENTATION AND METHOD. - /** - * Pauses an evaluation job. Pausing an evaluation job that is already in a `PAUSED` state is a - * no-op. - * - *
Sample code: - * - *
{@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);
- * }
- * }
- *
- * @param name Required. Name of the evaluation job that is going to be paused. Format:
- * "projects/<var>{project_id}</var>/evaluationJobs/<var>{evaluation_job_id}</var>" - * @throws com.google.api.gax.rpc.ApiException if the remote call fails - */ - public final void pauseEvaluationJob(String name) { - PauseEvaluationJobRequest request = - PauseEvaluationJobRequest.newBuilder().setName(name).build(); - pauseEvaluationJob(request); - } - - // AUTO-GENERATED DOCUMENTATION AND METHOD. - /** - * Pauses an evaluation job. Pausing an evaluation job that is already in a `PAUSED` state is a - * no-op. - * - *
Sample code: - * - *
{@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);
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final void pauseEvaluationJob(PauseEvaluationJobRequest request) {
- pauseEvaluationJobCallable().call(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Pauses an evaluation job. Pausing an evaluation job that is already in a `PAUSED` state is a
- * no-op.
- *
- * Sample code: - * - *
{@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 future =
- * dataLabelingServiceClient.pauseEvaluationJobCallable().futureCall(request);
- * // Do something.
- * future.get();
- * }
- * }
- */
- public final UnaryCallableSample code: - * - *
{@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);
- * }
- * }
- *
- * @param name Required. Name of the evaluation job that is going to be resumed. Format:
- * "projects/<var>{project_id}</var>/evaluationJobs/<var>{evaluation_job_id}</var>" - * @throws com.google.api.gax.rpc.ApiException if the remote call fails - */ - public final void resumeEvaluationJob(@Nullable EvaluationJobName name) { - ResumeEvaluationJobRequest request = - ResumeEvaluationJobRequest.newBuilder() - .setName(name == null ? null : name.toString()) - .build(); - resumeEvaluationJob(request); - } - - // AUTO-GENERATED DOCUMENTATION AND METHOD. - /** - * 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: - * - *
{@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);
- * }
- * }
- *
- * @param name Required. Name of the evaluation job that is going to be resumed. Format:
- * "projects/<var>{project_id}</var>/evaluationJobs/<var>{evaluation_job_id}</var>" - * @throws com.google.api.gax.rpc.ApiException if the remote call fails - */ - public final void resumeEvaluationJob(String name) { - ResumeEvaluationJobRequest request = - ResumeEvaluationJobRequest.newBuilder().setName(name).build(); - resumeEvaluationJob(request); - } - - // AUTO-GENERATED DOCUMENTATION AND METHOD. - /** - * 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: - * - *
{@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);
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final void resumeEvaluationJob(ResumeEvaluationJobRequest request) {
- resumeEvaluationJobCallable().call(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * 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: - * - *
{@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 future =
- * dataLabelingServiceClient.resumeEvaluationJobCallable().futureCall(request);
- * // Do something.
- * future.get();
- * }
- * }
- */
- public final UnaryCallableSample code: - * - *
{@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);
- * }
- * }
- *
- * @param name Required. Name of the evaluation job that is going to be deleted. Format:
- * "projects/<var>{project_id}</var>/evaluationJobs/<var>{evaluation_job_id}</var>" - * @throws com.google.api.gax.rpc.ApiException if the remote call fails - */ - public final void deleteEvaluationJob(@Nullable EvaluationJobName name) { - DeleteEvaluationJobRequest request = - DeleteEvaluationJobRequest.newBuilder() - .setName(name == null ? null : name.toString()) - .build(); - deleteEvaluationJob(request); - } - - // AUTO-GENERATED DOCUMENTATION AND METHOD. - /** - * Stops and deletes an evaluation job. - * - *
Sample code: - * - *
{@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);
- * }
- * }
- *
- * @param name Required. Name of the evaluation job that is going to be deleted. Format:
- * "projects/<var>{project_id}</var>/evaluationJobs/<var>{evaluation_job_id}</var>" - * @throws com.google.api.gax.rpc.ApiException if the remote call fails - */ - public final void deleteEvaluationJob(String name) { - DeleteEvaluationJobRequest request = - DeleteEvaluationJobRequest.newBuilder().setName(name).build(); - deleteEvaluationJob(request); - } - - // AUTO-GENERATED DOCUMENTATION AND METHOD. - /** - * Stops and deletes an evaluation job. - * - *
Sample code: - * - *
{@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);
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final void deleteEvaluationJob(DeleteEvaluationJobRequest request) {
- deleteEvaluationJobCallable().call(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Stops and deletes an evaluation job.
- *
- * Sample code: - * - *
{@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 future =
- * dataLabelingServiceClient.deleteEvaluationJobCallable().futureCall(request);
- * // Do something.
- * future.get();
- * }
- * }
- */
- public final UnaryCallableSample code: - * - *
{@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);
- * }
- * }
- * }
- *
- * @param parent Required. Evaluation job resource parent. Format:
- * "projects/<var>{project_id}</var>"
- * @param filter Optional. You can filter the jobs to list by model_id (also known as model_name,
- * as described in
- * [EvaluationJob.modelVersion][google.cloud.datalabeling.v1beta1.EvaluationJob.model_version])
- * or by evaluation job state (as described in
- * [EvaluationJob.state][google.cloud.datalabeling.v1beta1.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>"
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final ListEvaluationJobsPagedResponse listEvaluationJobs(
- @Nullable ProjectName parent, String filter) {
- ListEvaluationJobsRequest request =
- ListEvaluationJobsRequest.newBuilder()
- .setParent(parent == null ? null : parent.toString())
- .setFilter(filter)
- .build();
- return listEvaluationJobs(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Lists all evaluation jobs within a project with possible filters. Pagination is supported.
- *
- * Sample code: - * - *
{@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);
- * }
- * }
- * }
- *
- * @param parent Required. Evaluation job resource parent. Format:
- * "projects/<var>{project_id}</var>"
- * @param filter Optional. You can filter the jobs to list by model_id (also known as model_name,
- * as described in
- * [EvaluationJob.modelVersion][google.cloud.datalabeling.v1beta1.EvaluationJob.model_version])
- * or by evaluation job state (as described in
- * [EvaluationJob.state][google.cloud.datalabeling.v1beta1.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>"
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final ListEvaluationJobsPagedResponse listEvaluationJobs(String parent, String filter) {
- ListEvaluationJobsRequest request =
- ListEvaluationJobsRequest.newBuilder().setParent(parent).setFilter(filter).build();
- return listEvaluationJobs(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Lists all evaluation jobs within a project with possible filters. Pagination is supported.
- *
- * Sample code: - * - *
{@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);
- * }
- * }
- * }
- *
- * @param request The request object containing all of the parameters for the API call.
- * @throws com.google.api.gax.rpc.ApiException if the remote call fails
- */
- public final ListEvaluationJobsPagedResponse listEvaluationJobs(
- ListEvaluationJobsRequest request) {
- return listEvaluationJobsPagedCallable().call(request);
- }
-
- // AUTO-GENERATED DOCUMENTATION AND METHOD.
- /**
- * Lists all evaluation jobs within a project with possible filters. Pagination is supported.
- *
- * Sample code: - * - *
{@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 future =
- * dataLabelingServiceClient.listEvaluationJobsPagedCallable().futureCall(request);
- * // Do something.
- * for (EvaluationJob element : future.get().iterateAll()) {
- * // doThingsWith(element);
- * }
- * }
- * }
- */
- public final UnaryCallableSample code: - * - *
{@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;
- * }
- * }
- * }
- * }
- */
- public final UnaryCallableThe default instance has everything set to sensible defaults: - * - *
The builder of this class is recursive, so contained classes are themselves builders. When - * build() is called, the tree of builders is called to create the complete settings object. - * - *
For example, to set the - * [RetrySettings](https://cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.retrying.RetrySettings) - * of createDataset: - * - *
{@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
- * DataLabelingServiceSettings.Builder dataLabelingServiceSettingsBuilder =
- * DataLabelingServiceSettings.newBuilder();
- * dataLabelingServiceSettingsBuilder
- * .createDatasetSettings()
- * .setRetrySettings(
- * dataLabelingServiceSettingsBuilder
- * .createDatasetSettings()
- * .getRetrySettings()
- * .toBuilder()
- * .setInitialRetryDelayDuration(Duration.ofSeconds(1))
- * .setInitialRpcTimeoutDuration(Duration.ofSeconds(5))
- * .setMaxAttempts(5)
- * .setMaxRetryDelayDuration(Duration.ofSeconds(30))
- * .setMaxRpcTimeoutDuration(Duration.ofSeconds(60))
- * .setRetryDelayMultiplier(1.3)
- * .setRpcTimeoutMultiplier(1.5)
- * .setTotalTimeoutDuration(Duration.ofSeconds(300))
- * .build());
- * DataLabelingServiceSettings dataLabelingServiceSettings =
- * dataLabelingServiceSettingsBuilder.build();
- * }
- *
- * Please refer to the [Client Side Retry
- * Guide](https://docs.cloud.google.com/java/docs/client-retries) for additional support in setting
- * retries.
- *
- * To configure the RetrySettings of a Long Running Operation method, create an - * OperationTimedPollAlgorithm object and update the RPC's polling algorithm. For example, to - * configure the RetrySettings for importData: - * - *
{@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
- * DataLabelingServiceSettings.Builder dataLabelingServiceSettingsBuilder =
- * DataLabelingServiceSettings.newBuilder();
- * TimedRetryAlgorithm timedRetryAlgorithm =
- * OperationalTimedPollAlgorithm.create(
- * RetrySettings.newBuilder()
- * .setInitialRetryDelayDuration(Duration.ofMillis(500))
- * .setRetryDelayMultiplier(1.5)
- * .setMaxRetryDelayDuration(Duration.ofMillis(5000))
- * .setTotalTimeoutDuration(Duration.ofHours(24))
- * .build());
- * dataLabelingServiceSettingsBuilder
- * .createClusterOperationSettings()
- * .setPollingAlgorithm(timedRetryAlgorithm)
- * .build();
- * }
- */
-@NullMarked
-@BetaApi
-@Generated("by gapic-generator-java")
-public class DataLabelingServiceSettings extends ClientSettingsNote: This method does not support applying settings to streaming methods.
- */
- public Builder applyToAllUnaryMethods(
- ApiFunction The interfaces provided are listed below, along with usage samples.
- *
- * ======================= DataLabelingServiceClient =======================
- *
- * Service Description: Service for the AI Platform Data Labeling API.
- *
- * Sample for DataLabelingServiceClient:
- *
- * This class is for advanced usage and reflects the underlying API directly.
- */
-@NullMarked
-@BetaApi
-@Generated("by gapic-generator-java")
-public abstract class DataLabelingServiceStub implements BackgroundResource {
-
- public @Nullable OperationsStub getOperationsStub() {
- throw new UnsupportedOperationException("Not implemented: getOperationsStub()");
- }
-
- public UnaryCallable{@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);
- * }
- * }
- */
-@Generated("by gapic-generator-java")
-package com.google.cloud.datalabeling.v1beta1;
-
-import javax.annotation.Generated;
diff --git a/java-datalabeling/google-cloud-datalabeling/src/main/java/com/google/cloud/datalabeling/v1beta1/stub/DataLabelingServiceStub.java b/java-datalabeling/google-cloud-datalabeling/src/main/java/com/google/cloud/datalabeling/v1beta1/stub/DataLabelingServiceStub.java
deleted file mode 100644
index 65206591245e..000000000000
--- a/java-datalabeling/google-cloud-datalabeling/src/main/java/com/google/cloud/datalabeling/v1beta1/stub/DataLabelingServiceStub.java
+++ /dev/null
@@ -1,337 +0,0 @@
-/*
- * Copyright 2026 Google LLC
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package com.google.cloud.datalabeling.v1beta1.stub;
-
-import static com.google.cloud.datalabeling.v1beta1.DataLabelingServiceClient.ListAnnotatedDatasetsPagedResponse;
-import static com.google.cloud.datalabeling.v1beta1.DataLabelingServiceClient.ListAnnotationSpecSetsPagedResponse;
-import static com.google.cloud.datalabeling.v1beta1.DataLabelingServiceClient.ListDataItemsPagedResponse;
-import static com.google.cloud.datalabeling.v1beta1.DataLabelingServiceClient.ListDatasetsPagedResponse;
-import static com.google.cloud.datalabeling.v1beta1.DataLabelingServiceClient.ListEvaluationJobsPagedResponse;
-import static com.google.cloud.datalabeling.v1beta1.DataLabelingServiceClient.ListExamplesPagedResponse;
-import static com.google.cloud.datalabeling.v1beta1.DataLabelingServiceClient.ListInstructionsPagedResponse;
-import static com.google.cloud.datalabeling.v1beta1.DataLabelingServiceClient.SearchEvaluationsPagedResponse;
-import static com.google.cloud.datalabeling.v1beta1.DataLabelingServiceClient.SearchExampleComparisonsPagedResponse;
-
-import com.google.api.core.BetaApi;
-import com.google.api.gax.core.BackgroundResource;
-import com.google.api.gax.rpc.OperationCallable;
-import com.google.api.gax.rpc.UnaryCallable;
-import com.google.cloud.datalabeling.v1beta1.AnnotatedDataset;
-import com.google.cloud.datalabeling.v1beta1.AnnotationSpecSet;
-import com.google.cloud.datalabeling.v1beta1.CreateAnnotationSpecSetRequest;
-import com.google.cloud.datalabeling.v1beta1.CreateDatasetRequest;
-import com.google.cloud.datalabeling.v1beta1.CreateEvaluationJobRequest;
-import com.google.cloud.datalabeling.v1beta1.CreateInstructionMetadata;
-import com.google.cloud.datalabeling.v1beta1.CreateInstructionRequest;
-import com.google.cloud.datalabeling.v1beta1.DataItem;
-import com.google.cloud.datalabeling.v1beta1.Dataset;
-import com.google.cloud.datalabeling.v1beta1.DeleteAnnotatedDatasetRequest;
-import com.google.cloud.datalabeling.v1beta1.DeleteAnnotationSpecSetRequest;
-import com.google.cloud.datalabeling.v1beta1.DeleteDatasetRequest;
-import com.google.cloud.datalabeling.v1beta1.DeleteEvaluationJobRequest;
-import com.google.cloud.datalabeling.v1beta1.DeleteInstructionRequest;
-import com.google.cloud.datalabeling.v1beta1.Evaluation;
-import com.google.cloud.datalabeling.v1beta1.EvaluationJob;
-import com.google.cloud.datalabeling.v1beta1.Example;
-import com.google.cloud.datalabeling.v1beta1.ExportDataOperationMetadata;
-import com.google.cloud.datalabeling.v1beta1.ExportDataOperationResponse;
-import com.google.cloud.datalabeling.v1beta1.ExportDataRequest;
-import com.google.cloud.datalabeling.v1beta1.GetAnnotatedDatasetRequest;
-import com.google.cloud.datalabeling.v1beta1.GetAnnotationSpecSetRequest;
-import com.google.cloud.datalabeling.v1beta1.GetDataItemRequest;
-import com.google.cloud.datalabeling.v1beta1.GetDatasetRequest;
-import com.google.cloud.datalabeling.v1beta1.GetEvaluationJobRequest;
-import com.google.cloud.datalabeling.v1beta1.GetEvaluationRequest;
-import com.google.cloud.datalabeling.v1beta1.GetExampleRequest;
-import com.google.cloud.datalabeling.v1beta1.GetInstructionRequest;
-import com.google.cloud.datalabeling.v1beta1.ImportDataOperationMetadata;
-import com.google.cloud.datalabeling.v1beta1.ImportDataOperationResponse;
-import com.google.cloud.datalabeling.v1beta1.ImportDataRequest;
-import com.google.cloud.datalabeling.v1beta1.Instruction;
-import com.google.cloud.datalabeling.v1beta1.LabelImageRequest;
-import com.google.cloud.datalabeling.v1beta1.LabelOperationMetadata;
-import com.google.cloud.datalabeling.v1beta1.LabelTextRequest;
-import com.google.cloud.datalabeling.v1beta1.LabelVideoRequest;
-import com.google.cloud.datalabeling.v1beta1.ListAnnotatedDatasetsRequest;
-import com.google.cloud.datalabeling.v1beta1.ListAnnotatedDatasetsResponse;
-import com.google.cloud.datalabeling.v1beta1.ListAnnotationSpecSetsRequest;
-import com.google.cloud.datalabeling.v1beta1.ListAnnotationSpecSetsResponse;
-import com.google.cloud.datalabeling.v1beta1.ListDataItemsRequest;
-import com.google.cloud.datalabeling.v1beta1.ListDataItemsResponse;
-import com.google.cloud.datalabeling.v1beta1.ListDatasetsRequest;
-import com.google.cloud.datalabeling.v1beta1.ListDatasetsResponse;
-import com.google.cloud.datalabeling.v1beta1.ListEvaluationJobsRequest;
-import com.google.cloud.datalabeling.v1beta1.ListEvaluationJobsResponse;
-import com.google.cloud.datalabeling.v1beta1.ListExamplesRequest;
-import com.google.cloud.datalabeling.v1beta1.ListExamplesResponse;
-import com.google.cloud.datalabeling.v1beta1.ListInstructionsRequest;
-import com.google.cloud.datalabeling.v1beta1.ListInstructionsResponse;
-import com.google.cloud.datalabeling.v1beta1.PauseEvaluationJobRequest;
-import com.google.cloud.datalabeling.v1beta1.ResumeEvaluationJobRequest;
-import com.google.cloud.datalabeling.v1beta1.SearchEvaluationsRequest;
-import com.google.cloud.datalabeling.v1beta1.SearchEvaluationsResponse;
-import com.google.cloud.datalabeling.v1beta1.SearchExampleComparisonsRequest;
-import com.google.cloud.datalabeling.v1beta1.SearchExampleComparisonsResponse;
-import com.google.cloud.datalabeling.v1beta1.UpdateEvaluationJobRequest;
-import com.google.longrunning.Operation;
-import com.google.longrunning.stub.OperationsStub;
-import com.google.protobuf.Empty;
-import javax.annotation.Generated;
-import org.jspecify.annotations.NullMarked;
-import org.jspecify.annotations.Nullable;
-
-// AUTO-GENERATED DOCUMENTATION AND CLASS.
-/**
- * Base stub class for the DataLabelingService service API.
- *
- *