Class DataTransferServiceSettings (2.0.27)

public class DataTransferServiceSettings extends ClientSettings<DataTransferServiceSettings>

Settings class to configure an instance of DataTransferServiceClient.

The default instance has everything set to sensible defaults:

The default service address (bigquerydatatransfer.googleapis.com) and default port (443) are used.
Credentials are acquired automatically through Application Default Credentials.
Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of getDataSource to 30 seconds:


 DataTransferServiceSettings.Builder dataTransferServiceSettingsBuilder =
     DataTransferServiceSettings.newBuilder();
 dataTransferServiceSettingsBuilder
     .getDataSourceSettings()
     .setRetrySettings(
         dataTransferServiceSettingsBuilder
             .getDataSourceSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 DataTransferServiceSettings dataTransferServiceSettings =
     dataTransferServiceSettingsBuilder.build();

Inheritance

java.lang.Object > ClientSettings > DataTransferServiceSettings

Inherited Members

ClientSettings.<B>toBuilder()

ClientSettings.getBackgroundExecutorProvider()

ClientSettings.getClock()

ClientSettings.getCredentialsProvider()

ClientSettings.getEndpoint()

ClientSettings.getExecutorProvider()

ClientSettings.getHeaderProvider()

ClientSettings.getInternalHeaderProvider()

ClientSettings.getQuotaProjectId()

ClientSettings.getStubSettings()

ClientSettings.getTransportChannelProvider()

ClientSettings.getWatchdogCheckInterval()

ClientSettings.getWatchdogProvider()

ClientSettings.toString()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Constructors

DataTransferServiceSettings(DataTransferServiceSettings.Builder settingsBuilder)

protected DataTransferServiceSettings(DataTransferServiceSettings.Builder settingsBuilder)

Parameter

Name	Description
settingsBuilder	`DataTransferServiceSettings.Builder`

Methods

checkValidCredsSettings()

public UnaryCallSettings<CheckValidCredsRequest,CheckValidCredsResponse> checkValidCredsSettings()

Returns the object with the settings used for calls to checkValidCreds.

Returns

Type	Description
UnaryCallSettings<CheckValidCredsRequest,CheckValidCredsResponse>

create(DataTransferServiceStubSettings stub)

public static final DataTransferServiceSettings create(DataTransferServiceStubSettings stub)

Parameter

Name	Description
stub	`DataTransferServiceStubSettings`

Returns

Type	Description
DataTransferServiceSettings

Exceptions

Type	Description
IOException

createTransferConfigSettings()

public UnaryCallSettings<CreateTransferConfigRequest,TransferConfig> createTransferConfigSettings()

Returns the object with the settings used for calls to createTransferConfig.

Returns

Type	Description
UnaryCallSettings<CreateTransferConfigRequest,TransferConfig>

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

Returns

Type	Description
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns

Type	Description
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns

Type	Description
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

Returns

Type	Description
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()

Returns

Type	Description
TransportChannelProvider

deleteTransferConfigSettings()

public UnaryCallSettings<DeleteTransferConfigRequest,Empty> deleteTransferConfigSettings()

Returns the object with the settings used for calls to deleteTransferConfig.

Returns

Type	Description
UnaryCallSettings<DeleteTransferConfigRequest,Empty>

deleteTransferRunSettings()

public UnaryCallSettings<DeleteTransferRunRequest,Empty> deleteTransferRunSettings()

Returns the object with the settings used for calls to deleteTransferRun.

Returns

Type	Description
UnaryCallSettings<DeleteTransferRunRequest,Empty>

getDataSourceSettings()

public UnaryCallSettings<GetDataSourceRequest,DataSource> getDataSourceSettings()

Returns the object with the settings used for calls to getDataSource.

Returns

Type	Description
UnaryCallSettings<GetDataSourceRequest,DataSource>

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns

Type	Description
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns

Type	Description
List<String>

getTransferConfigSettings()

public UnaryCallSettings<GetTransferConfigRequest,TransferConfig> getTransferConfigSettings()

Returns the object with the settings used for calls to getTransferConfig.

Returns

Type	Description
UnaryCallSettings<GetTransferConfigRequest,TransferConfig>

getTransferRunSettings()

public UnaryCallSettings<GetTransferRunRequest,TransferRun> getTransferRunSettings()

Returns the object with the settings used for calls to getTransferRun.

Returns

Type	Description
UnaryCallSettings<GetTransferRunRequest,TransferRun>

listDataSourcesSettings()

public PagedCallSettings<ListDataSourcesRequest,ListDataSourcesResponse,DataTransferServiceClient.ListDataSourcesPagedResponse> listDataSourcesSettings()

Returns the object with the settings used for calls to listDataSources.

Returns

Type	Description
PagedCallSettings<ListDataSourcesRequest,ListDataSourcesResponse,ListDataSourcesPagedResponse>

listTransferConfigsSettings()

public PagedCallSettings<ListTransferConfigsRequest,ListTransferConfigsResponse,DataTransferServiceClient.ListTransferConfigsPagedResponse> listTransferConfigsSettings()

Returns the object with the settings used for calls to listTransferConfigs.

Returns

Type	Description
PagedCallSettings<ListTransferConfigsRequest,ListTransferConfigsResponse,ListTransferConfigsPagedResponse>

listTransferLogsSettings()

public PagedCallSettings<ListTransferLogsRequest,ListTransferLogsResponse,DataTransferServiceClient.ListTransferLogsPagedResponse> listTransferLogsSettings()

Returns the object with the settings used for calls to listTransferLogs.

Returns

Type	Description
PagedCallSettings<ListTransferLogsRequest,ListTransferLogsResponse,ListTransferLogsPagedResponse>

listTransferRunsSettings()

public PagedCallSettings<ListTransferRunsRequest,ListTransferRunsResponse,DataTransferServiceClient.ListTransferRunsPagedResponse> listTransferRunsSettings()

Returns the object with the settings used for calls to listTransferRuns.

Returns

Type	Description
PagedCallSettings<ListTransferRunsRequest,ListTransferRunsResponse,ListTransferRunsPagedResponse>

newBuilder()

public static DataTransferServiceSettings.Builder newBuilder()

Returns a new builder for this class.

Returns

Type	Description
DataTransferServiceSettings.Builder

newBuilder(ClientContext clientContext)

public static DataTransferServiceSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter

Name	Description
clientContext	`ClientContext`

Returns

Type	Description
DataTransferServiceSettings.Builder

scheduleTransferRunsSettings() (deprecated)

public UnaryCallSettings<ScheduleTransferRunsRequest,ScheduleTransferRunsResponse> scheduleTransferRunsSettings()

(deprecated) This method is deprecated and will be removed in the next major version update.

Returns the object with the settings used for calls to scheduleTransferRuns.

Returns

Type	Description
UnaryCallSettings<ScheduleTransferRunsRequest,ScheduleTransferRunsResponse>

startManualTransferRunsSettings()

public UnaryCallSettings<StartManualTransferRunsRequest,StartManualTransferRunsResponse> startManualTransferRunsSettings()

Returns the object with the settings used for calls to startManualTransferRuns.

Returns

Type	Description
UnaryCallSettings<StartManualTransferRunsRequest,StartManualTransferRunsResponse>

toBuilder()

public DataTransferServiceSettings.Builder toBuilder()

Returns a builder containing all the values of this settings class.

Returns

Type	Description
DataTransferServiceSettings.Builder

Overrides

ClientSettings<SettingsT>.<B>toBuilder()

updateTransferConfigSettings()

public UnaryCallSettings<UpdateTransferConfigRequest,TransferConfig> updateTransferConfigSettings()

Returns the object with the settings used for calls to updateTransferConfig.

Returns

Type	Description
UnaryCallSettings<UpdateTransferConfigRequest,TransferConfig>