Class DataTransferServiceSettings (2.23.0)

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:


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

Static Methods

create(DataTransferServiceStubSettings stub)

public static final DataTransferServiceSettings create(DataTransferServiceStubSettings stub)
Parameter
NameDescription
stubDataTransferServiceStubSettings
Returns
TypeDescription
DataTransferServiceSettings
Exceptions
TypeDescription
IOException

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 gRPC ChannelProvider for this service.

Returns
TypeDescription
Builder

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

Returns a builder for the default REST ChannelProvider for this service.

Returns
TypeDescription
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()
Returns
TypeDescription
TransportChannelProvider

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
TypeDescription
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
TypeDescription
List<String>

newBuilder()

public static DataTransferServiceSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
TypeDescription
DataTransferServiceSettings.Builder

newBuilder(ClientContext clientContext)

public static DataTransferServiceSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
DataTransferServiceSettings.Builder

newHttpJsonBuilder()

public static DataTransferServiceSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
TypeDescription
DataTransferServiceSettings.Builder

Constructors

DataTransferServiceSettings(DataTransferServiceSettings.Builder settingsBuilder)

protected DataTransferServiceSettings(DataTransferServiceSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderDataTransferServiceSettings.Builder

Methods

checkValidCredsSettings()

public UnaryCallSettings<CheckValidCredsRequest,CheckValidCredsResponse> checkValidCredsSettings()

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

Returns
TypeDescription
UnaryCallSettings<CheckValidCredsRequest,CheckValidCredsResponse>

createTransferConfigSettings()

public UnaryCallSettings<CreateTransferConfigRequest,TransferConfig> createTransferConfigSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateTransferConfigRequest,TransferConfig>

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>

enrollDataSourcesSettings()

public UnaryCallSettings<EnrollDataSourcesRequest,Empty> enrollDataSourcesSettings()

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

Returns
TypeDescription
UnaryCallSettings<EnrollDataSourcesRequest,Empty>

getDataSourceSettings()

public UnaryCallSettings<GetDataSourceRequest,DataSource> getDataSourceSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetDataSourceRequest,DataSource>

getLocationSettings()

public UnaryCallSettings<GetLocationRequest,Location> getLocationSettings()

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

Returns
TypeDescription
UnaryCallSettings<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>

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>

listLocationsSettings()

public PagedCallSettings<ListLocationsRequest,ListLocationsResponse,DataTransferServiceClient.ListLocationsPagedResponse> listLocationsSettings()

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

Returns
TypeDescription
PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,ListLocationsPagedResponse>

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>

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 DataTransferServiceSettings.Builder toBuilder()

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

Returns
TypeDescription
DataTransferServiceSettings.Builder
Overrides

updateTransferConfigSettings()

public UnaryCallSettings<UpdateTransferConfigRequest,TransferConfig> updateTransferConfigSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateTransferConfigRequest,TransferConfig>