com.google.cloud.aiplatform.v1

Class DatasetServiceClient

java.lang.Object

com.google.cloud.aiplatform.v1.DatasetServiceClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable

@Generated(value="by gapic-generator-java")
public class DatasetServiceClient
extends Object
implements com.google.api.gax.core.BackgroundResource

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

 try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
   DatasetName name = DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]");
   Dataset response = datasetServiceClient.getDataset(name);
 }
 

Note: close() needs to be called on the DatasetServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

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

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

See the individual methods for example code.

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

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

To customize credentials:

 DatasetServiceSettings datasetServiceSettings =
     DatasetServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 DatasetServiceClient datasetServiceClient = DatasetServiceClient.create(datasetServiceSettings);
 

To customize the endpoint:

 DatasetServiceSettings datasetServiceSettings =
     DatasetServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 DatasetServiceClient datasetServiceClient = DatasetServiceClient.create(datasetServiceSettings);
 

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DatasetServiceClient.ListAnnotationsFixedSizeCollection
static class	DatasetServiceClient.ListAnnotationsPage
static class	DatasetServiceClient.ListAnnotationsPagedResponse
static class	DatasetServiceClient.ListDataItemsFixedSizeCollection
static class	DatasetServiceClient.ListDataItemsPage
static class	DatasetServiceClient.ListDataItemsPagedResponse
static class	DatasetServiceClient.ListDatasetsFixedSizeCollection
static class	DatasetServiceClient.ListDatasetsPage
static class	DatasetServiceClient.ListDatasetsPagedResponse

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DatasetServiceClient(DatasetServiceSettings settings) Constructs an instance of DatasetServiceClient, using the given settings.
protected	DatasetServiceClient(DatasetServiceStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static DatasetServiceClient	create() Constructs an instance of DatasetServiceClient with default settings.
static DatasetServiceClient	create(DatasetServiceSettings settings) Constructs an instance of DatasetServiceClient, using the given settings.
static DatasetServiceClient	create(DatasetServiceStub stub) Constructs an instance of DatasetServiceClient, using the given stub for making calls.
com.google.api.gax.longrunning.OperationFuture<Dataset,CreateDatasetOperationMetadata>	createDatasetAsync(CreateDatasetRequest request) Creates a Dataset.
com.google.api.gax.longrunning.OperationFuture<Dataset,CreateDatasetOperationMetadata>	createDatasetAsync(LocationName parent, Dataset dataset) Creates a Dataset.
com.google.api.gax.longrunning.OperationFuture<Dataset,CreateDatasetOperationMetadata>	createDatasetAsync(String parent, Dataset dataset) Creates a Dataset.
com.google.api.gax.rpc.UnaryCallable<CreateDatasetRequest,com.google.longrunning.Operation>	createDatasetCallable() Creates a Dataset.
com.google.api.gax.rpc.OperationCallable<CreateDatasetRequest,Dataset,CreateDatasetOperationMetadata>	createDatasetOperationCallable() Creates a Dataset.
com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteOperationMetadata>	deleteDatasetAsync(DatasetName name) Deletes a Dataset.
com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteOperationMetadata>	deleteDatasetAsync(DeleteDatasetRequest request) Deletes a Dataset.
com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteOperationMetadata>	deleteDatasetAsync(String name) Deletes a Dataset.
com.google.api.gax.rpc.UnaryCallable<DeleteDatasetRequest,com.google.longrunning.Operation>	deleteDatasetCallable() Deletes a Dataset.
com.google.api.gax.rpc.OperationCallable<DeleteDatasetRequest,com.google.protobuf.Empty,DeleteOperationMetadata>	deleteDatasetOperationCallable() Deletes a Dataset.
com.google.api.gax.longrunning.OperationFuture<ExportDataResponse,ExportDataOperationMetadata>	exportDataAsync(DatasetName name, ExportDataConfig exportConfig) Exports data from a Dataset.
com.google.api.gax.longrunning.OperationFuture<ExportDataResponse,ExportDataOperationMetadata>	exportDataAsync(ExportDataRequest request) Exports data from a Dataset.
com.google.api.gax.longrunning.OperationFuture<ExportDataResponse,ExportDataOperationMetadata>	exportDataAsync(String name, ExportDataConfig exportConfig) Exports data from a Dataset.
com.google.api.gax.rpc.UnaryCallable<ExportDataRequest,com.google.longrunning.Operation>	exportDataCallable() Exports data from a Dataset.
com.google.api.gax.rpc.OperationCallable<ExportDataRequest,ExportDataResponse,ExportDataOperationMetadata>	exportDataOperationCallable() Exports data from a Dataset.
AnnotationSpec	getAnnotationSpec(AnnotationSpecName name) Gets an AnnotationSpec.
AnnotationSpec	getAnnotationSpec(GetAnnotationSpecRequest request) Gets an AnnotationSpec.
AnnotationSpec	getAnnotationSpec(String name) Gets an AnnotationSpec.
com.google.api.gax.rpc.UnaryCallable<GetAnnotationSpecRequest,AnnotationSpec>	getAnnotationSpecCallable() Gets an AnnotationSpec.
Dataset	getDataset(DatasetName name) Gets a Dataset.
Dataset	getDataset(GetDatasetRequest request) Gets a Dataset.
Dataset	getDataset(String name) Gets a Dataset.
com.google.api.gax.rpc.UnaryCallable<GetDatasetRequest,Dataset>	getDatasetCallable() Gets a Dataset.
com.google.longrunning.OperationsClient	getOperationsClient() Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
DatasetServiceSettings	getSettings()
DatasetServiceStub	getStub()
com.google.api.gax.longrunning.OperationFuture<ImportDataResponse,ImportDataOperationMetadata>	importDataAsync(DatasetName name, List<ImportDataConfig> importConfigs) Imports data into a Dataset.
com.google.api.gax.longrunning.OperationFuture<ImportDataResponse,ImportDataOperationMetadata>	importDataAsync(ImportDataRequest request) Imports data into a Dataset.
com.google.api.gax.longrunning.OperationFuture<ImportDataResponse,ImportDataOperationMetadata>	importDataAsync(String name, List<ImportDataConfig> importConfigs) Imports data into a Dataset.
com.google.api.gax.rpc.UnaryCallable<ImportDataRequest,com.google.longrunning.Operation>	importDataCallable() Imports data into a Dataset.
com.google.api.gax.rpc.OperationCallable<ImportDataRequest,ImportDataResponse,ImportDataOperationMetadata>	importDataOperationCallable() Imports data into a Dataset.
boolean	isShutdown()
boolean	isTerminated()
DatasetServiceClient.ListAnnotationsPagedResponse	listAnnotations(DataItemName parent) Lists Annotations belongs to a dataitem
DatasetServiceClient.ListAnnotationsPagedResponse	listAnnotations(ListAnnotationsRequest request) Lists Annotations belongs to a dataitem
DatasetServiceClient.ListAnnotationsPagedResponse	listAnnotations(String parent) Lists Annotations belongs to a dataitem
com.google.api.gax.rpc.UnaryCallable<ListAnnotationsRequest,ListAnnotationsResponse>	listAnnotationsCallable() Lists Annotations belongs to a dataitem
com.google.api.gax.rpc.UnaryCallable<ListAnnotationsRequest,DatasetServiceClient.ListAnnotationsPagedResponse>	listAnnotationsPagedCallable() Lists Annotations belongs to a dataitem
DatasetServiceClient.ListDataItemsPagedResponse	listDataItems(DatasetName parent) Lists DataItems in a Dataset.
DatasetServiceClient.ListDataItemsPagedResponse	listDataItems(ListDataItemsRequest request) Lists DataItems in a Dataset.
DatasetServiceClient.ListDataItemsPagedResponse	listDataItems(String parent) Lists DataItems in a Dataset.
com.google.api.gax.rpc.UnaryCallable<ListDataItemsRequest,ListDataItemsResponse>	listDataItemsCallable() Lists DataItems in a Dataset.
com.google.api.gax.rpc.UnaryCallable<ListDataItemsRequest,DatasetServiceClient.ListDataItemsPagedResponse>	listDataItemsPagedCallable() Lists DataItems in a Dataset.
DatasetServiceClient.ListDatasetsPagedResponse	listDatasets(ListDatasetsRequest request) Lists Datasets in a Location.
DatasetServiceClient.ListDatasetsPagedResponse	listDatasets(LocationName parent) Lists Datasets in a Location.
DatasetServiceClient.ListDatasetsPagedResponse	listDatasets(String parent) Lists Datasets in a Location.
com.google.api.gax.rpc.UnaryCallable<ListDatasetsRequest,ListDatasetsResponse>	listDatasetsCallable() Lists Datasets in a Location.
com.google.api.gax.rpc.UnaryCallable<ListDatasetsRequest,DatasetServiceClient.ListDatasetsPagedResponse>	listDatasetsPagedCallable() Lists Datasets in a Location.
void	shutdown()
void	shutdownNow()
Dataset	updateDataset(Dataset dataset, com.google.protobuf.FieldMask updateMask) Updates a Dataset.
Dataset	updateDataset(UpdateDatasetRequest request) Updates a Dataset.
com.google.api.gax.rpc.UnaryCallable<UpdateDatasetRequest,Dataset>	updateDatasetCallable() Updates a Dataset.

Methods inherited from class java.lang.Object

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

Constructor Detail

DatasetServiceClient

protected DatasetServiceClient(DatasetServiceSettings settings)
                        throws IOException

Constructs an instance of DatasetServiceClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Throws:

IOException

DatasetServiceClient

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

Method Detail

create

public static final DatasetServiceClient create()
                                         throws IOException

Constructs an instance of DatasetServiceClient with default settings.

Throws:

IOException

create

public static final DatasetServiceClient create(DatasetServiceSettings settings)
                                         throws IOException

Constructs an instance of DatasetServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Throws:

IOException

create

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

Constructs an instance of DatasetServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(DatasetServiceSettings).

getSettings

public final DatasetServiceSettings getSettings()

getStub

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

getOperationsClient

public final com.google.longrunning.OperationsClient getOperationsClient()

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

createDatasetAsync

public final com.google.api.gax.longrunning.OperationFuture<Dataset,CreateDatasetOperationMetadata> createDatasetAsync(LocationName parent,
                                                                                                                       Dataset dataset)

Creates a Dataset.

Sample code:

 try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   Dataset dataset = Dataset.newBuilder().build();
   Dataset response = datasetServiceClient.createDatasetAsync(parent, dataset).get();
 }
 

Parameters:

parent - Required. The resource name of the Location to create the Dataset in. Format: `projects/{project}/locations/{location}`

dataset - Required. The Dataset to create.

Throws:

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

createDatasetAsync

public final com.google.api.gax.longrunning.OperationFuture<Dataset,CreateDatasetOperationMetadata> createDatasetAsync(String parent,
                                                                                                                       Dataset dataset)

Creates a Dataset.

Sample code:

 try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   Dataset dataset = Dataset.newBuilder().build();
   Dataset response = datasetServiceClient.createDatasetAsync(parent, dataset).get();
 }
 

Parameters:

parent - Required. The resource name of the Location to create the Dataset in. Format: `projects/{project}/locations/{location}`

dataset - Required. The Dataset to create.

Throws:

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

createDatasetAsync

public final com.google.api.gax.longrunning.OperationFuture<Dataset,CreateDatasetOperationMetadata> createDatasetAsync(CreateDatasetRequest request)

Creates a Dataset.

Sample code:

 try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
   CreateDatasetRequest request =
       CreateDatasetRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setDataset(Dataset.newBuilder().build())
           .build();
   Dataset response = datasetServiceClient.createDatasetAsync(request).get();
 }
 

Parameters:

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

Throws:

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

createDatasetOperationCallable

public final com.google.api.gax.rpc.OperationCallable<CreateDatasetRequest,Dataset,CreateDatasetOperationMetadata> createDatasetOperationCallable()

Creates a Dataset.

Sample code:

 try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
   CreateDatasetRequest request =
       CreateDatasetRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setDataset(Dataset.newBuilder().build())
           .build();
   OperationFuture<Dataset, CreateDatasetOperationMetadata> future =
       datasetServiceClient.createDatasetOperationCallable().futureCall(request);
   // Do something.
   Dataset response = future.get();
 }
 

createDatasetCallable

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

Creates a Dataset.

Sample code:

 try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
   CreateDatasetRequest request =
       CreateDatasetRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setDataset(Dataset.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       datasetServiceClient.createDatasetCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

getDataset

public final Dataset getDataset(DatasetName name)

Gets a Dataset.

Sample code:

 try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
   DatasetName name = DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]");
   Dataset response = datasetServiceClient.getDataset(name);
 }
 

Parameters:

name - Required. The name of the Dataset resource.

Throws:

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

getDataset

public final Dataset getDataset(String name)

Gets a Dataset.

Sample code:

 try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
   String name = DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]").toString();
   Dataset response = datasetServiceClient.getDataset(name);
 }
 

Parameters:

name - Required. The name of the Dataset resource.

Throws:

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

getDataset

public final Dataset getDataset(GetDatasetRequest request)

Gets a Dataset.

Sample code:

 try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
   GetDatasetRequest request =
       GetDatasetRequest.newBuilder()
           .setName(DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]").toString())
           .setReadMask(FieldMask.newBuilder().build())
           .build();
   Dataset response = datasetServiceClient.getDataset(request);
 }
 

Parameters:

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

Throws:

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

getDatasetCallable

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

Gets a Dataset.

Sample code:

 try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
   GetDatasetRequest request =
       GetDatasetRequest.newBuilder()
           .setName(DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]").toString())
           .setReadMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Dataset> future = datasetServiceClient.getDatasetCallable().futureCall(request);
   // Do something.
   Dataset response = future.get();
 }
 

updateDataset

public final Dataset updateDataset(Dataset dataset,
                                   com.google.protobuf.FieldMask updateMask)

Updates a Dataset.

Sample code:

 try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
   Dataset dataset = Dataset.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Dataset response = datasetServiceClient.updateDataset(dataset, updateMask);
 }
 

Parameters:

dataset - Required. The Dataset which replaces the resource on the server.

updateMask - Required. The update mask applies to the resource. For the `FieldMask` definition, see [google.protobuf.FieldMask][google.protobuf.FieldMask]. Updatable fields:

* `display_name` * `description` * `labels`

Throws:

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

updateDataset

public final Dataset updateDataset(UpdateDatasetRequest request)

Updates a Dataset.

Sample code:

 try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
   UpdateDatasetRequest request =
       UpdateDatasetRequest.newBuilder()
           .setDataset(Dataset.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Dataset response = datasetServiceClient.updateDataset(request);
 }
 

Parameters:

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

Throws:

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

updateDatasetCallable

public final com.google.api.gax.rpc.UnaryCallable<UpdateDatasetRequest,Dataset> updateDatasetCallable()

Updates a Dataset.

Sample code:

 try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
   UpdateDatasetRequest request =
       UpdateDatasetRequest.newBuilder()
           .setDataset(Dataset.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Dataset> future = datasetServiceClient.updateDatasetCallable().futureCall(request);
   // Do something.
   Dataset response = future.get();
 }
 

listDatasets

public final DatasetServiceClient.ListDatasetsPagedResponse listDatasets(LocationName parent)

Lists Datasets in a Location.

Sample code:

 try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (Dataset element : datasetServiceClient.listDatasets(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - Required. The name of the Dataset's parent resource. Format: `projects/{project}/locations/{location}`

Throws:

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

listDatasets

public final DatasetServiceClient.ListDatasetsPagedResponse listDatasets(String parent)

Lists Datasets in a Location.

Sample code:

 try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (Dataset element : datasetServiceClient.listDatasets(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - Required. The name of the Dataset's parent resource. Format: `projects/{project}/locations/{location}`

Throws:

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

listDatasets

public final DatasetServiceClient.ListDatasetsPagedResponse listDatasets(ListDatasetsRequest request)

Lists Datasets in a Location.

Sample code:

 try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
   ListDatasetsRequest request =
       ListDatasetsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setReadMask(FieldMask.newBuilder().build())
           .setOrderBy("orderBy-1207110587")
           .build();
   for (Dataset element : datasetServiceClient.listDatasets(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

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

Throws:

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

listDatasetsPagedCallable

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

Lists Datasets in a Location.

Sample code:

 try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
   ListDatasetsRequest request =
       ListDatasetsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setReadMask(FieldMask.newBuilder().build())
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<Dataset> future =
       datasetServiceClient.listDatasetsPagedCallable().futureCall(request);
   // Do something.
   for (Dataset element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listDatasetsCallable

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

Lists Datasets in a Location.

Sample code:

 try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
   ListDatasetsRequest request =
       ListDatasetsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setReadMask(FieldMask.newBuilder().build())
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListDatasetsResponse response = datasetServiceClient.listDatasetsCallable().call(request);
     for (Dataset element : response.getResponsesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

deleteDatasetAsync

public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteOperationMetadata> deleteDatasetAsync(DatasetName name)

Deletes a Dataset.

Sample code:

 try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
   DatasetName name = DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]");
   datasetServiceClient.deleteDatasetAsync(name).get();
 }
 

Parameters:

name - Required. The resource name of the Dataset to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}`

Throws:

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

deleteDatasetAsync

public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteOperationMetadata> deleteDatasetAsync(String name)

Deletes a Dataset.

Sample code:

 try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
   String name = DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]").toString();
   datasetServiceClient.deleteDatasetAsync(name).get();
 }
 

Parameters:

name - Required. The resource name of the Dataset to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}`

Throws:

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

deleteDatasetAsync

public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteOperationMetadata> deleteDatasetAsync(DeleteDatasetRequest request)

Deletes a Dataset.

Sample code:

 try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
   DeleteDatasetRequest request =
       DeleteDatasetRequest.newBuilder()
           .setName(DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]").toString())
           .build();
   datasetServiceClient.deleteDatasetAsync(request).get();
 }
 

Parameters:

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

Throws:

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

deleteDatasetOperationCallable

public final com.google.api.gax.rpc.OperationCallable<DeleteDatasetRequest,com.google.protobuf.Empty,DeleteOperationMetadata> deleteDatasetOperationCallable()

Deletes a Dataset.

Sample code:

 try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
   DeleteDatasetRequest request =
       DeleteDatasetRequest.newBuilder()
           .setName(DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]").toString())
           .build();
   OperationFuture<Empty, DeleteOperationMetadata> future =
       datasetServiceClient.deleteDatasetOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
 

deleteDatasetCallable

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

Deletes a Dataset.

Sample code:

 try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
   DeleteDatasetRequest request =
       DeleteDatasetRequest.newBuilder()
           .setName(DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]").toString())
           .build();
   ApiFuture<Operation> future =
       datasetServiceClient.deleteDatasetCallable().futureCall(request);
   // Do something.
   future.get();
 }
 

importDataAsync

public final com.google.api.gax.longrunning.OperationFuture<ImportDataResponse,ImportDataOperationMetadata> importDataAsync(DatasetName name,
                                                                                                                            List<ImportDataConfig> importConfigs)

Imports data into a Dataset.

Sample code:

 try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
   DatasetName name = DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]");
   List<ImportDataConfig> importConfigs = new ArrayList<>();
   ImportDataResponse response = datasetServiceClient.importDataAsync(name, importConfigs).get();
 }
 

Parameters:

name - Required. The name of the Dataset resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}`

importConfigs - Required. The desired input locations. The contents of all input locations will be imported in one batch.

Throws:

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

importDataAsync

public final com.google.api.gax.longrunning.OperationFuture<ImportDataResponse,ImportDataOperationMetadata> importDataAsync(String name,
                                                                                                                            List<ImportDataConfig> importConfigs)

Imports data into a Dataset.

Sample code:

 try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
   String name = DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]").toString();
   List<ImportDataConfig> importConfigs = new ArrayList<>();
   ImportDataResponse response = datasetServiceClient.importDataAsync(name, importConfigs).get();
 }
 

Parameters:

name - Required. The name of the Dataset resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}`

importConfigs - Required. The desired input locations. The contents of all input locations will be imported in one batch.

Throws:

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

importDataAsync

public final com.google.api.gax.longrunning.OperationFuture<ImportDataResponse,ImportDataOperationMetadata> importDataAsync(ImportDataRequest request)

Imports data into a Dataset.

Sample code:

 try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
   ImportDataRequest request =
       ImportDataRequest.newBuilder()
           .setName(DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]").toString())
           .addAllImportConfigs(new ArrayList<ImportDataConfig>())
           .build();
   ImportDataResponse response = datasetServiceClient.importDataAsync(request).get();
 }
 

Parameters:

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

Throws:

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

importDataOperationCallable

public final com.google.api.gax.rpc.OperationCallable<ImportDataRequest,ImportDataResponse,ImportDataOperationMetadata> importDataOperationCallable()

Imports data into a Dataset.

Sample code:

 try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
   ImportDataRequest request =
       ImportDataRequest.newBuilder()
           .setName(DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]").toString())
           .addAllImportConfigs(new ArrayList<ImportDataConfig>())
           .build();
   OperationFuture<ImportDataResponse, ImportDataOperationMetadata> future =
       datasetServiceClient.importDataOperationCallable().futureCall(request);
   // Do something.
   ImportDataResponse response = future.get();
 }
 

importDataCallable

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

Imports data into a Dataset.

Sample code:

 try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
   ImportDataRequest request =
       ImportDataRequest.newBuilder()
           .setName(DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]").toString())
           .addAllImportConfigs(new ArrayList<ImportDataConfig>())
           .build();
   ApiFuture<Operation> future = datasetServiceClient.importDataCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

exportDataAsync

public final com.google.api.gax.longrunning.OperationFuture<ExportDataResponse,ExportDataOperationMetadata> exportDataAsync(DatasetName name,
                                                                                                                            ExportDataConfig exportConfig)

Exports data from a Dataset.

Sample code:

 try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
   DatasetName name = DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]");
   ExportDataConfig exportConfig = ExportDataConfig.newBuilder().build();
   ExportDataResponse response = datasetServiceClient.exportDataAsync(name, exportConfig).get();
 }
 

Parameters:

name - Required. The name of the Dataset resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}`

exportConfig - Required. The desired output location.

Throws:

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

exportDataAsync

public final com.google.api.gax.longrunning.OperationFuture<ExportDataResponse,ExportDataOperationMetadata> exportDataAsync(String name,
                                                                                                                            ExportDataConfig exportConfig)

Exports data from a Dataset.

Sample code:

 try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
   String name = DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]").toString();
   ExportDataConfig exportConfig = ExportDataConfig.newBuilder().build();
   ExportDataResponse response = datasetServiceClient.exportDataAsync(name, exportConfig).get();
 }
 

Parameters:

name - Required. The name of the Dataset resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}`

exportConfig - Required. The desired output location.

Throws:

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

exportDataAsync

public final com.google.api.gax.longrunning.OperationFuture<ExportDataResponse,ExportDataOperationMetadata> exportDataAsync(ExportDataRequest request)

Exports data from a Dataset.

Sample code:

 try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
   ExportDataRequest request =
       ExportDataRequest.newBuilder()
           .setName(DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]").toString())
           .setExportConfig(ExportDataConfig.newBuilder().build())
           .build();
   ExportDataResponse response = datasetServiceClient.exportDataAsync(request).get();
 }
 

Parameters:

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

Throws:

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

exportDataOperationCallable

public final com.google.api.gax.rpc.OperationCallable<ExportDataRequest,ExportDataResponse,ExportDataOperationMetadata> exportDataOperationCallable()

Exports data from a Dataset.

Sample code:

 try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
   ExportDataRequest request =
       ExportDataRequest.newBuilder()
           .setName(DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]").toString())
           .setExportConfig(ExportDataConfig.newBuilder().build())
           .build();
   OperationFuture<ExportDataResponse, ExportDataOperationMetadata> future =
       datasetServiceClient.exportDataOperationCallable().futureCall(request);
   // Do something.
   ExportDataResponse response = future.get();
 }
 

exportDataCallable

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

Exports data from a Dataset.

Sample code:

 try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
   ExportDataRequest request =
       ExportDataRequest.newBuilder()
           .setName(DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]").toString())
           .setExportConfig(ExportDataConfig.newBuilder().build())
           .build();
   ApiFuture<Operation> future = datasetServiceClient.exportDataCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

listDataItems

public final DatasetServiceClient.ListDataItemsPagedResponse listDataItems(DatasetName parent)

Lists DataItems in a Dataset.

Sample code:

 try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
   DatasetName parent = DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]");
   for (DataItem element : datasetServiceClient.listDataItems(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - Required. The resource name of the Dataset to list DataItems from. Format: `projects/{project}/locations/{location}/datasets/{dataset}`

Throws:

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

listDataItems

public final DatasetServiceClient.ListDataItemsPagedResponse listDataItems(String parent)

Lists DataItems in a Dataset.

Sample code:

 try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
   String parent = DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]").toString();
   for (DataItem element : datasetServiceClient.listDataItems(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - Required. The resource name of the Dataset to list DataItems from. Format: `projects/{project}/locations/{location}/datasets/{dataset}`

Throws:

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

listDataItems

public final DatasetServiceClient.ListDataItemsPagedResponse listDataItems(ListDataItemsRequest request)

Lists DataItems in a Dataset.

Sample code:

 try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
   ListDataItemsRequest request =
       ListDataItemsRequest.newBuilder()
           .setParent(DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setReadMask(FieldMask.newBuilder().build())
           .setOrderBy("orderBy-1207110587")
           .build();
   for (DataItem element : datasetServiceClient.listDataItems(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

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

Throws:

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

listDataItemsPagedCallable

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

Lists DataItems in a Dataset.

Sample code:

 try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
   ListDataItemsRequest request =
       ListDataItemsRequest.newBuilder()
           .setParent(DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setReadMask(FieldMask.newBuilder().build())
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<DataItem> future =
       datasetServiceClient.listDataItemsPagedCallable().futureCall(request);
   // Do something.
   for (DataItem element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listDataItemsCallable

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

Lists DataItems in a Dataset.

Sample code:

 try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
   ListDataItemsRequest request =
       ListDataItemsRequest.newBuilder()
           .setParent(DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setReadMask(FieldMask.newBuilder().build())
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListDataItemsResponse response = datasetServiceClient.listDataItemsCallable().call(request);
     for (DataItem element : response.getResponsesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

getAnnotationSpec

public final AnnotationSpec getAnnotationSpec(AnnotationSpecName name)

Gets an AnnotationSpec.

Sample code:

 try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
   AnnotationSpecName name =
       AnnotationSpecName.of("[PROJECT]", "[LOCATION]", "[DATASET]", "[ANNOTATION_SPEC]");
   AnnotationSpec response = datasetServiceClient.getAnnotationSpec(name);
 }
 

Parameters:

name - Required. The name of the AnnotationSpec resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}/annotationSpecs/{annotation_spec}`

Throws:

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

getAnnotationSpec

public final AnnotationSpec getAnnotationSpec(String name)

Gets an AnnotationSpec.

Sample code:

 try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
   String name =
       AnnotationSpecName.of("[PROJECT]", "[LOCATION]", "[DATASET]", "[ANNOTATION_SPEC]")
           .toString();
   AnnotationSpec response = datasetServiceClient.getAnnotationSpec(name);
 }
 

Parameters:

name - Required. The name of the AnnotationSpec resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}/annotationSpecs/{annotation_spec}`

Throws:

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

getAnnotationSpec

public final AnnotationSpec getAnnotationSpec(GetAnnotationSpecRequest request)

Gets an AnnotationSpec.

Sample code:

 try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
   GetAnnotationSpecRequest request =
       GetAnnotationSpecRequest.newBuilder()
           .setName(
               AnnotationSpecName.of("[PROJECT]", "[LOCATION]", "[DATASET]", "[ANNOTATION_SPEC]")
                   .toString())
           .setReadMask(FieldMask.newBuilder().build())
           .build();
   AnnotationSpec response = datasetServiceClient.getAnnotationSpec(request);
 }
 

Parameters:

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

Throws:

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

getAnnotationSpecCallable

public final com.google.api.gax.rpc.UnaryCallable<GetAnnotationSpecRequest,AnnotationSpec> getAnnotationSpecCallable()

Gets an AnnotationSpec.

Sample code:

 try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
   GetAnnotationSpecRequest request =
       GetAnnotationSpecRequest.newBuilder()
           .setName(
               AnnotationSpecName.of("[PROJECT]", "[LOCATION]", "[DATASET]", "[ANNOTATION_SPEC]")
                   .toString())
           .setReadMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<AnnotationSpec> future =
       datasetServiceClient.getAnnotationSpecCallable().futureCall(request);
   // Do something.
   AnnotationSpec response = future.get();
 }
 

listAnnotations

public final DatasetServiceClient.ListAnnotationsPagedResponse listAnnotations(DataItemName parent)

Lists Annotations belongs to a dataitem

Sample code:

 try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
   DataItemName parent = DataItemName.of("[PROJECT]", "[LOCATION]", "[DATASET]", "[DATA_ITEM]");
   for (Annotation element : datasetServiceClient.listAnnotations(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - Required. The resource name of the DataItem to list Annotations from. Format: `projects/{project}/locations/{location}/datasets/{dataset}/dataItems/{data_item}`

Throws:

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

listAnnotations

public final DatasetServiceClient.ListAnnotationsPagedResponse listAnnotations(String parent)

Lists Annotations belongs to a dataitem

Sample code:

 try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
   String parent =
       DataItemName.of("[PROJECT]", "[LOCATION]", "[DATASET]", "[DATA_ITEM]").toString();
   for (Annotation element : datasetServiceClient.listAnnotations(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - Required. The resource name of the DataItem to list Annotations from. Format: `projects/{project}/locations/{location}/datasets/{dataset}/dataItems/{data_item}`

Throws:

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

listAnnotations

public final DatasetServiceClient.ListAnnotationsPagedResponse listAnnotations(ListAnnotationsRequest request)

Lists Annotations belongs to a dataitem

Sample code:

 try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
   ListAnnotationsRequest request =
       ListAnnotationsRequest.newBuilder()
           .setParent(
               DataItemName.of("[PROJECT]", "[LOCATION]", "[DATASET]", "[DATA_ITEM]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setReadMask(FieldMask.newBuilder().build())
           .setOrderBy("orderBy-1207110587")
           .build();
   for (Annotation element : datasetServiceClient.listAnnotations(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

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

Throws:

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

listAnnotationsPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListAnnotationsRequest,DatasetServiceClient.ListAnnotationsPagedResponse> listAnnotationsPagedCallable()

Lists Annotations belongs to a dataitem

Sample code:

 try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
   ListAnnotationsRequest request =
       ListAnnotationsRequest.newBuilder()
           .setParent(
               DataItemName.of("[PROJECT]", "[LOCATION]", "[DATASET]", "[DATA_ITEM]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setReadMask(FieldMask.newBuilder().build())
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<Annotation> future =
       datasetServiceClient.listAnnotationsPagedCallable().futureCall(request);
   // Do something.
   for (Annotation element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listAnnotationsCallable

public final com.google.api.gax.rpc.UnaryCallable<ListAnnotationsRequest,ListAnnotationsResponse> listAnnotationsCallable()

Lists Annotations belongs to a dataitem

Sample code:

 try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
   ListAnnotationsRequest request =
       ListAnnotationsRequest.newBuilder()
           .setParent(
               DataItemName.of("[PROJECT]", "[LOCATION]", "[DATASET]", "[DATA_ITEM]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setReadMask(FieldMask.newBuilder().build())
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListAnnotationsResponse response =
         datasetServiceClient.listAnnotationsCallable().call(request);
     for (Annotation element : response.getResponsesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

close

public final void close()

Specified by:

close in interface AutoCloseable

shutdown

public void shutdown()

Specified by:

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

isShutdown

public boolean isShutdown()

Specified by:

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

isTerminated

public boolean isTerminated()

Specified by:

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

shutdownNow

public void shutdownNow()

Specified by:

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

awaitTermination

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

Specified by:

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

Throws:

InterruptedException