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 com.google.api.gax.rpc.StubSettings<StorageTransferServiceStubSettings>
Settings class to configure an instance ofStorageTransferServiceStub
.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 StorageTransferServiceStubSettings.Builder storageTransferServiceSettingsBuilder = StorageTransferServiceStubSettings.newBuilder(); storageTransferServiceSettingsBuilder .getGoogleServiceAccountSettings() .setRetrySettings( storageTransferServiceSettingsBuilder .getGoogleServiceAccountSettings() .getRetrySettings() .toBuilder() .setTotalTimeout(Duration.ofSeconds(30)) .build()); StorageTransferServiceStubSettings storageTransferServiceSettings = storageTransferServiceSettingsBuilder.build();
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
StorageTransferServiceStubSettings.Builder
Builder for StorageTransferServiceStubSettings.
-
Constructor Summary
Constructors Modifier Constructor Description protected
StorageTransferServiceStubSettings(StorageTransferServiceStubSettings.Builder settingsBuilder)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description com.google.api.gax.rpc.UnaryCallSettings<TransferProto.CreateAgentPoolRequest,TransferTypes.AgentPool>
createAgentPoolSettings()
Returns the object with the settings used for calls to createAgentPool.StorageTransferServiceStub
createStub()
com.google.api.gax.rpc.UnaryCallSettings<TransferProto.CreateTransferJobRequest,TransferTypes.TransferJob>
createTransferJobSettings()
Returns the object with the settings used for calls to createTransferJob.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.rpc.ApiClientHeaderProvider.Builder
defaultGrpcApiClientHeaderProviderBuilder()
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.rpc.ApiClientHeaderProvider.Builder
defaultHttpJsonApiClientHeaderProviderBuilder()
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<TransferProto.DeleteAgentPoolRequest,com.google.protobuf.Empty>
deleteAgentPoolSettings()
Returns the object with the settings used for calls to deleteAgentPool.com.google.api.gax.rpc.UnaryCallSettings<TransferProto.DeleteTransferJobRequest,com.google.protobuf.Empty>
deleteTransferJobSettings()
Returns the object with the settings used for calls to deleteTransferJob.com.google.api.gax.rpc.UnaryCallSettings<TransferProto.GetAgentPoolRequest,TransferTypes.AgentPool>
getAgentPoolSettings()
Returns the object with the settings used for calls to getAgentPool.static String
getDefaultEndpoint()
Returns the default service endpoint.static String
getDefaultMtlsEndpoint()
Returns the default mTLS service endpoint.static List<String>
getDefaultServiceScopes()
Returns the default service scopes.com.google.api.gax.rpc.UnaryCallSettings<TransferProto.GetGoogleServiceAccountRequest,TransferTypes.GoogleServiceAccount>
getGoogleServiceAccountSettings()
Returns the object with the settings used for calls to getGoogleServiceAccount.com.google.api.gax.rpc.UnaryCallSettings<TransferProto.GetTransferJobRequest,TransferTypes.TransferJob>
getTransferJobSettings()
Returns the object with the settings used for calls to getTransferJob.com.google.api.gax.rpc.PagedCallSettings<TransferProto.ListAgentPoolsRequest,TransferProto.ListAgentPoolsResponse,StorageTransferServiceClient.ListAgentPoolsPagedResponse>
listAgentPoolsSettings()
Returns the object with the settings used for calls to listAgentPools.com.google.api.gax.rpc.PagedCallSettings<TransferProto.ListTransferJobsRequest,TransferProto.ListTransferJobsResponse,StorageTransferServiceClient.ListTransferJobsPagedResponse>
listTransferJobsSettings()
Returns the object with the settings used for calls to listTransferJobs.static StorageTransferServiceStubSettings.Builder
newBuilder()
Returns a new gRPC builder for this class.static StorageTransferServiceStubSettings.Builder
newBuilder(com.google.api.gax.rpc.ClientContext clientContext)
Returns a new builder for this class.static StorageTransferServiceStubSettings.Builder
newHttpJsonBuilder()
Returns a new REST builder for this class.com.google.api.gax.rpc.UnaryCallSettings<TransferProto.PauseTransferOperationRequest,com.google.protobuf.Empty>
pauseTransferOperationSettings()
Returns the object with the settings used for calls to pauseTransfer.com.google.api.gax.rpc.UnaryCallSettings<TransferProto.ResumeTransferOperationRequest,com.google.protobuf.Empty>
resumeTransferOperationSettings()
Returns the object with the settings used for calls to resumeTransfer.com.google.api.gax.rpc.OperationCallSettings<TransferProto.RunTransferJobRequest,com.google.protobuf.Empty,TransferTypes.TransferOperation>
runTransferJobOperationSettings()
Returns the object with the settings used for calls to runTransferJob.com.google.api.gax.rpc.UnaryCallSettings<TransferProto.RunTransferJobRequest,com.google.longrunning.Operation>
runTransferJobSettings()
Returns the object with the settings used for calls to runTransferJob.StorageTransferServiceStubSettings.Builder
toBuilder()
Returns a builder containing all the values of this settings class.com.google.api.gax.rpc.UnaryCallSettings<TransferProto.UpdateAgentPoolRequest,TransferTypes.AgentPool>
updateAgentPoolSettings()
Returns the object with the settings used for calls to updateAgentPool.com.google.api.gax.rpc.UnaryCallSettings<TransferProto.UpdateTransferJobRequest,TransferTypes.TransferJob>
updateTransferJobSettings()
Returns the object with the settings used for calls to updateTransferJob.-
Methods inherited from class com.google.api.gax.rpc.StubSettings
getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getMtlsEndpoint, getQuotaProjectId, getStreamWatchdogCheckInterval, getStreamWatchdogProvider, getTracerFactory, getTransportChannelProvider, toString
-
-
-
-
Constructor Detail
-
StorageTransferServiceStubSettings
protected StorageTransferServiceStubSettings(StorageTransferServiceStubSettings.Builder settingsBuilder) throws IOException
- Throws:
IOException
-
-
Method Detail
-
getGoogleServiceAccountSettings
public com.google.api.gax.rpc.UnaryCallSettings<TransferProto.GetGoogleServiceAccountRequest,TransferTypes.GoogleServiceAccount> getGoogleServiceAccountSettings()
Returns the object with the settings used for calls to getGoogleServiceAccount.
-
createTransferJobSettings
public com.google.api.gax.rpc.UnaryCallSettings<TransferProto.CreateTransferJobRequest,TransferTypes.TransferJob> createTransferJobSettings()
Returns the object with the settings used for calls to createTransferJob.
-
updateTransferJobSettings
public com.google.api.gax.rpc.UnaryCallSettings<TransferProto.UpdateTransferJobRequest,TransferTypes.TransferJob> updateTransferJobSettings()
Returns the object with the settings used for calls to updateTransferJob.
-
getTransferJobSettings
public com.google.api.gax.rpc.UnaryCallSettings<TransferProto.GetTransferJobRequest,TransferTypes.TransferJob> getTransferJobSettings()
Returns the object with the settings used for calls to getTransferJob.
-
listTransferJobsSettings
public com.google.api.gax.rpc.PagedCallSettings<TransferProto.ListTransferJobsRequest,TransferProto.ListTransferJobsResponse,StorageTransferServiceClient.ListTransferJobsPagedResponse> listTransferJobsSettings()
Returns the object with the settings used for calls to listTransferJobs.
-
pauseTransferOperationSettings
public com.google.api.gax.rpc.UnaryCallSettings<TransferProto.PauseTransferOperationRequest,com.google.protobuf.Empty> pauseTransferOperationSettings()
Returns the object with the settings used for calls to pauseTransfer.
-
resumeTransferOperationSettings
public com.google.api.gax.rpc.UnaryCallSettings<TransferProto.ResumeTransferOperationRequest,com.google.protobuf.Empty> resumeTransferOperationSettings()
Returns the object with the settings used for calls to resumeTransfer.
-
runTransferJobSettings
public com.google.api.gax.rpc.UnaryCallSettings<TransferProto.RunTransferJobRequest,com.google.longrunning.Operation> runTransferJobSettings()
Returns the object with the settings used for calls to runTransferJob.
-
runTransferJobOperationSettings
public com.google.api.gax.rpc.OperationCallSettings<TransferProto.RunTransferJobRequest,com.google.protobuf.Empty,TransferTypes.TransferOperation> runTransferJobOperationSettings()
Returns the object with the settings used for calls to runTransferJob.
-
deleteTransferJobSettings
public com.google.api.gax.rpc.UnaryCallSettings<TransferProto.DeleteTransferJobRequest,com.google.protobuf.Empty> deleteTransferJobSettings()
Returns the object with the settings used for calls to deleteTransferJob.
-
createAgentPoolSettings
public com.google.api.gax.rpc.UnaryCallSettings<TransferProto.CreateAgentPoolRequest,TransferTypes.AgentPool> createAgentPoolSettings()
Returns the object with the settings used for calls to createAgentPool.
-
updateAgentPoolSettings
public com.google.api.gax.rpc.UnaryCallSettings<TransferProto.UpdateAgentPoolRequest,TransferTypes.AgentPool> updateAgentPoolSettings()
Returns the object with the settings used for calls to updateAgentPool.
-
getAgentPoolSettings
public com.google.api.gax.rpc.UnaryCallSettings<TransferProto.GetAgentPoolRequest,TransferTypes.AgentPool> getAgentPoolSettings()
Returns the object with the settings used for calls to getAgentPool.
-
listAgentPoolsSettings
public com.google.api.gax.rpc.PagedCallSettings<TransferProto.ListAgentPoolsRequest,TransferProto.ListAgentPoolsResponse,StorageTransferServiceClient.ListAgentPoolsPagedResponse> listAgentPoolsSettings()
Returns the object with the settings used for calls to listAgentPools.
-
deleteAgentPoolSettings
public com.google.api.gax.rpc.UnaryCallSettings<TransferProto.DeleteAgentPoolRequest,com.google.protobuf.Empty> deleteAgentPoolSettings()
Returns the object with the settings used for calls to deleteAgentPool.
-
createStub
public StorageTransferServiceStub createStub() 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.
-
getDefaultMtlsEndpoint
public static String getDefaultMtlsEndpoint()
Returns the default mTLS 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()
-
defaultGrpcApiClientHeaderProviderBuilder
@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 defaultGrpcApiClientHeaderProviderBuilder()
-
defaultHttpJsonApiClientHeaderProviderBuilder
@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 defaultHttpJsonApiClientHeaderProviderBuilder()
-
defaultApiClientHeaderProviderBuilder
public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
-
newBuilder
public static StorageTransferServiceStubSettings.Builder newBuilder()
Returns a new gRPC builder for this class.
-
newHttpJsonBuilder
public static StorageTransferServiceStubSettings.Builder newHttpJsonBuilder()
Returns a new REST builder for this class.
-
newBuilder
public static StorageTransferServiceStubSettings.Builder newBuilder(com.google.api.gax.rpc.ClientContext clientContext)
Returns a new builder for this class.
-
toBuilder
public StorageTransferServiceStubSettings.Builder toBuilder()
Returns a builder containing all the values of this settings class.- Specified by:
toBuilder
in classcom.google.api.gax.rpc.StubSettings<StorageTransferServiceStubSettings>
-
-