DataMigrationServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.clouddms_v1.services.data_migration_service.transports.base.DataMigrationServiceTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)
Database Migration service
Properties
transport
Returns the transport used by the client instance.
Returns | |
---|---|
Type | Description |
DataMigrationServiceTransport | The transport used by the client instance. |
Methods
DataMigrationServiceClient
DataMigrationServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.clouddms_v1.services.data_migration_service.transports.base.DataMigrationServiceTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)
Instantiates the data migration service client.
Parameters | |
---|---|
Name | Description |
credentials |
Optional[google.auth.credentials.Credentials]
The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment. |
transport |
Union[str, DataMigrationServiceTransport]
The transport to use. If set to None, a transport is chosen automatically. |
client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. It won't take effect if a |
client_info |
google.api_core.gapic_v1.client_info.ClientInfo
The client info used to send a user-agent string along with API requests. If |
Exceptions | |
---|---|
Type | Description |
google.auth.exceptions.MutualTLSChannelError | If mutual TLS transport creation failed for any reason. |
__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
common_billing_account_path
common_billing_account_path(billing_account: str)
Returns a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str)
Returns a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str)
Returns a fully-qualified location string.
common_organization_path
common_organization_path(organization: str)
Returns a fully-qualified organization string.
common_project_path
common_project_path(project: str)
Returns a fully-qualified project string.
connection_profile_path
connection_profile_path(project: str, location: str, connection_profile: str)
Returns a fully-qualified connection_profile string.
create_connection_profile
create_connection_profile(request: Optional[Union[google.cloud.clouddms_v1.types.clouddms.CreateConnectionProfileRequest, dict]] = None, *, parent: Optional[str] = None, connection_profile: Optional[google.cloud.clouddms_v1.types.clouddms_resources.ConnectionProfile] = None, connection_profile_id: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Creates a new connection profile in a given project and location.
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.clouddms_v1.types.CreateConnectionProfileRequest, dict]
The request object. Request message for 'CreateConnectionProfile' request. |
parent |
str
Required. The parent, which owns this collection of connection profiles. This corresponds to the |
connection_profile |
google.cloud.clouddms_v1.types.ConnectionProfile
Required. The create request body including the connection profile data This corresponds to the |
connection_profile_id |
str
Required. The connection profile identifier. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.api_core.operation.Operation | An object representing a long-running operation. The result type for the operation will be ConnectionProfile A connection profile definition. |
create_migration_job
create_migration_job(request: Optional[Union[google.cloud.clouddms_v1.types.clouddms.CreateMigrationJobRequest, dict]] = None, *, parent: Optional[str] = None, migration_job: Optional[google.cloud.clouddms_v1.types.clouddms_resources.MigrationJob] = None, migration_job_id: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Creates a new migration job in a given project and location.
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.clouddms_v1.types.CreateMigrationJobRequest, dict]
The request object. Request message to create a new Database Migration Service migration job in the specified project and region. |
parent |
str
Required. The parent, which owns this collection of migration jobs. This corresponds to the |
migration_job |
google.cloud.clouddms_v1.types.MigrationJob
Required. Represents a |
migration_job_id |
str
Required. The ID of the instance to create. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.api_core.operation.Operation | An object representing a long-running operation. The result type for the operation will be MigrationJob Represents a Database Migration Service migration job object. |
delete_connection_profile
delete_connection_profile(request: Optional[Union[google.cloud.clouddms_v1.types.clouddms.DeleteConnectionProfileRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Deletes a single Database Migration Service connection profile. A connection profile can only be deleted if it is not in use by any active migration jobs.
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.clouddms_v1.types.DeleteConnectionProfileRequest, dict]
The request object. Request message for 'DeleteConnectionProfile' request. |
name |
str
Required. Name of the connection profile resource to delete. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.api_core.operation.Operation | An object representing a long-running operation. The result type for the operation will be google.protobuf.empty_pb2.Empty A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}. |
delete_migration_job
delete_migration_job(request: Optional[Union[google.cloud.clouddms_v1.types.clouddms.DeleteMigrationJobRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Deletes a single migration job.
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.clouddms_v1.types.DeleteMigrationJobRequest, dict]
The request object. Request message for 'DeleteMigrationJob' request. |
name |
str
Required. Name of the migration job resource to delete. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.api_core.operation.Operation | An object representing a long-running operation. The result type for the operation will be google.protobuf.empty_pb2.Empty A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}. |
from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
Parameter | |
---|---|
Name | Description |
filename |
str
The path to the service account private key json file. |
Returns | |
---|---|
Type | Description |
DataMigrationServiceClient | The constructed client. |
from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
Parameter | |
---|---|
Name | Description |
info |
dict
The service account private key info. |
Returns | |
---|---|
Type | Description |
DataMigrationServiceClient | The constructed client. |
from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
Parameter | |
---|---|
Name | Description |
filename |
str
The path to the service account private key json file. |
Returns | |
---|---|
Type | Description |
DataMigrationServiceClient | The constructed client. |
generate_ssh_script
generate_ssh_script(request: Optional[Union[google.cloud.clouddms_v1.types.clouddms.GenerateSshScriptRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Generate a SSH configuration script to configure the reverse SSH connectivity.
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.clouddms_v1.types.GenerateSshScriptRequest, dict]
The request object. Request message for 'GenerateSshScript' request. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.cloud.clouddms_v1.types.SshScript | Response message for 'GenerateSshScript' request. |
get_connection_profile
get_connection_profile(request: Optional[Union[google.cloud.clouddms_v1.types.clouddms.GetConnectionProfileRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Gets details of a single connection profile.
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.clouddms_v1.types.GetConnectionProfileRequest, dict]
The request object. Request message for 'GetConnectionProfile' request. |
name |
str
Required. Name of the connection profile resource to get. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.cloud.clouddms_v1.types.ConnectionProfile | A connection profile definition. |
get_migration_job
get_migration_job(request: Optional[Union[google.cloud.clouddms_v1.types.clouddms.GetMigrationJobRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Gets details of a single migration job.
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.clouddms_v1.types.GetMigrationJobRequest, dict]
The request object. Request message for 'GetMigrationJob' request. |
name |
str
Required. Name of the migration job resource to get. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.cloud.clouddms_v1.types.MigrationJob | Represents a Database Migration Service migration job object. |
list_connection_profiles
list_connection_profiles(request: Optional[Union[google.cloud.clouddms_v1.types.clouddms.ListConnectionProfilesRequest, dict]] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Retrieve a list of all connection profiles in a given project and location.
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.clouddms_v1.types.ListConnectionProfilesRequest, dict]
The request object. Request message for 'ListConnectionProfiles' request. |
parent |
str
Required. The parent, which owns this collection of connection profiles. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.cloud.clouddms_v1.services.data_migration_service.pagers.ListConnectionProfilesPager | Response message for 'ListConnectionProfiles' request. Iterating over this object will yield results and resolve additional pages automatically. |
list_migration_jobs
list_migration_jobs(request: Optional[Union[google.cloud.clouddms_v1.types.clouddms.ListMigrationJobsRequest, dict]] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Lists migration jobs in a given project and location.
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.clouddms_v1.types.ListMigrationJobsRequest, dict]
The request object. Retrieve a list of all migration jobs in a given project and location. |
parent |
str
Required. The parent, which owns this collection of migrationJobs. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.cloud.clouddms_v1.services.data_migration_service.pagers.ListMigrationJobsPager | Response message for 'ListMigrationJobs' request. Iterating over this object will yield results and resolve additional pages automatically. |
migration_job_path
migration_job_path(project: str, location: str, migration_job: str)
Returns a fully-qualified migration_job string.
parse_common_billing_account_path
parse_common_billing_account_path(path: str)
Parse a billing_account path into its component segments.
parse_common_folder_path
parse_common_folder_path(path: str)
Parse a folder path into its component segments.
parse_common_location_path
parse_common_location_path(path: str)
Parse a location path into its component segments.
parse_common_organization_path
parse_common_organization_path(path: str)
Parse a organization path into its component segments.
parse_common_project_path
parse_common_project_path(path: str)
Parse a project path into its component segments.
parse_connection_profile_path
parse_connection_profile_path(path: str)
Parses a connection_profile path into its component segments.
parse_migration_job_path
parse_migration_job_path(path: str)
Parses a migration_job path into its component segments.
promote_migration_job
promote_migration_job(request: Optional[Union[google.cloud.clouddms_v1.types.clouddms.PromoteMigrationJobRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Promote a migration job, stopping replication to the destination and promoting the destination to be a standalone database.
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.clouddms_v1.types.PromoteMigrationJobRequest, dict]
The request object. Request message for 'PromoteMigrationJob' request. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.api_core.operation.Operation | An object representing a long-running operation. The result type for the operation will be MigrationJob Represents a Database Migration Service migration job object. |
restart_migration_job
restart_migration_job(request: Optional[Union[google.cloud.clouddms_v1.types.clouddms.RestartMigrationJobRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Restart a stopped or failed migration job, resetting the destination instance to its original state and starting the migration process from scratch.
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.clouddms_v1.types.RestartMigrationJobRequest, dict]
The request object. Request message for 'RestartMigrationJob' request. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.api_core.operation.Operation | An object representing a long-running operation. The result type for the operation will be MigrationJob Represents a Database Migration Service migration job object. |
resume_migration_job
resume_migration_job(request: Optional[Union[google.cloud.clouddms_v1.types.clouddms.ResumeMigrationJobRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Resume a migration job that is currently stopped and is resumable (was stopped during CDC phase).
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.clouddms_v1.types.ResumeMigrationJobRequest, dict]
The request object. Request message for 'ResumeMigrationJob' request. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.api_core.operation.Operation | An object representing a long-running operation. The result type for the operation will be MigrationJob Represents a Database Migration Service migration job object. |
start_migration_job
start_migration_job(request: Optional[Union[google.cloud.clouddms_v1.types.clouddms.StartMigrationJobRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Start an already created migration job.
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.clouddms_v1.types.StartMigrationJobRequest, dict]
The request object. Request message for 'StartMigrationJob' request. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.api_core.operation.Operation | An object representing a long-running operation. The result type for the operation will be MigrationJob Represents a Database Migration Service migration job object. |
stop_migration_job
stop_migration_job(request: Optional[Union[google.cloud.clouddms_v1.types.clouddms.StopMigrationJobRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Stops a running migration job.
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.clouddms_v1.types.StopMigrationJobRequest, dict]
The request object. Request message for 'StopMigrationJob' request. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.api_core.operation.Operation | An object representing a long-running operation. The result type for the operation will be MigrationJob Represents a Database Migration Service migration job object. |
update_connection_profile
update_connection_profile(request: Optional[Union[google.cloud.clouddms_v1.types.clouddms.UpdateConnectionProfileRequest, dict]] = None, *, connection_profile: Optional[google.cloud.clouddms_v1.types.clouddms_resources.ConnectionProfile] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Update the configuration of a single connection profile.
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.clouddms_v1.types.UpdateConnectionProfileRequest, dict]
The request object. Request message for 'UpdateConnectionProfile' request. |
connection_profile |
google.cloud.clouddms_v1.types.ConnectionProfile
Required. The connection profile parameters to update. This corresponds to the |
update_mask |
google.protobuf.field_mask_pb2.FieldMask
Required. Field mask is used to specify the fields to be overwritten in the connection profile resource by the update. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.api_core.operation.Operation | An object representing a long-running operation. The result type for the operation will be ConnectionProfile A connection profile definition. |
update_migration_job
update_migration_job(request: Optional[Union[google.cloud.clouddms_v1.types.clouddms.UpdateMigrationJobRequest, dict]] = None, *, migration_job: Optional[google.cloud.clouddms_v1.types.clouddms_resources.MigrationJob] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Updates the parameters of a single migration job.
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.clouddms_v1.types.UpdateMigrationJobRequest, dict]
The request object. Request message for 'UpdateMigrationJob' request. |
migration_job |
google.cloud.clouddms_v1.types.MigrationJob
Required. The migration job parameters to update. This corresponds to the |
update_mask |
google.protobuf.field_mask_pb2.FieldMask
Required. Field mask is used to specify the fields to be overwritten in the migration job resource by the update. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.api_core.operation.Operation | An object representing a long-running operation. The result type for the operation will be MigrationJob Represents a Database Migration Service migration job object. |
verify_migration_job
verify_migration_job(request: Optional[Union[google.cloud.clouddms_v1.types.clouddms.VerifyMigrationJobRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Verify a migration job, making sure the destination can reach the source and that all configuration and prerequisites are met.
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.clouddms_v1.types.VerifyMigrationJobRequest, dict]
The request object. Request message for 'VerifyMigrationJob' request. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.api_core.operation.Operation | An object representing a long-running operation. The result type for the operation will be MigrationJob Represents a Database Migration Service migration job object. |