Class MigrationServiceSettings
java.lang.Object
com.google.api.gax.rpc.ClientSettings<MigrationServiceSettings>
com.google.cloud.bigquery.migration.v2alpha.MigrationServiceSettings
@BetaApi
@Generated("by gapic-generator-java")
public class MigrationServiceSettings
extends ClientSettings<MigrationServiceSettings>
Settings class to configure an instance of
MigrationServiceClient.
The default instance has everything set to sensible defaults:
- The default service address (bigquerymigration.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 createMigrationWorkflow:
// 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
MigrationServiceSettings.Builder migrationServiceSettingsBuilder =
MigrationServiceSettings.newBuilder();
migrationServiceSettingsBuilder
.createMigrationWorkflowSettings()
.setRetrySettings(
migrationServiceSettingsBuilder
.createMigrationWorkflowSettings()
.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());
MigrationServiceSettings migrationServiceSettings = migrationServiceSettingsBuilder.build();
Please refer to the [Client Side Retry
Guide](https://docs.cloud.google.com/java/docs/client-retries) for additional support in setting
retries.-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classBuilder for MigrationServiceSettings. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedMigrationServiceSettings(MigrationServiceSettings.Builder settingsBuilder) -
Method Summary
Modifier and TypeMethodDescriptionstatic final MigrationServiceSettingsReturns the object with the settings used for calls to createMigrationWorkflow.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<DeleteMigrationWorkflowRequest,com.google.protobuf.Empty> Returns the object with the settings used for calls to deleteMigrationWorkflow.static StringReturns the default service endpoint.Returns the default service scopes.Returns the object with the settings used for calls to getMigrationSubtask.Returns the object with the settings used for calls to getMigrationWorkflow.PagedCallSettings<ListMigrationSubtasksRequest,ListMigrationSubtasksResponse, MigrationServiceClient.ListMigrationSubtasksPagedResponse> Returns the object with the settings used for calls to listMigrationSubtasks.PagedCallSettings<ListMigrationWorkflowsRequest,ListMigrationWorkflowsResponse, MigrationServiceClient.ListMigrationWorkflowsPagedResponse> Returns the object with the settings used for calls to listMigrationWorkflows.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<StartMigrationWorkflowRequest,com.google.protobuf.Empty> Returns the object with the settings used for calls to startMigrationWorkflow.Returns a builder containing all the values of this settings class.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
-
MigrationServiceSettings
protected MigrationServiceSettings(MigrationServiceSettings.Builder settingsBuilder) throws IOException - Throws:
IOException
-
-
Method Details
-
createMigrationWorkflowSettings
public UnaryCallSettings<CreateMigrationWorkflowRequest,MigrationWorkflow> createMigrationWorkflowSettings()Returns the object with the settings used for calls to createMigrationWorkflow. -
getMigrationWorkflowSettings
public UnaryCallSettings<GetMigrationWorkflowRequest,MigrationWorkflow> getMigrationWorkflowSettings()Returns the object with the settings used for calls to getMigrationWorkflow. -
listMigrationWorkflowsSettings
public PagedCallSettings<ListMigrationWorkflowsRequest,ListMigrationWorkflowsResponse, listMigrationWorkflowsSettings()MigrationServiceClient.ListMigrationWorkflowsPagedResponse> Returns the object with the settings used for calls to listMigrationWorkflows. -
deleteMigrationWorkflowSettings
public UnaryCallSettings<DeleteMigrationWorkflowRequest,com.google.protobuf.Empty> deleteMigrationWorkflowSettings()Returns the object with the settings used for calls to deleteMigrationWorkflow. -
startMigrationWorkflowSettings
public UnaryCallSettings<StartMigrationWorkflowRequest,com.google.protobuf.Empty> startMigrationWorkflowSettings()Returns the object with the settings used for calls to startMigrationWorkflow. -
getMigrationSubtaskSettings
Returns the object with the settings used for calls to getMigrationSubtask. -
listMigrationSubtasksSettings
public PagedCallSettings<ListMigrationSubtasksRequest,ListMigrationSubtasksResponse, listMigrationSubtasksSettings()MigrationServiceClient.ListMigrationSubtasksPagedResponse> Returns the object with the settings used for calls to listMigrationSubtasks. -
create
public static final MigrationServiceSettings create(MigrationServiceStubSettings 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 gRPC ChannelProvider for this service. -
defaultHttpJsonTransportProviderBuilder
@BetaApi public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()Returns a builder for the default REST ChannelProvider for this service. -
defaultTransportChannelProvider
-
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 classClientSettings<MigrationServiceSettings>
-