com.google.cloud.bigquery.datatransfer.v1.DataTransferServiceClient Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-cloud-bigquerydatatransfer Show documentation
Show all versions of google-cloud-bigquerydatatransfer Show documentation
Java idiomatic client for Google Cloud Bigquery Data Transfer.
/*
* Copyright 2024 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.bigquery.datatransfer.v1;
import com.google.api.core.ApiFuture;
import com.google.api.core.ApiFutures;
import com.google.api.gax.core.BackgroundResource;
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.PageContext;
import com.google.api.gax.rpc.UnaryCallable;
import com.google.cloud.bigquery.datatransfer.v1.stub.DataTransferServiceStub;
import com.google.cloud.bigquery.datatransfer.v1.stub.DataTransferServiceStubSettings;
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.protobuf.Empty;
import com.google.protobuf.FieldMask;
import com.google.protobuf.Timestamp;
import java.io.IOException;
import java.util.List;
import java.util.concurrent.TimeUnit;
import javax.annotation.Generated;
// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
* Service Description: This API allows users to manage their data transfers into BigQuery.
*
* This class provides the ability to make remote calls to the backing service through method
* calls that map to API methods. Sample code to get started:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
* DataSourceName name =
* DataSourceName.ofProjectLocationDataSourceName(
* "[PROJECT]", "[LOCATION]", "[DATA_SOURCE]");
* DataSource response = dataTransferServiceClient.getDataSource(name);
* }
* }
*
* Note: close() needs to be called on the DataTransferServiceClient object to clean up resources
* such as threads. In the example above, try-with-resources is used, which automatically calls
* close().
*
*
* Methods
*
* Method
* Description
* Method Variants
*
*
* GetDataSource
Retrieves a supported data source and returns its settings.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* getDataSource(GetDataSourceRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* getDataSource(DataSourceName name)
*
getDataSource(String name)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* getDataSourceCallable()
*
*
*
*
* ListDataSources
Lists supported data sources and returns their settings.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* listDataSources(ListDataSourcesRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* listDataSources(LocationName parent)
*
listDataSources(ProjectName parent)
*
listDataSources(String parent)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* listDataSourcesPagedCallable()
*
listDataSourcesCallable()
*
*
*
*
* CreateTransferConfig
Creates a new data transfer configuration.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* createTransferConfig(CreateTransferConfigRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* createTransferConfig(LocationName parent, TransferConfig transferConfig)
*
createTransferConfig(ProjectName parent, TransferConfig transferConfig)
*
createTransferConfig(String parent, TransferConfig transferConfig)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* createTransferConfigCallable()
*
*
*
*
* UpdateTransferConfig
Updates a data transfer configuration. All fields must be set, even if they are not updated.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* updateTransferConfig(UpdateTransferConfigRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* updateTransferConfig(TransferConfig transferConfig, FieldMask updateMask)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* updateTransferConfigCallable()
*
*
*
*
* DeleteTransferConfig
Deletes a data transfer configuration, including any associated transfer runs and logs.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* deleteTransferConfig(DeleteTransferConfigRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* deleteTransferConfig(TransferConfigName name)
*
deleteTransferConfig(String name)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* deleteTransferConfigCallable()
*
*
*
*
* GetTransferConfig
Returns information about a data transfer config.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* getTransferConfig(GetTransferConfigRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* getTransferConfig(TransferConfigName name)
*
getTransferConfig(String name)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* getTransferConfigCallable()
*
*
*
*
* ListTransferConfigs
Returns information about all transfer configs owned by a project in the specified location.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* listTransferConfigs(ListTransferConfigsRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* listTransferConfigs(LocationName parent)
*
listTransferConfigs(ProjectName parent)
*
listTransferConfigs(String parent)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* listTransferConfigsPagedCallable()
*
listTransferConfigsCallable()
*
*
*
*
* ScheduleTransferRuns
Creates transfer runs for a time range [start_time, end_time]. For each date - or whatever granularity the data source supports - in the range, one transfer run is created. Note that runs are created per UTC time in the time range. DEPRECATED: use StartManualTransferRuns instead.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* scheduleTransferRuns(ScheduleTransferRunsRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* scheduleTransferRuns(TransferConfigName parent, Timestamp startTime, Timestamp endTime)
*
scheduleTransferRuns(String parent, Timestamp startTime, Timestamp endTime)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* scheduleTransferRunsCallable()
*
*
*
*
* StartManualTransferRuns
Start manual transfer runs to be executed now with schedule_time equal to current time. The transfer runs can be created for a time range where the run_time is between start_time (inclusive) and end_time (exclusive), or for a specific run_time.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* startManualTransferRuns(StartManualTransferRunsRequest request)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* startManualTransferRunsCallable()
*
*
*
*
* GetTransferRun
Returns information about the particular transfer run.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* getTransferRun(GetTransferRunRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* getTransferRun(RunName name)
*
getTransferRun(String name)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* getTransferRunCallable()
*
*
*
*
* DeleteTransferRun
Deletes the specified transfer run.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* deleteTransferRun(DeleteTransferRunRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* deleteTransferRun(RunName name)
*
deleteTransferRun(String name)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* deleteTransferRunCallable()
*
*
*
*
* ListTransferRuns
Returns information about running and completed transfer runs.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* listTransferRuns(ListTransferRunsRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* listTransferRuns(TransferConfigName parent)
*
listTransferRuns(String parent)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* listTransferRunsPagedCallable()
*
listTransferRunsCallable()
*
*
*
*
* ListTransferLogs
Returns log messages for the transfer run.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* listTransferLogs(ListTransferLogsRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* listTransferLogs(RunName parent)
*
listTransferLogs(String parent)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* listTransferLogsPagedCallable()
*
listTransferLogsCallable()
*
*
*
*
* CheckValidCreds
Returns true if valid credentials exist for the given data source and requesting user.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* checkValidCreds(CheckValidCredsRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* checkValidCreds(DataSourceName name)
*
checkValidCreds(String name)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* checkValidCredsCallable()
*
*
*
*
* EnrollDataSources
Enroll data sources in a user project. This allows users to create transfer configurations for these data sources. They will also appear in the ListDataSources RPC and as such, will appear in the [BigQuery UI](https://console.cloud.google.com/bigquery), and the documents can be found in the public guide for [BigQuery Web UI](https://cloud.google.com/bigquery/bigquery-web-ui) and [Data Transfer Service](https://cloud.google.com/bigquery/docs/working-with-transfers).
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* enrollDataSources(EnrollDataSourcesRequest request)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* enrollDataSourcesCallable()
*
*
*
*
* UnenrollDataSources
Unenroll data sources in a user project. This allows users to remove transfer configurations for these data sources. They will no longer appear in the ListDataSources RPC and will also no longer appear in the [BigQuery UI](https://console.cloud.google.com/bigquery). Data transfers configurations of unenrolled data sources will not be scheduled.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* unenrollDataSources(UnenrollDataSourcesRequest request)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* unenrollDataSourcesCallable()
*
*
*
*
* ListLocations
Lists information about the supported locations for this service.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* listLocations(ListLocationsRequest request)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* listLocationsPagedCallable()
*
listLocationsCallable()
*
*
*
*
* GetLocation
Gets information about a location.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* getLocation(GetLocationRequest request)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* getLocationCallable()
*
*
*
*
*
* See the individual methods for example code.
*
*
Many parameters require resource names to be formatted in a particular way. To assist with
* these names, this class includes a format method for each type of name, and additionally a parse
* method to extract the individual identifiers contained within names that are returned.
*
*
This class can be customized by passing in a custom instance of DataTransferServiceSettings to
* create(). For example:
*
*
To customize credentials:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* DataTransferServiceSettings dataTransferServiceSettings =
* DataTransferServiceSettings.newBuilder()
* .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
* .build();
* DataTransferServiceClient dataTransferServiceClient =
* DataTransferServiceClient.create(dataTransferServiceSettings);
* }
*
* To customize the endpoint:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* DataTransferServiceSettings dataTransferServiceSettings =
* DataTransferServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
* DataTransferServiceClient dataTransferServiceClient =
* DataTransferServiceClient.create(dataTransferServiceSettings);
* }
*
* To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over
* the wire:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* DataTransferServiceSettings dataTransferServiceSettings =
* DataTransferServiceSettings.newHttpJsonBuilder().build();
* DataTransferServiceClient dataTransferServiceClient =
* DataTransferServiceClient.create(dataTransferServiceSettings);
* }
*
* Please refer to the GitHub repository's samples for more quickstart code snippets.
*/
@Generated("by gapic-generator-java")
public class DataTransferServiceClient implements BackgroundResource {
private final DataTransferServiceSettings settings;
private final DataTransferServiceStub stub;
/** Constructs an instance of DataTransferServiceClient with default settings. */
public static final DataTransferServiceClient create() throws IOException {
return create(DataTransferServiceSettings.newBuilder().build());
}
/**
* Constructs an instance of DataTransferServiceClient, 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 DataTransferServiceClient create(DataTransferServiceSettings settings)
throws IOException {
return new DataTransferServiceClient(settings);
}
/**
* Constructs an instance of DataTransferServiceClient, using the given stub for making calls.
* This is for advanced usage - prefer using create(DataTransferServiceSettings).
*/
public static final DataTransferServiceClient create(DataTransferServiceStub stub) {
return new DataTransferServiceClient(stub);
}
/**
* Constructs an instance of DataTransferServiceClient, 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 DataTransferServiceClient(DataTransferServiceSettings settings) throws IOException {
this.settings = settings;
this.stub = ((DataTransferServiceStubSettings) settings.getStubSettings()).createStub();
}
protected DataTransferServiceClient(DataTransferServiceStub stub) {
this.settings = null;
this.stub = stub;
}
public final DataTransferServiceSettings getSettings() {
return settings;
}
public DataTransferServiceStub getStub() {
return stub;
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Retrieves a supported data source and returns its settings.
*
*
Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
* DataSourceName name =
* DataSourceName.ofProjectLocationDataSourceName(
* "[PROJECT]", "[LOCATION]", "[DATA_SOURCE]");
* DataSource response = dataTransferServiceClient.getDataSource(name);
* }
* }
*
* @param name Required. The field will contain name of the resource requested, for example:
* `projects/{project_id}/dataSources/{data_source_id}` or
* `projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final DataSource getDataSource(DataSourceName name) {
GetDataSourceRequest request =
GetDataSourceRequest.newBuilder().setName(name == null ? null : name.toString()).build();
return getDataSource(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Retrieves a supported data source and returns its settings.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
* String name = DataSourceName.ofProjectDataSourceName("[PROJECT]", "[DATA_SOURCE]").toString();
* DataSource response = dataTransferServiceClient.getDataSource(name);
* }
* }
*
* @param name Required. The field will contain name of the resource requested, for example:
* `projects/{project_id}/dataSources/{data_source_id}` or
* `projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final DataSource getDataSource(String name) {
GetDataSourceRequest request = GetDataSourceRequest.newBuilder().setName(name).build();
return getDataSource(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Retrieves a supported data source and returns its settings.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
* GetDataSourceRequest request =
* GetDataSourceRequest.newBuilder()
* .setName(
* DataSourceName.ofProjectLocationDataSourceName(
* "[PROJECT]", "[LOCATION]", "[DATA_SOURCE]")
* .toString())
* .build();
* DataSource response = dataTransferServiceClient.getDataSource(request);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final DataSource getDataSource(GetDataSourceRequest request) {
return getDataSourceCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Retrieves a supported data source and returns its settings.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
* GetDataSourceRequest request =
* GetDataSourceRequest.newBuilder()
* .setName(
* DataSourceName.ofProjectLocationDataSourceName(
* "[PROJECT]", "[LOCATION]", "[DATA_SOURCE]")
* .toString())
* .build();
* ApiFuture future =
* dataTransferServiceClient.getDataSourceCallable().futureCall(request);
* // Do something.
* DataSource response = future.get();
* }
* }
*/
public final UnaryCallable getDataSourceCallable() {
return stub.getDataSourceCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists supported data sources and returns their settings.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
* LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
* for (DataSource element : dataTransferServiceClient.listDataSources(parent).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* @param parent Required. The BigQuery project id for which data sources should be returned. Must
* be in the form: `projects/{project_id}` or `projects/{project_id}/locations/{location_id}`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListDataSourcesPagedResponse listDataSources(LocationName parent) {
ListDataSourcesRequest request =
ListDataSourcesRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.build();
return listDataSources(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists supported data sources and returns their settings.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
* ProjectName parent = ProjectName.of("[PROJECT]");
* for (DataSource element : dataTransferServiceClient.listDataSources(parent).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* @param parent Required. The BigQuery project id for which data sources should be returned. Must
* be in the form: `projects/{project_id}` or `projects/{project_id}/locations/{location_id}`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListDataSourcesPagedResponse listDataSources(ProjectName parent) {
ListDataSourcesRequest request =
ListDataSourcesRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.build();
return listDataSources(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists supported data sources and returns their settings.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
* String parent = ProjectName.of("[PROJECT]").toString();
* for (DataSource element : dataTransferServiceClient.listDataSources(parent).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* @param parent Required. The BigQuery project id for which data sources should be returned. Must
* be in the form: `projects/{project_id}` or `projects/{project_id}/locations/{location_id}`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListDataSourcesPagedResponse listDataSources(String parent) {
ListDataSourcesRequest request = ListDataSourcesRequest.newBuilder().setParent(parent).build();
return listDataSources(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists supported data sources and returns their settings.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
* ListDataSourcesRequest request =
* ListDataSourcesRequest.newBuilder()
* .setParent(ProjectName.of("[PROJECT]").toString())
* .setPageToken("pageToken873572522")
* .setPageSize(883849137)
* .build();
* for (DataSource element : dataTransferServiceClient.listDataSources(request).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListDataSourcesPagedResponse listDataSources(ListDataSourcesRequest request) {
return listDataSourcesPagedCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists supported data sources and returns their settings.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
* ListDataSourcesRequest request =
* ListDataSourcesRequest.newBuilder()
* .setParent(ProjectName.of("[PROJECT]").toString())
* .setPageToken("pageToken873572522")
* .setPageSize(883849137)
* .build();
* ApiFuture future =
* dataTransferServiceClient.listDataSourcesPagedCallable().futureCall(request);
* // Do something.
* for (DataSource element : future.get().iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*/
public final UnaryCallable
listDataSourcesPagedCallable() {
return stub.listDataSourcesPagedCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists supported data sources and returns their settings.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
* ListDataSourcesRequest request =
* ListDataSourcesRequest.newBuilder()
* .setParent(ProjectName.of("[PROJECT]").toString())
* .setPageToken("pageToken873572522")
* .setPageSize(883849137)
* .build();
* while (true) {
* ListDataSourcesResponse response =
* dataTransferServiceClient.listDataSourcesCallable().call(request);
* for (DataSource element : response.getDataSourcesList()) {
* // doThingsWith(element);
* }
* String nextPageToken = response.getNextPageToken();
* if (!Strings.isNullOrEmpty(nextPageToken)) {
* request = request.toBuilder().setPageToken(nextPageToken).build();
* } else {
* break;
* }
* }
* }
* }
*/
public final UnaryCallable
listDataSourcesCallable() {
return stub.listDataSourcesCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a new data transfer configuration.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
* LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
* TransferConfig transferConfig = TransferConfig.newBuilder().build();
* TransferConfig response =
* dataTransferServiceClient.createTransferConfig(parent, transferConfig);
* }
* }
*
* @param parent Required. The BigQuery project id where the transfer configuration should be
* created. Must be in the format projects/{project_id}/locations/{location_id} or
* projects/{project_id}. If specified location and location of the destination bigquery
* dataset do not match - the request will fail.
* @param transferConfig Required. Data transfer configuration to create.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final TransferConfig createTransferConfig(
LocationName parent, TransferConfig transferConfig) {
CreateTransferConfigRequest request =
CreateTransferConfigRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.setTransferConfig(transferConfig)
.build();
return createTransferConfig(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a new data transfer configuration.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
* ProjectName parent = ProjectName.of("[PROJECT]");
* TransferConfig transferConfig = TransferConfig.newBuilder().build();
* TransferConfig response =
* dataTransferServiceClient.createTransferConfig(parent, transferConfig);
* }
* }
*
* @param parent Required. The BigQuery project id where the transfer configuration should be
* created. Must be in the format projects/{project_id}/locations/{location_id} or
* projects/{project_id}. If specified location and location of the destination bigquery
* dataset do not match - the request will fail.
* @param transferConfig Required. Data transfer configuration to create.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final TransferConfig createTransferConfig(
ProjectName parent, TransferConfig transferConfig) {
CreateTransferConfigRequest request =
CreateTransferConfigRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.setTransferConfig(transferConfig)
.build();
return createTransferConfig(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a new data transfer configuration.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
* String parent = ProjectName.of("[PROJECT]").toString();
* TransferConfig transferConfig = TransferConfig.newBuilder().build();
* TransferConfig response =
* dataTransferServiceClient.createTransferConfig(parent, transferConfig);
* }
* }
*
* @param parent Required. The BigQuery project id where the transfer configuration should be
* created. Must be in the format projects/{project_id}/locations/{location_id} or
* projects/{project_id}. If specified location and location of the destination bigquery
* dataset do not match - the request will fail.
* @param transferConfig Required. Data transfer configuration to create.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final TransferConfig createTransferConfig(String parent, TransferConfig transferConfig) {
CreateTransferConfigRequest request =
CreateTransferConfigRequest.newBuilder()
.setParent(parent)
.setTransferConfig(transferConfig)
.build();
return createTransferConfig(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a new data transfer configuration.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
* CreateTransferConfigRequest request =
* CreateTransferConfigRequest.newBuilder()
* .setParent(ProjectName.of("[PROJECT]").toString())
* .setTransferConfig(TransferConfig.newBuilder().build())
* .setAuthorizationCode("authorizationCode742596102")
* .setVersionInfo("versionInfo688769446")
* .setServiceAccountName("serviceAccountName2137368675")
* .build();
* TransferConfig response = dataTransferServiceClient.createTransferConfig(request);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final TransferConfig createTransferConfig(CreateTransferConfigRequest request) {
return createTransferConfigCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a new data transfer configuration.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
* CreateTransferConfigRequest request =
* CreateTransferConfigRequest.newBuilder()
* .setParent(ProjectName.of("[PROJECT]").toString())
* .setTransferConfig(TransferConfig.newBuilder().build())
* .setAuthorizationCode("authorizationCode742596102")
* .setVersionInfo("versionInfo688769446")
* .setServiceAccountName("serviceAccountName2137368675")
* .build();
* ApiFuture future =
* dataTransferServiceClient.createTransferConfigCallable().futureCall(request);
* // Do something.
* TransferConfig response = future.get();
* }
* }
*/
public final UnaryCallable
createTransferConfigCallable() {
return stub.createTransferConfigCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates a data transfer configuration. All fields must be set, even if they are not updated.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
* TransferConfig transferConfig = TransferConfig.newBuilder().build();
* FieldMask updateMask = FieldMask.newBuilder().build();
* TransferConfig response =
* dataTransferServiceClient.updateTransferConfig(transferConfig, updateMask);
* }
* }
*
* @param transferConfig Required. Data transfer configuration to create.
* @param updateMask Required. Required list of fields to be updated in this request.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final TransferConfig updateTransferConfig(
TransferConfig transferConfig, FieldMask updateMask) {
UpdateTransferConfigRequest request =
UpdateTransferConfigRequest.newBuilder()
.setTransferConfig(transferConfig)
.setUpdateMask(updateMask)
.build();
return updateTransferConfig(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates a data transfer configuration. All fields must be set, even if they are not updated.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
* UpdateTransferConfigRequest request =
* UpdateTransferConfigRequest.newBuilder()
* .setTransferConfig(TransferConfig.newBuilder().build())
* .setAuthorizationCode("authorizationCode742596102")
* .setUpdateMask(FieldMask.newBuilder().build())
* .setVersionInfo("versionInfo688769446")
* .setServiceAccountName("serviceAccountName2137368675")
* .build();
* TransferConfig response = dataTransferServiceClient.updateTransferConfig(request);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final TransferConfig updateTransferConfig(UpdateTransferConfigRequest request) {
return updateTransferConfigCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates a data transfer configuration. All fields must be set, even if they are not updated.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
* UpdateTransferConfigRequest request =
* UpdateTransferConfigRequest.newBuilder()
* .setTransferConfig(TransferConfig.newBuilder().build())
* .setAuthorizationCode("authorizationCode742596102")
* .setUpdateMask(FieldMask.newBuilder().build())
* .setVersionInfo("versionInfo688769446")
* .setServiceAccountName("serviceAccountName2137368675")
* .build();
* ApiFuture future =
* dataTransferServiceClient.updateTransferConfigCallable().futureCall(request);
* // Do something.
* TransferConfig response = future.get();
* }
* }
*/
public final UnaryCallable
updateTransferConfigCallable() {
return stub.updateTransferConfigCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes a data transfer configuration, including any associated transfer runs and logs.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
* TransferConfigName name =
* TransferConfigName.ofProjectLocationTransferConfigName(
* "[PROJECT]", "[LOCATION]", "[TRANSFER_CONFIG]");
* dataTransferServiceClient.deleteTransferConfig(name);
* }
* }
*
* @param name Required. The field will contain name of the resource requested, for example:
* `projects/{project_id}/transferConfigs/{config_id}` or
* `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void deleteTransferConfig(TransferConfigName name) {
DeleteTransferConfigRequest request =
DeleteTransferConfigRequest.newBuilder()
.setName(name == null ? null : name.toString())
.build();
deleteTransferConfig(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes a data transfer configuration, including any associated transfer runs and logs.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
* String name =
* TransferConfigName.ofProjectTransferConfigName("[PROJECT]", "[TRANSFER_CONFIG]")
* .toString();
* dataTransferServiceClient.deleteTransferConfig(name);
* }
* }
*
* @param name Required. The field will contain name of the resource requested, for example:
* `projects/{project_id}/transferConfigs/{config_id}` or
* `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void deleteTransferConfig(String name) {
DeleteTransferConfigRequest request =
DeleteTransferConfigRequest.newBuilder().setName(name).build();
deleteTransferConfig(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes a data transfer configuration, including any associated transfer runs and logs.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
* DeleteTransferConfigRequest request =
* DeleteTransferConfigRequest.newBuilder()
* .setName(
* TransferConfigName.ofProjectLocationTransferConfigName(
* "[PROJECT]", "[LOCATION]", "[TRANSFER_CONFIG]")
* .toString())
* .build();
* dataTransferServiceClient.deleteTransferConfig(request);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void deleteTransferConfig(DeleteTransferConfigRequest request) {
deleteTransferConfigCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes a data transfer configuration, including any associated transfer runs and logs.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
* DeleteTransferConfigRequest request =
* DeleteTransferConfigRequest.newBuilder()
* .setName(
* TransferConfigName.ofProjectLocationTransferConfigName(
* "[PROJECT]", "[LOCATION]", "[TRANSFER_CONFIG]")
* .toString())
* .build();
* ApiFuture future =
* dataTransferServiceClient.deleteTransferConfigCallable().futureCall(request);
* // Do something.
* future.get();
* }
* }
*/
public final UnaryCallable deleteTransferConfigCallable() {
return stub.deleteTransferConfigCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns information about a data transfer config.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
* TransferConfigName name =
* TransferConfigName.ofProjectLocationTransferConfigName(
* "[PROJECT]", "[LOCATION]", "[TRANSFER_CONFIG]");
* TransferConfig response = dataTransferServiceClient.getTransferConfig(name);
* }
* }
*
* @param name Required. The field will contain name of the resource requested, for example:
* `projects/{project_id}/transferConfigs/{config_id}` or
* `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final TransferConfig getTransferConfig(TransferConfigName name) {
GetTransferConfigRequest request =
GetTransferConfigRequest.newBuilder()
.setName(name == null ? null : name.toString())
.build();
return getTransferConfig(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns information about a data transfer config.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
* String name =
* TransferConfigName.ofProjectTransferConfigName("[PROJECT]", "[TRANSFER_CONFIG]")
* .toString();
* TransferConfig response = dataTransferServiceClient.getTransferConfig(name);
* }
* }
*
* @param name Required. The field will contain name of the resource requested, for example:
* `projects/{project_id}/transferConfigs/{config_id}` or
* `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final TransferConfig getTransferConfig(String name) {
GetTransferConfigRequest request = GetTransferConfigRequest.newBuilder().setName(name).build();
return getTransferConfig(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns information about a data transfer config.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
* GetTransferConfigRequest request =
* GetTransferConfigRequest.newBuilder()
* .setName(
* TransferConfigName.ofProjectLocationTransferConfigName(
* "[PROJECT]", "[LOCATION]", "[TRANSFER_CONFIG]")
* .toString())
* .build();
* TransferConfig response = dataTransferServiceClient.getTransferConfig(request);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final TransferConfig getTransferConfig(GetTransferConfigRequest request) {
return getTransferConfigCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns information about a data transfer config.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
* GetTransferConfigRequest request =
* GetTransferConfigRequest.newBuilder()
* .setName(
* TransferConfigName.ofProjectLocationTransferConfigName(
* "[PROJECT]", "[LOCATION]", "[TRANSFER_CONFIG]")
* .toString())
* .build();
* ApiFuture future =
* dataTransferServiceClient.getTransferConfigCallable().futureCall(request);
* // Do something.
* TransferConfig response = future.get();
* }
* }
*/
public final UnaryCallable getTransferConfigCallable() {
return stub.getTransferConfigCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns information about all transfer configs owned by a project in the specified location.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
* LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
* for (TransferConfig element :
* dataTransferServiceClient.listTransferConfigs(parent).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* @param parent Required. The BigQuery project id for which transfer configs should be returned:
* `projects/{project_id}` or `projects/{project_id}/locations/{location_id}`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListTransferConfigsPagedResponse listTransferConfigs(LocationName parent) {
ListTransferConfigsRequest request =
ListTransferConfigsRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.build();
return listTransferConfigs(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns information about all transfer configs owned by a project in the specified location.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
* ProjectName parent = ProjectName.of("[PROJECT]");
* for (TransferConfig element :
* dataTransferServiceClient.listTransferConfigs(parent).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* @param parent Required. The BigQuery project id for which transfer configs should be returned:
* `projects/{project_id}` or `projects/{project_id}/locations/{location_id}`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListTransferConfigsPagedResponse listTransferConfigs(ProjectName parent) {
ListTransferConfigsRequest request =
ListTransferConfigsRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.build();
return listTransferConfigs(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns information about all transfer configs owned by a project in the specified location.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
* String parent = ProjectName.of("[PROJECT]").toString();
* for (TransferConfig element :
* dataTransferServiceClient.listTransferConfigs(parent).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* @param parent Required. The BigQuery project id for which transfer configs should be returned:
* `projects/{project_id}` or `projects/{project_id}/locations/{location_id}`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListTransferConfigsPagedResponse listTransferConfigs(String parent) {
ListTransferConfigsRequest request =
ListTransferConfigsRequest.newBuilder().setParent(parent).build();
return listTransferConfigs(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns information about all transfer configs owned by a project in the specified location.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
* ListTransferConfigsRequest request =
* ListTransferConfigsRequest.newBuilder()
* .setParent(ProjectName.of("[PROJECT]").toString())
* .addAllDataSourceIds(new ArrayList())
* .setPageToken("pageToken873572522")
* .setPageSize(883849137)
* .build();
* for (TransferConfig element :
* dataTransferServiceClient.listTransferConfigs(request).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListTransferConfigsPagedResponse listTransferConfigs(
ListTransferConfigsRequest request) {
return listTransferConfigsPagedCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns information about all transfer configs owned by a project in the specified location.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
* ListTransferConfigsRequest request =
* ListTransferConfigsRequest.newBuilder()
* .setParent(ProjectName.of("[PROJECT]").toString())
* .addAllDataSourceIds(new ArrayList())
* .setPageToken("pageToken873572522")
* .setPageSize(883849137)
* .build();
* ApiFuture future =
* dataTransferServiceClient.listTransferConfigsPagedCallable().futureCall(request);
* // Do something.
* for (TransferConfig element : future.get().iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*/
public final UnaryCallable
listTransferConfigsPagedCallable() {
return stub.listTransferConfigsPagedCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns information about all transfer configs owned by a project in the specified location.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
* ListTransferConfigsRequest request =
* ListTransferConfigsRequest.newBuilder()
* .setParent(ProjectName.of("[PROJECT]").toString())
* .addAllDataSourceIds(new ArrayList())
* .setPageToken("pageToken873572522")
* .setPageSize(883849137)
* .build();
* while (true) {
* ListTransferConfigsResponse response =
* dataTransferServiceClient.listTransferConfigsCallable().call(request);
* for (TransferConfig element : response.getTransferConfigsList()) {
* // doThingsWith(element);
* }
* String nextPageToken = response.getNextPageToken();
* if (!Strings.isNullOrEmpty(nextPageToken)) {
* request = request.toBuilder().setPageToken(nextPageToken).build();
* } else {
* break;
* }
* }
* }
* }
*/
public final UnaryCallable
listTransferConfigsCallable() {
return stub.listTransferConfigsCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates transfer runs for a time range [start_time, end_time]. For each date - or whatever
* granularity the data source supports - in the range, one transfer run is created. Note that
* runs are created per UTC time in the time range. DEPRECATED: use StartManualTransferRuns
* instead.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
* TransferConfigName parent =
* TransferConfigName.ofProjectLocationTransferConfigName(
* "[PROJECT]", "[LOCATION]", "[TRANSFER_CONFIG]");
* Timestamp startTime = Timestamp.newBuilder().build();
* Timestamp endTime = Timestamp.newBuilder().build();
* ScheduleTransferRunsResponse response =
* dataTransferServiceClient.scheduleTransferRuns(parent, startTime, endTime);
* }
* }
*
* @param parent Required. Transfer configuration name in the form:
* `projects/{project_id}/transferConfigs/{config_id}` or
* `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`.
* @param startTime Required. Start time of the range of transfer runs. For example,
* `"2017-05-25T00:00:00+00:00"`.
* @param endTime Required. End time of the range of transfer runs. For example,
* `"2017-05-30T00:00:00+00:00"`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
* @deprecated This method is deprecated and will be removed in the next major version update.
*/
@Deprecated
public final ScheduleTransferRunsResponse scheduleTransferRuns(
TransferConfigName parent, Timestamp startTime, Timestamp endTime) {
ScheduleTransferRunsRequest request =
ScheduleTransferRunsRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.setStartTime(startTime)
.setEndTime(endTime)
.build();
return scheduleTransferRuns(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates transfer runs for a time range [start_time, end_time]. For each date - or whatever
* granularity the data source supports - in the range, one transfer run is created. Note that
* runs are created per UTC time in the time range. DEPRECATED: use StartManualTransferRuns
* instead.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
* String parent =
* TransferConfigName.ofProjectTransferConfigName("[PROJECT]", "[TRANSFER_CONFIG]")
* .toString();
* Timestamp startTime = Timestamp.newBuilder().build();
* Timestamp endTime = Timestamp.newBuilder().build();
* ScheduleTransferRunsResponse response =
* dataTransferServiceClient.scheduleTransferRuns(parent, startTime, endTime);
* }
* }
*
* @param parent Required. Transfer configuration name in the form:
* `projects/{project_id}/transferConfigs/{config_id}` or
* `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`.
* @param startTime Required. Start time of the range of transfer runs. For example,
* `"2017-05-25T00:00:00+00:00"`.
* @param endTime Required. End time of the range of transfer runs. For example,
* `"2017-05-30T00:00:00+00:00"`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
* @deprecated This method is deprecated and will be removed in the next major version update.
*/
@Deprecated
public final ScheduleTransferRunsResponse scheduleTransferRuns(
String parent, Timestamp startTime, Timestamp endTime) {
ScheduleTransferRunsRequest request =
ScheduleTransferRunsRequest.newBuilder()
.setParent(parent)
.setStartTime(startTime)
.setEndTime(endTime)
.build();
return scheduleTransferRuns(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates transfer runs for a time range [start_time, end_time]. For each date - or whatever
* granularity the data source supports - in the range, one transfer run is created. Note that
* runs are created per UTC time in the time range. DEPRECATED: use StartManualTransferRuns
* instead.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
* ScheduleTransferRunsRequest request =
* ScheduleTransferRunsRequest.newBuilder()
* .setParent(
* TransferConfigName.ofProjectLocationTransferConfigName(
* "[PROJECT]", "[LOCATION]", "[TRANSFER_CONFIG]")
* .toString())
* .setStartTime(Timestamp.newBuilder().build())
* .setEndTime(Timestamp.newBuilder().build())
* .build();
* ScheduleTransferRunsResponse response =
* dataTransferServiceClient.scheduleTransferRuns(request);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
* @deprecated This method is deprecated and will be removed in the next major version update.
*/
@Deprecated
public final ScheduleTransferRunsResponse scheduleTransferRuns(
ScheduleTransferRunsRequest request) {
return scheduleTransferRunsCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates transfer runs for a time range [start_time, end_time]. For each date - or whatever
* granularity the data source supports - in the range, one transfer run is created. Note that
* runs are created per UTC time in the time range. DEPRECATED: use StartManualTransferRuns
* instead.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
* ScheduleTransferRunsRequest request =
* ScheduleTransferRunsRequest.newBuilder()
* .setParent(
* TransferConfigName.ofProjectLocationTransferConfigName(
* "[PROJECT]", "[LOCATION]", "[TRANSFER_CONFIG]")
* .toString())
* .setStartTime(Timestamp.newBuilder().build())
* .setEndTime(Timestamp.newBuilder().build())
* .build();
* ApiFuture future =
* dataTransferServiceClient.scheduleTransferRunsCallable().futureCall(request);
* // Do something.
* ScheduleTransferRunsResponse response = future.get();
* }
* }
*
* @deprecated This method is deprecated and will be removed in the next major version update.
*/
@Deprecated
public final UnaryCallable
scheduleTransferRunsCallable() {
return stub.scheduleTransferRunsCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Start manual transfer runs to be executed now with schedule_time equal to current time. The
* transfer runs can be created for a time range where the run_time is between start_time
* (inclusive) and end_time (exclusive), or for a specific run_time.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
* StartManualTransferRunsRequest request =
* StartManualTransferRunsRequest.newBuilder()
* .setParent(
* TransferConfigName.ofProjectLocationTransferConfigName(
* "[PROJECT]", "[LOCATION]", "[TRANSFER_CONFIG]")
* .toString())
* .build();
* StartManualTransferRunsResponse response =
* dataTransferServiceClient.startManualTransferRuns(request);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final StartManualTransferRunsResponse startManualTransferRuns(
StartManualTransferRunsRequest request) {
return startManualTransferRunsCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Start manual transfer runs to be executed now with schedule_time equal to current time. The
* transfer runs can be created for a time range where the run_time is between start_time
* (inclusive) and end_time (exclusive), or for a specific run_time.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
* StartManualTransferRunsRequest request =
* StartManualTransferRunsRequest.newBuilder()
* .setParent(
* TransferConfigName.ofProjectLocationTransferConfigName(
* "[PROJECT]", "[LOCATION]", "[TRANSFER_CONFIG]")
* .toString())
* .build();
* ApiFuture future =
* dataTransferServiceClient.startManualTransferRunsCallable().futureCall(request);
* // Do something.
* StartManualTransferRunsResponse response = future.get();
* }
* }
*/
public final UnaryCallable
startManualTransferRunsCallable() {
return stub.startManualTransferRunsCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns information about the particular transfer run.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
* RunName name =
* RunName.ofProjectLocationTransferConfigRunName(
* "[PROJECT]", "[LOCATION]", "[TRANSFER_CONFIG]", "[RUN]");
* TransferRun response = dataTransferServiceClient.getTransferRun(name);
* }
* }
*
* @param name Required. The field will contain name of the resource requested, for example:
* `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or
* `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final TransferRun getTransferRun(RunName name) {
GetTransferRunRequest request =
GetTransferRunRequest.newBuilder().setName(name == null ? null : name.toString()).build();
return getTransferRun(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns information about the particular transfer run.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
* String name =
* RunName.ofProjectTransferConfigRunName("[PROJECT]", "[TRANSFER_CONFIG]", "[RUN]")
* .toString();
* TransferRun response = dataTransferServiceClient.getTransferRun(name);
* }
* }
*
* @param name Required. The field will contain name of the resource requested, for example:
* `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or
* `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final TransferRun getTransferRun(String name) {
GetTransferRunRequest request = GetTransferRunRequest.newBuilder().setName(name).build();
return getTransferRun(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns information about the particular transfer run.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
* GetTransferRunRequest request =
* GetTransferRunRequest.newBuilder()
* .setName(
* RunName.ofProjectLocationTransferConfigRunName(
* "[PROJECT]", "[LOCATION]", "[TRANSFER_CONFIG]", "[RUN]")
* .toString())
* .build();
* TransferRun response = dataTransferServiceClient.getTransferRun(request);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final TransferRun getTransferRun(GetTransferRunRequest request) {
return getTransferRunCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns information about the particular transfer run.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
* GetTransferRunRequest request =
* GetTransferRunRequest.newBuilder()
* .setName(
* RunName.ofProjectLocationTransferConfigRunName(
* "[PROJECT]", "[LOCATION]", "[TRANSFER_CONFIG]", "[RUN]")
* .toString())
* .build();
* ApiFuture future =
* dataTransferServiceClient.getTransferRunCallable().futureCall(request);
* // Do something.
* TransferRun response = future.get();
* }
* }
*/
public final UnaryCallable getTransferRunCallable() {
return stub.getTransferRunCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes the specified transfer run.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
* RunName name =
* RunName.ofProjectLocationTransferConfigRunName(
* "[PROJECT]", "[LOCATION]", "[TRANSFER_CONFIG]", "[RUN]");
* dataTransferServiceClient.deleteTransferRun(name);
* }
* }
*
* @param name Required. The field will contain name of the resource requested, for example:
* `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or
* `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void deleteTransferRun(RunName name) {
DeleteTransferRunRequest request =
DeleteTransferRunRequest.newBuilder()
.setName(name == null ? null : name.toString())
.build();
deleteTransferRun(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes the specified transfer run.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
* String name =
* RunName.ofProjectTransferConfigRunName("[PROJECT]", "[TRANSFER_CONFIG]", "[RUN]")
* .toString();
* dataTransferServiceClient.deleteTransferRun(name);
* }
* }
*
* @param name Required. The field will contain name of the resource requested, for example:
* `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or
* `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void deleteTransferRun(String name) {
DeleteTransferRunRequest request = DeleteTransferRunRequest.newBuilder().setName(name).build();
deleteTransferRun(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes the specified transfer run.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
* DeleteTransferRunRequest request =
* DeleteTransferRunRequest.newBuilder()
* .setName(
* RunName.ofProjectLocationTransferConfigRunName(
* "[PROJECT]", "[LOCATION]", "[TRANSFER_CONFIG]", "[RUN]")
* .toString())
* .build();
* dataTransferServiceClient.deleteTransferRun(request);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void deleteTransferRun(DeleteTransferRunRequest request) {
deleteTransferRunCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes the specified transfer run.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
* DeleteTransferRunRequest request =
* DeleteTransferRunRequest.newBuilder()
* .setName(
* RunName.ofProjectLocationTransferConfigRunName(
* "[PROJECT]", "[LOCATION]", "[TRANSFER_CONFIG]", "[RUN]")
* .toString())
* .build();
* ApiFuture future =
* dataTransferServiceClient.deleteTransferRunCallable().futureCall(request);
* // Do something.
* future.get();
* }
* }
*/
public final UnaryCallable deleteTransferRunCallable() {
return stub.deleteTransferRunCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns information about running and completed transfer runs.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
* TransferConfigName parent =
* TransferConfigName.ofProjectLocationTransferConfigName(
* "[PROJECT]", "[LOCATION]", "[TRANSFER_CONFIG]");
* for (TransferRun element : dataTransferServiceClient.listTransferRuns(parent).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* @param parent Required. Name of transfer configuration for which transfer runs should be
* retrieved. Format of transfer configuration resource name is:
* `projects/{project_id}/transferConfigs/{config_id}` or
* `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListTransferRunsPagedResponse listTransferRuns(TransferConfigName parent) {
ListTransferRunsRequest request =
ListTransferRunsRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.build();
return listTransferRuns(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns information about running and completed transfer runs.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
* String parent =
* TransferConfigName.ofProjectTransferConfigName("[PROJECT]", "[TRANSFER_CONFIG]")
* .toString();
* for (TransferRun element : dataTransferServiceClient.listTransferRuns(parent).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* @param parent Required. Name of transfer configuration for which transfer runs should be
* retrieved. Format of transfer configuration resource name is:
* `projects/{project_id}/transferConfigs/{config_id}` or
* `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListTransferRunsPagedResponse listTransferRuns(String parent) {
ListTransferRunsRequest request =
ListTransferRunsRequest.newBuilder().setParent(parent).build();
return listTransferRuns(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns information about running and completed transfer runs.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
* ListTransferRunsRequest request =
* ListTransferRunsRequest.newBuilder()
* .setParent(
* TransferConfigName.ofProjectLocationTransferConfigName(
* "[PROJECT]", "[LOCATION]", "[TRANSFER_CONFIG]")
* .toString())
* .addAllStates(new ArrayList())
* .setPageToken("pageToken873572522")
* .setPageSize(883849137)
* .build();
* for (TransferRun element : dataTransferServiceClient.listTransferRuns(request).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListTransferRunsPagedResponse listTransferRuns(ListTransferRunsRequest request) {
return listTransferRunsPagedCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns information about running and completed transfer runs.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
* ListTransferRunsRequest request =
* ListTransferRunsRequest.newBuilder()
* .setParent(
* TransferConfigName.ofProjectLocationTransferConfigName(
* "[PROJECT]", "[LOCATION]", "[TRANSFER_CONFIG]")
* .toString())
* .addAllStates(new ArrayList())
* .setPageToken("pageToken873572522")
* .setPageSize(883849137)
* .build();
* ApiFuture future =
* dataTransferServiceClient.listTransferRunsPagedCallable().futureCall(request);
* // Do something.
* for (TransferRun element : future.get().iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*/
public final UnaryCallable
listTransferRunsPagedCallable() {
return stub.listTransferRunsPagedCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns information about running and completed transfer runs.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
* ListTransferRunsRequest request =
* ListTransferRunsRequest.newBuilder()
* .setParent(
* TransferConfigName.ofProjectLocationTransferConfigName(
* "[PROJECT]", "[LOCATION]", "[TRANSFER_CONFIG]")
* .toString())
* .addAllStates(new ArrayList())
* .setPageToken("pageToken873572522")
* .setPageSize(883849137)
* .build();
* while (true) {
* ListTransferRunsResponse response =
* dataTransferServiceClient.listTransferRunsCallable().call(request);
* for (TransferRun element : response.getTransferRunsList()) {
* // doThingsWith(element);
* }
* String nextPageToken = response.getNextPageToken();
* if (!Strings.isNullOrEmpty(nextPageToken)) {
* request = request.toBuilder().setPageToken(nextPageToken).build();
* } else {
* break;
* }
* }
* }
* }
*/
public final UnaryCallable
listTransferRunsCallable() {
return stub.listTransferRunsCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns log messages for the transfer run.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
* RunName parent =
* RunName.ofProjectLocationTransferConfigRunName(
* "[PROJECT]", "[LOCATION]", "[TRANSFER_CONFIG]", "[RUN]");
* for (TransferMessage element :
* dataTransferServiceClient.listTransferLogs(parent).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* @param parent Required. Transfer run name in the form:
* `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or
* `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListTransferLogsPagedResponse listTransferLogs(RunName parent) {
ListTransferLogsRequest request =
ListTransferLogsRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.build();
return listTransferLogs(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns log messages for the transfer run.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
* String parent =
* RunName.ofProjectTransferConfigRunName("[PROJECT]", "[TRANSFER_CONFIG]", "[RUN]")
* .toString();
* for (TransferMessage element :
* dataTransferServiceClient.listTransferLogs(parent).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* @param parent Required. Transfer run name in the form:
* `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or
* `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListTransferLogsPagedResponse listTransferLogs(String parent) {
ListTransferLogsRequest request =
ListTransferLogsRequest.newBuilder().setParent(parent).build();
return listTransferLogs(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns log messages for the transfer run.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
* ListTransferLogsRequest request =
* ListTransferLogsRequest.newBuilder()
* .setParent(
* RunName.ofProjectLocationTransferConfigRunName(
* "[PROJECT]", "[LOCATION]", "[TRANSFER_CONFIG]", "[RUN]")
* .toString())
* .setPageToken("pageToken873572522")
* .setPageSize(883849137)
* .addAllMessageTypes(new ArrayList())
* .build();
* for (TransferMessage element :
* dataTransferServiceClient.listTransferLogs(request).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListTransferLogsPagedResponse listTransferLogs(ListTransferLogsRequest request) {
return listTransferLogsPagedCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns log messages for the transfer run.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
* ListTransferLogsRequest request =
* ListTransferLogsRequest.newBuilder()
* .setParent(
* RunName.ofProjectLocationTransferConfigRunName(
* "[PROJECT]", "[LOCATION]", "[TRANSFER_CONFIG]", "[RUN]")
* .toString())
* .setPageToken("pageToken873572522")
* .setPageSize(883849137)
* .addAllMessageTypes(new ArrayList())
* .build();
* ApiFuture future =
* dataTransferServiceClient.listTransferLogsPagedCallable().futureCall(request);
* // Do something.
* for (TransferMessage element : future.get().iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*/
public final UnaryCallable
listTransferLogsPagedCallable() {
return stub.listTransferLogsPagedCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns log messages for the transfer run.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
* ListTransferLogsRequest request =
* ListTransferLogsRequest.newBuilder()
* .setParent(
* RunName.ofProjectLocationTransferConfigRunName(
* "[PROJECT]", "[LOCATION]", "[TRANSFER_CONFIG]", "[RUN]")
* .toString())
* .setPageToken("pageToken873572522")
* .setPageSize(883849137)
* .addAllMessageTypes(new ArrayList())
* .build();
* while (true) {
* ListTransferLogsResponse response =
* dataTransferServiceClient.listTransferLogsCallable().call(request);
* for (TransferMessage element : response.getTransferMessagesList()) {
* // doThingsWith(element);
* }
* String nextPageToken = response.getNextPageToken();
* if (!Strings.isNullOrEmpty(nextPageToken)) {
* request = request.toBuilder().setPageToken(nextPageToken).build();
* } else {
* break;
* }
* }
* }
* }
*/
public final UnaryCallable
listTransferLogsCallable() {
return stub.listTransferLogsCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns true if valid credentials exist for the given data source and requesting user.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
* DataSourceName name =
* DataSourceName.ofProjectLocationDataSourceName(
* "[PROJECT]", "[LOCATION]", "[DATA_SOURCE]");
* CheckValidCredsResponse response = dataTransferServiceClient.checkValidCreds(name);
* }
* }
*
* @param name Required. The data source in the form:
* `projects/{project_id}/dataSources/{data_source_id}` or
* `projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final CheckValidCredsResponse checkValidCreds(DataSourceName name) {
CheckValidCredsRequest request =
CheckValidCredsRequest.newBuilder().setName(name == null ? null : name.toString()).build();
return checkValidCreds(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns true if valid credentials exist for the given data source and requesting user.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
* String name = DataSourceName.ofProjectDataSourceName("[PROJECT]", "[DATA_SOURCE]").toString();
* CheckValidCredsResponse response = dataTransferServiceClient.checkValidCreds(name);
* }
* }
*
* @param name Required. The data source in the form:
* `projects/{project_id}/dataSources/{data_source_id}` or
* `projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final CheckValidCredsResponse checkValidCreds(String name) {
CheckValidCredsRequest request = CheckValidCredsRequest.newBuilder().setName(name).build();
return checkValidCreds(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns true if valid credentials exist for the given data source and requesting user.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
* CheckValidCredsRequest request =
* CheckValidCredsRequest.newBuilder()
* .setName(
* DataSourceName.ofProjectLocationDataSourceName(
* "[PROJECT]", "[LOCATION]", "[DATA_SOURCE]")
* .toString())
* .build();
* CheckValidCredsResponse response = dataTransferServiceClient.checkValidCreds(request);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final CheckValidCredsResponse checkValidCreds(CheckValidCredsRequest request) {
return checkValidCredsCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns true if valid credentials exist for the given data source and requesting user.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
* CheckValidCredsRequest request =
* CheckValidCredsRequest.newBuilder()
* .setName(
* DataSourceName.ofProjectLocationDataSourceName(
* "[PROJECT]", "[LOCATION]", "[DATA_SOURCE]")
* .toString())
* .build();
* ApiFuture future =
* dataTransferServiceClient.checkValidCredsCallable().futureCall(request);
* // Do something.
* CheckValidCredsResponse response = future.get();
* }
* }
*/
public final UnaryCallable
checkValidCredsCallable() {
return stub.checkValidCredsCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Enroll data sources in a user project. This allows users to create transfer configurations for
* these data sources. They will also appear in the ListDataSources RPC and as such, will appear
* in the [BigQuery UI](https://console.cloud.google.com/bigquery), and the documents can be found
* in the public guide for [BigQuery Web UI](https://cloud.google.com/bigquery/bigquery-web-ui)
* and [Data Transfer Service](https://cloud.google.com/bigquery/docs/working-with-transfers).
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
* EnrollDataSourcesRequest request =
* EnrollDataSourcesRequest.newBuilder()
* .setName("name3373707")
* .addAllDataSourceIds(new ArrayList())
* .build();
* dataTransferServiceClient.enrollDataSources(request);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void enrollDataSources(EnrollDataSourcesRequest request) {
enrollDataSourcesCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Enroll data sources in a user project. This allows users to create transfer configurations for
* these data sources. They will also appear in the ListDataSources RPC and as such, will appear
* in the [BigQuery UI](https://console.cloud.google.com/bigquery), and the documents can be found
* in the public guide for [BigQuery Web UI](https://cloud.google.com/bigquery/bigquery-web-ui)
* and [Data Transfer Service](https://cloud.google.com/bigquery/docs/working-with-transfers).
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
* EnrollDataSourcesRequest request =
* EnrollDataSourcesRequest.newBuilder()
* .setName("name3373707")
* .addAllDataSourceIds(new ArrayList())
* .build();
* ApiFuture future =
* dataTransferServiceClient.enrollDataSourcesCallable().futureCall(request);
* // Do something.
* future.get();
* }
* }
*/
public final UnaryCallable enrollDataSourcesCallable() {
return stub.enrollDataSourcesCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Unenroll data sources in a user project. This allows users to remove transfer configurations
* for these data sources. They will no longer appear in the ListDataSources RPC and will also no
* longer appear in the [BigQuery UI](https://console.cloud.google.com/bigquery). Data transfers
* configurations of unenrolled data sources will not be scheduled.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
* UnenrollDataSourcesRequest request =
* UnenrollDataSourcesRequest.newBuilder()
* .setName("name3373707")
* .addAllDataSourceIds(new ArrayList())
* .build();
* dataTransferServiceClient.unenrollDataSources(request);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void unenrollDataSources(UnenrollDataSourcesRequest request) {
unenrollDataSourcesCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Unenroll data sources in a user project. This allows users to remove transfer configurations
* for these data sources. They will no longer appear in the ListDataSources RPC and will also no
* longer appear in the [BigQuery UI](https://console.cloud.google.com/bigquery). Data transfers
* configurations of unenrolled data sources will not be scheduled.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
* UnenrollDataSourcesRequest request =
* UnenrollDataSourcesRequest.newBuilder()
* .setName("name3373707")
* .addAllDataSourceIds(new ArrayList())
* .build();
* ApiFuture future =
* dataTransferServiceClient.unenrollDataSourcesCallable().futureCall(request);
* // Do something.
* future.get();
* }
* }
*/
public final UnaryCallable unenrollDataSourcesCallable() {
return stub.unenrollDataSourcesCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists information about the supported locations for this service.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
* ListLocationsRequest request =
* ListLocationsRequest.newBuilder()
* .setName("name3373707")
* .setFilter("filter-1274492040")
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .build();
* for (Location element : dataTransferServiceClient.listLocations(request).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListLocationsPagedResponse listLocations(ListLocationsRequest request) {
return listLocationsPagedCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists information about the supported locations for this service.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
* ListLocationsRequest request =
* ListLocationsRequest.newBuilder()
* .setName("name3373707")
* .setFilter("filter-1274492040")
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .build();
* ApiFuture future =
* dataTransferServiceClient.listLocationsPagedCallable().futureCall(request);
* // Do something.
* for (Location element : future.get().iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*/
public final UnaryCallable
listLocationsPagedCallable() {
return stub.listLocationsPagedCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Lists information about the supported locations for this service.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
* ListLocationsRequest request =
* ListLocationsRequest.newBuilder()
* .setName("name3373707")
* .setFilter("filter-1274492040")
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .build();
* while (true) {
* ListLocationsResponse response =
* dataTransferServiceClient.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;
* }
* }
* }
* }
*/
public final UnaryCallable listLocationsCallable() {
return stub.listLocationsCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets information about a location.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
* GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
* Location response = dataTransferServiceClient.getLocation(request);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Location getLocation(GetLocationRequest request) {
return getLocationCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets information about a location.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
* GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
* ApiFuture future =
* dataTransferServiceClient.getLocationCallable().futureCall(request);
* // Do something.
* Location response = future.get();
* }
* }
*/
public final UnaryCallable getLocationCallable() {
return stub.getLocationCallable();
}
@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 ListDataSourcesPagedResponse
extends AbstractPagedListResponse<
ListDataSourcesRequest,
ListDataSourcesResponse,
DataSource,
ListDataSourcesPage,
ListDataSourcesFixedSizeCollection> {
public static ApiFuture createAsync(
PageContext context,
ApiFuture futureResponse) {
ApiFuture futurePage =
ListDataSourcesPage.createEmptyPage().createPageAsync(context, futureResponse);
return ApiFutures.transform(
futurePage,
input -> new ListDataSourcesPagedResponse(input),
MoreExecutors.directExecutor());
}
private ListDataSourcesPagedResponse(ListDataSourcesPage page) {
super(page, ListDataSourcesFixedSizeCollection.createEmptyCollection());
}
}
public static class ListDataSourcesPage
extends AbstractPage<
ListDataSourcesRequest, ListDataSourcesResponse, DataSource, ListDataSourcesPage> {
private ListDataSourcesPage(
PageContext context,
ListDataSourcesResponse response) {
super(context, response);
}
private static ListDataSourcesPage createEmptyPage() {
return new ListDataSourcesPage(null, null);
}
@Override
protected ListDataSourcesPage createPage(
PageContext context,
ListDataSourcesResponse response) {
return new ListDataSourcesPage(context, response);
}
@Override
public ApiFuture createPageAsync(
PageContext context,
ApiFuture futureResponse) {
return super.createPageAsync(context, futureResponse);
}
}
public static class ListDataSourcesFixedSizeCollection
extends AbstractFixedSizeCollection<
ListDataSourcesRequest,
ListDataSourcesResponse,
DataSource,
ListDataSourcesPage,
ListDataSourcesFixedSizeCollection> {
private ListDataSourcesFixedSizeCollection(
List pages, int collectionSize) {
super(pages, collectionSize);
}
private static ListDataSourcesFixedSizeCollection createEmptyCollection() {
return new ListDataSourcesFixedSizeCollection(null, 0);
}
@Override
protected ListDataSourcesFixedSizeCollection createCollection(
List pages, int collectionSize) {
return new ListDataSourcesFixedSizeCollection(pages, collectionSize);
}
}
public static class ListTransferConfigsPagedResponse
extends AbstractPagedListResponse<
ListTransferConfigsRequest,
ListTransferConfigsResponse,
TransferConfig,
ListTransferConfigsPage,
ListTransferConfigsFixedSizeCollection> {
public static ApiFuture createAsync(
PageContext
context,
ApiFuture futureResponse) {
ApiFuture futurePage =
ListTransferConfigsPage.createEmptyPage().createPageAsync(context, futureResponse);
return ApiFutures.transform(
futurePage,
input -> new ListTransferConfigsPagedResponse(input),
MoreExecutors.directExecutor());
}
private ListTransferConfigsPagedResponse(ListTransferConfigsPage page) {
super(page, ListTransferConfigsFixedSizeCollection.createEmptyCollection());
}
}
public static class ListTransferConfigsPage
extends AbstractPage<
ListTransferConfigsRequest,
ListTransferConfigsResponse,
TransferConfig,
ListTransferConfigsPage> {
private ListTransferConfigsPage(
PageContext
context,
ListTransferConfigsResponse response) {
super(context, response);
}
private static ListTransferConfigsPage createEmptyPage() {
return new ListTransferConfigsPage(null, null);
}
@Override
protected ListTransferConfigsPage createPage(
PageContext
context,
ListTransferConfigsResponse response) {
return new ListTransferConfigsPage(context, response);
}
@Override
public ApiFuture createPageAsync(
PageContext
context,
ApiFuture futureResponse) {
return super.createPageAsync(context, futureResponse);
}
}
public static class ListTransferConfigsFixedSizeCollection
extends AbstractFixedSizeCollection<
ListTransferConfigsRequest,
ListTransferConfigsResponse,
TransferConfig,
ListTransferConfigsPage,
ListTransferConfigsFixedSizeCollection> {
private ListTransferConfigsFixedSizeCollection(
List pages, int collectionSize) {
super(pages, collectionSize);
}
private static ListTransferConfigsFixedSizeCollection createEmptyCollection() {
return new ListTransferConfigsFixedSizeCollection(null, 0);
}
@Override
protected ListTransferConfigsFixedSizeCollection createCollection(
List pages, int collectionSize) {
return new ListTransferConfigsFixedSizeCollection(pages, collectionSize);
}
}
public static class ListTransferRunsPagedResponse
extends AbstractPagedListResponse<
ListTransferRunsRequest,
ListTransferRunsResponse,
TransferRun,
ListTransferRunsPage,
ListTransferRunsFixedSizeCollection> {
public static ApiFuture createAsync(
PageContext context,
ApiFuture futureResponse) {
ApiFuture futurePage =
ListTransferRunsPage.createEmptyPage().createPageAsync(context, futureResponse);
return ApiFutures.transform(
futurePage,
input -> new ListTransferRunsPagedResponse(input),
MoreExecutors.directExecutor());
}
private ListTransferRunsPagedResponse(ListTransferRunsPage page) {
super(page, ListTransferRunsFixedSizeCollection.createEmptyCollection());
}
}
public static class ListTransferRunsPage
extends AbstractPage<
ListTransferRunsRequest, ListTransferRunsResponse, TransferRun, ListTransferRunsPage> {
private ListTransferRunsPage(
PageContext context,
ListTransferRunsResponse response) {
super(context, response);
}
private static ListTransferRunsPage createEmptyPage() {
return new ListTransferRunsPage(null, null);
}
@Override
protected ListTransferRunsPage createPage(
PageContext context,
ListTransferRunsResponse response) {
return new ListTransferRunsPage(context, response);
}
@Override
public ApiFuture createPageAsync(
PageContext context,
ApiFuture futureResponse) {
return super.createPageAsync(context, futureResponse);
}
}
public static class ListTransferRunsFixedSizeCollection
extends AbstractFixedSizeCollection<
ListTransferRunsRequest,
ListTransferRunsResponse,
TransferRun,
ListTransferRunsPage,
ListTransferRunsFixedSizeCollection> {
private ListTransferRunsFixedSizeCollection(
List pages, int collectionSize) {
super(pages, collectionSize);
}
private static ListTransferRunsFixedSizeCollection createEmptyCollection() {
return new ListTransferRunsFixedSizeCollection(null, 0);
}
@Override
protected ListTransferRunsFixedSizeCollection createCollection(
List pages, int collectionSize) {
return new ListTransferRunsFixedSizeCollection(pages, collectionSize);
}
}
public static class ListTransferLogsPagedResponse
extends AbstractPagedListResponse<
ListTransferLogsRequest,
ListTransferLogsResponse,
TransferMessage,
ListTransferLogsPage,
ListTransferLogsFixedSizeCollection> {
public static ApiFuture createAsync(
PageContext context,
ApiFuture futureResponse) {
ApiFuture futurePage =
ListTransferLogsPage.createEmptyPage().createPageAsync(context, futureResponse);
return ApiFutures.transform(
futurePage,
input -> new ListTransferLogsPagedResponse(input),
MoreExecutors.directExecutor());
}
private ListTransferLogsPagedResponse(ListTransferLogsPage page) {
super(page, ListTransferLogsFixedSizeCollection.createEmptyCollection());
}
}
public static class ListTransferLogsPage
extends AbstractPage<
ListTransferLogsRequest,
ListTransferLogsResponse,
TransferMessage,
ListTransferLogsPage> {
private ListTransferLogsPage(
PageContext context,
ListTransferLogsResponse response) {
super(context, response);
}
private static ListTransferLogsPage createEmptyPage() {
return new ListTransferLogsPage(null, null);
}
@Override
protected ListTransferLogsPage createPage(
PageContext context,
ListTransferLogsResponse response) {
return new ListTransferLogsPage(context, response);
}
@Override
public ApiFuture createPageAsync(
PageContext context,
ApiFuture futureResponse) {
return super.createPageAsync(context, futureResponse);
}
}
public static class ListTransferLogsFixedSizeCollection
extends AbstractFixedSizeCollection<
ListTransferLogsRequest,
ListTransferLogsResponse,
TransferMessage,
ListTransferLogsPage,
ListTransferLogsFixedSizeCollection> {
private ListTransferLogsFixedSizeCollection(
List pages, int collectionSize) {
super(pages, collectionSize);
}
private static ListTransferLogsFixedSizeCollection createEmptyCollection() {
return new ListTransferLogsFixedSizeCollection(null, 0);
}
@Override
protected ListTransferLogsFixedSizeCollection createCollection(
List pages, int collectionSize) {
return new ListTransferLogsFixedSizeCollection(pages, collectionSize);
}
}
public static class ListLocationsPagedResponse
extends AbstractPagedListResponse<
ListLocationsRequest,
ListLocationsResponse,
Location,
ListLocationsPage,
ListLocationsFixedSizeCollection> {
public static ApiFuture createAsync(
PageContext context,
ApiFuture futureResponse) {
ApiFuture 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 context,
ListLocationsResponse response) {
super(context, response);
}
private static ListLocationsPage createEmptyPage() {
return new ListLocationsPage(null, null);
}
@Override
protected ListLocationsPage createPage(
PageContext context,
ListLocationsResponse response) {
return new ListLocationsPage(context, response);
}
@Override
public ApiFuture createPageAsync(
PageContext context,
ApiFuture futureResponse) {
return super.createPageAsync(context, futureResponse);
}
}
public static class ListLocationsFixedSizeCollection
extends AbstractFixedSizeCollection<
ListLocationsRequest,
ListLocationsResponse,
Location,
ListLocationsPage,
ListLocationsFixedSizeCollection> {
private ListLocationsFixedSizeCollection(List pages, int collectionSize) {
super(pages, collectionSize);
}
private static ListLocationsFixedSizeCollection createEmptyCollection() {
return new ListLocationsFixedSizeCollection(null, 0);
}
@Override
protected ListLocationsFixedSizeCollection createCollection(
List pages, int collectionSize) {
return new ListLocationsFixedSizeCollection(pages, collectionSize);
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy