Class DataMigrationServiceClient (2.24.0)

Database Migration service.

Equality

Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection> objects compare equal. Objects that compare equal share the same underlying resources.

Performance

Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.

Thread Safety

Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.

Constructors

DataMigrationServiceClient(DataMigrationServiceClient const &)

Copy and move support

Parameter
Name	Description
	`DataMigrationServiceClient const &`

DataMigrationServiceClient(DataMigrationServiceClient &&)

Copy and move support

Parameter
Name	Description
	`DataMigrationServiceClient &&`

DataMigrationServiceClient(std::shared_ptr< DataMigrationServiceConnection >, Options)

Parameters
Name	Description
`connection`	`std::shared_ptr< DataMigrationServiceConnection >`
`opts`	`Options`

Operators

operator=(DataMigrationServiceClient const &)

Copy and move support

Parameter
Name	Description
	`DataMigrationServiceClient const &`

Returns
Type	Description
`DataMigrationServiceClient &`

operator=(DataMigrationServiceClient &&)

Copy and move support

Parameter
Name	Description
	`DataMigrationServiceClient &&`

Returns
Type	Description
`DataMigrationServiceClient &`

Functions

ListMigrationJobs(std::string const &, Options)

Lists migration jobs in a given project and location.

Parameters
Name	Description
`parent`	`std::string const &` Required. The parent which owns this collection of migrationJobs.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::clouddms::v1::MigrationJob >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.clouddms.v1.MigrationJob, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListMigrationJobs(google::cloud::clouddms::v1::ListMigrationJobsRequest, Options)

Lists migration jobs in a given project and location.

Parameters
Name	Description
`request`	`google::cloud::clouddms::v1::ListMigrationJobsRequest` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.clouddms.v1.ListMigrationJobsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::clouddms::v1::MigrationJob >

GetMigrationJob(std::string const &, Options)

Gets details of a single migration job.

Parameters
Name	Description
`name`	`std::string const &` Required. Name of the migration job resource to get.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::clouddms::v1::MigrationJob >`	the result of the RPC. The response message type (google.cloud.clouddms.v1.MigrationJob) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetMigrationJob(google::cloud::clouddms::v1::GetMigrationJobRequest const &, Options)

Gets details of a single migration job.

Parameters
Name	Description
`request`	`google::cloud::clouddms::v1::GetMigrationJobRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.clouddms.v1.GetMigrationJobRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::clouddms::v1::MigrationJob >`	the result of the RPC. The response message type (google.cloud.clouddms.v1.MigrationJob) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CreateMigrationJob(std::string const &, google::cloud::clouddms::v1::MigrationJob const &, std::string const &, Options)

Creates a new migration job in a given project and location.

Parameters
Name	Description
`parent`	`std::string const &` Required. The parent which owns this collection of migration jobs.
`migration_job`	`google::cloud::clouddms::v1::MigrationJob const &` Required. Represents a migration job object.
`migration_job_id`	`std::string const &` Required. The ID of the instance to create.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::clouddms::v1::MigrationJob > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.clouddms.v1.MigrationJob proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateMigrationJob(google::cloud::clouddms::v1::CreateMigrationJobRequest const &, Options)

Creates a new migration job in a given project and location.

Parameters
Name	Description
`request`	`google::cloud::clouddms::v1::CreateMigrationJobRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.clouddms.v1.CreateMigrationJobRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::clouddms::v1::MigrationJob > >

UpdateMigrationJob(google::cloud::clouddms::v1::MigrationJob const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single migration job.

Parameters
Name	Description
`migration_job`	`google::cloud::clouddms::v1::MigrationJob const &` Required. The migration job parameters to update.
`update_mask`	`google::protobuf::FieldMask const &` Required. Field mask is used to specify the fields to be overwritten by the update in the conversion workspace resource.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::clouddms::v1::MigrationJob > >

UpdateMigrationJob(google::cloud::clouddms::v1::UpdateMigrationJobRequest const &, Options)

Updates the parameters of a single migration job.

Parameters
Name	Description
`request`	`google::cloud::clouddms::v1::UpdateMigrationJobRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.clouddms.v1.UpdateMigrationJobRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::clouddms::v1::MigrationJob > >

DeleteMigrationJob(std::string const &, Options)

Deletes a single migration job.

Parameters
Name	Description
`name`	`std::string const &` Required. Name of the migration job resource to delete.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::clouddms::v1::OperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.clouddms.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteMigrationJob(google::cloud::clouddms::v1::DeleteMigrationJobRequest const &, Options)

Deletes a single migration job.

Parameters
Name	Description
`request`	`google::cloud::clouddms::v1::DeleteMigrationJobRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.clouddms.v1.DeleteMigrationJobRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::clouddms::v1::OperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.clouddms.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

StartMigrationJob(google::cloud::clouddms::v1::StartMigrationJobRequest const &, Options)

Start an already created migration job.

Parameters
Name	Description
`request`	`google::cloud::clouddms::v1::StartMigrationJobRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.clouddms.v1.StartMigrationJobRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::clouddms::v1::MigrationJob > >

StopMigrationJob(google::cloud::clouddms::v1::StopMigrationJobRequest const &, Options)

Stops a running migration job.

Parameters
Name	Description
`request`	`google::cloud::clouddms::v1::StopMigrationJobRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.clouddms.v1.StopMigrationJobRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::clouddms::v1::MigrationJob > >

ResumeMigrationJob(google::cloud::clouddms::v1::ResumeMigrationJobRequest const &, Options)

Resume a migration job that is currently stopped and is resumable (was stopped during CDC phase).

Parameters
Name	Description
`request`	`google::cloud::clouddms::v1::ResumeMigrationJobRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.clouddms.v1.ResumeMigrationJobRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::clouddms::v1::MigrationJob > >

PromoteMigrationJob(google::cloud::clouddms::v1::PromoteMigrationJobRequest const &, Options)

Promote a migration job, stopping replication to the destination and promoting the destination to be a standalone database.

Parameters
Name	Description
`request`	`google::cloud::clouddms::v1::PromoteMigrationJobRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.clouddms.v1.PromoteMigrationJobRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::clouddms::v1::MigrationJob > >

VerifyMigrationJob(google::cloud::clouddms::v1::VerifyMigrationJobRequest const &, Options)

Verify a migration job, making sure the destination can reach the source and that all configuration and prerequisites are met.

Parameters
Name	Description
`request`	`google::cloud::clouddms::v1::VerifyMigrationJobRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.clouddms.v1.VerifyMigrationJobRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::clouddms::v1::MigrationJob > >

RestartMigrationJob(google::cloud::clouddms::v1::RestartMigrationJobRequest const &, Options)

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`	`google::cloud::clouddms::v1::RestartMigrationJobRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.clouddms.v1.RestartMigrationJobRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::clouddms::v1::MigrationJob > >

GenerateSshScript(google::cloud::clouddms::v1::GenerateSshScriptRequest const &, Options)

Generate a SSH configuration script to configure the reverse SSH connectivity.

Parameters
Name	Description
`request`	`google::cloud::clouddms::v1::GenerateSshScriptRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.clouddms.v1.GenerateSshScriptRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::clouddms::v1::SshScript >`	the result of the RPC. The response message type (google.cloud.clouddms.v1.SshScript) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GenerateTcpProxyScript(google::cloud::clouddms::v1::GenerateTcpProxyScriptRequest const &, Options)

Generate a TCP Proxy configuration script to configure a cloud-hosted VM running a TCP Proxy.

Parameters
Name	Description
`request`	`google::cloud::clouddms::v1::GenerateTcpProxyScriptRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.clouddms.v1.GenerateTcpProxyScriptRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::clouddms::v1::TcpProxyScript >`	the result of the RPC. The response message type (google.cloud.clouddms.v1.TcpProxyScript) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

ListConnectionProfiles(std::string const &, Options)

Retrieves a list of all connection profiles in a given project and location.

Parameters
Name	Description
`parent`	`std::string const &` Required. The parent which owns this collection of connection profiles.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::clouddms::v1::ConnectionProfile >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.clouddms.v1.ConnectionProfile, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListConnectionProfiles(google::cloud::clouddms::v1::ListConnectionProfilesRequest, Options)

Retrieves a list of all connection profiles in a given project and location.

Parameters
Name	Description
`request`	`google::cloud::clouddms::v1::ListConnectionProfilesRequest` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.clouddms.v1.ListConnectionProfilesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::clouddms::v1::ConnectionProfile >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.clouddms.v1.ConnectionProfile, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetConnectionProfile(std::string const &, Options)

Gets details of a single connection profile.

Parameters
Name	Description
`name`	`std::string const &` Required. Name of the connection profile resource to get.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::clouddms::v1::ConnectionProfile >`	the result of the RPC. The response message type (google.cloud.clouddms.v1.ConnectionProfile) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetConnectionProfile(google::cloud::clouddms::v1::GetConnectionProfileRequest const &, Options)

Gets details of a single connection profile.

Parameters
Name	Description
`request`	`google::cloud::clouddms::v1::GetConnectionProfileRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.clouddms.v1.GetConnectionProfileRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::clouddms::v1::ConnectionProfile >`	the result of the RPC. The response message type (google.cloud.clouddms.v1.ConnectionProfile) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CreateConnectionProfile(std::string const &, google::cloud::clouddms::v1::ConnectionProfile const &, std::string const &, Options)

Creates a new connection profile in a given project and location.

Parameters
Name	Description
`parent`	`std::string const &` Required. The parent which owns this collection of connection profiles.
`connection_profile`	`google::cloud::clouddms::v1::ConnectionProfile const &` Required. The create request body including the connection profile data
`connection_profile_id`	`std::string const &` Required. The connection profile identifier.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::clouddms::v1::ConnectionProfile > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.clouddms.v1.ConnectionProfile proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateConnectionProfile(google::cloud::clouddms::v1::CreateConnectionProfileRequest const &, Options)

Creates a new connection profile in a given project and location.

Parameters
Name	Description
`request`	`google::cloud::clouddms::v1::CreateConnectionProfileRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.clouddms.v1.CreateConnectionProfileRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::clouddms::v1::ConnectionProfile > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.clouddms.v1.ConnectionProfile proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateConnectionProfile(google::cloud::clouddms::v1::ConnectionProfile const &, google::protobuf::FieldMask const &, Options)

Update the configuration of a single connection profile.

Parameters
Name	Description
`connection_profile`	`google::cloud::clouddms::v1::ConnectionProfile const &` Required. The connection profile parameters to update.
`update_mask`	`google::protobuf::FieldMask const &` Required. Field mask is used to specify the fields to be overwritten by the update in the conversion workspace resource.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::clouddms::v1::ConnectionProfile > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.clouddms.v1.ConnectionProfile proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateConnectionProfile(google::cloud::clouddms::v1::UpdateConnectionProfileRequest const &, Options)

Update the configuration of a single connection profile.

Parameters
Name	Description
`request`	`google::cloud::clouddms::v1::UpdateConnectionProfileRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.clouddms.v1.UpdateConnectionProfileRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::clouddms::v1::ConnectionProfile > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.clouddms.v1.ConnectionProfile proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteConnectionProfile(std::string const &, Options)

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
`name`	`std::string const &` Required. Name of the connection profile resource to delete.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::clouddms::v1::OperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.clouddms.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteConnectionProfile(google::cloud::clouddms::v1::DeleteConnectionProfileRequest const &, Options)

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`	`google::cloud::clouddms::v1::DeleteConnectionProfileRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.clouddms.v1.DeleteConnectionProfileRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::clouddms::v1::OperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.clouddms.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreatePrivateConnection(std::string const &, google::cloud::clouddms::v1::PrivateConnection const &, std::string const &, Options)

Creates a new private connection in a given project and location.

Parameters
Name	Description
`parent`	`std::string const &` Required. The parent that owns the collection of PrivateConnections.
`private_connection`	`google::cloud::clouddms::v1::PrivateConnection const &` Required. The private connection resource to create.
`private_connection_id`	`std::string const &` Required. The private connection identifier.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::clouddms::v1::PrivateConnection > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.clouddms.v1.PrivateConnection proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreatePrivateConnection(google::cloud::clouddms::v1::CreatePrivateConnectionRequest const &, Options)

Creates a new private connection in a given project and location.

Parameters
Name	Description
`request`	`google::cloud::clouddms::v1::CreatePrivateConnectionRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.clouddms.v1.CreatePrivateConnectionRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::clouddms::v1::PrivateConnection > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.clouddms.v1.PrivateConnection proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

GetPrivateConnection(std::string const &, Options)

Gets details of a single private connection.

Parameters
Name	Description
`name`	`std::string const &` Required. The name of the private connection to get.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::clouddms::v1::PrivateConnection >`	the result of the RPC. The response message type (google.cloud.clouddms.v1.PrivateConnection) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetPrivateConnection(google::cloud::clouddms::v1::GetPrivateConnectionRequest const &, Options)

Gets details of a single private connection.

Parameters
Name	Description
`request`	`google::cloud::clouddms::v1::GetPrivateConnectionRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.clouddms.v1.GetPrivateConnectionRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::clouddms::v1::PrivateConnection >`	the result of the RPC. The response message type (google.cloud.clouddms.v1.PrivateConnection) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

ListPrivateConnections(std::string const &, Options)

Retrieves a list of private connections in a given project and location.

Parameters
Name	Description
`parent`	`std::string const &` Required. The parent that owns the collection of private connections.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::clouddms::v1::PrivateConnection >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.clouddms.v1.PrivateConnection, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListPrivateConnections(google::cloud::clouddms::v1::ListPrivateConnectionsRequest, Options)

Retrieves a list of private connections in a given project and location.

Parameters
Name	Description
`request`	`google::cloud::clouddms::v1::ListPrivateConnectionsRequest` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.clouddms.v1.ListPrivateConnectionsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::clouddms::v1::PrivateConnection >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.clouddms.v1.PrivateConnection, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

DeletePrivateConnection(std::string const &, Options)

Deletes a single Database Migration Service private connection.

Parameters
Name	Description
`name`	`std::string const &` Required. The name of the private connection to delete.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::clouddms::v1::OperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.clouddms.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeletePrivateConnection(google::cloud::clouddms::v1::DeletePrivateConnectionRequest const &, Options)

Deletes a single Database Migration Service private connection.

Parameters
Name	Description
`request`	`google::cloud::clouddms::v1::DeletePrivateConnectionRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.clouddms.v1.DeletePrivateConnectionRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::clouddms::v1::OperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.clouddms.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

GetConversionWorkspace(std::string const &, Options)

Gets details of a single conversion workspace.

Parameters
Name	Description
`name`	`std::string const &` Required. Name of the conversion workspace resource to get.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::clouddms::v1::ConversionWorkspace >`	the result of the RPC. The response message type (google.cloud.clouddms.v1.ConversionWorkspace) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetConversionWorkspace(google::cloud::clouddms::v1::GetConversionWorkspaceRequest const &, Options)

Gets details of a single conversion workspace.

Parameters
Name	Description
`request`	`google::cloud::clouddms::v1::GetConversionWorkspaceRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.clouddms.v1.GetConversionWorkspaceRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::clouddms::v1::ConversionWorkspace >`	the result of the RPC. The response message type (google.cloud.clouddms.v1.ConversionWorkspace) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

ListConversionWorkspaces(std::string const &, Options)

Lists conversion workspaces in a given project and location.

Parameters
Name	Description
`parent`	`std::string const &` Required. The parent which owns this collection of conversion workspaces.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::clouddms::v1::ConversionWorkspace >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.clouddms.v1.ConversionWorkspace, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListConversionWorkspaces(google::cloud::clouddms::v1::ListConversionWorkspacesRequest, Options)

Lists conversion workspaces in a given project and location.

Parameters
Name	Description
`request`	`google::cloud::clouddms::v1::ListConversionWorkspacesRequest` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.clouddms.v1.ListConversionWorkspacesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::clouddms::v1::ConversionWorkspace >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.clouddms.v1.ConversionWorkspace, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

CreateConversionWorkspace(std::string const &, google::cloud::clouddms::v1::ConversionWorkspace const &, std::string const &, Options)

Creates a new conversion workspace in a given project and location.

Parameters
Name	Description
`parent`	`std::string const &` Required. The parent which owns this collection of conversion workspaces.
`conversion_workspace`	`google::cloud::clouddms::v1::ConversionWorkspace const &` Required. Represents a conversion workspace object.
`conversion_workspace_id`	`std::string const &` Required. The ID of the conversion workspace to create.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::clouddms::v1::ConversionWorkspace > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.clouddms.v1.ConversionWorkspace proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateConversionWorkspace(google::cloud::clouddms::v1::CreateConversionWorkspaceRequest const &, Options)

Creates a new conversion workspace in a given project and location.

Parameters
Name	Description
`request`	`google::cloud::clouddms::v1::CreateConversionWorkspaceRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.clouddms.v1.CreateConversionWorkspaceRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::clouddms::v1::ConversionWorkspace > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.clouddms.v1.ConversionWorkspace proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateConversionWorkspace(google::cloud::clouddms::v1::ConversionWorkspace const &, google::protobuf::FieldMask const &, Options)

Updates the parameters of a single conversion workspace.

Parameters
Name	Description
`conversion_workspace`	`google::cloud::clouddms::v1::ConversionWorkspace const &` Required. The conversion workspace parameters to update.
`update_mask`	`google::protobuf::FieldMask const &` Required. Field mask is used to specify the fields to be overwritten by the update in the conversion workspace resource.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::clouddms::v1::ConversionWorkspace > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.clouddms.v1.ConversionWorkspace proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateConversionWorkspace(google::cloud::clouddms::v1::UpdateConversionWorkspaceRequest const &, Options)

Updates the parameters of a single conversion workspace.

Parameters
Name	Description
`request`	`google::cloud::clouddms::v1::UpdateConversionWorkspaceRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.clouddms.v1.UpdateConversionWorkspaceRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::clouddms::v1::ConversionWorkspace > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.clouddms.v1.ConversionWorkspace proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteConversionWorkspace(std::string const &, Options)

Deletes a single conversion workspace.

Parameters
Name	Description
`name`	`std::string const &` Required. Name of the conversion workspace resource to delete.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::clouddms::v1::OperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.clouddms.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteConversionWorkspace(google::cloud::clouddms::v1::DeleteConversionWorkspaceRequest const &, Options)

Deletes a single conversion workspace.

Parameters
Name	Description
`request`	`google::cloud::clouddms::v1::DeleteConversionWorkspaceRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.clouddms.v1.DeleteConversionWorkspaceRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::clouddms::v1::OperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.clouddms.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateMappingRule(std::string const &, google::cloud::clouddms::v1::MappingRule const &, std::string const &, Options)

Creates a new mapping rule for a given conversion workspace.

Parameters
Name	Description
`parent`	`std::string const &` Required. The parent which owns this collection of mapping rules.
`mapping_rule`	`google::cloud::clouddms::v1::MappingRule const &` Required. Represents a mapping rule object.
`mapping_rule_id`	`std::string const &` Required. The ID of the rule to create.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::clouddms::v1::MappingRule >`	the result of the RPC. The response message type (google.cloud.clouddms.v1.MappingRule) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CreateMappingRule(google::cloud::clouddms::v1::CreateMappingRuleRequest const &, Options)

Creates a new mapping rule for a given conversion workspace.

Parameters
Name	Description
`request`	`google::cloud::clouddms::v1::CreateMappingRuleRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.clouddms.v1.CreateMappingRuleRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::clouddms::v1::MappingRule >`	the result of the RPC. The response message type (google.cloud.clouddms.v1.MappingRule) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

DeleteMappingRule(std::string const &, Options)

Deletes a single mapping rule.

Parameters
Name	Description
`name`	`std::string const &` Required. Name of the mapping rule resource to delete.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

DeleteMappingRule(google::cloud::clouddms::v1::DeleteMappingRuleRequest const &, Options)

Deletes a single mapping rule.

Parameters
Name	Description
`request`	`google::cloud::clouddms::v1::DeleteMappingRuleRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.clouddms.v1.DeleteMappingRuleRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

ListMappingRules(std::string const &, Options)

Lists the mapping rules for a specific conversion workspace.

Parameters
Name	Description
`parent`	`std::string const &` Required. Name of the conversion workspace resource whose mapping rules are listed in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::clouddms::v1::MappingRule >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.clouddms.v1.MappingRule, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListMappingRules(google::cloud::clouddms::v1::ListMappingRulesRequest, Options)

Lists the mapping rules for a specific conversion workspace.

Parameters
Name	Description
`request`	`google::cloud::clouddms::v1::ListMappingRulesRequest` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.clouddms.v1.ListMappingRulesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::clouddms::v1::MappingRule >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.clouddms.v1.MappingRule, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetMappingRule(std::string const &, Options)

Gets the details of a mapping rule.

Parameters
Name	Description
`name`	`std::string const &` Required. Name of the mapping rule resource to get. Example: conversionWorkspaces/123/mappingRules/rule123 In order to retrieve a previous revision of the mapping rule, also provide the revision ID. Example: `conversionWorkspace/123/mappingRules/rule123@c7cfa2a8c7cfa2a8c7cfa2a8c7cfa2a8`
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::clouddms::v1::MappingRule >`	the result of the RPC. The response message type (google.cloud.clouddms.v1.MappingRule) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetMappingRule(google::cloud::clouddms::v1::GetMappingRuleRequest const &, Options)

Gets the details of a mapping rule.

Parameters
Name	Description
`request`	`google::cloud::clouddms::v1::GetMappingRuleRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.clouddms.v1.GetMappingRuleRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::clouddms::v1::MappingRule >`	the result of the RPC. The response message type (google.cloud.clouddms.v1.MappingRule) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

SeedConversionWorkspace(google::cloud::clouddms::v1::SeedConversionWorkspaceRequest const &, Options)

Imports a snapshot of the source database into the conversion workspace.

Parameters
Name	Description
`request`	`google::cloud::clouddms::v1::SeedConversionWorkspaceRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.clouddms.v1.SeedConversionWorkspaceRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::clouddms::v1::ConversionWorkspace > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.clouddms.v1.ConversionWorkspace proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ImportMappingRules(google::cloud::clouddms::v1::ImportMappingRulesRequest const &, Options)

Imports the mapping rules for a given conversion workspace.

Supports various formats of external rules files.

Parameters
Name	Description
`request`	`google::cloud::clouddms::v1::ImportMappingRulesRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.clouddms.v1.ImportMappingRulesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::clouddms::v1::ConversionWorkspace > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.clouddms.v1.ConversionWorkspace proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ConvertConversionWorkspace(google::cloud::clouddms::v1::ConvertConversionWorkspaceRequest const &, Options)

Creates a draft tree schema for the destination database.

Parameters
Name	Description
`request`	`google::cloud::clouddms::v1::ConvertConversionWorkspaceRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.clouddms.v1.ConvertConversionWorkspaceRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::clouddms::v1::ConversionWorkspace > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.clouddms.v1.ConversionWorkspace proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CommitConversionWorkspace(google::cloud::clouddms::v1::CommitConversionWorkspaceRequest const &, Options)

Marks all the data in the conversion workspace as committed.

Parameters
Name	Description
`request`	`google::cloud::clouddms::v1::CommitConversionWorkspaceRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.clouddms.v1.CommitConversionWorkspaceRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::clouddms::v1::ConversionWorkspace > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.clouddms.v1.ConversionWorkspace proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

RollbackConversionWorkspace(google::cloud::clouddms::v1::RollbackConversionWorkspaceRequest const &, Options)

Rolls back a conversion workspace to the last committed snapshot.

Parameters
Name	Description
`request`	`google::cloud::clouddms::v1::RollbackConversionWorkspaceRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.clouddms.v1.RollbackConversionWorkspaceRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::clouddms::v1::ConversionWorkspace > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.clouddms.v1.ConversionWorkspace proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ApplyConversionWorkspace(google::cloud::clouddms::v1::ApplyConversionWorkspaceRequest const &, Options)

Applies draft tree onto a specific destination database.

Parameters
Name	Description
`request`	`google::cloud::clouddms::v1::ApplyConversionWorkspaceRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.clouddms.v1.ApplyConversionWorkspaceRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::clouddms::v1::ConversionWorkspace > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.clouddms.v1.ConversionWorkspace proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DescribeDatabaseEntities(google::cloud::clouddms::v1::DescribeDatabaseEntitiesRequest, Options)

Describes the database entities tree for a specific conversion workspace and a specific tree type.

Database entities are not resources like conversion workspaces or mapping rules, and they can't be created, updated or deleted. Instead, they are simple data objects describing the structure of the client database.

Parameters
Name	Description
`request`	`google::cloud::clouddms::v1::DescribeDatabaseEntitiesRequest` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.clouddms.v1.DescribeDatabaseEntitiesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::clouddms::v1::DatabaseEntity >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.clouddms.v1.DatabaseEntity, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

SearchBackgroundJobs(google::cloud::clouddms::v1::SearchBackgroundJobsRequest const &, Options)

Searches/lists the background jobs for a specific conversion workspace.

The background jobs are not resources like conversion workspaces or mapping rules, and they can't be created, updated or deleted. Instead, they are a way to expose the data plane jobs log.

Parameters
Name	Description
`request`	`google::cloud::clouddms::v1::SearchBackgroundJobsRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.clouddms.v1.SearchBackgroundJobsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::clouddms::v1::SearchBackgroundJobsResponse >`	the result of the RPC. The response message type (google.cloud.clouddms.v1.SearchBackgroundJobsResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

DescribeConversionWorkspaceRevisions(google::cloud::clouddms::v1::DescribeConversionWorkspaceRevisionsRequest const &, Options)

Retrieves a list of committed revisions of a specific conversion workspace.

Parameters
Name	Description
`request`	`google::cloud::clouddms::v1::DescribeConversionWorkspaceRevisionsRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.clouddms.v1.DescribeConversionWorkspaceRevisionsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::clouddms::v1::DescribeConversionWorkspaceRevisionsResponse >`	the result of the RPC. The response message type (google.cloud.clouddms.v1.DescribeConversionWorkspaceRevisionsResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

FetchStaticIps(std::string const &, Options)

Fetches a set of static IP addresses that need to be allowlisted by the customer when using the static-IP connectivity method.

Parameters
Name	Description
`name`	`std::string const &` Required. The resource name for the location for which static IPs should be returned. Must be in the format `projects//locations/`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< std::string >

FetchStaticIps(google::cloud::clouddms::v1::FetchStaticIpsRequest, Options)

Fetches a set of static IP addresses that need to be allowlisted by the customer when using the static-IP connectivity method.

Parameters
Name	Description
`request`	`google::cloud::clouddms::v1::FetchStaticIpsRequest` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.clouddms.v1.FetchStaticIpsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< std::string >