com.google.cloud.bigquery.datatransfer.v1

Class DataTransferServiceClient

java.lang.Object

com.google.cloud.bigquery.datatransfer.v1.DataTransferServiceClient

All Implemented Interfaces:

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

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

Service Description: The Google BigQuery Data Transfer Service API enables BigQuery users to configure the transfer of their data from other Google Products into BigQuery. This service contains methods that are end user exposed. It backs up the frontend.

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

 
 try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
   DataSourceName name = ProjectDataSourceName.of("[PROJECT]", "[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().

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

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

See the individual methods for example code.

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

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

To customize credentials:

 
 DataTransferServiceSettings dataTransferServiceSettings =
     DataTransferServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 DataTransferServiceClient dataTransferServiceClient =
     DataTransferServiceClient.create(dataTransferServiceSettings);
 
 

To customize the endpoint:

 
 DataTransferServiceSettings dataTransferServiceSettings =
     DataTransferServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 DataTransferServiceClient dataTransferServiceClient =
     DataTransferServiceClient.create(dataTransferServiceSettings);
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DataTransferServiceClient.ListDataSourcesFixedSizeCollection
static class	DataTransferServiceClient.ListDataSourcesPage
static class	DataTransferServiceClient.ListDataSourcesPagedResponse
static class	DataTransferServiceClient.ListTransferConfigsFixedSizeCollection
static class	DataTransferServiceClient.ListTransferConfigsPage
static class	DataTransferServiceClient.ListTransferConfigsPagedResponse
static class	DataTransferServiceClient.ListTransferLogsFixedSizeCollection
static class	DataTransferServiceClient.ListTransferLogsPage
static class	DataTransferServiceClient.ListTransferLogsPagedResponse
static class	DataTransferServiceClient.ListTransferRunsFixedSizeCollection
static class	DataTransferServiceClient.ListTransferRunsPage
static class	DataTransferServiceClient.ListTransferRunsPagedResponse

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DataTransferServiceClient(DataTransferServiceSettings settings) Constructs an instance of DataTransferServiceClient, using the given settings.
protected	DataTransferServiceClient(DataTransferServiceStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
CheckValidCredsResponse	checkValidCreds(CheckValidCredsRequest request) Returns true if valid credentials exist for the given data source and requesting user.
CheckValidCredsResponse	checkValidCreds(DataSourceName name) Returns true if valid credentials exist for the given data source and requesting user.
CheckValidCredsResponse	checkValidCreds(String name) Returns true if valid credentials exist for the given data source and requesting user.
com.google.api.gax.rpc.UnaryCallable<CheckValidCredsRequest,CheckValidCredsResponse>	checkValidCredsCallable() Returns true if valid credentials exist for the given data source and requesting user.
void	close()
static DataTransferServiceClient	create() Constructs an instance of DataTransferServiceClient with default settings.
static DataTransferServiceClient	create(DataTransferServiceSettings settings) Constructs an instance of DataTransferServiceClient, using the given settings.
static DataTransferServiceClient	create(DataTransferServiceStub stub) Constructs an instance of DataTransferServiceClient, using the given stub for making calls.
TransferConfig	createTransferConfig(CreateTransferConfigRequest request) Creates a new data transfer configuration.
TransferConfig	createTransferConfig(ParentName parent, TransferConfig transferConfig) Creates a new data transfer configuration.
TransferConfig	createTransferConfig(String parent, TransferConfig transferConfig) Creates a new data transfer configuration.
com.google.api.gax.rpc.UnaryCallable<CreateTransferConfigRequest,TransferConfig>	createTransferConfigCallable() Creates a new data transfer configuration.
void	deleteTransferConfig(DeleteTransferConfigRequest request) Deletes a data transfer configuration, including any associated transfer runs and logs.
void	deleteTransferConfig(String name) Deletes a data transfer configuration, including any associated transfer runs and logs.
void	deleteTransferConfig(TransferConfigName name) Deletes a data transfer configuration, including any associated transfer runs and logs.
com.google.api.gax.rpc.UnaryCallable<DeleteTransferConfigRequest,Empty>	deleteTransferConfigCallable() Deletes a data transfer configuration, including any associated transfer runs and logs.
void	deleteTransferRun(DeleteTransferRunRequest request) Deletes the specified transfer run.
void	deleteTransferRun(RunName name) Deletes the specified transfer run.
void	deleteTransferRun(String name) Deletes the specified transfer run.
com.google.api.gax.rpc.UnaryCallable<DeleteTransferRunRequest,Empty>	deleteTransferRunCallable() Deletes the specified transfer run.
DataSource	getDataSource(DataSourceName name) Retrieves a supported data source and returns its settings, which can be used for UI rendering.
DataSource	getDataSource(GetDataSourceRequest request) Retrieves a supported data source and returns its settings, which can be used for UI rendering.
DataSource	getDataSource(String name) Retrieves a supported data source and returns its settings, which can be used for UI rendering.
com.google.api.gax.rpc.UnaryCallable<GetDataSourceRequest,DataSource>	getDataSourceCallable() Retrieves a supported data source and returns its settings, which can be used for UI rendering.
DataTransferServiceSettings	getSettings()
DataTransferServiceStub	getStub()
TransferConfig	getTransferConfig(GetTransferConfigRequest request) Returns information about a data transfer config.
TransferConfig	getTransferConfig(String name) Returns information about a data transfer config.
TransferConfig	getTransferConfig(TransferConfigName name) Returns information about a data transfer config.
com.google.api.gax.rpc.UnaryCallable<GetTransferConfigRequest,TransferConfig>	getTransferConfigCallable() Returns information about a data transfer config.
TransferRun	getTransferRun(GetTransferRunRequest request) Returns information about the particular transfer run.
TransferRun	getTransferRun(RunName name) Returns information about the particular transfer run.
TransferRun	getTransferRun(String name) Returns information about the particular transfer run.
com.google.api.gax.rpc.UnaryCallable<GetTransferRunRequest,TransferRun>	getTransferRunCallable() Returns information about the particular transfer run.
boolean	isShutdown()
boolean	isTerminated()
DataTransferServiceClient.ListDataSourcesPagedResponse	listDataSources(ListDataSourcesRequest request) Lists supported data sources and returns their settings, which can be used for UI rendering.
DataTransferServiceClient.ListDataSourcesPagedResponse	listDataSources(ParentName parent) Lists supported data sources and returns their settings, which can be used for UI rendering.
DataTransferServiceClient.ListDataSourcesPagedResponse	listDataSources(String parent) Lists supported data sources and returns their settings, which can be used for UI rendering.
com.google.api.gax.rpc.UnaryCallable<ListDataSourcesRequest,ListDataSourcesResponse>	listDataSourcesCallable() Lists supported data sources and returns their settings, which can be used for UI rendering.
com.google.api.gax.rpc.UnaryCallable<ListDataSourcesRequest,DataTransferServiceClient.ListDataSourcesPagedResponse>	listDataSourcesPagedCallable() Lists supported data sources and returns their settings, which can be used for UI rendering.
DataTransferServiceClient.ListTransferConfigsPagedResponse	listTransferConfigs(ListTransferConfigsRequest request) Returns information about all data transfers in the project.
DataTransferServiceClient.ListTransferConfigsPagedResponse	listTransferConfigs(ParentName parent) Returns information about all data transfers in the project.
DataTransferServiceClient.ListTransferConfigsPagedResponse	listTransferConfigs(String parent) Returns information about all data transfers in the project.
com.google.api.gax.rpc.UnaryCallable<ListTransferConfigsRequest,ListTransferConfigsResponse>	listTransferConfigsCallable() Returns information about all data transfers in the project.
com.google.api.gax.rpc.UnaryCallable<ListTransferConfigsRequest,DataTransferServiceClient.ListTransferConfigsPagedResponse>	listTransferConfigsPagedCallable() Returns information about all data transfers in the project.
DataTransferServiceClient.ListTransferLogsPagedResponse	listTransferLogs(ListTransferLogsRequest request) Returns user facing log messages for the data transfer run.
DataTransferServiceClient.ListTransferLogsPagedResponse	listTransferLogs(RunName parent) Returns user facing log messages for the data transfer run.
DataTransferServiceClient.ListTransferLogsPagedResponse	listTransferLogs(String parent) Returns user facing log messages for the data transfer run.
com.google.api.gax.rpc.UnaryCallable<ListTransferLogsRequest,ListTransferLogsResponse>	listTransferLogsCallable() Returns user facing log messages for the data transfer run.
com.google.api.gax.rpc.UnaryCallable<ListTransferLogsRequest,DataTransferServiceClient.ListTransferLogsPagedResponse>	listTransferLogsPagedCallable() Returns user facing log messages for the data transfer run.
DataTransferServiceClient.ListTransferRunsPagedResponse	listTransferRuns(ListTransferRunsRequest request) Returns information about running and completed jobs.
DataTransferServiceClient.ListTransferRunsPagedResponse	listTransferRuns(String parent) Returns information about running and completed jobs.
DataTransferServiceClient.ListTransferRunsPagedResponse	listTransferRuns(TransferConfigName parent) Returns information about running and completed jobs.
com.google.api.gax.rpc.UnaryCallable<ListTransferRunsRequest,ListTransferRunsResponse>	listTransferRunsCallable() Returns information about running and completed jobs.
com.google.api.gax.rpc.UnaryCallable<ListTransferRunsRequest,DataTransferServiceClient.ListTransferRunsPagedResponse>	listTransferRunsPagedCallable() Returns information about running and completed jobs.
ScheduleTransferRunsResponse	scheduleTransferRuns(ScheduleTransferRunsRequest request) Creates transfer runs for a time range [start_time, end_time].
ScheduleTransferRunsResponse	scheduleTransferRuns(String parent, Timestamp startTime, Timestamp endTime) Creates transfer runs for a time range [start_time, end_time].
ScheduleTransferRunsResponse	scheduleTransferRuns(TransferConfigName parent, Timestamp startTime, Timestamp endTime) Creates transfer runs for a time range [start_time, end_time].
com.google.api.gax.rpc.UnaryCallable<ScheduleTransferRunsRequest,ScheduleTransferRunsResponse>	scheduleTransferRunsCallable() Creates transfer runs for a time range [start_time, end_time].
void	shutdown()
void	shutdownNow()
StartManualTransferRunsResponse	startManualTransferRuns(StartManualTransferRunsRequest request) Start manual transfer runs to be executed now with schedule_time equal to current time.
com.google.api.gax.rpc.UnaryCallable<StartManualTransferRunsRequest,StartManualTransferRunsResponse>	startManualTransferRunsCallable() Start manual transfer runs to be executed now with schedule_time equal to current time.
TransferConfig	updateTransferConfig(TransferConfig transferConfig, FieldMask updateMask) Updates a data transfer configuration.
TransferConfig	updateTransferConfig(UpdateTransferConfigRequest request) Updates a data transfer configuration.
com.google.api.gax.rpc.UnaryCallable<UpdateTransferConfigRequest,TransferConfig>	updateTransferConfigCallable() Updates a data transfer configuration.

Methods inherited from class java.lang.Object

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

Constructor Detail

DataTransferServiceClient

protected DataTransferServiceClient(DataTransferServiceSettings settings)
                             throws IOException

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.

Throws:

IOException

DataTransferServiceClient

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

Method Detail

create

public static final DataTransferServiceClient create()
                                              throws IOException

Constructs an instance of DataTransferServiceClient with default settings.

Throws:

IOException

create

public static final DataTransferServiceClient create(DataTransferServiceSettings settings)
                                              throws IOException

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.

Throws:

IOException

create

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

Constructs an instance of DataTransferServiceClient, using the given stub for making calls. This is for advanced usage - prefer to use DataTransferServiceSettings}.

getSettings

public final DataTransferServiceSettings getSettings()

getStub

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

getDataSource

public final DataSource getDataSource(DataSourceName name)

Retrieves a supported data source and returns its settings, which can be used for UI rendering.

Sample code:

 try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
   DataSourceName name = ProjectDataSourceName.of("[PROJECT]", "[DATA_SOURCE]");
   DataSource response = dataTransferServiceClient.getDataSource(name);
 }
 

Parameters:

name - Required. The field will contain name of the resource requested, for example: `projects/{project_id}/dataSources/{data_source_id}`

Throws:

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

getDataSource

public final DataSource getDataSource(String name)

Retrieves a supported data source and returns its settings, which can be used for UI rendering.

Sample code:

 try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
   DataSourceName name = ProjectDataSourceName.of("[PROJECT]", "[DATA_SOURCE]");
   DataSource response = dataTransferServiceClient.getDataSource(name.toString());
 }
 

Parameters:

name - Required. The field will contain name of the resource requested, for example: `projects/{project_id}/dataSources/{data_source_id}`

Throws:

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

getDataSource

public final DataSource getDataSource(GetDataSourceRequest request)

Retrieves a supported data source and returns its settings, which can be used for UI rendering.

Sample code:

 try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
   DataSourceName name = ProjectDataSourceName.of("[PROJECT]", "[DATA_SOURCE]");
   GetDataSourceRequest request = GetDataSourceRequest.newBuilder()
     .setName(name.toString())
     .build();
   DataSource response = dataTransferServiceClient.getDataSource(request);
 }
 

Parameters:

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

Throws:

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

getDataSourceCallable

public final com.google.api.gax.rpc.UnaryCallable<GetDataSourceRequest,DataSource> getDataSourceCallable()

Retrieves a supported data source and returns its settings, which can be used for UI rendering.

Sample code:

 try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
   DataSourceName name = ProjectDataSourceName.of("[PROJECT]", "[DATA_SOURCE]");
   GetDataSourceRequest request = GetDataSourceRequest.newBuilder()
     .setName(name.toString())
     .build();
   ApiFuture<DataSource> future = dataTransferServiceClient.getDataSourceCallable().futureCall(request);
   // Do something
   DataSource response = future.get();
 }
 

listDataSources

public final DataTransferServiceClient.ListDataSourcesPagedResponse listDataSources(ParentName parent)

Lists supported data sources and returns their settings, which can be used for UI rendering.

Sample code:

 try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
   ParentName parent = ProjectName.of("[PROJECT]");
   for (DataSource element : dataTransferServiceClient.listDataSources(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - Required. The BigQuery project id for which data sources should be returned. Must be in the form: `projects/{project_id}`

Throws:

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

listDataSources

public final DataTransferServiceClient.ListDataSourcesPagedResponse listDataSources(String parent)

Lists supported data sources and returns their settings, which can be used for UI rendering.

Sample code:

 try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
   ParentName parent = ProjectName.of("[PROJECT]");
   for (DataSource element : dataTransferServiceClient.listDataSources(parent.toString()).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - Required. The BigQuery project id for which data sources should be returned. Must be in the form: `projects/{project_id}`

Throws:

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

listDataSources

public final DataTransferServiceClient.ListDataSourcesPagedResponse listDataSources(ListDataSourcesRequest request)

Lists supported data sources and returns their settings, which can be used for UI rendering.

Sample code:

 try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
   ParentName parent = ProjectName.of("[PROJECT]");
   ListDataSourcesRequest request = ListDataSourcesRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   for (DataSource element : dataTransferServiceClient.listDataSources(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

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

Throws:

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

listDataSourcesPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListDataSourcesRequest,DataTransferServiceClient.ListDataSourcesPagedResponse> listDataSourcesPagedCallable()

Lists supported data sources and returns their settings, which can be used for UI rendering.

Sample code:

 try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
   ParentName parent = ProjectName.of("[PROJECT]");
   ListDataSourcesRequest request = ListDataSourcesRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   ApiFuture<ListDataSourcesPagedResponse> future = dataTransferServiceClient.listDataSourcesPagedCallable().futureCall(request);
   // Do something
   for (DataSource element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listDataSourcesCallable

public final com.google.api.gax.rpc.UnaryCallable<ListDataSourcesRequest,ListDataSourcesResponse> listDataSourcesCallable()

Lists supported data sources and returns their settings, which can be used for UI rendering.

Sample code:

 try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
   ParentName parent = ProjectName.of("[PROJECT]");
   ListDataSourcesRequest request = ListDataSourcesRequest.newBuilder()
     .setParent(parent.toString())
     .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;
     }
   }
 }
 

createTransferConfig

public final TransferConfig createTransferConfig(ParentName parent,
                                                 TransferConfig transferConfig)

Creates a new data transfer configuration.

Sample code:

 try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
   ParentName parent = ProjectName.of("[PROJECT]");
   TransferConfig transferConfig = TransferConfig.newBuilder().build();
   TransferConfig response = dataTransferServiceClient.createTransferConfig(parent, transferConfig);
 }
 

Parameters:

parent - Required. The BigQuery project id where the transfer configuration should be created. Must be in the format projects/{project_id}/locations/{location_id} If specified location and location of the destination bigquery dataset do not match - the request will fail.

transferConfig - Required. Data transfer configuration to create.

Throws:

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

createTransferConfig

public final TransferConfig createTransferConfig(String parent,
                                                 TransferConfig transferConfig)

Creates a new data transfer configuration.

Sample code:

 try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
   ParentName parent = ProjectName.of("[PROJECT]");
   TransferConfig transferConfig = TransferConfig.newBuilder().build();
   TransferConfig response = dataTransferServiceClient.createTransferConfig(parent.toString(), transferConfig);
 }
 

Parameters:

parent - Required. The BigQuery project id where the transfer configuration should be created. Must be in the format projects/{project_id}/locations/{location_id} If specified location and location of the destination bigquery dataset do not match - the request will fail.

transferConfig - Required. Data transfer configuration to create.

Throws:

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

createTransferConfig

public final TransferConfig createTransferConfig(CreateTransferConfigRequest request)

Creates a new data transfer configuration.

Sample code:

 try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
   ParentName parent = ProjectName.of("[PROJECT]");
   TransferConfig transferConfig = TransferConfig.newBuilder().build();
   CreateTransferConfigRequest request = CreateTransferConfigRequest.newBuilder()
     .setParent(parent.toString())
     .setTransferConfig(transferConfig)
     .build();
   TransferConfig response = dataTransferServiceClient.createTransferConfig(request);
 }
 

Parameters:

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

Throws:

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

createTransferConfigCallable

public final com.google.api.gax.rpc.UnaryCallable<CreateTransferConfigRequest,TransferConfig> createTransferConfigCallable()

Creates a new data transfer configuration.

Sample code:

 try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
   ParentName parent = ProjectName.of("[PROJECT]");
   TransferConfig transferConfig = TransferConfig.newBuilder().build();
   CreateTransferConfigRequest request = CreateTransferConfigRequest.newBuilder()
     .setParent(parent.toString())
     .setTransferConfig(transferConfig)
     .build();
   ApiFuture<TransferConfig> future = dataTransferServiceClient.createTransferConfigCallable().futureCall(request);
   // Do something
   TransferConfig response = future.get();
 }
 

updateTransferConfig

public final TransferConfig updateTransferConfig(TransferConfig transferConfig,
                                                 FieldMask updateMask)

Updates a data transfer configuration. All fields must be set, even if they are not updated.

Sample code:

 try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
   TransferConfig transferConfig = TransferConfig.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   TransferConfig response = dataTransferServiceClient.updateTransferConfig(transferConfig, updateMask);
 }
 

Parameters:

transferConfig - Required. Data transfer configuration to create.

updateMask - Required. Required list of fields to be updated in this request.

Throws:

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

updateTransferConfig

public final TransferConfig updateTransferConfig(UpdateTransferConfigRequest request)

Updates a data transfer configuration. All fields must be set, even if they are not updated.

Sample code:

 try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
   TransferConfig transferConfig = TransferConfig.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   UpdateTransferConfigRequest request = UpdateTransferConfigRequest.newBuilder()
     .setTransferConfig(transferConfig)
     .setUpdateMask(updateMask)
     .build();
   TransferConfig response = dataTransferServiceClient.updateTransferConfig(request);
 }
 

Parameters:

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

Throws:

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

updateTransferConfigCallable

public final com.google.api.gax.rpc.UnaryCallable<UpdateTransferConfigRequest,TransferConfig> updateTransferConfigCallable()

Updates a data transfer configuration. All fields must be set, even if they are not updated.

Sample code:

 try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
   TransferConfig transferConfig = TransferConfig.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   UpdateTransferConfigRequest request = UpdateTransferConfigRequest.newBuilder()
     .setTransferConfig(transferConfig)
     .setUpdateMask(updateMask)
     .build();
   ApiFuture<TransferConfig> future = dataTransferServiceClient.updateTransferConfigCallable().futureCall(request);
   // Do something
   TransferConfig response = future.get();
 }
 

deleteTransferConfig

public final void deleteTransferConfig(TransferConfigName name)

Deletes a data transfer configuration, including any associated transfer runs and logs.

Sample code:

 try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
   TransferConfigName name = ProjectTransferConfigName.of("[PROJECT]", "[TRANSFER_CONFIG]");
   dataTransferServiceClient.deleteTransferConfig(name);
 }
 

Parameters:

name - Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}`

Throws:

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

deleteTransferConfig

public final void deleteTransferConfig(String name)

Deletes a data transfer configuration, including any associated transfer runs and logs.

Sample code:

 try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
   TransferConfigName name = ProjectTransferConfigName.of("[PROJECT]", "[TRANSFER_CONFIG]");
   dataTransferServiceClient.deleteTransferConfig(name.toString());
 }
 

Parameters:

name - Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}`

Throws:

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

deleteTransferConfig

public final void deleteTransferConfig(DeleteTransferConfigRequest request)

Deletes a data transfer configuration, including any associated transfer runs and logs.

Sample code:

 try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
   TransferConfigName name = ProjectTransferConfigName.of("[PROJECT]", "[TRANSFER_CONFIG]");
   DeleteTransferConfigRequest request = DeleteTransferConfigRequest.newBuilder()
     .setName(name.toString())
     .build();
   dataTransferServiceClient.deleteTransferConfig(request);
 }
 

Parameters:

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

Throws:

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

deleteTransferConfigCallable

public final com.google.api.gax.rpc.UnaryCallable<DeleteTransferConfigRequest,Empty> deleteTransferConfigCallable()

Deletes a data transfer configuration, including any associated transfer runs and logs.

Sample code:

 try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
   TransferConfigName name = ProjectTransferConfigName.of("[PROJECT]", "[TRANSFER_CONFIG]");
   DeleteTransferConfigRequest request = DeleteTransferConfigRequest.newBuilder()
     .setName(name.toString())
     .build();
   ApiFuture<Void> future = dataTransferServiceClient.deleteTransferConfigCallable().futureCall(request);
   // Do something
   future.get();
 }
 

getTransferConfig

public final TransferConfig getTransferConfig(TransferConfigName name)

Returns information about a data transfer config.

Sample code:

 try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
   TransferConfigName name = ProjectTransferConfigName.of("[PROJECT]", "[TRANSFER_CONFIG]");
   TransferConfig response = dataTransferServiceClient.getTransferConfig(name);
 }
 

Parameters:

name - Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}`

Throws:

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

getTransferConfig

public final TransferConfig getTransferConfig(String name)

Returns information about a data transfer config.

Sample code:

 try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
   TransferConfigName name = ProjectTransferConfigName.of("[PROJECT]", "[TRANSFER_CONFIG]");
   TransferConfig response = dataTransferServiceClient.getTransferConfig(name.toString());
 }
 

Parameters:

name - Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}`

Throws:

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

getTransferConfig

public final TransferConfig getTransferConfig(GetTransferConfigRequest request)

Returns information about a data transfer config.

Sample code:

 try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
   TransferConfigName name = ProjectTransferConfigName.of("[PROJECT]", "[TRANSFER_CONFIG]");
   GetTransferConfigRequest request = GetTransferConfigRequest.newBuilder()
     .setName(name.toString())
     .build();
   TransferConfig response = dataTransferServiceClient.getTransferConfig(request);
 }
 

Parameters:

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

Throws:

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

getTransferConfigCallable

public final com.google.api.gax.rpc.UnaryCallable<GetTransferConfigRequest,TransferConfig> getTransferConfigCallable()

Returns information about a data transfer config.

Sample code:

 try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
   TransferConfigName name = ProjectTransferConfigName.of("[PROJECT]", "[TRANSFER_CONFIG]");
   GetTransferConfigRequest request = GetTransferConfigRequest.newBuilder()
     .setName(name.toString())
     .build();
   ApiFuture<TransferConfig> future = dataTransferServiceClient.getTransferConfigCallable().futureCall(request);
   // Do something
   TransferConfig response = future.get();
 }
 

listTransferConfigs

public final DataTransferServiceClient.ListTransferConfigsPagedResponse listTransferConfigs(ParentName parent)

Returns information about all data transfers in the project.

Sample code:

 try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
   ParentName parent = ProjectName.of("[PROJECT]");
   for (TransferConfig element : dataTransferServiceClient.listTransferConfigs(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - Required. The BigQuery project id for which data sources should be returned: `projects/{project_id}`.

Throws:

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

listTransferConfigs

public final DataTransferServiceClient.ListTransferConfigsPagedResponse listTransferConfigs(String parent)

Returns information about all data transfers in the project.

Sample code:

 try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
   ParentName parent = ProjectName.of("[PROJECT]");
   for (TransferConfig element : dataTransferServiceClient.listTransferConfigs(parent.toString()).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - Required. The BigQuery project id for which data sources should be returned: `projects/{project_id}`.

Throws:

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

listTransferConfigs

public final DataTransferServiceClient.ListTransferConfigsPagedResponse listTransferConfigs(ListTransferConfigsRequest request)

Returns information about all data transfers in the project.

Sample code:

 try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
   ParentName parent = ProjectName.of("[PROJECT]");
   ListTransferConfigsRequest request = ListTransferConfigsRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   for (TransferConfig element : dataTransferServiceClient.listTransferConfigs(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

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

Throws:

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

listTransferConfigsPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListTransferConfigsRequest,DataTransferServiceClient.ListTransferConfigsPagedResponse> listTransferConfigsPagedCallable()

Returns information about all data transfers in the project.

Sample code:

 try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
   ParentName parent = ProjectName.of("[PROJECT]");
   ListTransferConfigsRequest request = ListTransferConfigsRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   ApiFuture<ListTransferConfigsPagedResponse> future = dataTransferServiceClient.listTransferConfigsPagedCallable().futureCall(request);
   // Do something
   for (TransferConfig element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listTransferConfigsCallable

public final com.google.api.gax.rpc.UnaryCallable<ListTransferConfigsRequest,ListTransferConfigsResponse> listTransferConfigsCallable()

Returns information about all data transfers in the project.

Sample code:

 try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
   ParentName parent = ProjectName.of("[PROJECT]");
   ListTransferConfigsRequest request = ListTransferConfigsRequest.newBuilder()
     .setParent(parent.toString())
     .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;
     }
   }
 }
 

scheduleTransferRuns

public final ScheduleTransferRunsResponse scheduleTransferRuns(TransferConfigName parent,
                                                               Timestamp startTime,
                                                               Timestamp endTime)

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:

 try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
   TransferConfigName parent = ProjectTransferConfigName.of("[PROJECT]", "[TRANSFER_CONFIG]");
   Timestamp startTime = Timestamp.newBuilder().build();
   Timestamp endTime = Timestamp.newBuilder().build();
   ScheduleTransferRunsResponse response = dataTransferServiceClient.scheduleTransferRuns(parent, startTime, endTime);
 }
 

Parameters:

parent - Required. Transfer configuration name in the form: `projects/{project_id}/transferConfigs/{config_id}`.

startTime - Required. Start time of the range of transfer runs. For example, `"2017-05-25T00:00:00+00:00"`.

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

scheduleTransferRuns

public final ScheduleTransferRunsResponse scheduleTransferRuns(String parent,
                                                               Timestamp startTime,
                                                               Timestamp endTime)

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:

 try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
   TransferConfigName parent = ProjectTransferConfigName.of("[PROJECT]", "[TRANSFER_CONFIG]");
   Timestamp startTime = Timestamp.newBuilder().build();
   Timestamp endTime = Timestamp.newBuilder().build();
   ScheduleTransferRunsResponse response = dataTransferServiceClient.scheduleTransferRuns(parent.toString(), startTime, endTime);
 }
 

Parameters:

parent - Required. Transfer configuration name in the form: `projects/{project_id}/transferConfigs/{config_id}`.

startTime - Required. Start time of the range of transfer runs. For example, `"2017-05-25T00:00:00+00:00"`.

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

scheduleTransferRuns

public final ScheduleTransferRunsResponse scheduleTransferRuns(ScheduleTransferRunsRequest request)

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:

 try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
   TransferConfigName parent = ProjectTransferConfigName.of("[PROJECT]", "[TRANSFER_CONFIG]");
   Timestamp startTime = Timestamp.newBuilder().build();
   Timestamp endTime = Timestamp.newBuilder().build();
   ScheduleTransferRunsRequest request = ScheduleTransferRunsRequest.newBuilder()
     .setParent(parent.toString())
     .setStartTime(startTime)
     .setEndTime(endTime)
     .build();
   ScheduleTransferRunsResponse response = dataTransferServiceClient.scheduleTransferRuns(request);
 }
 

Parameters:

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

Throws:

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

scheduleTransferRunsCallable

public final com.google.api.gax.rpc.UnaryCallable<ScheduleTransferRunsRequest,ScheduleTransferRunsResponse> scheduleTransferRunsCallable()

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:

 try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
   TransferConfigName parent = ProjectTransferConfigName.of("[PROJECT]", "[TRANSFER_CONFIG]");
   Timestamp startTime = Timestamp.newBuilder().build();
   Timestamp endTime = Timestamp.newBuilder().build();
   ScheduleTransferRunsRequest request = ScheduleTransferRunsRequest.newBuilder()
     .setParent(parent.toString())
     .setStartTime(startTime)
     .setEndTime(endTime)
     .build();
   ApiFuture<ScheduleTransferRunsResponse> future = dataTransferServiceClient.scheduleTransferRunsCallable().futureCall(request);
   // Do something
   ScheduleTransferRunsResponse response = future.get();
 }
 

getTransferRun

public final TransferRun getTransferRun(RunName name)

Returns information about the particular transfer run.

Sample code:

 try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
   RunName name = ProjectRunName.of("[PROJECT]", "[TRANSFER_CONFIG]", "[RUN]");
   TransferRun response = dataTransferServiceClient.getTransferRun(name);
 }
 

Parameters:

name - Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`

Throws:

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

getTransferRun

public final TransferRun getTransferRun(String name)

Returns information about the particular transfer run.

Sample code:

 try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
   RunName name = ProjectRunName.of("[PROJECT]", "[TRANSFER_CONFIG]", "[RUN]");
   TransferRun response = dataTransferServiceClient.getTransferRun(name.toString());
 }
 

Parameters:

name - Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`

Throws:

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

getTransferRun

public final TransferRun getTransferRun(GetTransferRunRequest request)

Returns information about the particular transfer run.

Sample code:

 try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
   RunName name = ProjectRunName.of("[PROJECT]", "[TRANSFER_CONFIG]", "[RUN]");
   GetTransferRunRequest request = GetTransferRunRequest.newBuilder()
     .setName(name.toString())
     .build();
   TransferRun response = dataTransferServiceClient.getTransferRun(request);
 }
 

Parameters:

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

Throws:

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

getTransferRunCallable

public final com.google.api.gax.rpc.UnaryCallable<GetTransferRunRequest,TransferRun> getTransferRunCallable()

Returns information about the particular transfer run.

Sample code:

 try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
   RunName name = ProjectRunName.of("[PROJECT]", "[TRANSFER_CONFIG]", "[RUN]");
   GetTransferRunRequest request = GetTransferRunRequest.newBuilder()
     .setName(name.toString())
     .build();
   ApiFuture<TransferRun> future = dataTransferServiceClient.getTransferRunCallable().futureCall(request);
   // Do something
   TransferRun response = future.get();
 }
 

deleteTransferRun

public final void deleteTransferRun(RunName name)

Deletes the specified transfer run.

Sample code:

 try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
   RunName name = ProjectRunName.of("[PROJECT]", "[TRANSFER_CONFIG]", "[RUN]");
   dataTransferServiceClient.deleteTransferRun(name);
 }
 

Parameters:

name - Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`

Throws:

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

deleteTransferRun

public final void deleteTransferRun(String name)

Deletes the specified transfer run.

Sample code:

 try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
   RunName name = ProjectRunName.of("[PROJECT]", "[TRANSFER_CONFIG]", "[RUN]");
   dataTransferServiceClient.deleteTransferRun(name.toString());
 }
 

Parameters:

name - Required. The field will contain name of the resource requested, for example: `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`

Throws:

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

deleteTransferRun

public final void deleteTransferRun(DeleteTransferRunRequest request)

Deletes the specified transfer run.

Sample code:

 try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
   RunName name = ProjectRunName.of("[PROJECT]", "[TRANSFER_CONFIG]", "[RUN]");
   DeleteTransferRunRequest request = DeleteTransferRunRequest.newBuilder()
     .setName(name.toString())
     .build();
   dataTransferServiceClient.deleteTransferRun(request);
 }
 

Parameters:

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

Throws:

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

deleteTransferRunCallable

public final com.google.api.gax.rpc.UnaryCallable<DeleteTransferRunRequest,Empty> deleteTransferRunCallable()

Deletes the specified transfer run.

Sample code:

 try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
   RunName name = ProjectRunName.of("[PROJECT]", "[TRANSFER_CONFIG]", "[RUN]");
   DeleteTransferRunRequest request = DeleteTransferRunRequest.newBuilder()
     .setName(name.toString())
     .build();
   ApiFuture<Void> future = dataTransferServiceClient.deleteTransferRunCallable().futureCall(request);
   // Do something
   future.get();
 }
 

listTransferRuns

public final DataTransferServiceClient.ListTransferRunsPagedResponse listTransferRuns(TransferConfigName parent)

Returns information about running and completed jobs.

Sample code:

 try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
   TransferConfigName parent = ProjectTransferConfigName.of("[PROJECT]", "[TRANSFER_CONFIG]");
   for (TransferRun element : dataTransferServiceClient.listTransferRuns(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

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}`.

Throws:

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

listTransferRuns

public final DataTransferServiceClient.ListTransferRunsPagedResponse listTransferRuns(String parent)

Returns information about running and completed jobs.

Sample code:

 try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
   TransferConfigName parent = ProjectTransferConfigName.of("[PROJECT]", "[TRANSFER_CONFIG]");
   for (TransferRun element : dataTransferServiceClient.listTransferRuns(parent.toString()).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

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}`.

Throws:

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

listTransferRuns

public final DataTransferServiceClient.ListTransferRunsPagedResponse listTransferRuns(ListTransferRunsRequest request)

Returns information about running and completed jobs.

Sample code:

 try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
   TransferConfigName parent = ProjectTransferConfigName.of("[PROJECT]", "[TRANSFER_CONFIG]");
   ListTransferRunsRequest request = ListTransferRunsRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   for (TransferRun element : dataTransferServiceClient.listTransferRuns(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

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

Throws:

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

listTransferRunsPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListTransferRunsRequest,DataTransferServiceClient.ListTransferRunsPagedResponse> listTransferRunsPagedCallable()

Returns information about running and completed jobs.

Sample code:

 try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
   TransferConfigName parent = ProjectTransferConfigName.of("[PROJECT]", "[TRANSFER_CONFIG]");
   ListTransferRunsRequest request = ListTransferRunsRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   ApiFuture<ListTransferRunsPagedResponse> future = dataTransferServiceClient.listTransferRunsPagedCallable().futureCall(request);
   // Do something
   for (TransferRun element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listTransferRunsCallable

public final com.google.api.gax.rpc.UnaryCallable<ListTransferRunsRequest,ListTransferRunsResponse> listTransferRunsCallable()

Returns information about running and completed jobs.

Sample code:

 try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
   TransferConfigName parent = ProjectTransferConfigName.of("[PROJECT]", "[TRANSFER_CONFIG]");
   ListTransferRunsRequest request = ListTransferRunsRequest.newBuilder()
     .setParent(parent.toString())
     .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;
     }
   }
 }
 

listTransferLogs

public final DataTransferServiceClient.ListTransferLogsPagedResponse listTransferLogs(RunName parent)

Returns user facing log messages for the data transfer run.

Sample code:

 try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
   RunName parent = ProjectRunName.of("[PROJECT]", "[TRANSFER_CONFIG]", "[RUN]");
   for (TransferMessage element : dataTransferServiceClient.listTransferLogs(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - Required. Transfer run name in the form: `projects/{project_id}/transferConfigs/{config_Id}/runs/{run_id}`.

Throws:

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

listTransferLogs

public final DataTransferServiceClient.ListTransferLogsPagedResponse listTransferLogs(String parent)

Returns user facing log messages for the data transfer run.

Sample code:

 try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
   RunName parent = ProjectRunName.of("[PROJECT]", "[TRANSFER_CONFIG]", "[RUN]");
   for (TransferMessage element : dataTransferServiceClient.listTransferLogs(parent.toString()).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - Required. Transfer run name in the form: `projects/{project_id}/transferConfigs/{config_Id}/runs/{run_id}`.

Throws:

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

listTransferLogs

public final DataTransferServiceClient.ListTransferLogsPagedResponse listTransferLogs(ListTransferLogsRequest request)

Returns user facing log messages for the data transfer run.

Sample code:

 try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
   RunName parent = ProjectRunName.of("[PROJECT]", "[TRANSFER_CONFIG]", "[RUN]");
   ListTransferLogsRequest request = ListTransferLogsRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   for (TransferMessage element : dataTransferServiceClient.listTransferLogs(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

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

Throws:

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

listTransferLogsPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListTransferLogsRequest,DataTransferServiceClient.ListTransferLogsPagedResponse> listTransferLogsPagedCallable()

Returns user facing log messages for the data transfer run.

Sample code:

 try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
   RunName parent = ProjectRunName.of("[PROJECT]", "[TRANSFER_CONFIG]", "[RUN]");
   ListTransferLogsRequest request = ListTransferLogsRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   ApiFuture<ListTransferLogsPagedResponse> future = dataTransferServiceClient.listTransferLogsPagedCallable().futureCall(request);
   // Do something
   for (TransferMessage element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listTransferLogsCallable

public final com.google.api.gax.rpc.UnaryCallable<ListTransferLogsRequest,ListTransferLogsResponse> listTransferLogsCallable()

Returns user facing log messages for the data transfer run.

Sample code:

 try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
   RunName parent = ProjectRunName.of("[PROJECT]", "[TRANSFER_CONFIG]", "[RUN]");
   ListTransferLogsRequest request = ListTransferLogsRequest.newBuilder()
     .setParent(parent.toString())
     .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;
     }
   }
 }
 

checkValidCreds

public final CheckValidCredsResponse checkValidCreds(DataSourceName name)

Returns true if valid credentials exist for the given data source and requesting user. Some data sources doesn't support service account, so we need to talk to them on behalf of the end user. This API just checks whether we have OAuth token for the particular user, which is a pre-requisite before user can create a transfer config.

Sample code:

 try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
   DataSourceName name = ProjectDataSourceName.of("[PROJECT]", "[DATA_SOURCE]");
   CheckValidCredsResponse response = dataTransferServiceClient.checkValidCreds(name);
 }
 

Parameters:

name - Required. The data source in the form: `projects/{project_id}/dataSources/{data_source_id}`

Throws:

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

checkValidCreds

public final CheckValidCredsResponse checkValidCreds(String name)

Returns true if valid credentials exist for the given data source and requesting user. Some data sources doesn't support service account, so we need to talk to them on behalf of the end user. This API just checks whether we have OAuth token for the particular user, which is a pre-requisite before user can create a transfer config.

Sample code:

 try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
   DataSourceName name = ProjectDataSourceName.of("[PROJECT]", "[DATA_SOURCE]");
   CheckValidCredsResponse response = dataTransferServiceClient.checkValidCreds(name.toString());
 }
 

Parameters:

name - Required. The data source in the form: `projects/{project_id}/dataSources/{data_source_id}`

Throws:

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

checkValidCreds

public final CheckValidCredsResponse checkValidCreds(CheckValidCredsRequest request)

Returns true if valid credentials exist for the given data source and requesting user. Some data sources doesn't support service account, so we need to talk to them on behalf of the end user. This API just checks whether we have OAuth token for the particular user, which is a pre-requisite before user can create a transfer config.

Sample code:

 try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
   DataSourceName name = ProjectDataSourceName.of("[PROJECT]", "[DATA_SOURCE]");
   CheckValidCredsRequest request = CheckValidCredsRequest.newBuilder()
     .setName(name.toString())
     .build();
   CheckValidCredsResponse response = dataTransferServiceClient.checkValidCreds(request);
 }
 

Parameters:

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

Throws:

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

checkValidCredsCallable

public final com.google.api.gax.rpc.UnaryCallable<CheckValidCredsRequest,CheckValidCredsResponse> checkValidCredsCallable()

Returns true if valid credentials exist for the given data source and requesting user. Some data sources doesn't support service account, so we need to talk to them on behalf of the end user. This API just checks whether we have OAuth token for the particular user, which is a pre-requisite before user can create a transfer config.

Sample code:

 try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
   DataSourceName name = ProjectDataSourceName.of("[PROJECT]", "[DATA_SOURCE]");
   CheckValidCredsRequest request = CheckValidCredsRequest.newBuilder()
     .setName(name.toString())
     .build();
   ApiFuture<CheckValidCredsResponse> future = dataTransferServiceClient.checkValidCredsCallable().futureCall(request);
   // Do something
   CheckValidCredsResponse response = future.get();
 }
 

startManualTransferRuns

public final StartManualTransferRunsResponse startManualTransferRuns(StartManualTransferRunsRequest request)

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:

 try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
   StartManualTransferRunsRequest request = StartManualTransferRunsRequest.newBuilder().build();
   StartManualTransferRunsResponse response = dataTransferServiceClient.startManualTransferRuns(request);
 }
 

Parameters:

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

Throws:

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

startManualTransferRunsCallable

public final com.google.api.gax.rpc.UnaryCallable<StartManualTransferRunsRequest,StartManualTransferRunsResponse> startManualTransferRunsCallable()

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:

 try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
   StartManualTransferRunsRequest request = StartManualTransferRunsRequest.newBuilder().build();
   ApiFuture<StartManualTransferRunsResponse> future = dataTransferServiceClient.startManualTransferRunsCallable().futureCall(request);
   // Do something
   StartManualTransferRunsResponse response = future.get();
 }
 

close

public final void close()

Specified by:

close in interface AutoCloseable

shutdown

public void shutdown()

Specified by:

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

isShutdown

public boolean isShutdown()

Specified by:

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

isTerminated

public boolean isTerminated()

Specified by:

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

shutdownNow

public void shutdownNow()

Specified by:

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

awaitTermination

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

Specified by:

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

Throws:

InterruptedException