- 3.48.0 (latest)
- 3.47.0
- 3.46.0
- 3.45.0
- 3.44.0
- 3.43.0
- 3.42.0
- 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
GitHub Repository | Product Reference | REST Documentation | RPC Documentation |
Service Description: The service that manages 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:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
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().
Method | Description | Method Variants |
---|---|---|
CreateDataset |
Creates a 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
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 a 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.
|
UpdateDataset |
Updates a 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.
|
ListDatasets |
Lists Datasets in a Location. |
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. |
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
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 a 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
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 from a 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
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
CreateDatasetVersion |
Create a version from a 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
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DeleteDatasetVersion |
Deletes a Dataset version. |
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
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetDatasetVersion |
Gets a Dataset version. |
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.
|
ListDatasetVersions |
Lists DatasetVersions in a 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.
|
RestoreDatasetVersion |
Restores a dataset version. |
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
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 DataItems in a 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.
|
SearchDataItems |
Searches DataItems in a Dataset. |
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.
|
ListSavedQueries |
Lists SavedQueries in a 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.
|
DeleteSavedQuery |
Deletes a SavedQuery. |
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
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetAnnotationSpec |
Gets an AnnotationSpec. |
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.
|
ListAnnotations |
Lists Annotations belongs to a dataitem |
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.
|
ListLocations |
Lists information about the supported locations for this service. |
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.
|
GetLocation |
Gets information about a location. |
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.
|
SetIamPolicy |
Sets the access control policy on the specified resource. Replacesany existing policy. Can return |
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.
|
GetIamPolicy |
Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set. |
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.
|
TestIamPermissions |
Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning. |
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.
|
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:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
DatasetServiceSettings datasetServiceSettings =
DatasetServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
DatasetServiceClient datasetServiceClient = DatasetServiceClient.create(datasetServiceSettings);
To customize the endpoint:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
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.
Static Methods
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 |
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()
createDatasetAsync(CreateDatasetRequest request)
public final OperationFuture<Dataset,CreateDatasetOperationMetadata> createDatasetAsync(CreateDatasetRequest request)
Creates a Dataset.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (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:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
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:
|
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:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
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:
|
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:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
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();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<CreateDatasetRequest,Operation> |
createDatasetOperationCallable()
public final OperationCallable<CreateDatasetRequest,Dataset,CreateDatasetOperationMetadata> createDatasetOperationCallable()
Creates a Dataset.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (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();
}
Returns | |
---|---|
Type | Description |
OperationCallable<CreateDatasetRequest,Dataset,CreateDatasetOperationMetadata> |
createDatasetVersionAsync(CreateDatasetVersionRequest request)
public final OperationFuture<DatasetVersion,CreateDatasetVersionOperationMetadata> createDatasetVersionAsync(CreateDatasetVersionRequest request)
Create a version from a Dataset.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
CreateDatasetVersionRequest request =
CreateDatasetVersionRequest.newBuilder()
.setParent(DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]").toString())
.setDatasetVersion(DatasetVersion.newBuilder().build())
.build();
DatasetVersion response = datasetServiceClient.createDatasetVersionAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request |
CreateDatasetVersionRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<DatasetVersion,CreateDatasetVersionOperationMetadata> |
createDatasetVersionAsync(DatasetName parent, DatasetVersion datasetVersion)
public final OperationFuture<DatasetVersion,CreateDatasetVersionOperationMetadata> createDatasetVersionAsync(DatasetName parent, DatasetVersion datasetVersion)
Create a version from a Dataset.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
DatasetName parent = DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]");
DatasetVersion datasetVersion = DatasetVersion.newBuilder().build();
DatasetVersion response =
datasetServiceClient.createDatasetVersionAsync(parent, datasetVersion).get();
}
Parameters | |
---|---|
Name | Description |
parent |
DatasetName Required. The name of the Dataset resource. Format:
|
datasetVersion |
DatasetVersion Required. The version to be created. The same CMEK policies with the original Dataset will be applied the dataset version. So here we don't need to specify the EncryptionSpecType here. |
Returns | |
---|---|
Type | Description |
OperationFuture<DatasetVersion,CreateDatasetVersionOperationMetadata> |
createDatasetVersionAsync(String parent, DatasetVersion datasetVersion)
public final OperationFuture<DatasetVersion,CreateDatasetVersionOperationMetadata> createDatasetVersionAsync(String parent, DatasetVersion datasetVersion)
Create a version from a Dataset.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
String parent = DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]").toString();
DatasetVersion datasetVersion = DatasetVersion.newBuilder().build();
DatasetVersion response =
datasetServiceClient.createDatasetVersionAsync(parent, datasetVersion).get();
}
Parameters | |
---|---|
Name | Description |
parent |
String Required. The name of the Dataset resource. Format:
|
datasetVersion |
DatasetVersion Required. The version to be created. The same CMEK policies with the original Dataset will be applied the dataset version. So here we don't need to specify the EncryptionSpecType here. |
Returns | |
---|---|
Type | Description |
OperationFuture<DatasetVersion,CreateDatasetVersionOperationMetadata> |
createDatasetVersionCallable()
public final UnaryCallable<CreateDatasetVersionRequest,Operation> createDatasetVersionCallable()
Create a version from a Dataset.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
CreateDatasetVersionRequest request =
CreateDatasetVersionRequest.newBuilder()
.setParent(DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]").toString())
.setDatasetVersion(DatasetVersion.newBuilder().build())
.build();
ApiFuture<Operation> future =
datasetServiceClient.createDatasetVersionCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<CreateDatasetVersionRequest,Operation> |
createDatasetVersionOperationCallable()
public final OperationCallable<CreateDatasetVersionRequest,DatasetVersion,CreateDatasetVersionOperationMetadata> createDatasetVersionOperationCallable()
Create a version from a Dataset.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
CreateDatasetVersionRequest request =
CreateDatasetVersionRequest.newBuilder()
.setParent(DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]").toString())
.setDatasetVersion(DatasetVersion.newBuilder().build())
.build();
OperationFuture<DatasetVersion, CreateDatasetVersionOperationMetadata> future =
datasetServiceClient.createDatasetVersionOperationCallable().futureCall(request);
// Do something.
DatasetVersion response = future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<CreateDatasetVersionRequest,DatasetVersion,CreateDatasetVersionOperationMetadata> |
deleteDatasetAsync(DatasetName name)
public final OperationFuture<Empty,DeleteOperationMetadata> deleteDatasetAsync(DatasetName name)
Deletes a Dataset.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (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:
|
Returns | |
---|---|
Type | Description |
OperationFuture<Empty,DeleteOperationMetadata> |
deleteDatasetAsync(DeleteDatasetRequest request)
public final OperationFuture<Empty,DeleteOperationMetadata> deleteDatasetAsync(DeleteDatasetRequest request)
Deletes a Dataset.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (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:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
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:
|
Returns | |
---|---|
Type | Description |
OperationFuture<Empty,DeleteOperationMetadata> |
deleteDatasetCallable()
public final UnaryCallable<DeleteDatasetRequest,Operation> deleteDatasetCallable()
Deletes a Dataset.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (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();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<DeleteDatasetRequest,Operation> |
deleteDatasetOperationCallable()
public final OperationCallable<DeleteDatasetRequest,Empty,DeleteOperationMetadata> deleteDatasetOperationCallable()
Deletes a Dataset.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (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();
}
Returns | |
---|---|
Type | Description |
OperationCallable<DeleteDatasetRequest,Empty,DeleteOperationMetadata> |
deleteDatasetVersionAsync(DatasetVersionName name)
public final OperationFuture<Empty,DeleteOperationMetadata> deleteDatasetVersionAsync(DatasetVersionName name)
Deletes a Dataset version.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
DatasetVersionName name =
DatasetVersionName.of("[PROJECT]", "[LOCATION]", "[DATASET]", "[DATASET_VERSION]");
datasetServiceClient.deleteDatasetVersionAsync(name).get();
}
Parameter | |
---|---|
Name | Description |
name |
DatasetVersionName Required. The resource name of the Dataset version to delete. Format:
|
Returns | |
---|---|
Type | Description |
OperationFuture<Empty,DeleteOperationMetadata> |
deleteDatasetVersionAsync(DeleteDatasetVersionRequest request)
public final OperationFuture<Empty,DeleteOperationMetadata> deleteDatasetVersionAsync(DeleteDatasetVersionRequest request)
Deletes a Dataset version.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
DeleteDatasetVersionRequest request =
DeleteDatasetVersionRequest.newBuilder()
.setName(
DatasetVersionName.of("[PROJECT]", "[LOCATION]", "[DATASET]", "[DATASET_VERSION]")
.toString())
.build();
datasetServiceClient.deleteDatasetVersionAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request |
DeleteDatasetVersionRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Empty,DeleteOperationMetadata> |
deleteDatasetVersionAsync(String name)
public final OperationFuture<Empty,DeleteOperationMetadata> deleteDatasetVersionAsync(String name)
Deletes a Dataset version.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
String name =
DatasetVersionName.of("[PROJECT]", "[LOCATION]", "[DATASET]", "[DATASET_VERSION]")
.toString();
datasetServiceClient.deleteDatasetVersionAsync(name).get();
}
Parameter | |
---|---|
Name | Description |
name |
String Required. The resource name of the Dataset version to delete. Format:
|
Returns | |
---|---|
Type | Description |
OperationFuture<Empty,DeleteOperationMetadata> |
deleteDatasetVersionCallable()
public final UnaryCallable<DeleteDatasetVersionRequest,Operation> deleteDatasetVersionCallable()
Deletes a Dataset version.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
DeleteDatasetVersionRequest request =
DeleteDatasetVersionRequest.newBuilder()
.setName(
DatasetVersionName.of("[PROJECT]", "[LOCATION]", "[DATASET]", "[DATASET_VERSION]")
.toString())
.build();
ApiFuture<Operation> future =
datasetServiceClient.deleteDatasetVersionCallable().futureCall(request);
// Do something.
future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<DeleteDatasetVersionRequest,Operation> |
deleteDatasetVersionOperationCallable()
public final OperationCallable<DeleteDatasetVersionRequest,Empty,DeleteOperationMetadata> deleteDatasetVersionOperationCallable()
Deletes a Dataset version.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
DeleteDatasetVersionRequest request =
DeleteDatasetVersionRequest.newBuilder()
.setName(
DatasetVersionName.of("[PROJECT]", "[LOCATION]", "[DATASET]", "[DATASET_VERSION]")
.toString())
.build();
OperationFuture<Empty, DeleteOperationMetadata> future =
datasetServiceClient.deleteDatasetVersionOperationCallable().futureCall(request);
// Do something.
future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<DeleteDatasetVersionRequest,Empty,DeleteOperationMetadata> |
deleteSavedQueryAsync(DeleteSavedQueryRequest request)
public final OperationFuture<Empty,DeleteOperationMetadata> deleteSavedQueryAsync(DeleteSavedQueryRequest request)
Deletes a SavedQuery.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
DeleteSavedQueryRequest request =
DeleteSavedQueryRequest.newBuilder()
.setName(
SavedQueryName.of("[PROJECT]", "[LOCATION]", "[DATASET]", "[SAVED_QUERY]")
.toString())
.build();
datasetServiceClient.deleteSavedQueryAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request |
DeleteSavedQueryRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<Empty,DeleteOperationMetadata> |
deleteSavedQueryAsync(SavedQueryName name)
public final OperationFuture<Empty,DeleteOperationMetadata> deleteSavedQueryAsync(SavedQueryName name)
Deletes a SavedQuery.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
SavedQueryName name =
SavedQueryName.of("[PROJECT]", "[LOCATION]", "[DATASET]", "[SAVED_QUERY]");
datasetServiceClient.deleteSavedQueryAsync(name).get();
}
Parameter | |
---|---|
Name | Description |
name |
SavedQueryName Required. The resource name of the SavedQuery to delete. Format:
|
Returns | |
---|---|
Type | Description |
OperationFuture<Empty,DeleteOperationMetadata> |
deleteSavedQueryAsync(String name)
public final OperationFuture<Empty,DeleteOperationMetadata> deleteSavedQueryAsync(String name)
Deletes a SavedQuery.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
String name =
SavedQueryName.of("[PROJECT]", "[LOCATION]", "[DATASET]", "[SAVED_QUERY]").toString();
datasetServiceClient.deleteSavedQueryAsync(name).get();
}
Parameter | |
---|---|
Name | Description |
name |
String Required. The resource name of the SavedQuery to delete. Format:
|
Returns | |
---|---|
Type | Description |
OperationFuture<Empty,DeleteOperationMetadata> |
deleteSavedQueryCallable()
public final UnaryCallable<DeleteSavedQueryRequest,Operation> deleteSavedQueryCallable()
Deletes a SavedQuery.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
DeleteSavedQueryRequest request =
DeleteSavedQueryRequest.newBuilder()
.setName(
SavedQueryName.of("[PROJECT]", "[LOCATION]", "[DATASET]", "[SAVED_QUERY]")
.toString())
.build();
ApiFuture<Operation> future =
datasetServiceClient.deleteSavedQueryCallable().futureCall(request);
// Do something.
future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<DeleteSavedQueryRequest,Operation> |
deleteSavedQueryOperationCallable()
public final OperationCallable<DeleteSavedQueryRequest,Empty,DeleteOperationMetadata> deleteSavedQueryOperationCallable()
Deletes a SavedQuery.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
DeleteSavedQueryRequest request =
DeleteSavedQueryRequest.newBuilder()
.setName(
SavedQueryName.of("[PROJECT]", "[LOCATION]", "[DATASET]", "[SAVED_QUERY]")
.toString())
.build();
OperationFuture<Empty, DeleteOperationMetadata> future =
datasetServiceClient.deleteSavedQueryOperationCallable().futureCall(request);
// Do something.
future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<DeleteSavedQueryRequest,Empty,DeleteOperationMetadata> |
exportDataAsync(DatasetName name, ExportDataConfig exportConfig)
public final OperationFuture<ExportDataResponse,ExportDataOperationMetadata> exportDataAsync(DatasetName name, ExportDataConfig exportConfig)
Exports data from a Dataset.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (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:
|
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:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
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:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
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:
|
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:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
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();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ExportDataRequest,Operation> |
exportDataOperationCallable()
public final OperationCallable<ExportDataRequest,ExportDataResponse,ExportDataOperationMetadata> exportDataOperationCallable()
Exports data from a Dataset.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (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();
}
Returns | |
---|---|
Type | Description |
OperationCallable<ExportDataRequest,ExportDataResponse,ExportDataOperationMetadata> |
getAnnotationSpec(AnnotationSpecName name)
public final AnnotationSpec getAnnotationSpec(AnnotationSpecName name)
Gets an AnnotationSpec.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (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:
|
Returns | |
---|---|
Type | Description |
AnnotationSpec |
getAnnotationSpec(GetAnnotationSpecRequest request)
public final AnnotationSpec getAnnotationSpec(GetAnnotationSpecRequest request)
Gets an AnnotationSpec.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (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:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
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:
|
Returns | |
---|---|
Type | Description |
AnnotationSpec |
getAnnotationSpecCallable()
public final UnaryCallable<GetAnnotationSpecRequest,AnnotationSpec> getAnnotationSpecCallable()
Gets an AnnotationSpec.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (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();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<GetAnnotationSpecRequest,AnnotationSpec> |
getDataset(DatasetName name)
public final Dataset getDataset(DatasetName name)
Gets a Dataset.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (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:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
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:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
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:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
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();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<GetDatasetRequest,Dataset> |
getDatasetVersion(DatasetVersionName name)
public final DatasetVersion getDatasetVersion(DatasetVersionName name)
Gets a Dataset version.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
DatasetVersionName name =
DatasetVersionName.of("[PROJECT]", "[LOCATION]", "[DATASET]", "[DATASET_VERSION]");
DatasetVersion response = datasetServiceClient.getDatasetVersion(name);
}
Parameter | |
---|---|
Name | Description |
name |
DatasetVersionName Required. The resource name of the Dataset version to delete. Format:
|
Returns | |
---|---|
Type | Description |
DatasetVersion |
getDatasetVersion(GetDatasetVersionRequest request)
public final DatasetVersion getDatasetVersion(GetDatasetVersionRequest request)
Gets a Dataset version.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
GetDatasetVersionRequest request =
GetDatasetVersionRequest.newBuilder()
.setName(
DatasetVersionName.of("[PROJECT]", "[LOCATION]", "[DATASET]", "[DATASET_VERSION]")
.toString())
.setReadMask(FieldMask.newBuilder().build())
.build();
DatasetVersion response = datasetServiceClient.getDatasetVersion(request);
}
Parameter | |
---|---|
Name | Description |
request |
GetDatasetVersionRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
DatasetVersion |
getDatasetVersion(String name)
public final DatasetVersion getDatasetVersion(String name)
Gets a Dataset version.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
String name =
DatasetVersionName.of("[PROJECT]", "[LOCATION]", "[DATASET]", "[DATASET_VERSION]")
.toString();
DatasetVersion response = datasetServiceClient.getDatasetVersion(name);
}
Parameter | |
---|---|
Name | Description |
name |
String Required. The resource name of the Dataset version to delete. Format:
|
Returns | |
---|---|
Type | Description |
DatasetVersion |
getDatasetVersionCallable()
public final UnaryCallable<GetDatasetVersionRequest,DatasetVersion> getDatasetVersionCallable()
Gets a Dataset version.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
GetDatasetVersionRequest request =
GetDatasetVersionRequest.newBuilder()
.setName(
DatasetVersionName.of("[PROJECT]", "[LOCATION]", "[DATASET]", "[DATASET_VERSION]")
.toString())
.setReadMask(FieldMask.newBuilder().build())
.build();
ApiFuture<DatasetVersion> future =
datasetServiceClient.getDatasetVersionCallable().futureCall(request);
// Do something.
DatasetVersion response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<GetDatasetVersionRequest,DatasetVersion> |
getIamPolicy(GetIamPolicyRequest request)
public final Policy getIamPolicy(GetIamPolicyRequest request)
Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
GetIamPolicyRequest request =
GetIamPolicyRequest.newBuilder()
.setResource(
EndpointName.ofProjectLocationEndpointName(
"[PROJECT]", "[LOCATION]", "[ENDPOINT]")
.toString())
.setOptions(GetPolicyOptions.newBuilder().build())
.build();
Policy response = datasetServiceClient.getIamPolicy(request);
}
Parameter | |
---|---|
Name | Description |
request |
com.google.iam.v1.GetIamPolicyRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
com.google.iam.v1.Policy |
getIamPolicyCallable()
public final UnaryCallable<GetIamPolicyRequest,Policy> getIamPolicyCallable()
Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
GetIamPolicyRequest request =
GetIamPolicyRequest.newBuilder()
.setResource(
EndpointName.ofProjectLocationEndpointName(
"[PROJECT]", "[LOCATION]", "[ENDPOINT]")
.toString())
.setOptions(GetPolicyOptions.newBuilder().build())
.build();
ApiFuture<Policy> future = datasetServiceClient.getIamPolicyCallable().futureCall(request);
// Do something.
Policy response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy> |
getLocation(GetLocationRequest request)
public final Location getLocation(GetLocationRequest request)
Gets information about a location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
Location response = datasetServiceClient.getLocation(request);
}
Parameter | |
---|---|
Name | Description |
request |
com.google.cloud.location.GetLocationRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
com.google.cloud.location.Location |
getLocationCallable()
public final UnaryCallable<GetLocationRequest,Location> getLocationCallable()
Gets information about a location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
ApiFuture<Location> future = datasetServiceClient.getLocationCallable().futureCall(request);
// Do something.
Location response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location> |
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:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
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 | Description |
name |
DatasetName Required. The name of the Dataset resource. Format:
|
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:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
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();
}
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:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
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 | Description |
name |
String Required. The name of the Dataset resource. Format:
|
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:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
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();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ImportDataRequest,Operation> |
importDataOperationCallable()
public final OperationCallable<ImportDataRequest,ImportDataResponse,ImportDataOperationMetadata> importDataOperationCallable()
Imports data into a Dataset.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (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();
}
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:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
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:
|
Returns | |
---|---|
Type | Description |
DatasetServiceClient.ListAnnotationsPagedResponse |
listAnnotations(ListAnnotationsRequest request)
public final DatasetServiceClient.ListAnnotationsPagedResponse listAnnotations(ListAnnotationsRequest request)
Lists Annotations belongs to a dataitem
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (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:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
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:
|
Returns | |
---|---|
Type | Description |
DatasetServiceClient.ListAnnotationsPagedResponse |
listAnnotationsCallable()
public final UnaryCallable<ListAnnotationsRequest,ListAnnotationsResponse> listAnnotationsCallable()
Lists Annotations belongs to a dataitem
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (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.getAnnotationsList()) {
// 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:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
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);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListAnnotationsRequest,ListAnnotationsPagedResponse> |
listDataItems(DatasetName parent)
public final DatasetServiceClient.ListDataItemsPagedResponse listDataItems(DatasetName parent)
Lists DataItems in a Dataset.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (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:
|
Returns | |
---|---|
Type | Description |
DatasetServiceClient.ListDataItemsPagedResponse |
listDataItems(ListDataItemsRequest request)
public final DatasetServiceClient.ListDataItemsPagedResponse listDataItems(ListDataItemsRequest request)
Lists DataItems in a Dataset.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (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:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
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:
|
Returns | |
---|---|
Type | Description |
DatasetServiceClient.ListDataItemsPagedResponse |
listDataItemsCallable()
public final UnaryCallable<ListDataItemsRequest,ListDataItemsResponse> listDataItemsCallable()
Lists DataItems in a Dataset.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (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.getDataItemsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListDataItemsRequest,ListDataItemsResponse> |
listDataItemsPagedCallable()
public final UnaryCallable<ListDataItemsRequest,DatasetServiceClient.ListDataItemsPagedResponse> listDataItemsPagedCallable()
Lists DataItems in a Dataset.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (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);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListDataItemsRequest,ListDataItemsPagedResponse> |
listDatasetVersions(DatasetName parent)
public final DatasetServiceClient.ListDatasetVersionsPagedResponse listDatasetVersions(DatasetName parent)
Lists DatasetVersions in a Dataset.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
DatasetName parent = DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]");
for (DatasetVersion element : datasetServiceClient.listDatasetVersions(parent).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
parent |
DatasetName Required. The resource name of the Dataset to list DatasetVersions from. Format:
|
Returns | |
---|---|
Type | Description |
DatasetServiceClient.ListDatasetVersionsPagedResponse |
listDatasetVersions(ListDatasetVersionsRequest request)
public final DatasetServiceClient.ListDatasetVersionsPagedResponse listDatasetVersions(ListDatasetVersionsRequest request)
Lists DatasetVersions in a Dataset.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
ListDatasetVersionsRequest request =
ListDatasetVersionsRequest.newBuilder()
.setParent(DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]").toString())
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setReadMask(FieldMask.newBuilder().build())
.setOrderBy("orderBy-1207110587")
.build();
for (DatasetVersion element :
datasetServiceClient.listDatasetVersions(request).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
request |
ListDatasetVersionsRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
DatasetServiceClient.ListDatasetVersionsPagedResponse |
listDatasetVersions(String parent)
public final DatasetServiceClient.ListDatasetVersionsPagedResponse listDatasetVersions(String parent)
Lists DatasetVersions in a Dataset.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
String parent = DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]").toString();
for (DatasetVersion element : datasetServiceClient.listDatasetVersions(parent).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
parent |
String Required. The resource name of the Dataset to list DatasetVersions from. Format:
|
Returns | |
---|---|
Type | Description |
DatasetServiceClient.ListDatasetVersionsPagedResponse |
listDatasetVersionsCallable()
public final UnaryCallable<ListDatasetVersionsRequest,ListDatasetVersionsResponse> listDatasetVersionsCallable()
Lists DatasetVersions in a Dataset.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
ListDatasetVersionsRequest request =
ListDatasetVersionsRequest.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) {
ListDatasetVersionsResponse response =
datasetServiceClient.listDatasetVersionsCallable().call(request);
for (DatasetVersion element : response.getDatasetVersionsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListDatasetVersionsRequest,ListDatasetVersionsResponse> |
listDatasetVersionsPagedCallable()
public final UnaryCallable<ListDatasetVersionsRequest,DatasetServiceClient.ListDatasetVersionsPagedResponse> listDatasetVersionsPagedCallable()
Lists DatasetVersions in a Dataset.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
ListDatasetVersionsRequest request =
ListDatasetVersionsRequest.newBuilder()
.setParent(DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]").toString())
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setReadMask(FieldMask.newBuilder().build())
.setOrderBy("orderBy-1207110587")
.build();
ApiFuture<DatasetVersion> future =
datasetServiceClient.listDatasetVersionsPagedCallable().futureCall(request);
// Do something.
for (DatasetVersion element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListDatasetVersionsRequest,ListDatasetVersionsPagedResponse> |
listDatasets(ListDatasetsRequest request)
public final DatasetServiceClient.ListDatasetsPagedResponse listDatasets(ListDatasetsRequest request)
Lists Datasets in a Location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (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:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
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:
|
Returns | |
---|---|
Type | Description |
DatasetServiceClient.ListDatasetsPagedResponse |
listDatasets(String parent)
public final DatasetServiceClient.ListDatasetsPagedResponse listDatasets(String parent)
Lists Datasets in a Location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (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:
|
Returns | |
---|---|
Type | Description |
DatasetServiceClient.ListDatasetsPagedResponse |
listDatasetsCallable()
public final UnaryCallable<ListDatasetsRequest,ListDatasetsResponse> listDatasetsCallable()
Lists Datasets in a Location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (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.getDatasetsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListDatasetsRequest,ListDatasetsResponse> |
listDatasetsPagedCallable()
public final UnaryCallable<ListDatasetsRequest,DatasetServiceClient.ListDatasetsPagedResponse> listDatasetsPagedCallable()
Lists Datasets in a Location.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (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);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListDatasetsRequest,ListDatasetsPagedResponse> |
listLocations(ListLocationsRequest request)
public final DatasetServiceClient.ListLocationsPagedResponse listLocations(ListLocationsRequest request)
Lists information about the supported locations for this service.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
ListLocationsRequest request =
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for (Location element : datasetServiceClient.listLocations(request).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
request |
com.google.cloud.location.ListLocationsRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
DatasetServiceClient.ListLocationsPagedResponse |
listLocationsCallable()
public final UnaryCallable<ListLocationsRequest,ListLocationsResponse> listLocationsCallable()
Lists information about the supported locations for this service.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
ListLocationsRequest request =
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
while (true) {
ListLocationsResponse response = datasetServiceClient.listLocationsCallable().call(request);
for (Location element : response.getLocationsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse> |
listLocationsPagedCallable()
public final UnaryCallable<ListLocationsRequest,DatasetServiceClient.ListLocationsPagedResponse> listLocationsPagedCallable()
Lists information about the supported locations for this service.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
ListLocationsRequest request =
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture<Location> future =
datasetServiceClient.listLocationsPagedCallable().futureCall(request);
// Do something.
for (Location element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<com.google.cloud.location.ListLocationsRequest,ListLocationsPagedResponse> |
listSavedQueries(DatasetName parent)
public final DatasetServiceClient.ListSavedQueriesPagedResponse listSavedQueries(DatasetName parent)
Lists SavedQueries in a Dataset.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
DatasetName parent = DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]");
for (SavedQuery element : datasetServiceClient.listSavedQueries(parent).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
parent |
DatasetName Required. The resource name of the Dataset to list SavedQueries from. Format:
|
Returns | |
---|---|
Type | Description |
DatasetServiceClient.ListSavedQueriesPagedResponse |
listSavedQueries(ListSavedQueriesRequest request)
public final DatasetServiceClient.ListSavedQueriesPagedResponse listSavedQueries(ListSavedQueriesRequest request)
Lists SavedQueries in a Dataset.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
ListSavedQueriesRequest request =
ListSavedQueriesRequest.newBuilder()
.setParent(DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]").toString())
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setReadMask(FieldMask.newBuilder().build())
.setOrderBy("orderBy-1207110587")
.build();
for (SavedQuery element : datasetServiceClient.listSavedQueries(request).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
request |
ListSavedQueriesRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
DatasetServiceClient.ListSavedQueriesPagedResponse |
listSavedQueries(String parent)
public final DatasetServiceClient.ListSavedQueriesPagedResponse listSavedQueries(String parent)
Lists SavedQueries in a Dataset.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
String parent = DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]").toString();
for (SavedQuery element : datasetServiceClient.listSavedQueries(parent).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
parent |
String Required. The resource name of the Dataset to list SavedQueries from. Format:
|
Returns | |
---|---|
Type | Description |
DatasetServiceClient.ListSavedQueriesPagedResponse |
listSavedQueriesCallable()
public final UnaryCallable<ListSavedQueriesRequest,ListSavedQueriesResponse> listSavedQueriesCallable()
Lists SavedQueries in a Dataset.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
ListSavedQueriesRequest request =
ListSavedQueriesRequest.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) {
ListSavedQueriesResponse response =
datasetServiceClient.listSavedQueriesCallable().call(request);
for (SavedQuery element : response.getSavedQueriesList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListSavedQueriesRequest,ListSavedQueriesResponse> |
listSavedQueriesPagedCallable()
public final UnaryCallable<ListSavedQueriesRequest,DatasetServiceClient.ListSavedQueriesPagedResponse> listSavedQueriesPagedCallable()
Lists SavedQueries in a Dataset.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
ListSavedQueriesRequest request =
ListSavedQueriesRequest.newBuilder()
.setParent(DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]").toString())
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setReadMask(FieldMask.newBuilder().build())
.setOrderBy("orderBy-1207110587")
.build();
ApiFuture<SavedQuery> future =
datasetServiceClient.listSavedQueriesPagedCallable().futureCall(request);
// Do something.
for (SavedQuery element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListSavedQueriesRequest,ListSavedQueriesPagedResponse> |
restoreDatasetVersionAsync(DatasetVersionName name)
public final OperationFuture<DatasetVersion,RestoreDatasetVersionOperationMetadata> restoreDatasetVersionAsync(DatasetVersionName name)
Restores a dataset version.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
DatasetVersionName name =
DatasetVersionName.of("[PROJECT]", "[LOCATION]", "[DATASET]", "[DATASET_VERSION]");
DatasetVersion response = datasetServiceClient.restoreDatasetVersionAsync(name).get();
}
Parameter | |
---|---|
Name | Description |
name |
DatasetVersionName Required. The name of the DatasetVersion resource. Format:
|
Returns | |
---|---|
Type | Description |
OperationFuture<DatasetVersion,RestoreDatasetVersionOperationMetadata> |
restoreDatasetVersionAsync(RestoreDatasetVersionRequest request)
public final OperationFuture<DatasetVersion,RestoreDatasetVersionOperationMetadata> restoreDatasetVersionAsync(RestoreDatasetVersionRequest request)
Restores a dataset version.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
RestoreDatasetVersionRequest request =
RestoreDatasetVersionRequest.newBuilder()
.setName(
DatasetVersionName.of("[PROJECT]", "[LOCATION]", "[DATASET]", "[DATASET_VERSION]")
.toString())
.build();
DatasetVersion response = datasetServiceClient.restoreDatasetVersionAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request |
RestoreDatasetVersionRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<DatasetVersion,RestoreDatasetVersionOperationMetadata> |
restoreDatasetVersionAsync(String name)
public final OperationFuture<DatasetVersion,RestoreDatasetVersionOperationMetadata> restoreDatasetVersionAsync(String name)
Restores a dataset version.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
String name =
DatasetVersionName.of("[PROJECT]", "[LOCATION]", "[DATASET]", "[DATASET_VERSION]")
.toString();
DatasetVersion response = datasetServiceClient.restoreDatasetVersionAsync(name).get();
}
Parameter | |
---|---|
Name | Description |
name |
String Required. The name of the DatasetVersion resource. Format:
|
Returns | |
---|---|
Type | Description |
OperationFuture<DatasetVersion,RestoreDatasetVersionOperationMetadata> |
restoreDatasetVersionCallable()
public final UnaryCallable<RestoreDatasetVersionRequest,Operation> restoreDatasetVersionCallable()
Restores a dataset version.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
RestoreDatasetVersionRequest request =
RestoreDatasetVersionRequest.newBuilder()
.setName(
DatasetVersionName.of("[PROJECT]", "[LOCATION]", "[DATASET]", "[DATASET_VERSION]")
.toString())
.build();
ApiFuture<Operation> future =
datasetServiceClient.restoreDatasetVersionCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<RestoreDatasetVersionRequest,Operation> |
restoreDatasetVersionOperationCallable()
public final OperationCallable<RestoreDatasetVersionRequest,DatasetVersion,RestoreDatasetVersionOperationMetadata> restoreDatasetVersionOperationCallable()
Restores a dataset version.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
RestoreDatasetVersionRequest request =
RestoreDatasetVersionRequest.newBuilder()
.setName(
DatasetVersionName.of("[PROJECT]", "[LOCATION]", "[DATASET]", "[DATASET_VERSION]")
.toString())
.build();
OperationFuture<DatasetVersion, RestoreDatasetVersionOperationMetadata> future =
datasetServiceClient.restoreDatasetVersionOperationCallable().futureCall(request);
// Do something.
DatasetVersion response = future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<RestoreDatasetVersionRequest,DatasetVersion,RestoreDatasetVersionOperationMetadata> |
searchDataItems(SearchDataItemsRequest request)
public final DatasetServiceClient.SearchDataItemsPagedResponse searchDataItems(SearchDataItemsRequest request)
Searches DataItems in a Dataset.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
SearchDataItemsRequest request =
SearchDataItemsRequest.newBuilder()
.setDataset(DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]").toString())
.setSavedQuery(
SavedQueryName.of("[PROJECT]", "[LOCATION]", "[DATASET]", "[SAVED_QUERY]")
.toString())
.setDataLabelingJob("dataLabelingJob951814757")
.setDataItemFilter("dataItemFilter1487804341")
.setAnnotationsFilter("annotationsFilter-583841860")
.addAllAnnotationFilters(new ArrayList<String>())
.setFieldMask(FieldMask.newBuilder().build())
.setAnnotationsLimit(134561504)
.setPageSize(883849137)
.setOrderBy("orderBy-1207110587")
.setPageToken("pageToken873572522")
.build();
for (DataItemView element : datasetServiceClient.searchDataItems(request).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
request |
SearchDataItemsRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
DatasetServiceClient.SearchDataItemsPagedResponse |
searchDataItemsCallable()
public final UnaryCallable<SearchDataItemsRequest,SearchDataItemsResponse> searchDataItemsCallable()
Searches DataItems in a Dataset.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
SearchDataItemsRequest request =
SearchDataItemsRequest.newBuilder()
.setDataset(DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]").toString())
.setSavedQuery(
SavedQueryName.of("[PROJECT]", "[LOCATION]", "[DATASET]", "[SAVED_QUERY]")
.toString())
.setDataLabelingJob("dataLabelingJob951814757")
.setDataItemFilter("dataItemFilter1487804341")
.setAnnotationsFilter("annotationsFilter-583841860")
.addAllAnnotationFilters(new ArrayList<String>())
.setFieldMask(FieldMask.newBuilder().build())
.setAnnotationsLimit(134561504)
.setPageSize(883849137)
.setOrderBy("orderBy-1207110587")
.setPageToken("pageToken873572522")
.build();
while (true) {
SearchDataItemsResponse response =
datasetServiceClient.searchDataItemsCallable().call(request);
for (DataItemView element : response.getDataItemViewsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<SearchDataItemsRequest,SearchDataItemsResponse> |
searchDataItemsPagedCallable()
public final UnaryCallable<SearchDataItemsRequest,DatasetServiceClient.SearchDataItemsPagedResponse> searchDataItemsPagedCallable()
Searches DataItems in a Dataset.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
SearchDataItemsRequest request =
SearchDataItemsRequest.newBuilder()
.setDataset(DatasetName.of("[PROJECT]", "[LOCATION]", "[DATASET]").toString())
.setSavedQuery(
SavedQueryName.of("[PROJECT]", "[LOCATION]", "[DATASET]", "[SAVED_QUERY]")
.toString())
.setDataLabelingJob("dataLabelingJob951814757")
.setDataItemFilter("dataItemFilter1487804341")
.setAnnotationsFilter("annotationsFilter-583841860")
.addAllAnnotationFilters(new ArrayList<String>())
.setFieldMask(FieldMask.newBuilder().build())
.setAnnotationsLimit(134561504)
.setPageSize(883849137)
.setOrderBy("orderBy-1207110587")
.setPageToken("pageToken873572522")
.build();
ApiFuture<DataItemView> future =
datasetServiceClient.searchDataItemsPagedCallable().futureCall(request);
// Do something.
for (DataItemView element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<SearchDataItemsRequest,SearchDataItemsPagedResponse> |
setIamPolicy(SetIamPolicyRequest request)
public final Policy setIamPolicy(SetIamPolicyRequest request)
Sets the access control policy on the specified resource. Replacesany existing policy.
Can return NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
SetIamPolicyRequest request =
SetIamPolicyRequest.newBuilder()
.setResource(
EndpointName.ofProjectLocationEndpointName(
"[PROJECT]", "[LOCATION]", "[ENDPOINT]")
.toString())
.setPolicy(Policy.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
Policy response = datasetServiceClient.setIamPolicy(request);
}
Parameter | |
---|---|
Name | Description |
request |
com.google.iam.v1.SetIamPolicyRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
com.google.iam.v1.Policy |
setIamPolicyCallable()
public final UnaryCallable<SetIamPolicyRequest,Policy> setIamPolicyCallable()
Sets the access control policy on the specified resource. Replacesany existing policy.
Can return NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
SetIamPolicyRequest request =
SetIamPolicyRequest.newBuilder()
.setResource(
EndpointName.ofProjectLocationEndpointName(
"[PROJECT]", "[LOCATION]", "[ENDPOINT]")
.toString())
.setPolicy(Policy.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
ApiFuture<Policy> future = datasetServiceClient.setIamPolicyCallable().futureCall(request);
// Do something.
Policy response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy> |
shutdown()
public void shutdown()
shutdownNow()
public void shutdownNow()
testIamPermissions(TestIamPermissionsRequest request)
public final TestIamPermissionsResponse testIamPermissions(TestIamPermissionsRequest request)
Returns permissions that a caller has on the specified resource. If theresource does not exist,
this will return an empty set ofpermissions, not a NOT_FOUND
error.
Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
TestIamPermissionsRequest request =
TestIamPermissionsRequest.newBuilder()
.setResource(
EndpointName.ofProjectLocationEndpointName(
"[PROJECT]", "[LOCATION]", "[ENDPOINT]")
.toString())
.addAllPermissions(new ArrayList<String>())
.build();
TestIamPermissionsResponse response = datasetServiceClient.testIamPermissions(request);
}
Parameter | |
---|---|
Name | Description |
request |
com.google.iam.v1.TestIamPermissionsRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
com.google.iam.v1.TestIamPermissionsResponse |
testIamPermissionsCallable()
public final UnaryCallable<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsCallable()
Returns permissions that a caller has on the specified resource. If theresource does not exist,
this will return an empty set ofpermissions, not a NOT_FOUND
error.
Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DatasetServiceClient datasetServiceClient = DatasetServiceClient.create()) {
TestIamPermissionsRequest request =
TestIamPermissionsRequest.newBuilder()
.setResource(
EndpointName.ofProjectLocationEndpointName(
"[PROJECT]", "[LOCATION]", "[ENDPOINT]")
.toString())
.addAllPermissions(new ArrayList<String>())
.build();
ApiFuture<TestIamPermissionsResponse> future =
datasetServiceClient.testIamPermissionsCallable().futureCall(request);
// Do something.
TestIamPermissionsResponse response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse> |
updateDataset(Dataset dataset, FieldMask updateMask)
public final Dataset updateDataset(Dataset dataset, FieldMask updateMask)
Updates a Dataset.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (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 * |
Returns | |
---|---|
Type | Description |
Dataset |
updateDataset(UpdateDatasetRequest request)
public final Dataset updateDataset(UpdateDatasetRequest request)
Updates a Dataset.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (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:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
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();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<UpdateDatasetRequest,Dataset> |