Class DatasetServiceClient (2.4.0)

Version 2.4.0

• 3.42.0 (latest)
• 3.41.0
• 3.40.0
• 3.38.0
• 3.37.0
• 3.36.0
• 3.35.0
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.30.0
• 3.29.0
• 3.28.0
• 3.25.0
• 3.24.0
• 3.23.0
• 3.22.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.0.0
• 2.9.8
• 2.8.9
• 2.7.4
• 2.5.3
• 2.4.0

public class DatasetServiceClient implements BackgroundResource

Service Description: The service that handles the CRUD of Vertex AI Dataset and its child resources.

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.

Inheritance

java.lang.Object > DatasetServiceClient

Implements

BackgroundResource

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Constructors

DatasetServiceClient(DatasetServiceSettings settings)

protected DatasetServiceClient(DatasetServiceSettings settings)

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.

Parameter

Name	Description
settings	DatasetServiceSettings

DatasetServiceClient(DatasetServiceStub stub)

protected DatasetServiceClient(DatasetServiceStub stub)

Parameter

Name	Description
stub	DatasetServiceStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)

Parameters

Name	Description
duration	long
unit	TimeUnit

Returns

Type	Description
boolean

Exceptions

Type	Description
InterruptedException

close()

public final void close()

create()

public static final DatasetServiceClient create()

Constructs an instance of DatasetServiceClient with default settings.

Returns

Type	Description
DatasetServiceClient

Exceptions

Type	Description
IOException

create(DatasetServiceSettings settings)

public static final DatasetServiceClient create(DatasetServiceSettings settings)

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.

Parameter

Name	Description
settings	DatasetServiceSettings

Returns

Type	Description
DatasetServiceClient

Exceptions

Type	Description
IOException

create(DatasetServiceStub stub)

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

Parameter

Name	Description
stub	DatasetServiceStub

Returns

Type	Description
DatasetServiceClient

createDatasetAsync(CreateDatasetRequest request)

public final 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();
 }
 

Parameter

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

Returns

Type	Description
OperationFuture<Dataset,CreateDatasetOperationMetadata>

createDatasetAsync(LocationName parent, Dataset dataset)

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

Name	Description
parent	LocationName Required. The resource name of the Location to create the Dataset in. Format: projects/{project}/locations/{location}
dataset	Dataset Required. The Dataset to create.

Returns

Type	Description
OperationFuture<Dataset,CreateDatasetOperationMetadata>

createDatasetAsync(String parent, Dataset dataset)

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

Name	Description
parent	String Required. The resource name of the Location to create the Dataset in. Format: projects/{project}/locations/{location}
dataset	Dataset Required. The Dataset to create.

Returns

Type	Description
OperationFuture<Dataset,CreateDatasetOperationMetadata>

createDatasetCallable()

public final UnaryCallable<CreateDatasetRequest,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

Returns

Type	Description
UnaryCallable<CreateDatasetRequest,Operation>

createDatasetOperationCallable()

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

Returns

Type	Description
OperationCallable<CreateDatasetRequest,Dataset,CreateDatasetOperationMetadata>

deleteDatasetAsync(DatasetName name)

public final OperationFuture<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();
 }
 

Parameter

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

Returns

Type	Description
OperationFuture<Empty,DeleteOperationMetadata>

deleteDatasetAsync(DeleteDatasetRequest request)

public final OperationFuture<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();
 }
 

Parameter

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

Returns

Type	Description
OperationFuture<Empty,DeleteOperationMetadata>

deleteDatasetAsync(String name)

public final OperationFuture<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();
 }
 

Parameter

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

Returns

Type	Description
OperationFuture<Empty,DeleteOperationMetadata>

deleteDatasetCallable()

public final UnaryCallable<DeleteDatasetRequest,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

Returns

Type	Description
UnaryCallable<DeleteDatasetRequest,Operation>

deleteDatasetOperationCallable()

public final OperationCallable<DeleteDatasetRequest,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

Returns

Type	Description
OperationCallable<DeleteDatasetRequest,Empty,DeleteOperationMetadata>

exportDataAsync(DatasetName name, ExportDataConfig exportConfig)

public final 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	Description
name	DatasetName Required. The name of the Dataset resource. Format: projects/{project}/locations/{location}/datasets/{dataset}
exportConfig	ExportDataConfig Required. The desired output location.

Returns

Type	Description
OperationFuture<ExportDataResponse,ExportDataOperationMetadata>

exportDataAsync(ExportDataRequest request)

public final 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();
 }
 

Parameter

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

Returns

Type	Description
OperationFuture<ExportDataResponse,ExportDataOperationMetadata>

exportDataAsync(String name, ExportDataConfig exportConfig)

public final 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	Description
name	String Required. The name of the Dataset resource. Format: projects/{project}/locations/{location}/datasets/{dataset}
exportConfig	ExportDataConfig Required. The desired output location.

Returns

Type	Description
OperationFuture<ExportDataResponse,ExportDataOperationMetadata>

exportDataCallable()

public final UnaryCallable<ExportDataRequest,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

Returns

Type	Description
UnaryCallable<ExportDataRequest,Operation>

exportDataOperationCallable()

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

Returns

Type	Description
OperationCallable<ExportDataRequest,ExportDataResponse,ExportDataOperationMetadata>

getAnnotationSpec(AnnotationSpecName name)

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);
 }
 

Parameter

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

Returns

Type	Description
AnnotationSpec

getAnnotationSpec(GetAnnotationSpecRequest request)

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);
 }
 

Parameter

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

Returns

Type	Description
AnnotationSpec

getAnnotationSpec(String name)

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);
 }
 

Parameter

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

Returns

Type	Description
AnnotationSpec

getAnnotationSpecCallable()

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

Returns

Type	Description
UnaryCallable<GetAnnotationSpecRequest,AnnotationSpec>

getDataset(DatasetName name)

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);
 }
 

Parameter

Name	Description
name	DatasetName Required. The name of the Dataset resource.

Returns

Type	Description
Dataset

getDataset(GetDatasetRequest request)

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);
 }
 

Parameter

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

Returns

Type	Description
Dataset

getDataset(String name)

public final Dataset getDataset(String name)

Gets a Dataset.

Sample code:

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

Parameter

Name	Description
name	String Required. The name of the Dataset resource.

Returns

Type	Description
Dataset

getDatasetCallable()

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

Returns

Type	Description
UnaryCallable<GetDatasetRequest,Dataset>

getOperationsClient()

public final OperationsClient getOperationsClient()

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

Returns

Type	Description
OperationsClient

getSettings()

public final DatasetServiceSettings getSettings()

Returns

Type	Description
DatasetServiceSettings

getStub()

public DatasetServiceStub getStub()

Returns

Type	Description
DatasetServiceStub

importDataAsync(DatasetName name, List<ImportDataConfig> importConfigs)

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

Parameters

Name	Description
name	DatasetName Required. The name of the Dataset resource. Format: projects/{project}/locations/{location}/datasets/{dataset}
importConfigs	List<ImportDataConfig> Required. The desired input locations. The contents of all input locations will be imported in one batch.

Returns

Type	Description
OperationFuture<ImportDataResponse,ImportDataOperationMetadata>

importDataAsync(ImportDataRequest request)

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

Parameter

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

Returns

Type	Description
OperationFuture<ImportDataResponse,ImportDataOperationMetadata>

importDataAsync(String name, List<ImportDataConfig> importConfigs)

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

Parameters

Name	Description
name	String Required. The name of the Dataset resource. Format: projects/{project}/locations/{location}/datasets/{dataset}
importConfigs	List<ImportDataConfig> Required. The desired input locations. The contents of all input locations will be imported in one batch.

Returns

Type	Description
OperationFuture<ImportDataResponse,ImportDataOperationMetadata>

importDataCallable()

public final UnaryCallable<ImportDataRequest,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

Returns

Type	Description
UnaryCallable<ImportDataRequest,Operation>

importDataOperationCallable()

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

Returns

Type	Description
OperationCallable<ImportDataRequest,ImportDataResponse,ImportDataOperationMetadata>

isShutdown()

public boolean isShutdown()

Returns

Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns

Type	Description
boolean

listAnnotations(DataItemName parent)

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);
   }
 }
 

Parameter

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

Returns

Type	Description
DatasetServiceClient.ListAnnotationsPagedResponse

listAnnotations(ListAnnotationsRequest request)

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);
   }
 }
 

Parameter

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

Returns

Type	Description
DatasetServiceClient.ListAnnotationsPagedResponse

listAnnotations(String parent)

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);
   }
 }
 

Parameter

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

Returns

Type	Description
DatasetServiceClient.ListAnnotationsPagedResponse

listAnnotationsCallable()

public final 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;
     }
   }
 }
 

Returns

Type	Description
UnaryCallable<ListAnnotationsRequest,ListAnnotationsResponse>

listAnnotationsPagedCallable()

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

Returns

Type	Description
UnaryCallable<ListAnnotationsRequest,ListAnnotationsPagedResponse>

listDataItems(DatasetName parent)

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);
   }
 }
 

Parameter

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

Returns

Type	Description
DatasetServiceClient.ListDataItemsPagedResponse

listDataItems(ListDataItemsRequest request)

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);
   }
 }
 

Parameter

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

Returns

Type	Description
DatasetServiceClient.ListDataItemsPagedResponse

listDataItems(String parent)

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);
   }
 }
 

Parameter

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

Returns

Type	Description
DatasetServiceClient.ListDataItemsPagedResponse

listDataItemsCallable()

public final 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;
     }
   }
 }
 

Returns

Type	Description
UnaryCallable<ListDataItemsRequest,ListDataItemsResponse>

listDataItemsPagedCallable()

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

Returns

Type	Description
UnaryCallable<ListDataItemsRequest,ListDataItemsPagedResponse>

listDatasets(ListDatasetsRequest request)

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);
   }
 }
 

Parameter

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

Returns

Type	Description
DatasetServiceClient.ListDatasetsPagedResponse

listDatasets(LocationName parent)

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);
   }
 }
 

Parameter

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

Returns

Type	Description
DatasetServiceClient.ListDatasetsPagedResponse

listDatasets(String parent)

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);
   }
 }
 

Parameter

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

Returns

Type	Description
DatasetServiceClient.ListDatasetsPagedResponse

listDatasetsCallable()

public final 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;
     }
   }
 }
 

Returns

Type	Description
UnaryCallable<ListDatasetsRequest,ListDatasetsResponse>

listDatasetsPagedCallable()

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

Returns

Type	Description
UnaryCallable<ListDatasetsRequest,ListDatasetsPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateDataset(Dataset dataset, FieldMask updateMask)

public final Dataset updateDataset(Dataset dataset, 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

Name	Description
dataset	Dataset Required. The Dataset which replaces the resource on the server.
updateMask	FieldMask Required. The update mask applies to the resource. For the FieldMask definition, see google.protobuf.FieldMask. Updatable fields: * display_name * description * labels

Returns

Type	Description
Dataset

updateDataset(UpdateDatasetRequest request)

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);
 }
 

Parameter

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

Returns

Type	Description
Dataset

updateDatasetCallable()

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

Returns

Type	Description
UnaryCallable<UpdateDatasetRequest,Dataset>