Class DataTransferServiceSettings
java.lang.Object
com.google.api.gax.rpc.ClientSettings<DataTransferServiceSettings>
com.google.cloud.networkconnectivity.v1.DataTransferServiceSettings
@Generated("by gapic-generator-java")
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](https://cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.retrying.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](https://docs.cloud.google.com/java/docs/client-retries) 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();
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classBuilder for DataTransferServiceSettings. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedDataTransferServiceSettings(DataTransferServiceSettings.Builder settingsBuilder) -
Method Summary
Modifier and TypeMethodDescriptionstatic final DataTransferServiceSettingsReturns the object with the settings used for calls to createDestination.Returns the object with the settings used for calls to createDestination.OperationCallSettings<CreateMulticloudDataTransferConfigRequest,MulticloudDataTransferConfig, OperationMetadata> Returns the object with the settings used for calls to createMulticloudDataTransferConfig.Returns the object with the settings used for calls to createMulticloudDataTransferConfig.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 ChannelProvider for this service.static TransportChannelProviderOperationCallSettings<DeleteDestinationRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to deleteDestination.Returns the object with the settings used for calls to deleteDestination.OperationCallSettings<DeleteMulticloudDataTransferConfigRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to deleteMulticloudDataTransferConfig.Returns the object with the settings used for calls to deleteMulticloudDataTransferConfig.static StringReturns the default service endpoint.Returns the default service scopes.Returns the object with the settings used for calls to getDestination.Returns the object with the settings used for calls to getIamPolicy.Returns the object with the settings used for calls to getLocation.Returns the object with the settings used for calls to getMulticloudDataTransferConfig.UnaryCallSettings<GetMulticloudDataTransferSupportedServiceRequest,MulticloudDataTransferSupportedService> Returns the object with the settings used for calls to getMulticloudDataTransferSupportedService.PagedCallSettings<ListDestinationsRequest,ListDestinationsResponse, DataTransferServiceClient.ListDestinationsPagedResponse> Returns the object with the settings used for calls to listDestinations.PagedCallSettings<ListLocationsRequest,ListLocationsResponse, DataTransferServiceClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations.PagedCallSettings<ListMulticloudDataTransferConfigsRequest,ListMulticloudDataTransferConfigsResponse, DataTransferServiceClient.ListMulticloudDataTransferConfigsPagedResponse> Returns the object with the settings used for calls to listMulticloudDataTransferConfigs.PagedCallSettings<ListMulticloudDataTransferSupportedServicesRequest,ListMulticloudDataTransferSupportedServicesResponse, DataTransferServiceClient.ListMulticloudDataTransferSupportedServicesPagedResponse> Returns the object with the settings used for calls to listMulticloudDataTransferSupportedServices.Returns a new builder for this class.newBuilder(ClientContext clientContext) Returns a new builder for this class.Returns the object with the settings used for calls to setIamPolicy.Returns the object with the settings used for calls to testIamPermissions.Returns a builder containing all the values of this settings class.Returns the object with the settings used for calls to updateDestination.Returns the object with the settings used for calls to updateDestination.OperationCallSettings<UpdateMulticloudDataTransferConfigRequest,MulticloudDataTransferConfig, OperationMetadata> Returns the object with the settings used for calls to updateMulticloudDataTransferConfig.Returns the object with the settings used for calls to updateMulticloudDataTransferConfig.Methods inherited from class com.google.api.gax.rpc.ClientSettings
getApiKey, getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getQuotaProjectId, getStubSettings, getTransportChannelProvider, getUniverseDomain, getWatchdogCheckInterval, getWatchdogCheckIntervalDuration, getWatchdogProvider, toString
-
Constructor Details
-
DataTransferServiceSettings
protected DataTransferServiceSettings(DataTransferServiceSettings.Builder settingsBuilder) throws IOException - Throws:
IOException
-
-
Method Details
-
listMulticloudDataTransferConfigsSettings
public PagedCallSettings<ListMulticloudDataTransferConfigsRequest,ListMulticloudDataTransferConfigsResponse, listMulticloudDataTransferConfigsSettings()DataTransferServiceClient.ListMulticloudDataTransferConfigsPagedResponse> Returns the object with the settings used for calls to listMulticloudDataTransferConfigs. -
getMulticloudDataTransferConfigSettings
public UnaryCallSettings<GetMulticloudDataTransferConfigRequest,MulticloudDataTransferConfig> getMulticloudDataTransferConfigSettings()Returns the object with the settings used for calls to getMulticloudDataTransferConfig. -
createMulticloudDataTransferConfigSettings
public UnaryCallSettings<CreateMulticloudDataTransferConfigRequest,Operation> createMulticloudDataTransferConfigSettings()Returns the object with the settings used for calls to createMulticloudDataTransferConfig. -
createMulticloudDataTransferConfigOperationSettings
public OperationCallSettings<CreateMulticloudDataTransferConfigRequest,MulticloudDataTransferConfig, createMulticloudDataTransferConfigOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createMulticloudDataTransferConfig. -
updateMulticloudDataTransferConfigSettings
public UnaryCallSettings<UpdateMulticloudDataTransferConfigRequest,Operation> updateMulticloudDataTransferConfigSettings()Returns the object with the settings used for calls to updateMulticloudDataTransferConfig. -
updateMulticloudDataTransferConfigOperationSettings
public OperationCallSettings<UpdateMulticloudDataTransferConfigRequest,MulticloudDataTransferConfig, updateMulticloudDataTransferConfigOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateMulticloudDataTransferConfig. -
deleteMulticloudDataTransferConfigSettings
public UnaryCallSettings<DeleteMulticloudDataTransferConfigRequest,Operation> deleteMulticloudDataTransferConfigSettings()Returns the object with the settings used for calls to deleteMulticloudDataTransferConfig. -
deleteMulticloudDataTransferConfigOperationSettings
public OperationCallSettings<DeleteMulticloudDataTransferConfigRequest,com.google.protobuf.Empty, deleteMulticloudDataTransferConfigOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteMulticloudDataTransferConfig. -
listDestinationsSettings
public PagedCallSettings<ListDestinationsRequest,ListDestinationsResponse, listDestinationsSettings()DataTransferServiceClient.ListDestinationsPagedResponse> Returns the object with the settings used for calls to listDestinations. -
getDestinationSettings
Returns the object with the settings used for calls to getDestination. -
createDestinationSettings
Returns the object with the settings used for calls to createDestination. -
createDestinationOperationSettings
public OperationCallSettings<CreateDestinationRequest,Destination, createDestinationOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createDestination. -
updateDestinationSettings
Returns the object with the settings used for calls to updateDestination. -
updateDestinationOperationSettings
public OperationCallSettings<UpdateDestinationRequest,Destination, updateDestinationOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateDestination. -
deleteDestinationSettings
Returns the object with the settings used for calls to deleteDestination. -
deleteDestinationOperationSettings
public OperationCallSettings<DeleteDestinationRequest,com.google.protobuf.Empty, deleteDestinationOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteDestination. -
getMulticloudDataTransferSupportedServiceSettings
public UnaryCallSettings<GetMulticloudDataTransferSupportedServiceRequest,MulticloudDataTransferSupportedService> getMulticloudDataTransferSupportedServiceSettings()Returns the object with the settings used for calls to getMulticloudDataTransferSupportedService. -
listMulticloudDataTransferSupportedServicesSettings
public PagedCallSettings<ListMulticloudDataTransferSupportedServicesRequest,ListMulticloudDataTransferSupportedServicesResponse, listMulticloudDataTransferSupportedServicesSettings()DataTransferServiceClient.ListMulticloudDataTransferSupportedServicesPagedResponse> Returns the object with the settings used for calls to listMulticloudDataTransferSupportedServices. -
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. -
setIamPolicySettings
Returns the object with the settings used for calls to setIamPolicy. -
getIamPolicySettings
Returns the object with the settings used for calls to getIamPolicy. -
testIamPermissionsSettings
public UnaryCallSettings<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsSettings()Returns the object with the settings used for calls to testIamPermissions. -
create
public static final DataTransferServiceSettings create(DataTransferServiceStubSettings stub) throws IOException - Throws:
IOException
-
defaultExecutorProviderBuilder
Returns a builder for the default ExecutorProvider for this service. -
getDefaultEndpoint
Returns the default 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 ChannelProvider for this service. -
defaultTransportChannelProvider
-
defaultApiClientHeaderProviderBuilder
-
newBuilder
Returns a new 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 classClientSettings<DataTransferServiceSettings>
-