Class DataTransferServiceStubSettings
java.lang.Object
com.google.api.gax.rpc.StubSettings<DataTransferServiceStubSettings>
com.google.cloud.bigquery.datatransfer.v1.stub.DataTransferServiceStubSettings
@Generated("by gapic-generator-java")
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 [RetrySettings](https://cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.retrying.RetrySettings) of getDataSource:
// 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
DataTransferServiceStubSettings.Builder dataTransferServiceSettingsBuilder =
DataTransferServiceStubSettings.newBuilder();
dataTransferServiceSettingsBuilder
.getDataSourceSettings()
.setRetrySettings(
dataTransferServiceSettingsBuilder
.getDataSourceSettings()
.getRetrySettings()
.toBuilder()
.setInitialRetryDelayDuration(Duration.ofSeconds(1))
.setInitialRpcTimeoutDuration(Duration.ofSeconds(5))
.setMaxAttempts(5)
.setMaxRetryDelayDuration(Duration.ofSeconds(30))
.setMaxRpcTimeoutDuration(Duration.ofSeconds(60))
.setRetryDelayMultiplier(1.3)
.setRpcTimeoutMultiplier(1.5)
.setTotalTimeoutDuration(Duration.ofSeconds(300))
.build());
DataTransferServiceStubSettings dataTransferServiceSettings =
dataTransferServiceSettingsBuilder.build();
Please refer to the [Client Side Retry
Guide](https://docs.cloud.google.com/java/docs/client-retries) for additional support in setting
retries.-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classBuilder for DataTransferServiceStubSettings. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedDataTransferServiceStubSettings(DataTransferServiceStubSettings.Builder settingsBuilder) -
Method Summary
Modifier and TypeMethodDescriptionReturns the object with the settings used for calls to checkValidCreds.Returns the object with the settings used for calls to createTransferConfig.Returns a builder for the default credentials for this service.Returns a builder for the default ExecutorProvider for this service.Returns a builder for the default gRPC ChannelProvider for this service.Returns a builder for the default REST ChannelProvider for this service.static TransportChannelProviderUnaryCallSettings<DeleteTransferConfigRequest,com.google.protobuf.Empty> Returns the object with the settings used for calls to deleteTransferConfig.UnaryCallSettings<DeleteTransferRunRequest,com.google.protobuf.Empty> Returns the object with the settings used for calls to deleteTransferRun.UnaryCallSettings<EnrollDataSourcesRequest,com.google.protobuf.Empty> Returns the object with the settings used for calls to enrollDataSources.Returns the object with the settings used for calls to getDataSource.static StringReturns the default service endpoint.static StringReturns the default mTLS service endpoint.Returns the default service scopes.protected LibraryMetadataReturns the object with the settings used for calls to getLocation.Returns the default service name.Returns the object with the settings used for calls to getTransferConfig.Returns the object with the settings used for calls to getTransferRun.PagedCallSettings<ListDataSourcesRequest,ListDataSourcesResponse, DataTransferServiceClient.ListDataSourcesPagedResponse> Returns the object with the settings used for calls to listDataSources.PagedCallSettings<ListLocationsRequest,ListLocationsResponse, DataTransferServiceClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations.PagedCallSettings<ListTransferConfigsRequest,ListTransferConfigsResponse, DataTransferServiceClient.ListTransferConfigsPagedResponse> Returns the object with the settings used for calls to listTransferConfigs.PagedCallSettings<ListTransferLogsRequest,ListTransferLogsResponse, DataTransferServiceClient.ListTransferLogsPagedResponse> Returns the object with the settings used for calls to listTransferLogs.PagedCallSettings<ListTransferRunsRequest,ListTransferRunsResponse, DataTransferServiceClient.ListTransferRunsPagedResponse> Returns the object with the settings used for calls to listTransferRuns.Returns a new gRPC builder for this class.newBuilder(ClientContext clientContext) Returns a new builder for this class.Returns a new REST builder for this class.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 startManualTransferRuns.Returns a builder containing all the values of this settings class.UnaryCallSettings<UnenrollDataSourcesRequest,com.google.protobuf.Empty> Returns the object with the settings used for calls to unenrollDataSources.Returns the object with the settings used for calls to updateTransferConfig.Methods inherited from class com.google.api.gax.rpc.StubSettings
getApiKey, getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getMtlsEndpoint, getQuotaProjectId, getStreamWatchdogCheckInterval, getStreamWatchdogCheckIntervalDuration, getStreamWatchdogProvider, getTracerFactory, getTransportChannelProvider, getUniverseDomain, toString
-
Constructor Details
-
DataTransferServiceStubSettings
protected DataTransferServiceStubSettings(DataTransferServiceStubSettings.Builder settingsBuilder) throws IOException - Throws:
IOException
-
-
Method Details
-
getDataSourceSettings
Returns the object with the settings used for calls to getDataSource. -
listDataSourcesSettings
public PagedCallSettings<ListDataSourcesRequest,ListDataSourcesResponse, listDataSourcesSettings()DataTransferServiceClient.ListDataSourcesPagedResponse> Returns the object with the settings used for calls to listDataSources. -
createTransferConfigSettings
Returns the object with the settings used for calls to createTransferConfig. -
updateTransferConfigSettings
Returns the object with the settings used for calls to updateTransferConfig. -
deleteTransferConfigSettings
public UnaryCallSettings<DeleteTransferConfigRequest,com.google.protobuf.Empty> deleteTransferConfigSettings()Returns the object with the settings used for calls to deleteTransferConfig. -
getTransferConfigSettings
Returns the object with the settings used for calls to getTransferConfig. -
listTransferConfigsSettings
public PagedCallSettings<ListTransferConfigsRequest,ListTransferConfigsResponse, listTransferConfigsSettings()DataTransferServiceClient.ListTransferConfigsPagedResponse> Returns the object with the settings used for calls to listTransferConfigs. -
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. -
startManualTransferRunsSettings
public UnaryCallSettings<StartManualTransferRunsRequest,StartManualTransferRunsResponse> startManualTransferRunsSettings()Returns the object with the settings used for calls to startManualTransferRuns. -
getTransferRunSettings
Returns the object with the settings used for calls to getTransferRun. -
deleteTransferRunSettings
public UnaryCallSettings<DeleteTransferRunRequest,com.google.protobuf.Empty> deleteTransferRunSettings()Returns the object with the settings used for calls to deleteTransferRun. -
listTransferRunsSettings
public PagedCallSettings<ListTransferRunsRequest,ListTransferRunsResponse, listTransferRunsSettings()DataTransferServiceClient.ListTransferRunsPagedResponse> Returns the object with the settings used for calls to listTransferRuns. -
listTransferLogsSettings
public PagedCallSettings<ListTransferLogsRequest,ListTransferLogsResponse, listTransferLogsSettings()DataTransferServiceClient.ListTransferLogsPagedResponse> Returns the object with the settings used for calls to listTransferLogs. -
checkValidCredsSettings
Returns the object with the settings used for calls to checkValidCreds. -
enrollDataSourcesSettings
public UnaryCallSettings<EnrollDataSourcesRequest,com.google.protobuf.Empty> enrollDataSourcesSettings()Returns the object with the settings used for calls to enrollDataSources. -
unenrollDataSourcesSettings
public UnaryCallSettings<UnenrollDataSourcesRequest,com.google.protobuf.Empty> unenrollDataSourcesSettings()Returns the object with the settings used for calls to unenrollDataSources. -
listLocationsSettings
public PagedCallSettings<ListLocationsRequest,ListLocationsResponse, listLocationsSettings()DataTransferServiceClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations. -
getLocationSettings
Returns the object with the settings used for calls to getLocation. -
createStub
- Throws:
IOException
-
getServiceName
Returns the default service name.- Overrides:
getServiceNamein classStubSettings<DataTransferServiceStubSettings>
-
defaultExecutorProviderBuilder
Returns a builder for the default ExecutorProvider for this service. -
getDefaultEndpoint
Returns the default service endpoint. -
getDefaultMtlsEndpoint
Returns the default mTLS service endpoint. -
getDefaultServiceScopes
Returns the default service scopes. -
defaultCredentialsProviderBuilder
Returns a builder for the default credentials for this service. -
defaultGrpcTransportProviderBuilder
Returns a builder for the default gRPC ChannelProvider for this service. -
defaultHttpJsonTransportProviderBuilder
@BetaApi public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()Returns a builder for the default REST ChannelProvider for this service. -
defaultTransportChannelProvider
-
defaultGrpcApiClientHeaderProviderBuilder
-
defaultHttpJsonApiClientHeaderProviderBuilder
-
defaultApiClientHeaderProviderBuilder
-
newBuilder
Returns a new gRPC builder for this class. -
newHttpJsonBuilder
Returns a new REST builder for this class. -
newBuilder
Returns a new builder for this class. -
toBuilder
Returns a builder containing all the values of this settings class.- Specified by:
toBuilderin classStubSettings<DataTransferServiceStubSettings>
-
getLibraryMetadata
- Overrides:
getLibraryMetadatain classStubSettings<DataTransferServiceStubSettings>
-