Class DataTransferServiceSettings
- java.lang.Object
-
- com.google.api.gax.rpc.ClientSettings<DataTransferServiceSettings>
-
- com.google.cloud.bigquery.datatransfer.v1.DataTransferServiceSettings
-
@Generated("by gapic-generator-java") public class DataTransferServiceSettings extends com.google.api.gax.rpc.ClientSettings<DataTransferServiceSettings>
Settings class to configure an instance ofDataTransferServiceClient
.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();
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
DataTransferServiceSettings.Builder
Builder for DataTransferServiceSettings.
-
Constructor Summary
Constructors Modifier Constructor Description protected
DataTransferServiceSettings(DataTransferServiceSettings.Builder settingsBuilder)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description com.google.api.gax.rpc.UnaryCallSettings<CheckValidCredsRequest,CheckValidCredsResponse>
checkValidCredsSettings()
Returns the object with the settings used for calls to checkValidCreds.static DataTransferServiceSettings
create(DataTransferServiceStubSettings stub)
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.grpc.InstantiatingGrpcChannelProvider.Builder
defaultGrpcTransportProviderBuilder()
Returns a builder for the default gRPC ChannelProvider for this service.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 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.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 DataTransferServiceSettings.Builder
newBuilder()
Returns a new gRPC builder for this class.static DataTransferServiceSettings.Builder
newBuilder(com.google.api.gax.rpc.ClientContext clientContext)
Returns a new builder for this class.static DataTransferServiceSettings.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.DataTransferServiceSettings.Builder
toBuilder()
Returns a builder containing all the values of this settings class.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.ClientSettings
getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getQuotaProjectId, getStubSettings, getTransportChannelProvider, getWatchdogCheckInterval, getWatchdogProvider, toString
-
-
-
-
Constructor Detail
-
DataTransferServiceSettings
protected DataTransferServiceSettings(DataTransferServiceSettings.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.
-
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.
-
create
public static final DataTransferServiceSettings create(DataTransferServiceStubSettings stub) throws IOException
- Throws:
IOException
-
defaultExecutorProviderBuilder
public static com.google.api.gax.core.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 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()
-
defaultApiClientHeaderProviderBuilder
@BetaApi("The surface for customizing headers is not stable yet and may change in the future.") public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
-
newBuilder
public static DataTransferServiceSettings.Builder newBuilder()
Returns a new gRPC builder for this class.
-
newHttpJsonBuilder
@BetaApi public static DataTransferServiceSettings.Builder newHttpJsonBuilder()
Returns a new REST builder for this class.
-
newBuilder
public static DataTransferServiceSettings.Builder newBuilder(com.google.api.gax.rpc.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 classcom.google.api.gax.rpc.ClientSettings<DataTransferServiceSettings>
-
-