Class StorageTransferServiceStubSettings
java.lang.Object
com.google.api.gax.rpc.StubSettings<StorageTransferServiceStubSettings>
com.google.storagetransfer.v1.proto.stub.StorageTransferServiceStubSettings
@Generated("by gapic-generator-java")
public class StorageTransferServiceStubSettings
extends StubSettings<StorageTransferServiceStubSettings>
Settings class to configure an instance of
StorageTransferServiceStub.
The default instance has everything set to sensible defaults:
- The default service address (storagetransfer.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 getGoogleServiceAccount:
// 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
StorageTransferServiceStubSettings.Builder storageTransferServiceSettingsBuilder =
StorageTransferServiceStubSettings.newBuilder();
storageTransferServiceSettingsBuilder
.getGoogleServiceAccountSettings()
.setRetrySettings(
storageTransferServiceSettingsBuilder
.getGoogleServiceAccountSettings()
.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());
StorageTransferServiceStubSettings storageTransferServiceSettings =
storageTransferServiceSettingsBuilder.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 runTransferJob:
// 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
StorageTransferServiceStubSettings.Builder storageTransferServiceSettingsBuilder =
StorageTransferServiceStubSettings.newBuilder();
TimedRetryAlgorithm timedRetryAlgorithm =
OperationalTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelayDuration(Duration.ofMillis(500))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelayDuration(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
storageTransferServiceSettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classBuilder for StorageTransferServiceStubSettings. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected -
Method Summary
Modifier and TypeMethodDescriptionReturns the object with the settings used for calls to createAgentPool.Returns the object with the settings used for calls to createTransferJob.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 gRPC ChannelProvider for this service.Returns a builder for the default REST ChannelProvider for this service.static TransportChannelProviderUnaryCallSettings<TransferProto.DeleteAgentPoolRequest,com.google.protobuf.Empty> Returns the object with the settings used for calls to deleteAgentPool.UnaryCallSettings<TransferProto.DeleteTransferJobRequest,com.google.protobuf.Empty> Returns the object with the settings used for calls to deleteTransferJob.Returns the object with the settings used for calls to getAgentPool.static StringReturns the default service endpoint.static StringReturns the default mTLS service endpoint.Returns the default service scopes.Returns the object with the settings used for calls to getGoogleServiceAccount.protected LibraryMetadataReturns the default service name.Returns the object with the settings used for calls to getTransferJob.PagedCallSettings<TransferProto.ListAgentPoolsRequest,TransferProto.ListAgentPoolsResponse, StorageTransferServiceClient.ListAgentPoolsPagedResponse> Returns the object with the settings used for calls to listAgentPools.PagedCallSettings<TransferProto.ListTransferJobsRequest,TransferProto.ListTransferJobsResponse, StorageTransferServiceClient.ListTransferJobsPagedResponse> Returns the object with the settings used for calls to listTransferJobs.Returns a new gRPC builder for this class.newBuilder(ClientContext clientContext) Returns a new builder for this class.Returns a new REST builder for this class.UnaryCallSettings<TransferProto.PauseTransferOperationRequest,com.google.protobuf.Empty> Returns the object with the settings used for calls to pauseTransfer.UnaryCallSettings<TransferProto.ResumeTransferOperationRequest,com.google.protobuf.Empty> Returns the object with the settings used for calls to resumeTransfer.OperationCallSettings<TransferProto.RunTransferJobRequest,com.google.protobuf.Empty, TransferTypes.TransferOperation> Returns the object with the settings used for calls to runTransferJob.Returns the object with the settings used for calls to runTransferJob.Returns a builder containing all the values of this settings class.Returns the object with the settings used for calls to updateAgentPool.Returns the object with the settings used for calls to updateTransferJob.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
-
Constructor Details
-
StorageTransferServiceStubSettings
protected StorageTransferServiceStubSettings(StorageTransferServiceStubSettings.Builder settingsBuilder) throws IOException - Throws:
IOException
-
-
Method Details
-
getGoogleServiceAccountSettings
public UnaryCallSettings<TransferProto.GetGoogleServiceAccountRequest,TransferTypes.GoogleServiceAccount> getGoogleServiceAccountSettings()Returns the object with the settings used for calls to getGoogleServiceAccount. -
createTransferJobSettings
public UnaryCallSettings<TransferProto.CreateTransferJobRequest,TransferTypes.TransferJob> createTransferJobSettings()Returns the object with the settings used for calls to createTransferJob. -
updateTransferJobSettings
public UnaryCallSettings<TransferProto.UpdateTransferJobRequest,TransferTypes.TransferJob> updateTransferJobSettings()Returns the object with the settings used for calls to updateTransferJob. -
getTransferJobSettings
public UnaryCallSettings<TransferProto.GetTransferJobRequest,TransferTypes.TransferJob> getTransferJobSettings()Returns the object with the settings used for calls to getTransferJob. -
listTransferJobsSettings
public PagedCallSettings<TransferProto.ListTransferJobsRequest,TransferProto.ListTransferJobsResponse, listTransferJobsSettings()StorageTransferServiceClient.ListTransferJobsPagedResponse> Returns the object with the settings used for calls to listTransferJobs. -
pauseTransferOperationSettings
public UnaryCallSettings<TransferProto.PauseTransferOperationRequest,com.google.protobuf.Empty> pauseTransferOperationSettings()Returns the object with the settings used for calls to pauseTransfer. -
resumeTransferOperationSettings
public UnaryCallSettings<TransferProto.ResumeTransferOperationRequest,com.google.protobuf.Empty> resumeTransferOperationSettings()Returns the object with the settings used for calls to resumeTransfer. -
runTransferJobSettings
Returns the object with the settings used for calls to runTransferJob. -
runTransferJobOperationSettings
public OperationCallSettings<TransferProto.RunTransferJobRequest,com.google.protobuf.Empty, runTransferJobOperationSettings()TransferTypes.TransferOperation> Returns the object with the settings used for calls to runTransferJob. -
deleteTransferJobSettings
public UnaryCallSettings<TransferProto.DeleteTransferJobRequest,com.google.protobuf.Empty> deleteTransferJobSettings()Returns the object with the settings used for calls to deleteTransferJob. -
createAgentPoolSettings
public UnaryCallSettings<TransferProto.CreateAgentPoolRequest,TransferTypes.AgentPool> createAgentPoolSettings()Returns the object with the settings used for calls to createAgentPool. -
updateAgentPoolSettings
public UnaryCallSettings<TransferProto.UpdateAgentPoolRequest,TransferTypes.AgentPool> updateAgentPoolSettings()Returns the object with the settings used for calls to updateAgentPool. -
getAgentPoolSettings
public UnaryCallSettings<TransferProto.GetAgentPoolRequest,TransferTypes.AgentPool> getAgentPoolSettings()Returns the object with the settings used for calls to getAgentPool. -
listAgentPoolsSettings
public PagedCallSettings<TransferProto.ListAgentPoolsRequest,TransferProto.ListAgentPoolsResponse, listAgentPoolsSettings()StorageTransferServiceClient.ListAgentPoolsPagedResponse> Returns the object with the settings used for calls to listAgentPools. -
deleteAgentPoolSettings
public UnaryCallSettings<TransferProto.DeleteAgentPoolRequest,com.google.protobuf.Empty> deleteAgentPoolSettings()Returns the object with the settings used for calls to deleteAgentPool. -
createStub
- Throws:
IOException
-
getServiceName
Returns the default service name.- Overrides:
getServiceNamein classStubSettings<StorageTransferServiceStubSettings>
-
defaultExecutorProviderBuilder
Returns a builder for the default ExecutorProvider for this service. -
getDefaultEndpoint
Returns the default service endpoint. -
getDefaultMtlsEndpoint
Returns the default mTLS 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 gRPC ChannelProvider for this service. -
defaultHttpJsonTransportProviderBuilder
@BetaApi public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()Returns a builder for the default REST ChannelProvider for this service. -
defaultTransportChannelProvider
-
defaultGrpcApiClientHeaderProviderBuilder
-
defaultHttpJsonApiClientHeaderProviderBuilder
-
defaultApiClientHeaderProviderBuilder
-
newBuilder
Returns a new gRPC builder for this class. -
newHttpJsonBuilder
Returns a new REST 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 classStubSettings<StorageTransferServiceStubSettings>
-
getLibraryMetadata
- Overrides:
getLibraryMetadatain classStubSettings<StorageTransferServiceStubSettings>
-