Reference documentation and code samples for the Cloud Database Migration Service API module Google::Cloud::CloudDMS.
Methods
.configure
defself.configure()->::Google::Cloud::Config
Configure the google-cloud-cloud_dms library.
The following configuration parameters are supported:
credentials (type:String, Hash, Google::Auth::Credentials) -
The path to the keyfile as a String, the contents of the keyfile as a
Hash, or a Google::Auth::Credentials object.
lib_name (type:String) -
The library name as recorded in instrumentation and logging.
lib_version (type:String) -
The library version as recorded in instrumentation and logging.
interceptors (type:Array<GRPC::ClientInterceptor>) -
An array of interceptors that are run before calls are executed.
timeout (type:Numeric) -
Default timeout in seconds.
metadata (type:Hash{Symbol=>String}) -
Additional headers to be sent with the call.
retry_policy (type:Hash) -
The retry policy. The value is a hash with the following keys:
:initial_delay (type:Numeric) - The initial delay in seconds.
:max_delay (type:Numeric) - The max delay in seconds.
:multiplier (type:Numeric) - The incremental backoff multiplier.
:retry_codes (type:Array<String>) -
The error codes that should trigger a retry.
Yields
(::Google::Cloud.configure.cloud_dms)
Returns
(::Google::Cloud::Config) — The default configuration used by this library
Create a new client object for DataMigrationService.
By default, this returns an instance of
Google::Cloud::CloudDMS::V1::DataMigrationService::Client
for a gRPC client for version V1 of the API.
However, you can specify a different API version by passing it in the
version parameter. If the DataMigrationService service is
supported by that API version, and the corresponding gem is available, the
appropriate versioned client will be returned.
Raises an exception if the currently installed versioned client gem for the
given API version does not support the DataMigrationService service.
You can determine whether the method will succeed by calling
CloudDMS.data_migration_service_available?.
About DataMigrationService
Database Migration service
Parameter
version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional.
Defaults to :v1.
Returns
(::Object) — A client object for the specified version.
Determines whether the DataMigrationService service is supported by the current client.
If true, you can retrieve a client object by calling CloudDMS.data_migration_service.
If false, that method will raise an exception. This could happen if the given
API version does not exist or does not support the DataMigrationService service,
or if the versioned client gem needs an update to support the DataMigrationService service.
Parameter
version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional.
Defaults to :v1.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# Cloud Database Migration Service API - Module Google::Cloud::CloudDMS (v1.4.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.4.1 (latest)](/ruby/docs/reference/google-cloud-cloud_dms/latest/Google-Cloud-CloudDMS)\n- [1.4.0](/ruby/docs/reference/google-cloud-cloud_dms/1.4.0/Google-Cloud-CloudDMS)\n- [1.3.1](/ruby/docs/reference/google-cloud-cloud_dms/1.3.1/Google-Cloud-CloudDMS)\n- [1.2.0](/ruby/docs/reference/google-cloud-cloud_dms/1.2.0/Google-Cloud-CloudDMS)\n- [1.1.0](/ruby/docs/reference/google-cloud-cloud_dms/1.1.0/Google-Cloud-CloudDMS)\n- [1.0.1](/ruby/docs/reference/google-cloud-cloud_dms/1.0.1/Google-Cloud-CloudDMS) \nReference documentation and code samples for the Cloud Database Migration Service API module Google::Cloud::CloudDMS.\n\nMethods\n-------\n\n### .configure\n\n def self.configure() -\u003e ::Google::Cloud::Config\n\nConfigure the google-cloud-cloud_dms library.\n\nThe following configuration parameters are supported:\n\n- `credentials` (*type:* `String, Hash, Google::Auth::Credentials`) - The path to the keyfile as a String, the contents of the keyfile as a Hash, or a Google::Auth::Credentials object.\n- `lib_name` (*type:* `String`) - The library name as recorded in instrumentation and logging.\n- `lib_version` (*type:* `String`) - The library version as recorded in instrumentation and logging.\n- `interceptors` (*type:* `Array\u003cGRPC::ClientInterceptor\u003e`) - An array of interceptors that are run before calls are executed.\n- `timeout` (*type:* `Numeric`) - Default timeout in seconds.\n- `metadata` (*type:* `Hash{Symbol=\u003eString}`) - Additional headers to be sent with the call.\n- `retry_policy` (*type:* `Hash`) - The retry policy. The value is a hash with the following keys:\n - `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.\n - `:max_delay` (*type:* `Numeric`) - The max delay in seconds.\n - `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.\n- `:retry_codes` (*type:* `Array\u003cString\u003e`) - The error codes that should trigger a retry. \n**Yields**\n\n- (::Google::Cloud.configure.cloud_dms) \n**Returns**\n\n- (::Google::Cloud::Config) --- The default configuration used by this library\n\n### .data_migration_service\n\n def self.data_migration_service(version: :v1, &block) -\u003e ::Object\n\nCreate a new client object for DataMigrationService.\n\n\nBy default, this returns an instance of\n[Google::Cloud::CloudDMS::V1::DataMigrationService::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-cloud_dms-v1/latest/Google-Cloud-CloudDMS-V1-DataMigrationService-Client)\nfor a gRPC client for version V1 of the API.\nHowever, you can specify a different API version by passing it in the\n`version` parameter. If the DataMigrationService service is\nsupported by that API version, and the corresponding gem is available, the\nappropriate versioned client will be returned.\n\n\u003cbr /\u003e\n\nRaises an exception if the currently installed versioned client gem for the\ngiven API version does not support the DataMigrationService service.\nYou can determine whether the method will succeed by calling\n[CloudDMS.data_migration_service_available?](/ruby/docs/reference/google-cloud-cloud_dms/latest/Google-Cloud-CloudDMS#Google__Cloud__CloudDMS_data_migration_service_available__class_ \"Google::Cloud::CloudDMS.data_migration_service_available? (method)\").\n\n#### About DataMigrationService\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\nDatabase Migration service \n**Parameter**\n\n- **version** (::String, ::Symbol) *(defaults to: :v1)* --- The API version to connect to. Optional. Defaults to `:v1`. \n**Returns**\n\n- (::Object) --- A client object for the specified version.\n\n### .data_migration_service_available?\n\n def self.data_migration_service_available?(version: :v1) -\u003e boolean\n\nDetermines whether the DataMigrationService service is supported by the current client.\nIf true, you can retrieve a client object by calling [CloudDMS.data_migration_service](/ruby/docs/reference/google-cloud-cloud_dms/latest/Google-Cloud-CloudDMS#Google__Cloud__CloudDMS_data_migration_service_class_ \"Google::Cloud::CloudDMS.data_migration_service (method)\").\nIf false, that method will raise an exception. This could happen if the given\nAPI version does not exist or does not support the DataMigrationService service,\nor if the versioned client gem needs an update to support the DataMigrationService service. \n**Parameter**\n\n- **version** (::String, ::Symbol) *(defaults to: :v1)* --- The API version to connect to. Optional. Defaults to `:v1`. \n**Returns**\n\n- (boolean) --- Whether the service is available.\n\nConstants\n---------\n\n### VERSION\n\n**value:**\"1.4.1\""]]
