DataTransferServiceClient (BigQuery DataTransfer 2.67.0 API)

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-java")
public class DataTransferServiceClient
extends Object
implements com.google.api.gax.core.BackgroundResource

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:


 // 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:


 // 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:


 // 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:


 // 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.

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.ListLocationsFixedSizeCollection`
`static class`	`DataTransferServiceClient.ListLocationsPage`
`static class`	`DataTransferServiceClient.ListLocationsPagedResponse`
`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 Deprecated Methods
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(LocationName parent, TransferConfig transferConfig)` Creates a new data transfer configuration.
`TransferConfig`	`createTransferConfig(ProjectName 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,com.google.protobuf.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,com.google.protobuf.Empty>`	`deleteTransferRunCallable()` Deletes the specified transfer run.
`void`	`enrollDataSources(EnrollDataSourcesRequest request)` Enroll data sources in a user project.
`com.google.api.gax.rpc.UnaryCallable<EnrollDataSourcesRequest,com.google.protobuf.Empty>`	`enrollDataSourcesCallable()` Enroll data sources in a user project.
`DataSource`	`getDataSource(DataSourceName name)` Retrieves a supported data source and returns its settings.
`DataSource`	`getDataSource(GetDataSourceRequest request)` Retrieves a supported data source and returns its settings.
`DataSource`	`getDataSource(String name)` Retrieves a supported data source and returns its settings.
`com.google.api.gax.rpc.UnaryCallable<GetDataSourceRequest,DataSource>`	`getDataSourceCallable()` Retrieves a supported data source and returns its settings.
`com.google.cloud.location.Location`	`getLocation(com.google.cloud.location.GetLocationRequest request)` Gets information about a location.
`com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>`	`getLocationCallable()` Gets information about a location.
`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.
`DataTransferServiceClient.ListDataSourcesPagedResponse`	`listDataSources(LocationName parent)` Lists supported data sources and returns their settings.
`DataTransferServiceClient.ListDataSourcesPagedResponse`	`listDataSources(ProjectName parent)` Lists supported data sources and returns their settings.
`DataTransferServiceClient.ListDataSourcesPagedResponse`	`listDataSources(String parent)` Lists supported data sources and returns their settings.
`com.google.api.gax.rpc.UnaryCallable<ListDataSourcesRequest,ListDataSourcesResponse>`	`listDataSourcesCallable()` Lists supported data sources and returns their settings.
`com.google.api.gax.rpc.UnaryCallable<ListDataSourcesRequest,DataTransferServiceClient.ListDataSourcesPagedResponse>`	`listDataSourcesPagedCallable()` Lists supported data sources and returns their settings.
`DataTransferServiceClient.ListLocationsPagedResponse`	`listLocations(com.google.cloud.location.ListLocationsRequest request)` Lists information about the supported locations for this service.
`com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse>`	`listLocationsCallable()` Lists information about the supported locations for this service.
`com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,DataTransferServiceClient.ListLocationsPagedResponse>`	`listLocationsPagedCallable()` Lists information about the supported locations for this service.
`DataTransferServiceClient.ListTransferConfigsPagedResponse`	`listTransferConfigs(ListTransferConfigsRequest request)` Returns information about all transfer configs owned by a project in the specified location.
`DataTransferServiceClient.ListTransferConfigsPagedResponse`	`listTransferConfigs(LocationName parent)` Returns information about all transfer configs owned by a project in the specified location.
`DataTransferServiceClient.ListTransferConfigsPagedResponse`	`listTransferConfigs(ProjectName parent)` Returns information about all transfer configs owned by a project in the specified location.
`DataTransferServiceClient.ListTransferConfigsPagedResponse`	`listTransferConfigs(String parent)` Returns information about all transfer configs owned by a project in the specified location.
`com.google.api.gax.rpc.UnaryCallable<ListTransferConfigsRequest,ListTransferConfigsResponse>`	`listTransferConfigsCallable()` Returns information about all transfer configs owned by a project in the specified location.
`com.google.api.gax.rpc.UnaryCallable<ListTransferConfigsRequest,DataTransferServiceClient.ListTransferConfigsPagedResponse>`	`listTransferConfigsPagedCallable()` Returns information about all transfer configs owned by a project in the specified location.
`DataTransferServiceClient.ListTransferLogsPagedResponse`	`listTransferLogs(ListTransferLogsRequest request)` Returns log messages for the transfer run.
`DataTransferServiceClient.ListTransferLogsPagedResponse`	`listTransferLogs(RunName parent)` Returns log messages for the transfer run.
`DataTransferServiceClient.ListTransferLogsPagedResponse`	`listTransferLogs(String parent)` Returns log messages for the transfer run.
`com.google.api.gax.rpc.UnaryCallable<ListTransferLogsRequest,ListTransferLogsResponse>`	`listTransferLogsCallable()` Returns log messages for the transfer run.
`com.google.api.gax.rpc.UnaryCallable<ListTransferLogsRequest,DataTransferServiceClient.ListTransferLogsPagedResponse>`	`listTransferLogsPagedCallable()` Returns log messages for the transfer run.
`DataTransferServiceClient.ListTransferRunsPagedResponse`	`listTransferRuns(ListTransferRunsRequest request)` Returns information about running and completed transfer runs.
`DataTransferServiceClient.ListTransferRunsPagedResponse`	`listTransferRuns(String parent)` Returns information about running and completed transfer runs.
`DataTransferServiceClient.ListTransferRunsPagedResponse`	`listTransferRuns(TransferConfigName parent)` Returns information about running and completed transfer runs.
`com.google.api.gax.rpc.UnaryCallable<ListTransferRunsRequest,ListTransferRunsResponse>`	`listTransferRunsCallable()` Returns information about running and completed transfer runs.
`com.google.api.gax.rpc.UnaryCallable<ListTransferRunsRequest,DataTransferServiceClient.ListTransferRunsPagedResponse>`	`listTransferRunsPagedCallable()` Returns information about running and completed transfer runs.
`ScheduleTransferRunsResponse`	`scheduleTransferRuns(ScheduleTransferRunsRequest request)` Deprecated. This method is deprecated and will be removed in the next major version update.
`ScheduleTransferRunsResponse`	`scheduleTransferRuns(String parent, com.google.protobuf.Timestamp startTime, com.google.protobuf.Timestamp endTime)` Deprecated. This method is deprecated and will be removed in the next major version update.
`ScheduleTransferRunsResponse`	`scheduleTransferRuns(TransferConfigName parent, com.google.protobuf.Timestamp startTime, com.google.protobuf.Timestamp endTime)` Deprecated. This method is deprecated and will be removed in the next major version update.
`com.google.api.gax.rpc.UnaryCallable<ScheduleTransferRunsRequest,ScheduleTransferRunsResponse>`	`scheduleTransferRunsCallable()` Deprecated. This method is deprecated and will be removed in the next major version update.
`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.
`void`	`unenrollDataSources(UnenrollDataSourcesRequest request)` Unenroll data sources in a user project.
`com.google.api.gax.rpc.UnaryCallable<UnenrollDataSourcesRequest,com.google.protobuf.Empty>`	`unenrollDataSourcesCallable()` Unenroll data sources in a user project.
`TransferConfig`	`updateTransferConfig(TransferConfig transferConfig, com.google.protobuf.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
```
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
```
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 using create(DataTransferServiceSettings).

getSettings

public final DataTransferServiceSettings getSettings()

getStub

public DataTransferServiceStub getStub()

getDataSource

public final DataSource getDataSource(DataSourceName name)

Retrieves a supported data source and returns its settings.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
   DataSourceName name =
       DataSourceName.ofProjectLocationDataSourceName(
           "[PROJECT]", "[LOCATION]", "[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}` or `projects/{project_id}/locations/{location_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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
   String name = DataSourceName.ofProjectDataSourceName("[PROJECT]", "[DATA_SOURCE]").toString();
   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}` or `projects/{project_id}/locations/{location_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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
   GetDataSourceRequest request =
       GetDataSourceRequest.newBuilder()
           .setName(
               DataSourceName.ofProjectLocationDataSourceName(
                       "[PROJECT]", "[LOCATION]", "[DATA_SOURCE]")
                   .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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
   GetDataSourceRequest request =
       GetDataSourceRequest.newBuilder()
           .setName(
               DataSourceName.ofProjectLocationDataSourceName(
                       "[PROJECT]", "[LOCATION]", "[DATA_SOURCE]")
                   .toString())
           .build();
   ApiFuture<DataSource> future =
       dataTransferServiceClient.getDataSourceCallable().futureCall(request);
   // Do something.
   DataSource response = future.get();
 }

listDataSources

public final DataTransferServiceClient.ListDataSourcesPagedResponse listDataSources(LocationName parent)

Lists supported data sources and returns their settings.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   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}` or `projects/{project_id}/locations/{location_id}`
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listDataSources

public final DataTransferServiceClient.ListDataSourcesPagedResponse listDataSources(ProjectName parent)

Lists supported data sources and returns their settings.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
   ProjectName 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}` or `projects/{project_id}/locations/{location_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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
   String parent = ProjectName.of("[PROJECT]").toString();
   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}` or `projects/{project_id}/locations/{location_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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (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);
   }
 }

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
   ListDataSourcesRequest request =
       ListDataSourcesRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setPageToken("pageToken873572522")
           .setPageSize(883849137)
           .build();
   ApiFuture<DataSource> 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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (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;
     }
   }
 }

createTransferConfig

public final TransferConfig createTransferConfig(LocationName parent,
                                                 TransferConfig transferConfig)

Creates a new data transfer configuration.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   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} or projects/{project_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(ProjectName parent,
                                                 TransferConfig transferConfig)

Creates a new data transfer configuration.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
   ProjectName 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} or projects/{project_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:


 // 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);
 }

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} or projects/{project_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:


 // 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);
 }

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:


 // 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<TransferConfig> future =
       dataTransferServiceClient.createTransferConfigCallable().futureCall(request);
   // Do something.
   TransferConfig response = future.get();
 }

updateTransferConfig

public final TransferConfig updateTransferConfig(TransferConfig transferConfig,
                                                 com.google.protobuf.FieldMask updateMask)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (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:


 // 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);
 }

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:


 // 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<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:


 // 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);
 }

Parameters:: 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

deleteTransferConfig

public final void deleteTransferConfig(String name)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
   String name =
       TransferConfigName.ofProjectTransferConfigName("[PROJECT]", "[TRANSFER_CONFIG]")
           .toString();
   dataTransferServiceClient.deleteTransferConfig(name);
 }

Parameters:: 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

deleteTransferConfig

public final void deleteTransferConfig(DeleteTransferConfigRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
   DeleteTransferConfigRequest request =
       DeleteTransferConfigRequest.newBuilder()
           .setName(
               TransferConfigName.ofProjectLocationTransferConfigName(
                       "[PROJECT]", "[LOCATION]", "[TRANSFER_CONFIG]")
                   .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,com.google.protobuf.Empty> deleteTransferConfigCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
   DeleteTransferConfigRequest request =
       DeleteTransferConfigRequest.newBuilder()
           .setName(
               TransferConfigName.ofProjectLocationTransferConfigName(
                       "[PROJECT]", "[LOCATION]", "[TRANSFER_CONFIG]")
                   .toString())
           .build();
   ApiFuture<Empty> 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:


 // 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);
 }

Parameters:: 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

getTransferConfig

public final TransferConfig getTransferConfig(String name)

Returns information about a data transfer config.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
   String name =
       TransferConfigName.ofProjectTransferConfigName("[PROJECT]", "[TRANSFER_CONFIG]")
           .toString();
   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}` or `projects/{project_id}/locations/{location_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:


 // 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);
 }

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:


 // 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<TransferConfig> future =
       dataTransferServiceClient.getTransferConfigCallable().futureCall(request);
   // Do something.
   TransferConfig response = future.get();
 }