com.google.cloud.bigquery.datatransfer.v1.stub

Class DataTransferServiceStubSettings

java.lang.Object

com.google.api.gax.rpc.StubSettings<DataTransferServiceStubSettings>

com.google.cloud.bigquery.datatransfer.v1.stub.DataTransferServiceStubSettings

@Generated(value="by gapic-generator-java")
public class DataTransferServiceStubSettings
extends com.google.api.gax.rpc.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://github.com/googleapis/google-cloud-java/blob/main/docs/client_retries.md) for additional support in setting retries.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DataTransferServiceStubSettings.Builder Builder for DataTransferServiceStubSettings.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DataTransferServiceStubSettings(DataTransferServiceStubSettings.Builder settingsBuilder)

Method Summary

Modifier and Type	Method and Description
com.google.api.gax.rpc.UnaryCallSettings<CheckValidCredsRequest,CheckValidCredsResponse>	checkValidCredsSettings() Returns the object with the settings used for calls to checkValidCreds.
DataTransferServiceStub	createStub()
com.google.api.gax.rpc.UnaryCallSettings<CreateTransferConfigRequest,TransferConfig>	createTransferConfigSettings() Returns the object with the settings used for calls to createTransferConfig.
static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder	defaultApiClientHeaderProviderBuilder()
static com.google.api.gax.core.GoogleCredentialsProvider.Builder	defaultCredentialsProviderBuilder() Returns a builder for the default credentials for this service.
static com.google.api.gax.core.InstantiatingExecutorProvider.Builder	defaultExecutorProviderBuilder() Returns a builder for the default ExecutorProvider for this service.
static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder	defaultGrpcApiClientHeaderProviderBuilder()
static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder	defaultGrpcTransportProviderBuilder() Returns a builder for the default gRPC ChannelProvider for this service.
static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder	defaultHttpJsonApiClientHeaderProviderBuilder()
static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder	defaultHttpJsonTransportProviderBuilder() Returns a builder for the default REST ChannelProvider for this service.
static com.google.api.gax.rpc.TransportChannelProvider	defaultTransportChannelProvider()
com.google.api.gax.rpc.UnaryCallSettings<DeleteTransferConfigRequest,com.google.protobuf.Empty>	deleteTransferConfigSettings() Returns the object with the settings used for calls to deleteTransferConfig.
com.google.api.gax.rpc.UnaryCallSettings<DeleteTransferRunRequest,com.google.protobuf.Empty>	deleteTransferRunSettings() Returns the object with the settings used for calls to deleteTransferRun.
com.google.api.gax.rpc.UnaryCallSettings<EnrollDataSourcesRequest,com.google.protobuf.Empty>	enrollDataSourcesSettings() Returns the object with the settings used for calls to enrollDataSources.
com.google.api.gax.rpc.UnaryCallSettings<GetDataSourceRequest,DataSource>	getDataSourceSettings() Returns the object with the settings used for calls to getDataSource.
static String	getDefaultEndpoint() Returns the default service endpoint.
static String	getDefaultMtlsEndpoint() Returns the default mTLS service endpoint.
static List<String>	getDefaultServiceScopes() Returns the default service scopes.
com.google.api.gax.rpc.UnaryCallSettings<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>	getLocationSettings() Returns the object with the settings used for calls to getLocation.
String	getServiceName() Returns the default service name.
com.google.api.gax.rpc.UnaryCallSettings<GetTransferConfigRequest,TransferConfig>	getTransferConfigSettings() Returns the object with the settings used for calls to getTransferConfig.
com.google.api.gax.rpc.UnaryCallSettings<GetTransferRunRequest,TransferRun>	getTransferRunSettings() Returns the object with the settings used for calls to getTransferRun.
com.google.api.gax.rpc.PagedCallSettings<ListDataSourcesRequest,ListDataSourcesResponse,DataTransferServiceClient.ListDataSourcesPagedResponse>	listDataSourcesSettings() Returns the object with the settings used for calls to listDataSources.
com.google.api.gax.rpc.PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,DataTransferServiceClient.ListLocationsPagedResponse>	listLocationsSettings() Returns the object with the settings used for calls to listLocations.
com.google.api.gax.rpc.PagedCallSettings<ListTransferConfigsRequest,ListTransferConfigsResponse,DataTransferServiceClient.ListTransferConfigsPagedResponse>	listTransferConfigsSettings() Returns the object with the settings used for calls to listTransferConfigs.
com.google.api.gax.rpc.PagedCallSettings<ListTransferLogsRequest,ListTransferLogsResponse,DataTransferServiceClient.ListTransferLogsPagedResponse>	listTransferLogsSettings() Returns the object with the settings used for calls to listTransferLogs.
com.google.api.gax.rpc.PagedCallSettings<ListTransferRunsRequest,ListTransferRunsResponse,DataTransferServiceClient.ListTransferRunsPagedResponse>	listTransferRunsSettings() Returns the object with the settings used for calls to listTransferRuns.
static DataTransferServiceStubSettings.Builder	newBuilder() Returns a new gRPC builder for this class.
static DataTransferServiceStubSettings.Builder	newBuilder(com.google.api.gax.rpc.ClientContext clientContext) Returns a new builder for this class.
static DataTransferServiceStubSettings.Builder	newHttpJsonBuilder() Returns a new REST builder for this class.
com.google.api.gax.rpc.UnaryCallSettings<ScheduleTransferRunsRequest,ScheduleTransferRunsResponse>	scheduleTransferRunsSettings() Deprecated. This method is deprecated and will be removed in the next major version update.
com.google.api.gax.rpc.UnaryCallSettings<StartManualTransferRunsRequest,StartManualTransferRunsResponse>	startManualTransferRunsSettings() Returns the object with the settings used for calls to startManualTransferRuns.
DataTransferServiceStubSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.
com.google.api.gax.rpc.UnaryCallSettings<UnenrollDataSourcesRequest,com.google.protobuf.Empty>	unenrollDataSourcesSettings() Returns the object with the settings used for calls to unenrollDataSources.
com.google.api.gax.rpc.UnaryCallSettings<UpdateTransferConfigRequest,TransferConfig>	updateTransferConfigSettings() 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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DataTransferServiceStubSettings

protected DataTransferServiceStubSettings(DataTransferServiceStubSettings.Builder settingsBuilder)
                                   throws IOException

Throws:

IOException

Method Detail

getDataSourceSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetDataSourceRequest,DataSource> getDataSourceSettings()

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

listDataSourcesSettings

public com.google.api.gax.rpc.PagedCallSettings<ListDataSourcesRequest,ListDataSourcesResponse,DataTransferServiceClient.ListDataSourcesPagedResponse> listDataSourcesSettings()

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

createTransferConfigSettings

public com.google.api.gax.rpc.UnaryCallSettings<CreateTransferConfigRequest,TransferConfig> createTransferConfigSettings()

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

updateTransferConfigSettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateTransferConfigRequest,TransferConfig> updateTransferConfigSettings()

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

deleteTransferConfigSettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteTransferConfigRequest,com.google.protobuf.Empty> deleteTransferConfigSettings()

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

getTransferConfigSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetTransferConfigRequest,TransferConfig> getTransferConfigSettings()

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

listTransferConfigsSettings

public com.google.api.gax.rpc.PagedCallSettings<ListTransferConfigsRequest,ListTransferConfigsResponse,DataTransferServiceClient.ListTransferConfigsPagedResponse> listTransferConfigsSettings()

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

scheduleTransferRunsSettings

@Deprecated
public com.google.api.gax.rpc.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 com.google.api.gax.rpc.UnaryCallSettings<StartManualTransferRunsRequest,StartManualTransferRunsResponse> startManualTransferRunsSettings()

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

getTransferRunSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetTransferRunRequest,TransferRun> getTransferRunSettings()

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

deleteTransferRunSettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteTransferRunRequest,com.google.protobuf.Empty> deleteTransferRunSettings()

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

listTransferRunsSettings

public com.google.api.gax.rpc.PagedCallSettings<ListTransferRunsRequest,ListTransferRunsResponse,DataTransferServiceClient.ListTransferRunsPagedResponse> listTransferRunsSettings()

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

listTransferLogsSettings

public com.google.api.gax.rpc.PagedCallSettings<ListTransferLogsRequest,ListTransferLogsResponse,DataTransferServiceClient.ListTransferLogsPagedResponse> listTransferLogsSettings()

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

checkValidCredsSettings

public com.google.api.gax.rpc.UnaryCallSettings<CheckValidCredsRequest,CheckValidCredsResponse> checkValidCredsSettings()

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

enrollDataSourcesSettings

public com.google.api.gax.rpc.UnaryCallSettings<EnrollDataSourcesRequest,com.google.protobuf.Empty> enrollDataSourcesSettings()

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

unenrollDataSourcesSettings

public com.google.api.gax.rpc.UnaryCallSettings<UnenrollDataSourcesRequest,com.google.protobuf.Empty> unenrollDataSourcesSettings()

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

listLocationsSettings

public com.google.api.gax.rpc.PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,DataTransferServiceClient.ListLocationsPagedResponse> listLocationsSettings()

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

getLocationSettings

public com.google.api.gax.rpc.UnaryCallSettings<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location> getLocationSettings()

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

createStub

public DataTransferServiceStub createStub()
                                   throws IOException

Throws:

IOException

getServiceName

public String getServiceName()

Returns the default service name.

Overrides:

getServiceName in class com.google.api.gax.rpc.StubSettings<DataTransferServiceStubSettings>

defaultExecutorProviderBuilder

public static com.google.api.gax.core.InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

getDefaultEndpoint

@ObsoleteApi(value="Use getEndpoint() instead")
public static String getDefaultEndpoint()

Returns the default service endpoint.

getDefaultMtlsEndpoint

public static String getDefaultMtlsEndpoint()

Returns the default mTLS service endpoint.

getDefaultServiceScopes

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

defaultCredentialsProviderBuilder

public static com.google.api.gax.core.GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

defaultGrpcTransportProviderBuilder

public static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

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

defaultHttpJsonTransportProviderBuilder

@BetaApi
public static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

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

defaultTransportChannelProvider

public static com.google.api.gax.rpc.TransportChannelProvider defaultTransportChannelProvider()

defaultGrpcApiClientHeaderProviderBuilder

public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultGrpcApiClientHeaderProviderBuilder()

defaultHttpJsonApiClientHeaderProviderBuilder

public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultHttpJsonApiClientHeaderProviderBuilder()

defaultApiClientHeaderProviderBuilder

public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

newBuilder

public static DataTransferServiceStubSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

newHttpJsonBuilder

public static DataTransferServiceStubSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

newBuilder

public static DataTransferServiceStubSettings.Builder newBuilder(com.google.api.gax.rpc.ClientContext clientContext)

Returns a new builder for this class.

toBuilder

public DataTransferServiceStubSettings.Builder toBuilder()

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

Specified by:

toBuilder in class com.google.api.gax.rpc.StubSettings<DataTransferServiceStubSettings>