- 1.53.0 (latest)
- 1.52.0
- 1.51.0
- 1.49.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.37.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.24.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.9.0
- 1.8.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.0.4
public class StorageTransferServiceSettings extends ClientSettings<StorageTransferServiceSettings>Settings class to configure an instance of StorageTransferServiceClient.
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 total timeout of getGoogleServiceAccount 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
StorageTransferServiceSettings.Builder storageTransferServiceSettingsBuilder =
StorageTransferServiceSettings.newBuilder();
storageTransferServiceSettingsBuilder
.getGoogleServiceAccountSettings()
.setRetrySettings(
storageTransferServiceSettingsBuilder
.getGoogleServiceAccountSettings()
.getRetrySettings()
.toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
StorageTransferServiceSettings storageTransferServiceSettings =
storageTransferServiceSettingsBuilder.build();
Static Methods
create(StorageTransferServiceStubSettings stub)
public static final StorageTransferServiceSettings create(StorageTransferServiceStubSettings stub)| Parameter | |
|---|---|
| Name | Description |
stub |
StorageTransferServiceStubSettings |
| Returns | |
|---|---|
| Type | Description |
StorageTransferServiceSettings |
|
| 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 gRPC ChannelProvider for this service.
| Returns | |
|---|---|
| Type | Description |
Builder |
|
defaultHttpJsonTransportProviderBuilder()
public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()Returns a builder for the default REST 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 StorageTransferServiceSettings.Builder newBuilder()Returns a new gRPC builder for this class.
| Returns | |
|---|---|
| Type | Description |
StorageTransferServiceSettings.Builder |
|
newBuilder(ClientContext clientContext)
public static StorageTransferServiceSettings.Builder newBuilder(ClientContext clientContext)Returns a new builder for this class.
| Parameter | |
|---|---|
| Name | Description |
clientContext |
ClientContext |
| Returns | |
|---|---|
| Type | Description |
StorageTransferServiceSettings.Builder |
|
newHttpJsonBuilder()
public static StorageTransferServiceSettings.Builder newHttpJsonBuilder()Returns a new REST builder for this class.
| Returns | |
|---|---|
| Type | Description |
StorageTransferServiceSettings.Builder |
|
Constructors
StorageTransferServiceSettings(StorageTransferServiceSettings.Builder settingsBuilder)
protected StorageTransferServiceSettings(StorageTransferServiceSettings.Builder settingsBuilder)| Parameter | |
|---|---|
| Name | Description |
settingsBuilder |
StorageTransferServiceSettings.Builder |
Methods
createAgentPoolSettings()
public UnaryCallSettings<TransferProto.CreateAgentPoolRequest,TransferTypes.AgentPool> createAgentPoolSettings()Returns the object with the settings used for calls to createAgentPool.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<CreateAgentPoolRequest,AgentPool> |
|
createTransferJobSettings()
public UnaryCallSettings<TransferProto.CreateTransferJobRequest,TransferTypes.TransferJob> createTransferJobSettings()Returns the object with the settings used for calls to createTransferJob.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<CreateTransferJobRequest,TransferJob> |
|
deleteAgentPoolSettings()
public UnaryCallSettings<TransferProto.DeleteAgentPoolRequest,Empty> deleteAgentPoolSettings()Returns the object with the settings used for calls to deleteAgentPool.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<DeleteAgentPoolRequest,Empty> |
|
deleteTransferJobSettings()
public UnaryCallSettings<TransferProto.DeleteTransferJobRequest,Empty> deleteTransferJobSettings()Returns the object with the settings used for calls to deleteTransferJob.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<DeleteTransferJobRequest,Empty> |
|
getAgentPoolSettings()
public UnaryCallSettings<TransferProto.GetAgentPoolRequest,TransferTypes.AgentPool> getAgentPoolSettings()Returns the object with the settings used for calls to getAgentPool.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<GetAgentPoolRequest,AgentPool> |
|
getGoogleServiceAccountSettings()
public UnaryCallSettings<TransferProto.GetGoogleServiceAccountRequest,TransferTypes.GoogleServiceAccount> getGoogleServiceAccountSettings()Returns the object with the settings used for calls to getGoogleServiceAccount.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<GetGoogleServiceAccountRequest,GoogleServiceAccount> |
|
getTransferJobSettings()
public UnaryCallSettings<TransferProto.GetTransferJobRequest,TransferTypes.TransferJob> getTransferJobSettings()Returns the object with the settings used for calls to getTransferJob.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<GetTransferJobRequest,TransferJob> |
|
listAgentPoolsSettings()
public PagedCallSettings<TransferProto.ListAgentPoolsRequest,TransferProto.ListAgentPoolsResponse,StorageTransferServiceClient.ListAgentPoolsPagedResponse> listAgentPoolsSettings()Returns the object with the settings used for calls to listAgentPools.
| Returns | |
|---|---|
| Type | Description |
PagedCallSettings<ListAgentPoolsRequest,ListAgentPoolsResponse,ListAgentPoolsPagedResponse> |
|
listTransferJobsSettings()
public PagedCallSettings<TransferProto.ListTransferJobsRequest,TransferProto.ListTransferJobsResponse,StorageTransferServiceClient.ListTransferJobsPagedResponse> listTransferJobsSettings()Returns the object with the settings used for calls to listTransferJobs.
| Returns | |
|---|---|
| Type | Description |
PagedCallSettings<ListTransferJobsRequest,ListTransferJobsResponse,ListTransferJobsPagedResponse> |
|
pauseTransferOperationSettings()
public UnaryCallSettings<TransferProto.PauseTransferOperationRequest,Empty> pauseTransferOperationSettings()Returns the object with the settings used for calls to pauseTransfer.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<PauseTransferOperationRequest,Empty> |
|
resumeTransferOperationSettings()
public UnaryCallSettings<TransferProto.ResumeTransferOperationRequest,Empty> resumeTransferOperationSettings()Returns the object with the settings used for calls to resumeTransfer.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<ResumeTransferOperationRequest,Empty> |
|
runTransferJobOperationSettings()
public OperationCallSettings<TransferProto.RunTransferJobRequest,Empty,TransferTypes.TransferOperation> runTransferJobOperationSettings()Returns the object with the settings used for calls to runTransferJob.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<RunTransferJobRequest,Empty,TransferOperation> |
|
runTransferJobSettings()
public UnaryCallSettings<TransferProto.RunTransferJobRequest,Operation> runTransferJobSettings()Returns the object with the settings used for calls to runTransferJob.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<RunTransferJobRequest,Operation> |
|
toBuilder()
public StorageTransferServiceSettings.Builder toBuilder()Returns a builder containing all the values of this settings class.
| Returns | |
|---|---|
| Type | Description |
StorageTransferServiceSettings.Builder |
|
updateAgentPoolSettings()
public UnaryCallSettings<TransferProto.UpdateAgentPoolRequest,TransferTypes.AgentPool> updateAgentPoolSettings()Returns the object with the settings used for calls to updateAgentPool.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<UpdateAgentPoolRequest,AgentPool> |
|
updateTransferJobSettings()
public UnaryCallSettings<TransferProto.UpdateTransferJobRequest,TransferTypes.TransferJob> updateTransferJobSettings()Returns the object with the settings used for calls to updateTransferJob.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<UpdateTransferJobRequest,TransferJob> |
|