Class DataTransferServiceStubSettings (2.0.27)

public class DataTransferServiceStubSettings extends StubSettings<DataTransferServiceStubSettings>

Settings class to configure an instance of DataTransferServiceStub.

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:


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

Inheritance

java.lang.Object > StubSettings > DataTransferServiceStubSettings

Constructors

DataTransferServiceStubSettings(DataTransferServiceStubSettings.Builder settingsBuilder)

protected DataTransferServiceStubSettings(DataTransferServiceStubSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderDataTransferServiceStubSettings.Builder

Methods

checkValidCredsSettings()

public UnaryCallSettings<CheckValidCredsRequest,CheckValidCredsResponse> checkValidCredsSettings()

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

Returns
TypeDescription
UnaryCallSettings<CheckValidCredsRequest,CheckValidCredsResponse>

createStub()

public DataTransferServiceStub createStub()
Returns
TypeDescription
DataTransferServiceStub
Exceptions
TypeDescription
IOException

createTransferConfigSettings()

public UnaryCallSettings<CreateTransferConfigRequest,TransferConfig> createTransferConfigSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateTransferConfigRequest,TransferConfig>

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
Returns
TypeDescription
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
TypeDescription
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
TypeDescription
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

Returns
TypeDescription
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()
Returns
TypeDescription
TransportChannelProvider

deleteTransferConfigSettings()

public UnaryCallSettings<DeleteTransferConfigRequest,Empty> deleteTransferConfigSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteTransferConfigRequest,Empty>

deleteTransferRunSettings()

public UnaryCallSettings<DeleteTransferRunRequest,Empty> deleteTransferRunSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteTransferRunRequest,Empty>

getDataSourceSettings()

public UnaryCallSettings<GetDataSourceRequest,DataSource> getDataSourceSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetDataSourceRequest,DataSource>

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
TypeDescription
String

getDefaultMtlsEndpoint()

public static String getDefaultMtlsEndpoint()

Returns the default mTLS service endpoint.

Returns
TypeDescription
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
TypeDescription
List<String>

getTransferConfigSettings()

public UnaryCallSettings<GetTransferConfigRequest,TransferConfig> getTransferConfigSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetTransferConfigRequest,TransferConfig>

getTransferRunSettings()

public UnaryCallSettings<GetTransferRunRequest,TransferRun> getTransferRunSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetTransferRunRequest,TransferRun>

listDataSourcesSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListDataSourcesRequest,ListDataSourcesResponse,ListDataSourcesPagedResponse>

listTransferConfigsSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListTransferConfigsRequest,ListTransferConfigsResponse,ListTransferConfigsPagedResponse>

listTransferLogsSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListTransferLogsRequest,ListTransferLogsResponse,ListTransferLogsPagedResponse>

listTransferRunsSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListTransferRunsRequest,ListTransferRunsResponse,ListTransferRunsPagedResponse>

newBuilder()

public static DataTransferServiceStubSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
TypeDescription
DataTransferServiceStubSettings.Builder

newBuilder(ClientContext clientContext)

public static DataTransferServiceStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
DataTransferServiceStubSettings.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
TypeDescription
UnaryCallSettings<ScheduleTransferRunsRequest,ScheduleTransferRunsResponse>

startManualTransferRunsSettings()

public UnaryCallSettings<StartManualTransferRunsRequest,StartManualTransferRunsResponse> startManualTransferRunsSettings()

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

Returns
TypeDescription
UnaryCallSettings<StartManualTransferRunsRequest,StartManualTransferRunsResponse>

toBuilder()

public DataTransferServiceStubSettings.Builder toBuilder()

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

Returns
TypeDescription
DataTransferServiceStubSettings.Builder
Overrides

updateTransferConfigSettings()

public UnaryCallSettings<UpdateTransferConfigRequest,TransferConfig> updateTransferConfigSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateTransferConfigRequest,TransferConfig>