DatasetServiceClient.java
/*
* Copyright 2022 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.cloud.aiplatform.v1beta1;
import com.google.api.core.ApiFuture;
import com.google.api.core.ApiFutures;
import com.google.api.core.BetaApi;
import com.google.api.gax.core.BackgroundResource;
import com.google.api.gax.longrunning.OperationFuture;
import com.google.api.gax.paging.AbstractFixedSizeCollection;
import com.google.api.gax.paging.AbstractPage;
import com.google.api.gax.paging.AbstractPagedListResponse;
import com.google.api.gax.rpc.OperationCallable;
import com.google.api.gax.rpc.PageContext;
import com.google.api.gax.rpc.UnaryCallable;
import com.google.cloud.aiplatform.v1beta1.stub.DatasetServiceStub;
import com.google.cloud.aiplatform.v1beta1.stub.DatasetServiceStubSettings;
import com.google.cloud.location.GetLocationRequest;
import com.google.cloud.location.ListLocationsRequest;
import com.google.cloud.location.ListLocationsResponse;
import com.google.cloud.location.Location;
import com.google.common.util.concurrent.MoreExecutors;
import com.google.iam.v1.GetIamPolicyRequest;
import com.google.iam.v1.Policy;
import com.google.iam.v1.SetIamPolicyRequest;
import com.google.iam.v1.TestIamPermissionsRequest;
import com.google.iam.v1.TestIamPermissionsResponse;
import com.google.longrunning.Operation;
import com.google.longrunning.OperationsClient;
import com.google.protobuf.Empty;
import com.google.protobuf.FieldMask;
import java.io.IOException;
import java.util.List;
import java.util.concurrent.TimeUnit;
import javax.annotation.Generated;
// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
* Service Description: The service that handles the CRUD of Vertex AI Dataset and its child
* resources.
*
* <p>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:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying 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);
* }
* }</pre>
*
* <p>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().
*
* <p>The surface of this class includes several types of Java methods for each of the API's
* methods:
*
* <ol>
* <li>A "flattened" method. With this type of method, the fields of the request type have been
* converted into function parameters. It may be the case that not all fields are available as
* parameters, and not every API method will have a flattened method entry point.
* <li>A "request object" method. This type of method only takes one parameter, a request object,
* which must be constructed before the call. Not every API method will have a request object
* method.
* <li>A "callable" method. This type of method takes no parameters and returns an immutable API
* callable object, which can be used to initiate calls to the service.
* </ol>
*
* <p>See the individual methods for example code.
*
* <p>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.
*
* <p>This class can be customized by passing in a custom instance of DatasetServiceSettings to
* create(). For example:
*
* <p>To customize credentials:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require 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);
* }</pre>
*
* <p>To customize the endpoint:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require 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);
* }</pre>
*
* <p>Please refer to the GitHub repository's samples for more quickstart code snippets.
*/
@BetaApi
@Generated("by gapic-generator-java")
public class DatasetServiceClient implements BackgroundResource {
private final DatasetServiceSettings settings;
private final DatasetServiceStub stub;
private final OperationsClient operationsClient;
/** Constructs an instance of DatasetServiceClient with default settings. */
public static final DatasetServiceClient create() throws IOException {
return create(DatasetServiceSettings.newBuilder().build());
}
/**
* 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.
*/
public static final DatasetServiceClient create(DatasetServiceSettings settings)
throws IOException {
return new DatasetServiceClient(settings);
}
/**
* Constructs an instance of DatasetServiceClient, using the given stub for making calls. This is
* for advanced usage - prefer using create(DatasetServiceSettings).
*/
public static final DatasetServiceClient create(DatasetServiceStub stub) {
return new DatasetServiceClient(stub);
}
/**
* 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.
*/
protected DatasetServiceClient(DatasetServiceSettings settings) throws IOException {
this.settings = settings;
this.stub = ((DatasetServiceStubSettings) settings.getStubSettings()).createStub();
this.operationsClient = OperationsClient.create(this.stub.getOperationsStub());
}
protected DatasetServiceClient(DatasetServiceStub stub) {
this.settings = null;
this.stub = stub;
this.operationsClient = OperationsClient.create(this.stub.getOperationsStub());
}
public final DatasetServiceSettings getSettings() {
return settings;
}
public DatasetServiceStub getStub() {
return stub;
}
/**
* Returns the OperationsClient that can be used to query the status of a long-running operation
* returned by another API method call.
*/
public final OperationsClient getOperationsClient() {
return operationsClient;
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a Dataset.
*
* <p>Sample code:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying 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();
* }
* }</pre>
*
* @param parent Required. The resource name of the Location to create the Dataset in. Format:
* `projects/{project}/locations/{location}`
* @param dataset Required. The Dataset to create.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture<Dataset, CreateDatasetOperationMetadata> createDatasetAsync(
LocationName parent, Dataset dataset) {
CreateDatasetRequest request =
CreateDatasetRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.setDataset(dataset)
.build();
return createDatasetAsync(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a Dataset.
*
* <p>Sample code:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying 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();
* }
* }</pre>
*
* @param parent Required. The resource name of the Location to create the Dataset in. Format:
* `projects/{project}/locations/{location}`
* @param dataset Required. The Dataset to create.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture<Dataset, CreateDatasetOperationMetadata> createDatasetAsync(
String parent, Dataset dataset) {
CreateDatasetRequest request =
CreateDatasetRequest.newBuilder().setParent(parent).setDataset(dataset).build();
return createDatasetAsync(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a Dataset.
*
* <p>Sample code:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying 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();
* }
* }</pre>
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture<Dataset, CreateDatasetOperationMetadata> createDatasetAsync(
CreateDatasetRequest request) {
return createDatasetOperationCallable().futureCall(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a Dataset.
*
* <p>Sample code:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying 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();
* }
* }</pre>
*/
public final OperationCallable<CreateDatasetRequest, Dataset, CreateDatasetOperationMetadata>
createDatasetOperationCallable() {
return stub.createDatasetOperationCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a Dataset.
*
* <p>Sample code:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying 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();
* }
* }</pre>
*/
public final UnaryCallable<CreateDatasetRequest, Operation> createDatasetCallable() {
return stub.createDatasetCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets a Dataset.
*
* <p>Sample code:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying 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);
* }
* }</pre>
*
* @param name Required. The name of the Dataset resource.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Dataset getDataset(DatasetName name) {
GetDatasetRequest request =
GetDatasetRequest.newBuilder().setName(name == null ? null : name.toString()).build();
return getDataset(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets a Dataset.
*
* <p>Sample code:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying 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);
* }
* }</pre>
*
* @param name Required. The name of the Dataset resource.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Dataset getDataset(String name) {
GetDatasetRequest request = GetDatasetRequest.newBuilder().setName(name).build();
return getDataset(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets a Dataset.
*
* <p>Sample code:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying 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);
* }
* }</pre>
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Dataset getDataset(GetDatasetRequest request) {
return getDatasetCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets a Dataset.
*
* <p>Sample code:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying 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();
* }
* }</pre>
*/
public final UnaryCallable<GetDatasetRequest, Dataset> getDatasetCallable() {
return stub.getDatasetCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates a Dataset.
*
* <p>Sample code:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying 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);
* }
* }</pre>
*
* @param dataset Required. The Dataset which replaces the resource on the server.
* @param updateMask Required. The update mask applies to the resource. For the `FieldMask`
* definition, see [google.protobuf.FieldMask][google.protobuf.FieldMask]. Updatable fields:
* <p>* `display_name` * `description` * `labels`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Dataset updateDataset(Dataset dataset, FieldMask updateMask) {
UpdateDatasetRequest request =
UpdateDatasetRequest.newBuilder().setDataset(dataset).setUpdateMask(updateMask).build();
return updateDataset(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates a Dataset.
*
* <p>Sample code:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying 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);
* }
* }</pre>
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Dataset updateDataset(UpdateDatasetRequest request) {
return updateDatasetCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates a Dataset.
*
* <p>Sample code:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying 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();
* }
* }</pre>
*/
public final UnaryCallable<UpdateDatasetRequest, Dataset> updateDatasetCallable() {
return stub.updateDatasetCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists Datasets in a Location.
*
* <p>Sample code:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying 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);
* }
* }
* }</pre>
*
* @param parent Required. The name of the Dataset's parent resource. Format:
* `projects/{project}/locations/{location}`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListDatasetsPagedResponse listDatasets(LocationName parent) {
ListDatasetsRequest request =
ListDatasetsRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.build();
return listDatasets(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists Datasets in a Location.
*
* <p>Sample code:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying 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);
* }
* }
* }</pre>
*
* @param parent Required. The name of the Dataset's parent resource. Format:
* `projects/{project}/locations/{location}`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListDatasetsPagedResponse listDatasets(String parent) {
ListDatasetsRequest request = ListDatasetsRequest.newBuilder().setParent(parent).build();
return listDatasets(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists Datasets in a Location.
*
* <p>Sample code:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying 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);
* }
* }
* }</pre>
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListDatasetsPagedResponse listDatasets(ListDatasetsRequest request) {
return listDatasetsPagedCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists Datasets in a Location.
*
* <p>Sample code:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying 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);
* }
* }
* }</pre>
*/
public final UnaryCallable<ListDatasetsRequest, ListDatasetsPagedResponse>
listDatasetsPagedCallable() {
return stub.listDatasetsPagedCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists Datasets in a Location.
*
* <p>Sample code:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying 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;
* }
* }
* }
* }</pre>
*/
public final UnaryCallable<ListDatasetsRequest, ListDatasetsResponse> listDatasetsCallable() {
return stub.listDatasetsCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes a Dataset.
*
* <p>Sample code:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying 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();
* }
* }</pre>
*
* @param name Required. The resource name of the Dataset to delete. Format:
* `projects/{project}/locations/{location}/datasets/{dataset}`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture<Empty, DeleteOperationMetadata> deleteDatasetAsync(
DatasetName name) {
DeleteDatasetRequest request =
DeleteDatasetRequest.newBuilder().setName(name == null ? null : name.toString()).build();
return deleteDatasetAsync(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes a Dataset.
*
* <p>Sample code:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying 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();
* }
* }</pre>
*
* @param name Required. The resource name of the Dataset to delete. Format:
* `projects/{project}/locations/{location}/datasets/{dataset}`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture<Empty, DeleteOperationMetadata> deleteDatasetAsync(String name) {
DeleteDatasetRequest request = DeleteDatasetRequest.newBuilder().setName(name).build();
return deleteDatasetAsync(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes a Dataset.
*
* <p>Sample code:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying 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();
* }
* }</pre>
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture<Empty, DeleteOperationMetadata> deleteDatasetAsync(
DeleteDatasetRequest request) {
return deleteDatasetOperationCallable().futureCall(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes a Dataset.
*
* <p>Sample code:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying 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();
* }
* }</pre>
*/
public final OperationCallable<DeleteDatasetRequest, Empty, DeleteOperationMetadata>
deleteDatasetOperationCallable() {
return stub.deleteDatasetOperationCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes a Dataset.
*
* <p>Sample code:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying 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();
* }
* }</pre>
*/
public final UnaryCallable<DeleteDatasetRequest, Operation> deleteDatasetCallable() {
return stub.deleteDatasetCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Imports data into a Dataset.
*
* <p>Sample code:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying 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();
* }
* }</pre>
*
* @param name Required. The name of the Dataset resource. Format:
* `projects/{project}/locations/{location}/datasets/{dataset}`
* @param importConfigs Required. The desired input locations. The contents of all input locations
* will be imported in one batch.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture<ImportDataResponse, ImportDataOperationMetadata> importDataAsync(
DatasetName name, List<ImportDataConfig> importConfigs) {
ImportDataRequest request =
ImportDataRequest.newBuilder()
.setName(name == null ? null : name.toString())
.addAllImportConfigs(importConfigs)
.build();
return importDataAsync(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Imports data into a Dataset.
*
* <p>Sample code:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying 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();
* }
* }</pre>
*
* @param name Required. The name of the Dataset resource. Format:
* `projects/{project}/locations/{location}/datasets/{dataset}`
* @param importConfigs Required. The desired input locations. The contents of all input locations
* will be imported in one batch.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture<ImportDataResponse, ImportDataOperationMetadata> importDataAsync(
String name, List<ImportDataConfig> importConfigs) {
ImportDataRequest request =
ImportDataRequest.newBuilder().setName(name).addAllImportConfigs(importConfigs).build();
return importDataAsync(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Imports data into a Dataset.
*
* <p>Sample code:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying 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();
* }
* }</pre>
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture<ImportDataResponse, ImportDataOperationMetadata> importDataAsync(
ImportDataRequest request) {
return importDataOperationCallable().futureCall(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Imports data into a Dataset.
*
* <p>Sample code:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying 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();
* }
* }</pre>
*/
public final OperationCallable<ImportDataRequest, ImportDataResponse, ImportDataOperationMetadata>
importDataOperationCallable() {
return stub.importDataOperationCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Imports data into a Dataset.
*
* <p>Sample code:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying 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();
* }
* }</pre>
*/
public final UnaryCallable<ImportDataRequest, Operation> importDataCallable() {
return stub.importDataCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Exports data from a Dataset.
*
* <p>Sample code:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying 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();
* }
* }</pre>
*
* @param name Required. The name of the Dataset resource. Format:
* `projects/{project}/locations/{location}/datasets/{dataset}`
* @param exportConfig Required. The desired output location.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture<ExportDataResponse, ExportDataOperationMetadata> exportDataAsync(
DatasetName name, ExportDataConfig exportConfig) {
ExportDataRequest request =
ExportDataRequest.newBuilder()
.setName(name == null ? null : name.toString())
.setExportConfig(exportConfig)
.build();
return exportDataAsync(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Exports data from a Dataset.
*
* <p>Sample code:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying 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();
* }
* }</pre>
*
* @param name Required. The name of the Dataset resource. Format:
* `projects/{project}/locations/{location}/datasets/{dataset}`
* @param exportConfig Required. The desired output location.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture<ExportDataResponse, ExportDataOperationMetadata> exportDataAsync(
String name, ExportDataConfig exportConfig) {
ExportDataRequest request =
ExportDataRequest.newBuilder().setName(name).setExportConfig(exportConfig).build();
return exportDataAsync(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Exports data from a Dataset.
*
* <p>Sample code:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying 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();
* }
* }</pre>
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture<ExportDataResponse, ExportDataOperationMetadata> exportDataAsync(
ExportDataRequest request) {
return exportDataOperationCallable().futureCall(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Exports data from a Dataset.
*
* <p>Sample code:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying 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();
* }
* }</pre>
*/
public final OperationCallable<ExportDataRequest, ExportDataResponse, ExportDataOperationMetadata>
exportDataOperationCallable() {
return stub.exportDataOperationCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Exports data from a Dataset.
*
* <p>Sample code:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying 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();
* }
* }</pre>
*/
public final UnaryCallable<ExportDataRequest, Operation> exportDataCallable() {
return stub.exportDataCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists DataItems in a Dataset.
*
* <p>Sample code:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying 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);
* }
* }
* }</pre>
*
* @param parent Required. The resource name of the Dataset to list DataItems from. Format:
* `projects/{project}/locations/{location}/datasets/{dataset}`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListDataItemsPagedResponse listDataItems(DatasetName parent) {
ListDataItemsRequest request =
ListDataItemsRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.build();
return listDataItems(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists DataItems in a Dataset.
*
* <p>Sample code:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying 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);
* }
* }
* }</pre>
*
* @param parent Required. The resource name of the Dataset to list DataItems from. Format:
* `projects/{project}/locations/{location}/datasets/{dataset}`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListDataItemsPagedResponse listDataItems(String parent) {
ListDataItemsRequest request = ListDataItemsRequest.newBuilder().setParent(parent).build();
return listDataItems(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists DataItems in a Dataset.
*
* <p>Sample code:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying 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);
* }
* }
* }</pre>
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListDataItemsPagedResponse listDataItems(ListDataItemsRequest request) {
return listDataItemsPagedCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists DataItems in a Dataset.
*
* <p>Sample code:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying 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);
* }
* }
* }</pre>
*/
public final UnaryCallable<ListDataItemsRequest, ListDataItemsPagedResponse>
listDataItemsPagedCallable() {
return stub.listDataItemsPagedCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists DataItems in a Dataset.
*
* <p>Sample code:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying 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;
* }
* }
* }
* }</pre>
*/
public final UnaryCallable<ListDataItemsRequest, ListDataItemsResponse> listDataItemsCallable() {
return stub.listDataItemsCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists SavedQueries in a Dataset.
*
* <p>Sample code:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying 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);
* }
* }
* }</pre>
*
* @param parent Required. The resource name of the Dataset to list SavedQueries from. Format:
* `projects/{project}/locations/{location}/datasets/{dataset}`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListSavedQueriesPagedResponse listSavedQueries(DatasetName parent) {
ListSavedQueriesRequest request =
ListSavedQueriesRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.build();
return listSavedQueries(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists SavedQueries in a Dataset.
*
* <p>Sample code:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying 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);
* }
* }
* }</pre>
*
* @param parent Required. The resource name of the Dataset to list SavedQueries from. Format:
* `projects/{project}/locations/{location}/datasets/{dataset}`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListSavedQueriesPagedResponse listSavedQueries(String parent) {
ListSavedQueriesRequest request =
ListSavedQueriesRequest.newBuilder().setParent(parent).build();
return listSavedQueries(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists SavedQueries in a Dataset.
*
* <p>Sample code:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying 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);
* }
* }
* }</pre>
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListSavedQueriesPagedResponse listSavedQueries(ListSavedQueriesRequest request) {
return listSavedQueriesPagedCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists SavedQueries in a Dataset.
*
* <p>Sample code:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying 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);
* }
* }
* }</pre>
*/
public final UnaryCallable<ListSavedQueriesRequest, ListSavedQueriesPagedResponse>
listSavedQueriesPagedCallable() {
return stub.listSavedQueriesPagedCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists SavedQueries in a Dataset.
*
* <p>Sample code:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying 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;
* }
* }
* }
* }</pre>
*/
public final UnaryCallable<ListSavedQueriesRequest, ListSavedQueriesResponse>
listSavedQueriesCallable() {
return stub.listSavedQueriesCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets an AnnotationSpec.
*
* <p>Sample code:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying 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);
* }
* }</pre>
*
* @param name Required. The name of the AnnotationSpec resource. Format:
* `projects/{project}/locations/{location}/datasets/{dataset}/annotationSpecs/{annotation_spec}`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final AnnotationSpec getAnnotationSpec(AnnotationSpecName name) {
GetAnnotationSpecRequest request =
GetAnnotationSpecRequest.newBuilder()
.setName(name == null ? null : name.toString())
.build();
return getAnnotationSpec(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets an AnnotationSpec.
*
* <p>Sample code:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying 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);
* }
* }</pre>
*
* @param name Required. The name of the AnnotationSpec resource. Format:
* `projects/{project}/locations/{location}/datasets/{dataset}/annotationSpecs/{annotation_spec}`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final AnnotationSpec getAnnotationSpec(String name) {
GetAnnotationSpecRequest request = GetAnnotationSpecRequest.newBuilder().setName(name).build();
return getAnnotationSpec(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets an AnnotationSpec.
*
* <p>Sample code:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying 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);
* }
* }</pre>
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final AnnotationSpec getAnnotationSpec(GetAnnotationSpecRequest request) {
return getAnnotationSpecCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets an AnnotationSpec.
*
* <p>Sample code:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying 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();
* }
* }</pre>
*/
public final UnaryCallable<GetAnnotationSpecRequest, AnnotationSpec> getAnnotationSpecCallable() {
return stub.getAnnotationSpecCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists Annotations belongs to a dataitem
*
* <p>Sample code:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying 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);
* }
* }
* }</pre>
*
* @param parent Required. The resource name of the DataItem to list Annotations from. Format:
* `projects/{project}/locations/{location}/datasets/{dataset}/dataItems/{data_item}`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListAnnotationsPagedResponse listAnnotations(DataItemName parent) {
ListAnnotationsRequest request =
ListAnnotationsRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.build();
return listAnnotations(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists Annotations belongs to a dataitem
*
* <p>Sample code:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying 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);
* }
* }
* }</pre>
*
* @param parent Required. The resource name of the DataItem to list Annotations from. Format:
* `projects/{project}/locations/{location}/datasets/{dataset}/dataItems/{data_item}`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListAnnotationsPagedResponse listAnnotations(String parent) {
ListAnnotationsRequest request = ListAnnotationsRequest.newBuilder().setParent(parent).build();
return listAnnotations(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists Annotations belongs to a dataitem
*
* <p>Sample code:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying 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);
* }
* }
* }</pre>
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListAnnotationsPagedResponse listAnnotations(ListAnnotationsRequest request) {
return listAnnotationsPagedCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists Annotations belongs to a dataitem
*
* <p>Sample code:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying 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);
* }
* }
* }</pre>
*/
public final UnaryCallable<ListAnnotationsRequest, ListAnnotationsPagedResponse>
listAnnotationsPagedCallable() {
return stub.listAnnotationsPagedCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists Annotations belongs to a dataitem
*
* <p>Sample code:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying 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;
* }
* }
* }
* }</pre>
*/
public final UnaryCallable<ListAnnotationsRequest, ListAnnotationsResponse>
listAnnotationsCallable() {
return stub.listAnnotationsCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists information about the supported locations for this service.
*
* <p>Sample code:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying 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);
* }
* }
* }</pre>
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListLocationsPagedResponse listLocations(ListLocationsRequest request) {
return listLocationsPagedCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists information about the supported locations for this service.
*
* <p>Sample code:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying 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);
* }
* }
* }</pre>
*/
public final UnaryCallable<ListLocationsRequest, ListLocationsPagedResponse>
listLocationsPagedCallable() {
return stub.listLocationsPagedCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists information about the supported locations for this service.
*
* <p>Sample code:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying 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;
* }
* }
* }
* }</pre>
*/
public final UnaryCallable<ListLocationsRequest, ListLocationsResponse> listLocationsCallable() {
return stub.listLocationsCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets information about a location.
*
* <p>Sample code:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying 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);
* }
* }</pre>
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Location getLocation(GetLocationRequest request) {
return getLocationCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets information about a location.
*
* <p>Sample code:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying 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();
* }
* }</pre>
*/
public final UnaryCallable<GetLocationRequest, Location> getLocationCallable() {
return stub.getLocationCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Sets the access control policy on the specified resource. Replacesany existing policy.
*
* <p>Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.
*
* <p>Sample code:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying 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(
* EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]")
* .toString())
* .setPolicy(Policy.newBuilder().build())
* .setUpdateMask(FieldMask.newBuilder().build())
* .build();
* Policy response = datasetServiceClient.setIamPolicy(request);
* }
* }</pre>
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Policy setIamPolicy(SetIamPolicyRequest request) {
return setIamPolicyCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Sets the access control policy on the specified resource. Replacesany existing policy.
*
* <p>Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.
*
* <p>Sample code:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying 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(
* EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]")
* .toString())
* .setPolicy(Policy.newBuilder().build())
* .setUpdateMask(FieldMask.newBuilder().build())
* .build();
* ApiFuture<Policy> future = datasetServiceClient.setIamPolicyCallable().futureCall(request);
* // Do something.
* Policy response = future.get();
* }
* }</pre>
*/
public final UnaryCallable<SetIamPolicyRequest, Policy> setIamPolicyCallable() {
return stub.setIamPolicyCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets the access control policy for a resource. Returns an empty policyif the resource exists
* and does not have a policy set.
*
* <p>Sample code:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying 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(
* EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]")
* .toString())
* .setOptions(GetPolicyOptions.newBuilder().build())
* .build();
* Policy response = datasetServiceClient.getIamPolicy(request);
* }
* }</pre>
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Policy getIamPolicy(GetIamPolicyRequest request) {
return getIamPolicyCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets the access control policy for a resource. Returns an empty policyif the resource exists
* and does not have a policy set.
*
* <p>Sample code:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying 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(
* EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]")
* .toString())
* .setOptions(GetPolicyOptions.newBuilder().build())
* .build();
* ApiFuture<Policy> future = datasetServiceClient.getIamPolicyCallable().futureCall(request);
* // Do something.
* Policy response = future.get();
* }
* }</pre>
*/
public final UnaryCallable<GetIamPolicyRequest, Policy> getIamPolicyCallable() {
return stub.getIamPolicyCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* 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.
*
* <p>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.
*
* <p>Sample code:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying 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(
* EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]")
* .toString())
* .addAllPermissions(new ArrayList<String>())
* .build();
* TestIamPermissionsResponse response = datasetServiceClient.testIamPermissions(request);
* }
* }</pre>
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final TestIamPermissionsResponse testIamPermissions(TestIamPermissionsRequest request) {
return testIamPermissionsCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* 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.
*
* <p>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.
*
* <p>Sample code:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying 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(
* EntityTypeName.of("[PROJECT]", "[LOCATION]", "[FEATURESTORE]", "[ENTITY_TYPE]")
* .toString())
* .addAllPermissions(new ArrayList<String>())
* .build();
* ApiFuture<TestIamPermissionsResponse> future =
* datasetServiceClient.testIamPermissionsCallable().futureCall(request);
* // Do something.
* TestIamPermissionsResponse response = future.get();
* }
* }</pre>
*/
public final UnaryCallable<TestIamPermissionsRequest, TestIamPermissionsResponse>
testIamPermissionsCallable() {
return stub.testIamPermissionsCallable();
}
@Override
public final void close() {
stub.close();
}
@Override
public void shutdown() {
stub.shutdown();
}
@Override
public boolean isShutdown() {
return stub.isShutdown();
}
@Override
public boolean isTerminated() {
return stub.isTerminated();
}
@Override
public void shutdownNow() {
stub.shutdownNow();
}
@Override
public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException {
return stub.awaitTermination(duration, unit);
}
public static class ListDatasetsPagedResponse
extends AbstractPagedListResponse<
ListDatasetsRequest,
ListDatasetsResponse,
Dataset,
ListDatasetsPage,
ListDatasetsFixedSizeCollection> {
public static ApiFuture<ListDatasetsPagedResponse> createAsync(
PageContext<ListDatasetsRequest, ListDatasetsResponse, Dataset> context,
ApiFuture<ListDatasetsResponse> futureResponse) {
ApiFuture<ListDatasetsPage> futurePage =
ListDatasetsPage.createEmptyPage().createPageAsync(context, futureResponse);
return ApiFutures.transform(
futurePage,
input -> new ListDatasetsPagedResponse(input),
MoreExecutors.directExecutor());
}
private ListDatasetsPagedResponse(ListDatasetsPage page) {
super(page, ListDatasetsFixedSizeCollection.createEmptyCollection());
}
}
public static class ListDatasetsPage
extends AbstractPage<ListDatasetsRequest, ListDatasetsResponse, Dataset, ListDatasetsPage> {
private ListDatasetsPage(
PageContext<ListDatasetsRequest, ListDatasetsResponse, Dataset> context,
ListDatasetsResponse response) {
super(context, response);
}
private static ListDatasetsPage createEmptyPage() {
return new ListDatasetsPage(null, null);
}
@Override
protected ListDatasetsPage createPage(
PageContext<ListDatasetsRequest, ListDatasetsResponse, Dataset> context,
ListDatasetsResponse response) {
return new ListDatasetsPage(context, response);
}
@Override
public ApiFuture<ListDatasetsPage> createPageAsync(
PageContext<ListDatasetsRequest, ListDatasetsResponse, Dataset> context,
ApiFuture<ListDatasetsResponse> futureResponse) {
return super.createPageAsync(context, futureResponse);
}
}
public static class ListDatasetsFixedSizeCollection
extends AbstractFixedSizeCollection<
ListDatasetsRequest,
ListDatasetsResponse,
Dataset,
ListDatasetsPage,
ListDatasetsFixedSizeCollection> {
private ListDatasetsFixedSizeCollection(List<ListDatasetsPage> pages, int collectionSize) {
super(pages, collectionSize);
}
private static ListDatasetsFixedSizeCollection createEmptyCollection() {
return new ListDatasetsFixedSizeCollection(null, 0);
}
@Override
protected ListDatasetsFixedSizeCollection createCollection(
List<ListDatasetsPage> pages, int collectionSize) {
return new ListDatasetsFixedSizeCollection(pages, collectionSize);
}
}
public static class ListDataItemsPagedResponse
extends AbstractPagedListResponse<
ListDataItemsRequest,
ListDataItemsResponse,
DataItem,
ListDataItemsPage,
ListDataItemsFixedSizeCollection> {
public static ApiFuture<ListDataItemsPagedResponse> createAsync(
PageContext<ListDataItemsRequest, ListDataItemsResponse, DataItem> context,
ApiFuture<ListDataItemsResponse> futureResponse) {
ApiFuture<ListDataItemsPage> futurePage =
ListDataItemsPage.createEmptyPage().createPageAsync(context, futureResponse);
return ApiFutures.transform(
futurePage,
input -> new ListDataItemsPagedResponse(input),
MoreExecutors.directExecutor());
}
private ListDataItemsPagedResponse(ListDataItemsPage page) {
super(page, ListDataItemsFixedSizeCollection.createEmptyCollection());
}
}
public static class ListDataItemsPage
extends AbstractPage<
ListDataItemsRequest, ListDataItemsResponse, DataItem, ListDataItemsPage> {
private ListDataItemsPage(
PageContext<ListDataItemsRequest, ListDataItemsResponse, DataItem> context,
ListDataItemsResponse response) {
super(context, response);
}
private static ListDataItemsPage createEmptyPage() {
return new ListDataItemsPage(null, null);
}
@Override
protected ListDataItemsPage createPage(
PageContext<ListDataItemsRequest, ListDataItemsResponse, DataItem> context,
ListDataItemsResponse response) {
return new ListDataItemsPage(context, response);
}
@Override
public ApiFuture<ListDataItemsPage> createPageAsync(
PageContext<ListDataItemsRequest, ListDataItemsResponse, DataItem> context,
ApiFuture<ListDataItemsResponse> futureResponse) {
return super.createPageAsync(context, futureResponse);
}
}
public static class ListDataItemsFixedSizeCollection
extends AbstractFixedSizeCollection<
ListDataItemsRequest,
ListDataItemsResponse,
DataItem,
ListDataItemsPage,
ListDataItemsFixedSizeCollection> {
private ListDataItemsFixedSizeCollection(List<ListDataItemsPage> pages, int collectionSize) {
super(pages, collectionSize);
}
private static ListDataItemsFixedSizeCollection createEmptyCollection() {
return new ListDataItemsFixedSizeCollection(null, 0);
}
@Override
protected ListDataItemsFixedSizeCollection createCollection(
List<ListDataItemsPage> pages, int collectionSize) {
return new ListDataItemsFixedSizeCollection(pages, collectionSize);
}
}
public static class ListSavedQueriesPagedResponse
extends AbstractPagedListResponse<
ListSavedQueriesRequest,
ListSavedQueriesResponse,
SavedQuery,
ListSavedQueriesPage,
ListSavedQueriesFixedSizeCollection> {
public static ApiFuture<ListSavedQueriesPagedResponse> createAsync(
PageContext<ListSavedQueriesRequest, ListSavedQueriesResponse, SavedQuery> context,
ApiFuture<ListSavedQueriesResponse> futureResponse) {
ApiFuture<ListSavedQueriesPage> futurePage =
ListSavedQueriesPage.createEmptyPage().createPageAsync(context, futureResponse);
return ApiFutures.transform(
futurePage,
input -> new ListSavedQueriesPagedResponse(input),
MoreExecutors.directExecutor());
}
private ListSavedQueriesPagedResponse(ListSavedQueriesPage page) {
super(page, ListSavedQueriesFixedSizeCollection.createEmptyCollection());
}
}
public static class ListSavedQueriesPage
extends AbstractPage<
ListSavedQueriesRequest, ListSavedQueriesResponse, SavedQuery, ListSavedQueriesPage> {
private ListSavedQueriesPage(
PageContext<ListSavedQueriesRequest, ListSavedQueriesResponse, SavedQuery> context,
ListSavedQueriesResponse response) {
super(context, response);
}
private static ListSavedQueriesPage createEmptyPage() {
return new ListSavedQueriesPage(null, null);
}
@Override
protected ListSavedQueriesPage createPage(
PageContext<ListSavedQueriesRequest, ListSavedQueriesResponse, SavedQuery> context,
ListSavedQueriesResponse response) {
return new ListSavedQueriesPage(context, response);
}
@Override
public ApiFuture<ListSavedQueriesPage> createPageAsync(
PageContext<ListSavedQueriesRequest, ListSavedQueriesResponse, SavedQuery> context,
ApiFuture<ListSavedQueriesResponse> futureResponse) {
return super.createPageAsync(context, futureResponse);
}
}
public static class ListSavedQueriesFixedSizeCollection
extends AbstractFixedSizeCollection<
ListSavedQueriesRequest,
ListSavedQueriesResponse,
SavedQuery,
ListSavedQueriesPage,
ListSavedQueriesFixedSizeCollection> {
private ListSavedQueriesFixedSizeCollection(
List<ListSavedQueriesPage> pages, int collectionSize) {
super(pages, collectionSize);
}
private static ListSavedQueriesFixedSizeCollection createEmptyCollection() {
return new ListSavedQueriesFixedSizeCollection(null, 0);
}
@Override
protected ListSavedQueriesFixedSizeCollection createCollection(
List<ListSavedQueriesPage> pages, int collectionSize) {
return new ListSavedQueriesFixedSizeCollection(pages, collectionSize);
}
}
public static class ListAnnotationsPagedResponse
extends AbstractPagedListResponse<
ListAnnotationsRequest,
ListAnnotationsResponse,
Annotation,
ListAnnotationsPage,
ListAnnotationsFixedSizeCollection> {
public static ApiFuture<ListAnnotationsPagedResponse> createAsync(
PageContext<ListAnnotationsRequest, ListAnnotationsResponse, Annotation> context,
ApiFuture<ListAnnotationsResponse> futureResponse) {
ApiFuture<ListAnnotationsPage> futurePage =
ListAnnotationsPage.createEmptyPage().createPageAsync(context, futureResponse);
return ApiFutures.transform(
futurePage,
input -> new ListAnnotationsPagedResponse(input),
MoreExecutors.directExecutor());
}
private ListAnnotationsPagedResponse(ListAnnotationsPage page) {
super(page, ListAnnotationsFixedSizeCollection.createEmptyCollection());
}
}
public static class ListAnnotationsPage
extends AbstractPage<
ListAnnotationsRequest, ListAnnotationsResponse, Annotation, ListAnnotationsPage> {
private ListAnnotationsPage(
PageContext<ListAnnotationsRequest, ListAnnotationsResponse, Annotation> context,
ListAnnotationsResponse response) {
super(context, response);
}
private static ListAnnotationsPage createEmptyPage() {
return new ListAnnotationsPage(null, null);
}
@Override
protected ListAnnotationsPage createPage(
PageContext<ListAnnotationsRequest, ListAnnotationsResponse, Annotation> context,
ListAnnotationsResponse response) {
return new ListAnnotationsPage(context, response);
}
@Override
public ApiFuture<ListAnnotationsPage> createPageAsync(
PageContext<ListAnnotationsRequest, ListAnnotationsResponse, Annotation> context,
ApiFuture<ListAnnotationsResponse> futureResponse) {
return super.createPageAsync(context, futureResponse);
}
}
public static class ListAnnotationsFixedSizeCollection
extends AbstractFixedSizeCollection<
ListAnnotationsRequest,
ListAnnotationsResponse,
Annotation,
ListAnnotationsPage,
ListAnnotationsFixedSizeCollection> {
private ListAnnotationsFixedSizeCollection(
List<ListAnnotationsPage> pages, int collectionSize) {
super(pages, collectionSize);
}
private static ListAnnotationsFixedSizeCollection createEmptyCollection() {
return new ListAnnotationsFixedSizeCollection(null, 0);
}
@Override
protected ListAnnotationsFixedSizeCollection createCollection(
List<ListAnnotationsPage> pages, int collectionSize) {
return new ListAnnotationsFixedSizeCollection(pages, collectionSize);
}
}
public static class ListLocationsPagedResponse
extends AbstractPagedListResponse<
ListLocationsRequest,
ListLocationsResponse,
Location,
ListLocationsPage,
ListLocationsFixedSizeCollection> {
public static ApiFuture<ListLocationsPagedResponse> createAsync(
PageContext<ListLocationsRequest, ListLocationsResponse, Location> context,
ApiFuture<ListLocationsResponse> futureResponse) {
ApiFuture<ListLocationsPage> futurePage =
ListLocationsPage.createEmptyPage().createPageAsync(context, futureResponse);
return ApiFutures.transform(
futurePage,
input -> new ListLocationsPagedResponse(input),
MoreExecutors.directExecutor());
}
private ListLocationsPagedResponse(ListLocationsPage page) {
super(page, ListLocationsFixedSizeCollection.createEmptyCollection());
}
}
public static class ListLocationsPage
extends AbstractPage<
ListLocationsRequest, ListLocationsResponse, Location, ListLocationsPage> {
private ListLocationsPage(
PageContext<ListLocationsRequest, ListLocationsResponse, Location> context,
ListLocationsResponse response) {
super(context, response);
}
private static ListLocationsPage createEmptyPage() {
return new ListLocationsPage(null, null);
}
@Override
protected ListLocationsPage createPage(
PageContext<ListLocationsRequest, ListLocationsResponse, Location> context,
ListLocationsResponse response) {
return new ListLocationsPage(context, response);
}
@Override
public ApiFuture<ListLocationsPage> createPageAsync(
PageContext<ListLocationsRequest, ListLocationsResponse, Location> context,
ApiFuture<ListLocationsResponse> futureResponse) {
return super.createPageAsync(context, futureResponse);
}
}
public static class ListLocationsFixedSizeCollection
extends AbstractFixedSizeCollection<
ListLocationsRequest,
ListLocationsResponse,
Location,
ListLocationsPage,
ListLocationsFixedSizeCollection> {
private ListLocationsFixedSizeCollection(List<ListLocationsPage> pages, int collectionSize) {
super(pages, collectionSize);
}
private static ListLocationsFixedSizeCollection createEmptyCollection() {
return new ListLocationsFixedSizeCollection(null, 0);
}
@Override
protected ListLocationsFixedSizeCollection createCollection(
List<ListLocationsPage> pages, int collectionSize) {
return new ListLocationsFixedSizeCollection(pages, collectionSize);
}
}
}