com.google.cloud.bigquery.datatransfer.v1

Class DataTransferServiceSettings

java.lang.Object

com.google.api.gax.rpc.ClientSettings<DataTransferServiceSettings>

com.google.cloud.bigquery.datatransfer.v1.DataTransferServiceSettings

@Generated(value="by gapic-generator")
 @BetaApi
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().getRetrySettings().toBuilder()
     .setTotalTimeout(Duration.ofSeconds(30));
 DataTransferServiceSettings dataTransferServiceSettings = dataTransferServiceSettingsBuilder.build();
 
 

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
UnaryCallSettings<com.google.cloud.bigquery.datatransfer.v1.CheckValidCredsRequest,com.google.cloud.bigquery.datatransfer.v1.CheckValidCredsResponse>	checkValidCredsSettings() Returns the object with the settings used for calls to checkValidCreds.
static DataTransferServiceSettings	create(DataTransferServiceStubSettings stub)
UnaryCallSettings<com.google.cloud.bigquery.datatransfer.v1.CreateTransferConfigRequest,com.google.cloud.bigquery.datatransfer.v1.TransferConfig>	createTransferConfigSettings() Returns the object with the settings used for calls to createTransferConfig.
static ApiClientHeaderProvider.Builder	defaultApiClientHeaderProviderBuilder()
static GoogleCredentialsProvider.Builder	defaultCredentialsProviderBuilder() Returns a builder for the default credentials for this service.
static InstantiatingExecutorProvider.Builder	defaultExecutorProviderBuilder() Returns a builder for the default ExecutorProvider for this service.
static InstantiatingGrpcChannelProvider.Builder	defaultGrpcTransportProviderBuilder() Returns a builder for the default ChannelProvider for this service.
static TransportChannelProvider	defaultTransportChannelProvider()
UnaryCallSettings<com.google.cloud.bigquery.datatransfer.v1.DeleteTransferConfigRequest,Empty>	deleteTransferConfigSettings() Returns the object with the settings used for calls to deleteTransferConfig.
UnaryCallSettings<com.google.cloud.bigquery.datatransfer.v1.DeleteTransferRunRequest,Empty>	deleteTransferRunSettings() Returns the object with the settings used for calls to deleteTransferRun.
UnaryCallSettings<com.google.cloud.bigquery.datatransfer.v1.GetDataSourceRequest,com.google.cloud.bigquery.datatransfer.v1.DataSource>	getDataSourceSettings() Returns the object with the settings used for calls to getDataSource.
static String	getDefaultEndpoint() Returns the default service endpoint.
static List<String>	getDefaultServiceScopes() Returns the default service scopes.
UnaryCallSettings<com.google.cloud.bigquery.datatransfer.v1.GetTransferConfigRequest,com.google.cloud.bigquery.datatransfer.v1.TransferConfig>	getTransferConfigSettings() Returns the object with the settings used for calls to getTransferConfig.
UnaryCallSettings<com.google.cloud.bigquery.datatransfer.v1.GetTransferRunRequest,com.google.cloud.bigquery.datatransfer.v1.TransferRun>	getTransferRunSettings() Returns the object with the settings used for calls to getTransferRun.
PagedCallSettings<com.google.cloud.bigquery.datatransfer.v1.ListDataSourcesRequest,com.google.cloud.bigquery.datatransfer.v1.ListDataSourcesResponse,DataTransferServiceClient.ListDataSourcesPagedResponse>	listDataSourcesSettings() Returns the object with the settings used for calls to listDataSources.
PagedCallSettings<com.google.cloud.bigquery.datatransfer.v1.ListTransferConfigsRequest,com.google.cloud.bigquery.datatransfer.v1.ListTransferConfigsResponse,DataTransferServiceClient.ListTransferConfigsPagedResponse>	listTransferConfigsSettings() Returns the object with the settings used for calls to listTransferConfigs.
PagedCallSettings<com.google.cloud.bigquery.datatransfer.v1.ListTransferLogsRequest,com.google.cloud.bigquery.datatransfer.v1.ListTransferLogsResponse,DataTransferServiceClient.ListTransferLogsPagedResponse>	listTransferLogsSettings() Returns the object with the settings used for calls to listTransferLogs.
PagedCallSettings<com.google.cloud.bigquery.datatransfer.v1.ListTransferRunsRequest,com.google.cloud.bigquery.datatransfer.v1.ListTransferRunsResponse,DataTransferServiceClient.ListTransferRunsPagedResponse>	listTransferRunsSettings() Returns the object with the settings used for calls to listTransferRuns.
static DataTransferServiceSettings.Builder	newBuilder() Returns a new builder for this class.
static DataTransferServiceSettings.Builder	newBuilder(ClientContext clientContext) Returns a new builder for this class.
UnaryCallSettings<com.google.cloud.bigquery.datatransfer.v1.ScheduleTransferRunsRequest,com.google.cloud.bigquery.datatransfer.v1.ScheduleTransferRunsResponse>	scheduleTransferRunsSettings() Returns the object with the settings used for calls to scheduleTransferRuns.
DataTransferServiceSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.
UnaryCallSettings<com.google.cloud.bigquery.datatransfer.v1.UpdateTransferConfigRequest,com.google.cloud.bigquery.datatransfer.v1.TransferConfig>	updateTransferConfigSettings() Returns the object with the settings used for calls to updateTransferConfig.

Methods inherited from class com.google.api.gax.rpc.ClientSettings

getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getHeaderProvider, getInternalHeaderProvider, getStubSettings, getTransportChannelProvider, getWatchdogCheckInterval, getWatchdogProvider, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

DataTransferServiceSettings

protected DataTransferServiceSettings(DataTransferServiceSettings.Builder settingsBuilder)
                               throws IOException

Throws:

IOException

Method Detail

getDataSourceSettings

public UnaryCallSettings<com.google.cloud.bigquery.datatransfer.v1.GetDataSourceRequest,com.google.cloud.bigquery.datatransfer.v1.DataSource> getDataSourceSettings()

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

listDataSourcesSettings

public PagedCallSettings<com.google.cloud.bigquery.datatransfer.v1.ListDataSourcesRequest,com.google.cloud.bigquery.datatransfer.v1.ListDataSourcesResponse,DataTransferServiceClient.ListDataSourcesPagedResponse> listDataSourcesSettings()

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

createTransferConfigSettings

public UnaryCallSettings<com.google.cloud.bigquery.datatransfer.v1.CreateTransferConfigRequest,com.google.cloud.bigquery.datatransfer.v1.TransferConfig> createTransferConfigSettings()

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

updateTransferConfigSettings

public UnaryCallSettings<com.google.cloud.bigquery.datatransfer.v1.UpdateTransferConfigRequest,com.google.cloud.bigquery.datatransfer.v1.TransferConfig> updateTransferConfigSettings()

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

deleteTransferConfigSettings

public UnaryCallSettings<com.google.cloud.bigquery.datatransfer.v1.DeleteTransferConfigRequest,Empty> deleteTransferConfigSettings()

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

getTransferConfigSettings

public UnaryCallSettings<com.google.cloud.bigquery.datatransfer.v1.GetTransferConfigRequest,com.google.cloud.bigquery.datatransfer.v1.TransferConfig> getTransferConfigSettings()

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

listTransferConfigsSettings

public PagedCallSettings<com.google.cloud.bigquery.datatransfer.v1.ListTransferConfigsRequest,com.google.cloud.bigquery.datatransfer.v1.ListTransferConfigsResponse,DataTransferServiceClient.ListTransferConfigsPagedResponse> listTransferConfigsSettings()

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

scheduleTransferRunsSettings

public UnaryCallSettings<com.google.cloud.bigquery.datatransfer.v1.ScheduleTransferRunsRequest,com.google.cloud.bigquery.datatransfer.v1.ScheduleTransferRunsResponse> scheduleTransferRunsSettings()

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

getTransferRunSettings

public UnaryCallSettings<com.google.cloud.bigquery.datatransfer.v1.GetTransferRunRequest,com.google.cloud.bigquery.datatransfer.v1.TransferRun> getTransferRunSettings()

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

deleteTransferRunSettings

public UnaryCallSettings<com.google.cloud.bigquery.datatransfer.v1.DeleteTransferRunRequest,Empty> deleteTransferRunSettings()

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

listTransferRunsSettings

public PagedCallSettings<com.google.cloud.bigquery.datatransfer.v1.ListTransferRunsRequest,com.google.cloud.bigquery.datatransfer.v1.ListTransferRunsResponse,DataTransferServiceClient.ListTransferRunsPagedResponse> listTransferRunsSettings()

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

listTransferLogsSettings

public PagedCallSettings<com.google.cloud.bigquery.datatransfer.v1.ListTransferLogsRequest,com.google.cloud.bigquery.datatransfer.v1.ListTransferLogsResponse,DataTransferServiceClient.ListTransferLogsPagedResponse> listTransferLogsSettings()

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

checkValidCredsSettings

public UnaryCallSettings<com.google.cloud.bigquery.datatransfer.v1.CheckValidCredsRequest,com.google.cloud.bigquery.datatransfer.v1.CheckValidCredsResponse> checkValidCredsSettings()

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

create

public static final DataTransferServiceSettings create(DataTransferServiceStubSettings stub)
                                                throws IOException

Throws:

IOException

defaultExecutorProviderBuilder

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

getDefaultEndpoint

public static String getDefaultEndpoint()

Returns the default service endpoint.

getDefaultServiceScopes

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

defaultCredentialsProviderBuilder

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

defaultGrpcTransportProviderBuilder

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

defaultTransportChannelProvider

public static TransportChannelProvider defaultTransportChannelProvider()

defaultApiClientHeaderProviderBuilder

@BetaApi(value="The surface for customizing headers is not stable yet and may change in the future.")
public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

newBuilder

public static DataTransferServiceSettings.Builder newBuilder()

Returns a new builder for this class.

newBuilder

public static DataTransferServiceSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

toBuilder

public DataTransferServiceSettings.Builder toBuilder()

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

Specified by:

toBuilder in class ClientSettings<DataTransferServiceSettings>