DataTransferServiceClient (Google Cloud 0.90.0-alpha API)

java.lang.Object
- com.google.cloud.bigquery.datatransfer.v1.DataTransferServiceClient

All Implemented Interfaces:

BackgroundResource, AutoCloseable
```
@Generated(value="by gapic-generator")
 @BetaApi
public class DataTransferServiceClient
extends Object
implements 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

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`com.google.cloud.bigquery.datatransfer.v1.CheckValidCredsResponse`	`checkValidCreds(com.google.cloud.bigquery.datatransfer.v1.CheckValidCredsRequest request)` Returns true if valid credentials exist for the given data source and requesting user.
`com.google.cloud.bigquery.datatransfer.v1.CheckValidCredsResponse`	`checkValidCreds(com.google.cloud.bigquery.datatransfer.v1.DataSourceName name)` Returns true if valid credentials exist for the given data source and requesting user.
`com.google.cloud.bigquery.datatransfer.v1.CheckValidCredsResponse`	`checkValidCreds(String name)` Returns true if valid credentials exist for the given data source and requesting user.
`UnaryCallable<com.google.cloud.bigquery.datatransfer.v1.CheckValidCredsRequest,com.google.cloud.bigquery.datatransfer.v1.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.
`com.google.cloud.bigquery.datatransfer.v1.TransferConfig`	`createTransferConfig(com.google.cloud.bigquery.datatransfer.v1.CreateTransferConfigRequest request)` Creates a new data transfer configuration.
`com.google.cloud.bigquery.datatransfer.v1.TransferConfig`	`createTransferConfig(com.google.cloud.bigquery.datatransfer.v1.ParentName parent, com.google.cloud.bigquery.datatransfer.v1.TransferConfig transferConfig)` Creates a new data transfer configuration.
`com.google.cloud.bigquery.datatransfer.v1.TransferConfig`	`createTransferConfig(String parent, com.google.cloud.bigquery.datatransfer.v1.TransferConfig transferConfig)` Creates a new data transfer configuration.
`UnaryCallable<com.google.cloud.bigquery.datatransfer.v1.CreateTransferConfigRequest,com.google.cloud.bigquery.datatransfer.v1.TransferConfig>`	`createTransferConfigCallable()` Creates a new data transfer configuration.
`void`	`deleteTransferConfig(com.google.cloud.bigquery.datatransfer.v1.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(com.google.cloud.bigquery.datatransfer.v1.TransferConfigName name)` Deletes a data transfer configuration, including any associated transfer runs and logs.
`UnaryCallable<com.google.cloud.bigquery.datatransfer.v1.DeleteTransferConfigRequest,Empty>`	`deleteTransferConfigCallable()` Deletes a data transfer configuration, including any associated transfer runs and logs.
`void`	`deleteTransferRun(com.google.cloud.bigquery.datatransfer.v1.DeleteTransferRunRequest request)` Deletes the specified transfer run.
`void`	`deleteTransferRun(com.google.cloud.bigquery.datatransfer.v1.RunName name)` Deletes the specified transfer run.
`void`	`deleteTransferRun(String name)` Deletes the specified transfer run.
`UnaryCallable<com.google.cloud.bigquery.datatransfer.v1.DeleteTransferRunRequest,Empty>`	`deleteTransferRunCallable()` Deletes the specified transfer run.
`com.google.cloud.bigquery.datatransfer.v1.DataSource`	`getDataSource(com.google.cloud.bigquery.datatransfer.v1.DataSourceName name)` Retrieves a supported data source and returns its settings, which can be used for UI rendering.
`com.google.cloud.bigquery.datatransfer.v1.DataSource`	`getDataSource(com.google.cloud.bigquery.datatransfer.v1.GetDataSourceRequest request)` Retrieves a supported data source and returns its settings, which can be used for UI rendering.
`com.google.cloud.bigquery.datatransfer.v1.DataSource`	`getDataSource(String name)` Retrieves a supported data source and returns its settings, which can be used for UI rendering.
`UnaryCallable<com.google.cloud.bigquery.datatransfer.v1.GetDataSourceRequest,com.google.cloud.bigquery.datatransfer.v1.DataSource>`	`getDataSourceCallable()` Retrieves a supported data source and returns its settings, which can be used for UI rendering.
`DataTransferServiceSettings`	`getSettings()`
`DataTransferServiceStub`	`getStub()`
`com.google.cloud.bigquery.datatransfer.v1.TransferConfig`	`getTransferConfig(com.google.cloud.bigquery.datatransfer.v1.GetTransferConfigRequest request)` Returns information about a data transfer config.
`com.google.cloud.bigquery.datatransfer.v1.TransferConfig`	`getTransferConfig(String name)` Returns information about a data transfer config.
`com.google.cloud.bigquery.datatransfer.v1.TransferConfig`	`getTransferConfig(com.google.cloud.bigquery.datatransfer.v1.TransferConfigName name)` Returns information about a data transfer config.
`UnaryCallable<com.google.cloud.bigquery.datatransfer.v1.GetTransferConfigRequest,com.google.cloud.bigquery.datatransfer.v1.TransferConfig>`	`getTransferConfigCallable()` Returns information about a data transfer config.
`com.google.cloud.bigquery.datatransfer.v1.TransferRun`	`getTransferRun(com.google.cloud.bigquery.datatransfer.v1.GetTransferRunRequest request)` Returns information about the particular transfer run.
`com.google.cloud.bigquery.datatransfer.v1.TransferRun`	`getTransferRun(com.google.cloud.bigquery.datatransfer.v1.RunName name)` Returns information about the particular transfer run.
`com.google.cloud.bigquery.datatransfer.v1.TransferRun`	`getTransferRun(String name)` Returns information about the particular transfer run.
`UnaryCallable<com.google.cloud.bigquery.datatransfer.v1.GetTransferRunRequest,com.google.cloud.bigquery.datatransfer.v1.TransferRun>`	`getTransferRunCallable()` Returns information about the particular transfer run.
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`DataTransferServiceClient.ListDataSourcesPagedResponse`	`listDataSources(com.google.cloud.bigquery.datatransfer.v1.ListDataSourcesRequest request)` Lists supported data sources and returns their settings, which can be used for UI rendering.
`DataTransferServiceClient.ListDataSourcesPagedResponse`	`listDataSources(com.google.cloud.bigquery.datatransfer.v1.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.
`UnaryCallable<com.google.cloud.bigquery.datatransfer.v1.ListDataSourcesRequest,com.google.cloud.bigquery.datatransfer.v1.ListDataSourcesResponse>`	`listDataSourcesCallable()` Lists supported data sources and returns their settings, which can be used for UI rendering.
`UnaryCallable<com.google.cloud.bigquery.datatransfer.v1.ListDataSourcesRequest,DataTransferServiceClient.ListDataSourcesPagedResponse>`	`listDataSourcesPagedCallable()` Lists supported data sources and returns their settings, which can be used for UI rendering.
`DataTransferServiceClient.ListTransferConfigsPagedResponse`	`listTransferConfigs(com.google.cloud.bigquery.datatransfer.v1.ListTransferConfigsRequest request)` Returns information about all data transfers in the project.
`DataTransferServiceClient.ListTransferConfigsPagedResponse`	`listTransferConfigs(com.google.cloud.bigquery.datatransfer.v1.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.
`UnaryCallable<com.google.cloud.bigquery.datatransfer.v1.ListTransferConfigsRequest,com.google.cloud.bigquery.datatransfer.v1.ListTransferConfigsResponse>`	`listTransferConfigsCallable()` Returns information about all data transfers in the project.
`UnaryCallable<com.google.cloud.bigquery.datatransfer.v1.ListTransferConfigsRequest,DataTransferServiceClient.ListTransferConfigsPagedResponse>`	`listTransferConfigsPagedCallable()` Returns information about all data transfers in the project.
`DataTransferServiceClient.ListTransferLogsPagedResponse`	`listTransferLogs(com.google.cloud.bigquery.datatransfer.v1.ListTransferLogsRequest request)` Returns user facing log messages for the data transfer run.
`DataTransferServiceClient.ListTransferLogsPagedResponse`	`listTransferLogs(com.google.cloud.bigquery.datatransfer.v1.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.
`UnaryCallable<com.google.cloud.bigquery.datatransfer.v1.ListTransferLogsRequest,com.google.cloud.bigquery.datatransfer.v1.ListTransferLogsResponse>`	`listTransferLogsCallable()` Returns user facing log messages for the data transfer run.
`UnaryCallable<com.google.cloud.bigquery.datatransfer.v1.ListTransferLogsRequest,DataTransferServiceClient.ListTransferLogsPagedResponse>`	`listTransferLogsPagedCallable()` Returns user facing log messages for the data transfer run.
`DataTransferServiceClient.ListTransferRunsPagedResponse`	`listTransferRuns(com.google.cloud.bigquery.datatransfer.v1.ListTransferRunsRequest request)` Returns information about running and completed jobs.
`DataTransferServiceClient.ListTransferRunsPagedResponse`	`listTransferRuns(String parent)` Returns information about running and completed jobs.
`DataTransferServiceClient.ListTransferRunsPagedResponse`	`listTransferRuns(com.google.cloud.bigquery.datatransfer.v1.TransferConfigName parent)` Returns information about running and completed jobs.
`UnaryCallable<com.google.cloud.bigquery.datatransfer.v1.ListTransferRunsRequest,com.google.cloud.bigquery.datatransfer.v1.ListTransferRunsResponse>`	`listTransferRunsCallable()` Returns information about running and completed jobs.
`UnaryCallable<com.google.cloud.bigquery.datatransfer.v1.ListTransferRunsRequest,DataTransferServiceClient.ListTransferRunsPagedResponse>`	`listTransferRunsPagedCallable()` Returns information about running and completed jobs.
`com.google.cloud.bigquery.datatransfer.v1.ScheduleTransferRunsResponse`	`scheduleTransferRuns(com.google.cloud.bigquery.datatransfer.v1.ScheduleTransferRunsRequest request)` Creates transfer runs for a time range [start_time, end_time].
`com.google.cloud.bigquery.datatransfer.v1.ScheduleTransferRunsResponse`	`scheduleTransferRuns(String parent, Timestamp startTime, Timestamp endTime)` Creates transfer runs for a time range [start_time, end_time].
`com.google.cloud.bigquery.datatransfer.v1.ScheduleTransferRunsResponse`	`scheduleTransferRuns(com.google.cloud.bigquery.datatransfer.v1.TransferConfigName parent, Timestamp startTime, Timestamp endTime)` Creates transfer runs for a time range [start_time, end_time].
`UnaryCallable<com.google.cloud.bigquery.datatransfer.v1.ScheduleTransferRunsRequest,com.google.cloud.bigquery.datatransfer.v1.ScheduleTransferRunsResponse>`	`scheduleTransferRunsCallable()` Creates transfer runs for a time range [start_time, end_time].
`void`	`shutdown()`
`void`	`shutdownNow()`
`com.google.cloud.bigquery.datatransfer.v1.TransferConfig`	`updateTransferConfig(com.google.cloud.bigquery.datatransfer.v1.TransferConfig transferConfig, FieldMask updateMask)` Updates a data transfer configuration.
`com.google.cloud.bigquery.datatransfer.v1.TransferConfig`	`updateTransferConfig(com.google.cloud.bigquery.datatransfer.v1.UpdateTransferConfigRequest request)` Updates a data transfer configuration.
`UnaryCallable<com.google.cloud.bigquery.datatransfer.v1.UpdateTransferConfigRequest,com.google.cloud.bigquery.datatransfer.v1.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 com.google.cloud.bigquery.datatransfer.v1.DataSource getDataSource(com.google.cloud.bigquery.datatransfer.v1.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 - The field will contain name of the resource requested, for example: `projects/{project_id}/dataSources/{data_source_id}`
Throws:: ApiException - if the remote call fails

getDataSource

public final com.google.cloud.bigquery.datatransfer.v1.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 - The field will contain name of the resource requested, for example: `projects/{project_id}/dataSources/{data_source_id}`
Throws:: ApiException - if the remote call fails

getDataSource

public final com.google.cloud.bigquery.datatransfer.v1.DataSource getDataSource(com.google.cloud.bigquery.datatransfer.v1.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:: ApiException - if the remote call fails

getDataSourceCallable

public final UnaryCallable<com.google.cloud.bigquery.datatransfer.v1.GetDataSourceRequest,com.google.cloud.bigquery.datatransfer.v1.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();
 }