- 1.73.0 (latest)
- 1.72.0
- 1.71.0
- 1.69.0
- 1.67.0
- 1.66.0
- 1.63.0
- 1.62.0
- 1.61.0
- 1.59.0
- 1.58.0
- 1.57.0
- 1.56.0
- 1.55.0
- 1.54.0
- 1.53.0
- 1.52.0
- 1.51.0
- 1.50.0
- 1.48.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.0
- 1.36.0
- 1.35.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.26.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.0
- 1.11.0
- 1.10.0
- 1.8.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.3.0
- 1.2.9
- 1.1.1
- 1.0.0
- 0.5.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 (networkconnectivity.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 of getMulticloudDataTransferConfig:
// 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
.getMulticloudDataTransferConfigSettings()
.setRetrySettings(
dataTransferServiceSettingsBuilder
.getMulticloudDataTransferConfigSettings()
.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());
DataTransferServiceSettings dataTransferServiceSettings =
dataTransferServiceSettingsBuilder.build();
Please refer to the Client Side Retry Guide for additional support in setting retries.
To configure the RetrySettings of a Long Running Operation method, create an OperationTimedPollAlgorithm object and update the RPC's polling algorithm. For example, to configure the RetrySettings for createMulticloudDataTransferConfig:
// 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();
TimedRetryAlgorithm timedRetryAlgorithm =
OperationalTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelayDuration(Duration.ofMillis(500))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelayDuration(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
dataTransferServiceSettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
Static Methods
create(DataTransferServiceStubSettings stub)
public static final DataTransferServiceSettings create(DataTransferServiceStubSettings stub)| Parameter | |
|---|---|
| Name | Description |
stub |
DataTransferServiceStubSettings |
| Returns | |
|---|---|
| Type | Description |
DataTransferServiceSettings |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
defaultApiClientHeaderProviderBuilder()
public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()| Returns | |
|---|---|
| Type | Description |
Builder |
|
defaultCredentialsProviderBuilder()
public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()Returns a builder for the default credentials for this service.
| Returns | |
|---|---|
| Type | Description |
Builder |
|
defaultExecutorProviderBuilder()
public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()Returns a builder for the default ExecutorProvider for this service.
| Returns | |
|---|---|
| Type | Description |
Builder |
|
defaultGrpcTransportProviderBuilder()
public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()Returns a builder for the default ChannelProvider for this service.
| Returns | |
|---|---|
| Type | Description |
Builder |
|
defaultTransportChannelProvider()
public static TransportChannelProvider defaultTransportChannelProvider()| Returns | |
|---|---|
| Type | Description |
TransportChannelProvider |
|
getDefaultEndpoint()
public static String getDefaultEndpoint()Returns the default service endpoint.
| Returns | |
|---|---|
| Type | Description |
String |
|
getDefaultServiceScopes()
public static List<String> getDefaultServiceScopes()Returns the default service scopes.
| Returns | |
|---|---|
| Type | Description |
List<String> |
|
newBuilder()
public static DataTransferServiceSettings.Builder newBuilder()Returns a new builder for this class.
| Returns | |
|---|---|
| Type | Description |
DataTransferServiceSettings.Builder |
|
newBuilder(ClientContext clientContext)
public static DataTransferServiceSettings.Builder newBuilder(ClientContext clientContext)Returns a new builder for this class.
| Parameter | |
|---|---|
| Name | Description |
clientContext |
ClientContext |
| Returns | |
|---|---|
| Type | Description |
DataTransferServiceSettings.Builder |
|
Constructors
DataTransferServiceSettings(DataTransferServiceSettings.Builder settingsBuilder)
protected DataTransferServiceSettings(DataTransferServiceSettings.Builder settingsBuilder)| Parameter | |
|---|---|
| Name | Description |
settingsBuilder |
DataTransferServiceSettings.Builder |
Methods
createDestinationOperationSettings()
public OperationCallSettings<CreateDestinationRequest,Destination,OperationMetadata> createDestinationOperationSettings()Returns the object with the settings used for calls to createDestination.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<CreateDestinationRequest,Destination,OperationMetadata> |
|
createDestinationSettings()
public UnaryCallSettings<CreateDestinationRequest,Operation> createDestinationSettings()Returns the object with the settings used for calls to createDestination.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<CreateDestinationRequest,Operation> |
|
createMulticloudDataTransferConfigOperationSettings()
public OperationCallSettings<CreateMulticloudDataTransferConfigRequest,MulticloudDataTransferConfig,OperationMetadata> createMulticloudDataTransferConfigOperationSettings()Returns the object with the settings used for calls to createMulticloudDataTransferConfig.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<CreateMulticloudDataTransferConfigRequest,MulticloudDataTransferConfig,OperationMetadata> |
|
createMulticloudDataTransferConfigSettings()
public UnaryCallSettings<CreateMulticloudDataTransferConfigRequest,Operation> createMulticloudDataTransferConfigSettings()Returns the object with the settings used for calls to createMulticloudDataTransferConfig.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<CreateMulticloudDataTransferConfigRequest,Operation> |
|
deleteDestinationOperationSettings()
public OperationCallSettings<DeleteDestinationRequest,Empty,OperationMetadata> deleteDestinationOperationSettings()Returns the object with the settings used for calls to deleteDestination.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<DeleteDestinationRequest,Empty,OperationMetadata> |
|
deleteDestinationSettings()
public UnaryCallSettings<DeleteDestinationRequest,Operation> deleteDestinationSettings()Returns the object with the settings used for calls to deleteDestination.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<DeleteDestinationRequest,Operation> |
|
deleteMulticloudDataTransferConfigOperationSettings()
public OperationCallSettings<DeleteMulticloudDataTransferConfigRequest,Empty,OperationMetadata> deleteMulticloudDataTransferConfigOperationSettings()Returns the object with the settings used for calls to deleteMulticloudDataTransferConfig.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<DeleteMulticloudDataTransferConfigRequest,Empty,OperationMetadata> |
|
deleteMulticloudDataTransferConfigSettings()
public UnaryCallSettings<DeleteMulticloudDataTransferConfigRequest,Operation> deleteMulticloudDataTransferConfigSettings()Returns the object with the settings used for calls to deleteMulticloudDataTransferConfig.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<DeleteMulticloudDataTransferConfigRequest,Operation> |
|
getDestinationSettings()
public UnaryCallSettings<GetDestinationRequest,Destination> getDestinationSettings()Returns the object with the settings used for calls to getDestination.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<GetDestinationRequest,Destination> |
|
getIamPolicySettings()
public UnaryCallSettings<GetIamPolicyRequest,Policy> getIamPolicySettings()Returns the object with the settings used for calls to getIamPolicy.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy> |
|
getLocationSettings()
public UnaryCallSettings<GetLocationRequest,Location> getLocationSettings()Returns the object with the settings used for calls to getLocation.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location> |
|
getMulticloudDataTransferConfigSettings()
public UnaryCallSettings<GetMulticloudDataTransferConfigRequest,MulticloudDataTransferConfig> getMulticloudDataTransferConfigSettings()Returns the object with the settings used for calls to getMulticloudDataTransferConfig.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<GetMulticloudDataTransferConfigRequest,MulticloudDataTransferConfig> |
|
getMulticloudDataTransferSupportedServiceSettings()
public UnaryCallSettings<GetMulticloudDataTransferSupportedServiceRequest,MulticloudDataTransferSupportedService> getMulticloudDataTransferSupportedServiceSettings()Returns the object with the settings used for calls to getMulticloudDataTransferSupportedService.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<GetMulticloudDataTransferSupportedServiceRequest,MulticloudDataTransferSupportedService> |
|
listDestinationsSettings()
public PagedCallSettings<ListDestinationsRequest,ListDestinationsResponse,DataTransferServiceClient.ListDestinationsPagedResponse> listDestinationsSettings()Returns the object with the settings used for calls to listDestinations.
| Returns | |
|---|---|
| Type | Description |
PagedCallSettings<ListDestinationsRequest,ListDestinationsResponse,ListDestinationsPagedResponse> |
|
listLocationsSettings()
public PagedCallSettings<ListLocationsRequest,ListLocationsResponse,DataTransferServiceClient.ListLocationsPagedResponse> listLocationsSettings()Returns the object with the settings used for calls to listLocations.
| Returns | |
|---|---|
| Type | Description |
PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,ListLocationsPagedResponse> |
|
listMulticloudDataTransferConfigsSettings()
public PagedCallSettings<ListMulticloudDataTransferConfigsRequest,ListMulticloudDataTransferConfigsResponse,DataTransferServiceClient.ListMulticloudDataTransferConfigsPagedResponse> listMulticloudDataTransferConfigsSettings()Returns the object with the settings used for calls to listMulticloudDataTransferConfigs.
| Returns | |
|---|---|
| Type | Description |
PagedCallSettings<ListMulticloudDataTransferConfigsRequest,ListMulticloudDataTransferConfigsResponse,ListMulticloudDataTransferConfigsPagedResponse> |
|
listMulticloudDataTransferSupportedServicesSettings()
public PagedCallSettings<ListMulticloudDataTransferSupportedServicesRequest,ListMulticloudDataTransferSupportedServicesResponse,DataTransferServiceClient.ListMulticloudDataTransferSupportedServicesPagedResponse> listMulticloudDataTransferSupportedServicesSettings()Returns the object with the settings used for calls to listMulticloudDataTransferSupportedServices.
setIamPolicySettings()
public UnaryCallSettings<SetIamPolicyRequest,Policy> setIamPolicySettings()Returns the object with the settings used for calls to setIamPolicy.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy> |
|
testIamPermissionsSettings()
public UnaryCallSettings<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsSettings()Returns the object with the settings used for calls to testIamPermissions.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse> |
|
toBuilder()
public DataTransferServiceSettings.Builder toBuilder()Returns a builder containing all the values of this settings class.
| Returns | |
|---|---|
| Type | Description |
DataTransferServiceSettings.Builder |
|
updateDestinationOperationSettings()
public OperationCallSettings<UpdateDestinationRequest,Destination,OperationMetadata> updateDestinationOperationSettings()Returns the object with the settings used for calls to updateDestination.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<UpdateDestinationRequest,Destination,OperationMetadata> |
|
updateDestinationSettings()
public UnaryCallSettings<UpdateDestinationRequest,Operation> updateDestinationSettings()Returns the object with the settings used for calls to updateDestination.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<UpdateDestinationRequest,Operation> |
|
updateMulticloudDataTransferConfigOperationSettings()
public OperationCallSettings<UpdateMulticloudDataTransferConfigRequest,MulticloudDataTransferConfig,OperationMetadata> updateMulticloudDataTransferConfigOperationSettings()Returns the object with the settings used for calls to updateMulticloudDataTransferConfig.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<UpdateMulticloudDataTransferConfigRequest,MulticloudDataTransferConfig,OperationMetadata> |
|
updateMulticloudDataTransferConfigSettings()
public UnaryCallSettings<UpdateMulticloudDataTransferConfigRequest,Operation> updateMulticloudDataTransferConfigSettings()Returns the object with the settings used for calls to updateMulticloudDataTransferConfig.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<UpdateMulticloudDataTransferConfigRequest,Operation> |
|