google_cloud_clouddms_v1/

client.rs

// Copyright 2025 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// Code generated by sidekick. DO NOT EDIT.
#![allow(rustdoc::bare_urls)]
#![allow(rustdoc::broken_intra_doc_links)]
#![allow(rustdoc::invalid_html_tags)]
#![allow(rustdoc::redundant_explicit_links)]

/// Implements a client for the Database Migration API.
///
/// # Example
/// ```
/// # use google_cloud_clouddms_v1::client::DataMigrationService;
/// use google_cloud_gax::paginator::ItemPaginator as _;
/// async fn sample(
///    project_id: &str,
///    location_id: &str,
/// ) -> anyhow::Result<()> {
///     let client = DataMigrationService::builder().build().await?;
///     let mut list = client.list_migration_jobs()
///         .set_parent(format!("projects/{project_id}/locations/{location_id}"))
///         .by_item();
///     while let Some(item) = list.next().await.transpose()? {
///         println!("{:?}", item);
///     }
///     Ok(())
/// }
/// ```
///
/// # Service Description
///
/// Database Migration service
///
/// # Configuration
///
/// To configure `DataMigrationService` use the `with_*` methods in the type returned
/// by [builder()][DataMigrationService::builder]. The default configuration should
/// work for most applications. Common configuration changes include
///
/// * [with_endpoint()]: by default this client uses the global default endpoint
///   (`https://datamigration.googleapis.com`). Applications using regional
///   endpoints or running in restricted networks (e.g. a network configured
///   with [Private Google Access with VPC Service Controls]) may want to
///   override this default.
/// * [with_credentials()]: by default this client uses
///   [Application Default Credentials]. Applications using custom
///   authentication may need to override this default.
///
/// [with_endpoint()]: super::builder::data_migration_service::ClientBuilder::with_endpoint
/// [with_credentials()]: super::builder::data_migration_service::ClientBuilder::with_credentials
/// [Private Google Access with VPC Service Controls]: https://cloud.google.com/vpc-service-controls/docs/private-connectivity
/// [Application Default Credentials]: https://cloud.google.com/docs/authentication#adc
///
/// # Pooling and Cloning
///
/// `DataMigrationService` holds a connection pool internally, it is advised to
/// create one and reuse it. You do not need to wrap `DataMigrationService` in
/// an [Rc](std::rc::Rc) or [Arc](std::sync::Arc) to reuse it, because it
/// already uses an `Arc` internally.
#[derive(Clone, Debug)]
pub struct DataMigrationService {
    inner: std::sync::Arc<dyn super::stub::dynamic::DataMigrationService>,
}

impl DataMigrationService {
    /// Returns a builder for [DataMigrationService].
    ///
    /// ```
    /// # async fn sample() -> google_cloud_gax::client_builder::Result<()> {
    /// # use google_cloud_clouddms_v1::client::DataMigrationService;
    /// let client = DataMigrationService::builder().build().await?;
    /// # Ok(()) }
    /// ```
    pub fn builder() -> super::builder::data_migration_service::ClientBuilder {
        crate::new_client_builder(super::builder::data_migration_service::client::Factory)
    }

    /// Creates a new client from the provided stub.
    ///
    /// The most common case for calling this function is in tests mocking the
    /// client's behavior.
    pub fn from_stub<T>(stub: impl Into<std::sync::Arc<T>>) -> Self
    where
        T: super::stub::DataMigrationService + 'static,
    {
        Self { inner: stub.into() }
    }

    pub(crate) async fn new(
        config: gaxi::options::ClientConfig,
    ) -> crate::ClientBuilderResult<Self> {
        let inner = Self::build_inner(config).await?;
        Ok(Self { inner })
    }

    async fn build_inner(
        conf: gaxi::options::ClientConfig,
    ) -> crate::ClientBuilderResult<std::sync::Arc<dyn super::stub::dynamic::DataMigrationService>>
    {
        if gaxi::options::tracing_enabled(&conf) {
            return Ok(std::sync::Arc::new(Self::build_with_tracing(conf).await?));
        }
        Ok(std::sync::Arc::new(Self::build_transport(conf).await?))
    }

    async fn build_transport(
        conf: gaxi::options::ClientConfig,
    ) -> crate::ClientBuilderResult<impl super::stub::DataMigrationService> {
        super::transport::DataMigrationService::new(conf).await
    }

    async fn build_with_tracing(
        conf: gaxi::options::ClientConfig,
    ) -> crate::ClientBuilderResult<impl super::stub::DataMigrationService> {
        Self::build_transport(conf)
            .await
            .map(super::tracing::DataMigrationService::new)
    }

    /// Lists migration jobs in a given project and location.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_clouddms_v1::client::DataMigrationService;
    /// use google_cloud_gax::paginator::ItemPaginator as _;
    /// use google_cloud_clouddms_v1::Result;
    /// async fn sample(
    ///    client: &DataMigrationService, project_id: &str, location_id: &str
    /// ) -> Result<()> {
    ///     let mut list = client.list_migration_jobs()
    ///         .set_parent(format!("projects/{project_id}/locations/{location_id}"))
    ///         .by_item();
    ///     while let Some(item) = list.next().await.transpose()? {
    ///         println!("{:?}", item);
    ///     }
    ///     Ok(())
    /// }
    /// ```
    pub fn list_migration_jobs(&self) -> super::builder::data_migration_service::ListMigrationJobs {
        super::builder::data_migration_service::ListMigrationJobs::new(self.inner.clone())
    }

    /// Gets details of a single migration job.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_clouddms_v1::client::DataMigrationService;
    /// use google_cloud_clouddms_v1::Result;
    /// async fn sample(
    ///    client: &DataMigrationService, project_id: &str, location_id: &str, migration_job_id: &str
    /// ) -> Result<()> {
    ///     let response = client.get_migration_job()
    ///         .set_name(format!("projects/{project_id}/locations/{location_id}/migrationJobs/{migration_job_id}"))
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn get_migration_job(&self) -> super::builder::data_migration_service::GetMigrationJob {
        super::builder::data_migration_service::GetMigrationJob::new(self.inner.clone())
    }

    /// Creates a new migration job in a given project and location.
    ///
    /// # Long running operations
    ///
    /// This method is used to start, and/or poll a [long-running Operation].
    /// The [Working with long-running operations] chapter in the [user guide]
    /// covers these operations in detail.
    ///
    /// [long-running operation]: https://google.aip.dev/151
    /// [user guide]: https://googleapis.github.io/google-cloud-rust/
    /// [working with long-running operations]: https://googleapis.github.io/google-cloud-rust/working_with_long_running_operations.html
    ///
    /// # Example
    /// ```
    /// # use google_cloud_clouddms_v1::client::DataMigrationService;
    /// use google_cloud_lro::Poller;
    /// use google_cloud_clouddms_v1::model::MigrationJob;
    /// use google_cloud_clouddms_v1::Result;
    /// async fn sample(
    ///    client: &DataMigrationService, project_id: &str, location_id: &str
    /// ) -> Result<()> {
    ///     let response = client.create_migration_job()
    ///         .set_parent(format!("projects/{project_id}/locations/{location_id}"))
    ///         .set_migration_job(
    ///             MigrationJob::new()/* set fields */
    ///         )
    ///         .poller().until_done().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn create_migration_job(
        &self,
    ) -> super::builder::data_migration_service::CreateMigrationJob {
        super::builder::data_migration_service::CreateMigrationJob::new(self.inner.clone())
    }

    /// Updates the parameters of a single migration job.
    ///
    /// # Long running operations
    ///
    /// This method is used to start, and/or poll a [long-running Operation].
    /// The [Working with long-running operations] chapter in the [user guide]
    /// covers these operations in detail.
    ///
    /// [long-running operation]: https://google.aip.dev/151
    /// [user guide]: https://googleapis.github.io/google-cloud-rust/
    /// [working with long-running operations]: https://googleapis.github.io/google-cloud-rust/working_with_long_running_operations.html
    ///
    /// # Example
    /// ```
    /// # use google_cloud_clouddms_v1::client::DataMigrationService;
    /// use google_cloud_lro::Poller;
    /// # extern crate wkt as google_cloud_wkt;
    /// use google_cloud_wkt::FieldMask;
    /// use google_cloud_clouddms_v1::model::MigrationJob;
    /// use google_cloud_clouddms_v1::Result;
    /// async fn sample(
    ///    client: &DataMigrationService, project_id: &str, location_id: &str, migration_job_id: &str
    /// ) -> Result<()> {
    ///     let response = client.update_migration_job()
    ///         .set_migration_job(
    ///             MigrationJob::new().set_name(format!("projects/{project_id}/locations/{location_id}/migrationJobs/{migration_job_id}"))/* set fields */
    ///         )
    ///         .set_update_mask(FieldMask::default().set_paths(["updated.field.path1", "updated.field.path2"]))
    ///         .poller().until_done().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn update_migration_job(
        &self,
    ) -> super::builder::data_migration_service::UpdateMigrationJob {
        super::builder::data_migration_service::UpdateMigrationJob::new(self.inner.clone())
    }

    /// Deletes a single migration job.
    ///
    /// # Long running operations
    ///
    /// This method is used to start, and/or poll a [long-running Operation].
    /// The [Working with long-running operations] chapter in the [user guide]
    /// covers these operations in detail.
    ///
    /// [long-running operation]: https://google.aip.dev/151
    /// [user guide]: https://googleapis.github.io/google-cloud-rust/
    /// [working with long-running operations]: https://googleapis.github.io/google-cloud-rust/working_with_long_running_operations.html
    ///
    /// # Example
    /// ```
    /// # use google_cloud_clouddms_v1::client::DataMigrationService;
    /// use google_cloud_lro::Poller;
    /// use google_cloud_clouddms_v1::Result;
    /// async fn sample(
    ///    client: &DataMigrationService, project_id: &str, location_id: &str, migration_job_id: &str
    /// ) -> Result<()> {
    ///     client.delete_migration_job()
    ///         .set_name(format!("projects/{project_id}/locations/{location_id}/migrationJobs/{migration_job_id}"))
    ///         .poller().until_done().await?;
    ///     Ok(())
    /// }
    /// ```
    pub fn delete_migration_job(
        &self,
    ) -> super::builder::data_migration_service::DeleteMigrationJob {
        super::builder::data_migration_service::DeleteMigrationJob::new(self.inner.clone())
    }

    /// Start an already created migration job.
    ///
    /// # Long running operations
    ///
    /// This method is used to start, and/or poll a [long-running Operation].
    /// The [Working with long-running operations] chapter in the [user guide]
    /// covers these operations in detail.
    ///
    /// [long-running operation]: https://google.aip.dev/151
    /// [user guide]: https://googleapis.github.io/google-cloud-rust/
    /// [working with long-running operations]: https://googleapis.github.io/google-cloud-rust/working_with_long_running_operations.html
    ///
    /// # Example
    /// ```
    /// # use google_cloud_clouddms_v1::client::DataMigrationService;
    /// use google_cloud_lro::Poller;
    /// use google_cloud_clouddms_v1::Result;
    /// async fn sample(
    ///    client: &DataMigrationService
    /// ) -> Result<()> {
    ///     let response = client.start_migration_job()
    ///         /* set fields */
    ///         .poller().until_done().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn start_migration_job(&self) -> super::builder::data_migration_service::StartMigrationJob {
        super::builder::data_migration_service::StartMigrationJob::new(self.inner.clone())
    }

    /// Stops a running migration job.
    ///
    /// # Long running operations
    ///
    /// This method is used to start, and/or poll a [long-running Operation].
    /// The [Working with long-running operations] chapter in the [user guide]
    /// covers these operations in detail.
    ///
    /// [long-running operation]: https://google.aip.dev/151
    /// [user guide]: https://googleapis.github.io/google-cloud-rust/
    /// [working with long-running operations]: https://googleapis.github.io/google-cloud-rust/working_with_long_running_operations.html
    ///
    /// # Example
    /// ```
    /// # use google_cloud_clouddms_v1::client::DataMigrationService;
    /// use google_cloud_lro::Poller;
    /// use google_cloud_clouddms_v1::Result;
    /// async fn sample(
    ///    client: &DataMigrationService
    /// ) -> Result<()> {
    ///     let response = client.stop_migration_job()
    ///         /* set fields */
    ///         .poller().until_done().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn stop_migration_job(&self) -> super::builder::data_migration_service::StopMigrationJob {
        super::builder::data_migration_service::StopMigrationJob::new(self.inner.clone())
    }

    /// Resume a migration job that is currently stopped and is resumable (was
    /// stopped during CDC phase).
    ///
    /// # Long running operations
    ///
    /// This method is used to start, and/or poll a [long-running Operation].
    /// The [Working with long-running operations] chapter in the [user guide]
    /// covers these operations in detail.
    ///
    /// [long-running operation]: https://google.aip.dev/151
    /// [user guide]: https://googleapis.github.io/google-cloud-rust/
    /// [working with long-running operations]: https://googleapis.github.io/google-cloud-rust/working_with_long_running_operations.html
    ///
    /// # Example
    /// ```
    /// # use google_cloud_clouddms_v1::client::DataMigrationService;
    /// use google_cloud_lro::Poller;
    /// use google_cloud_clouddms_v1::Result;
    /// async fn sample(
    ///    client: &DataMigrationService
    /// ) -> Result<()> {
    ///     let response = client.resume_migration_job()
    ///         /* set fields */
    ///         .poller().until_done().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn resume_migration_job(
        &self,
    ) -> super::builder::data_migration_service::ResumeMigrationJob {
        super::builder::data_migration_service::ResumeMigrationJob::new(self.inner.clone())
    }

    /// Promote a migration job, stopping replication to the destination and
    /// promoting the destination to be a standalone database.
    ///
    /// # Long running operations
    ///
    /// This method is used to start, and/or poll a [long-running Operation].
    /// The [Working with long-running operations] chapter in the [user guide]
    /// covers these operations in detail.
    ///
    /// [long-running operation]: https://google.aip.dev/151
    /// [user guide]: https://googleapis.github.io/google-cloud-rust/
    /// [working with long-running operations]: https://googleapis.github.io/google-cloud-rust/working_with_long_running_operations.html
    ///
    /// # Example
    /// ```
    /// # use google_cloud_clouddms_v1::client::DataMigrationService;
    /// use google_cloud_lro::Poller;
    /// use google_cloud_clouddms_v1::Result;
    /// async fn sample(
    ///    client: &DataMigrationService
    /// ) -> Result<()> {
    ///     let response = client.promote_migration_job()
    ///         /* set fields */
    ///         .poller().until_done().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn promote_migration_job(
        &self,
    ) -> super::builder::data_migration_service::PromoteMigrationJob {
        super::builder::data_migration_service::PromoteMigrationJob::new(self.inner.clone())
    }

    /// Verify a migration job, making sure the destination can reach the source
    /// and that all configuration and prerequisites are met.
    ///
    /// # Long running operations
    ///
    /// This method is used to start, and/or poll a [long-running Operation].
    /// The [Working with long-running operations] chapter in the [user guide]
    /// covers these operations in detail.
    ///
    /// [long-running operation]: https://google.aip.dev/151
    /// [user guide]: https://googleapis.github.io/google-cloud-rust/
    /// [working with long-running operations]: https://googleapis.github.io/google-cloud-rust/working_with_long_running_operations.html
    ///
    /// # Example
    /// ```
    /// # use google_cloud_clouddms_v1::client::DataMigrationService;
    /// use google_cloud_lro::Poller;
    /// use google_cloud_clouddms_v1::Result;
    /// async fn sample(
    ///    client: &DataMigrationService
    /// ) -> Result<()> {
    ///     let response = client.verify_migration_job()
    ///         /* set fields */
    ///         .poller().until_done().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn verify_migration_job(
        &self,
    ) -> super::builder::data_migration_service::VerifyMigrationJob {
        super::builder::data_migration_service::VerifyMigrationJob::new(self.inner.clone())
    }

    /// Restart a stopped or failed migration job, resetting the destination
    /// instance to its original state and starting the migration process from
    /// scratch.
    ///
    /// # Long running operations
    ///
    /// This method is used to start, and/or poll a [long-running Operation].
    /// The [Working with long-running operations] chapter in the [user guide]
    /// covers these operations in detail.
    ///
    /// [long-running operation]: https://google.aip.dev/151
    /// [user guide]: https://googleapis.github.io/google-cloud-rust/
    /// [working with long-running operations]: https://googleapis.github.io/google-cloud-rust/working_with_long_running_operations.html
    ///
    /// # Example
    /// ```
    /// # use google_cloud_clouddms_v1::client::DataMigrationService;
    /// use google_cloud_lro::Poller;
    /// use google_cloud_clouddms_v1::Result;
    /// async fn sample(
    ///    client: &DataMigrationService
    /// ) -> Result<()> {
    ///     let response = client.restart_migration_job()
    ///         /* set fields */
    ///         .poller().until_done().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn restart_migration_job(
        &self,
    ) -> super::builder::data_migration_service::RestartMigrationJob {
        super::builder::data_migration_service::RestartMigrationJob::new(self.inner.clone())
    }

    /// Generate a SSH configuration script to configure the reverse SSH
    /// connectivity.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_clouddms_v1::client::DataMigrationService;
    /// use google_cloud_clouddms_v1::Result;
    /// async fn sample(
    ///    client: &DataMigrationService
    /// ) -> Result<()> {
    ///     let response = client.generate_ssh_script()
    ///         /* set fields */
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn generate_ssh_script(&self) -> super::builder::data_migration_service::GenerateSshScript {
        super::builder::data_migration_service::GenerateSshScript::new(self.inner.clone())
    }

    /// Generate a TCP Proxy configuration script to configure a cloud-hosted VM
    /// running a TCP Proxy.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_clouddms_v1::client::DataMigrationService;
    /// use google_cloud_clouddms_v1::Result;
    /// async fn sample(
    ///    client: &DataMigrationService
    /// ) -> Result<()> {
    ///     let response = client.generate_tcp_proxy_script()
    ///         /* set fields */
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn generate_tcp_proxy_script(
        &self,
    ) -> super::builder::data_migration_service::GenerateTcpProxyScript {
        super::builder::data_migration_service::GenerateTcpProxyScript::new(self.inner.clone())
    }

    /// Retrieves a list of all connection profiles in a given project and
    /// location.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_clouddms_v1::client::DataMigrationService;
    /// use google_cloud_gax::paginator::ItemPaginator as _;
    /// use google_cloud_clouddms_v1::Result;
    /// async fn sample(
    ///    client: &DataMigrationService, project_id: &str, location_id: &str
    /// ) -> Result<()> {
    ///     let mut list = client.list_connection_profiles()
    ///         .set_parent(format!("projects/{project_id}/locations/{location_id}"))
    ///         .by_item();
    ///     while let Some(item) = list.next().await.transpose()? {
    ///         println!("{:?}", item);
    ///     }
    ///     Ok(())
    /// }
    /// ```
    pub fn list_connection_profiles(
        &self,
    ) -> super::builder::data_migration_service::ListConnectionProfiles {
        super::builder::data_migration_service::ListConnectionProfiles::new(self.inner.clone())
    }

    /// Gets details of a single connection profile.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_clouddms_v1::client::DataMigrationService;
    /// use google_cloud_clouddms_v1::Result;
    /// async fn sample(
    ///    client: &DataMigrationService, project_id: &str, location_id: &str, connection_profile_id: &str
    /// ) -> Result<()> {
    ///     let response = client.get_connection_profile()
    ///         .set_name(format!("projects/{project_id}/locations/{location_id}/connectionProfiles/{connection_profile_id}"))
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn get_connection_profile(
        &self,
    ) -> super::builder::data_migration_service::GetConnectionProfile {
        super::builder::data_migration_service::GetConnectionProfile::new(self.inner.clone())
    }

    /// Creates a new connection profile in a given project and location.
    ///
    /// # Long running operations
    ///
    /// This method is used to start, and/or poll a [long-running Operation].
    /// The [Working with long-running operations] chapter in the [user guide]
    /// covers these operations in detail.
    ///
    /// [long-running operation]: https://google.aip.dev/151
    /// [user guide]: https://googleapis.github.io/google-cloud-rust/
    /// [working with long-running operations]: https://googleapis.github.io/google-cloud-rust/working_with_long_running_operations.html
    ///
    /// # Example
    /// ```
    /// # use google_cloud_clouddms_v1::client::DataMigrationService;
    /// use google_cloud_lro::Poller;
    /// use google_cloud_clouddms_v1::model::ConnectionProfile;
    /// use google_cloud_clouddms_v1::Result;
    /// async fn sample(
    ///    client: &DataMigrationService, project_id: &str, location_id: &str
    /// ) -> Result<()> {
    ///     let response = client.create_connection_profile()
    ///         .set_parent(format!("projects/{project_id}/locations/{location_id}"))
    ///         .set_connection_profile(
    ///             ConnectionProfile::new()/* set fields */
    ///         )
    ///         .poller().until_done().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn create_connection_profile(
        &self,
    ) -> super::builder::data_migration_service::CreateConnectionProfile {
        super::builder::data_migration_service::CreateConnectionProfile::new(self.inner.clone())
    }

    /// Update the configuration of a single connection profile.
    ///
    /// # Long running operations
    ///
    /// This method is used to start, and/or poll a [long-running Operation].
    /// The [Working with long-running operations] chapter in the [user guide]
    /// covers these operations in detail.
    ///
    /// [long-running operation]: https://google.aip.dev/151
    /// [user guide]: https://googleapis.github.io/google-cloud-rust/
    /// [working with long-running operations]: https://googleapis.github.io/google-cloud-rust/working_with_long_running_operations.html
    ///
    /// # Example
    /// ```
    /// # use google_cloud_clouddms_v1::client::DataMigrationService;
    /// use google_cloud_lro::Poller;
    /// # extern crate wkt as google_cloud_wkt;
    /// use google_cloud_wkt::FieldMask;
    /// use google_cloud_clouddms_v1::model::ConnectionProfile;
    /// use google_cloud_clouddms_v1::Result;
    /// async fn sample(
    ///    client: &DataMigrationService, project_id: &str, location_id: &str, connection_profile_id: &str
    /// ) -> Result<()> {
    ///     let response = client.update_connection_profile()
    ///         .set_connection_profile(
    ///             ConnectionProfile::new().set_name(format!("projects/{project_id}/locations/{location_id}/connectionProfiles/{connection_profile_id}"))/* set fields */
    ///         )
    ///         .set_update_mask(FieldMask::default().set_paths(["updated.field.path1", "updated.field.path2"]))
    ///         .poller().until_done().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn update_connection_profile(
        &self,
    ) -> super::builder::data_migration_service::UpdateConnectionProfile {
        super::builder::data_migration_service::UpdateConnectionProfile::new(self.inner.clone())
    }

    /// 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.
    ///
    /// # Long running operations
    ///
    /// This method is used to start, and/or poll a [long-running Operation].
    /// The [Working with long-running operations] chapter in the [user guide]
    /// covers these operations in detail.
    ///
    /// [long-running operation]: https://google.aip.dev/151
    /// [user guide]: https://googleapis.github.io/google-cloud-rust/
    /// [working with long-running operations]: https://googleapis.github.io/google-cloud-rust/working_with_long_running_operations.html
    ///
    /// # Example
    /// ```
    /// # use google_cloud_clouddms_v1::client::DataMigrationService;
    /// use google_cloud_lro::Poller;
    /// use google_cloud_clouddms_v1::Result;
    /// async fn sample(
    ///    client: &DataMigrationService, project_id: &str, location_id: &str, connection_profile_id: &str
    /// ) -> Result<()> {
    ///     client.delete_connection_profile()
    ///         .set_name(format!("projects/{project_id}/locations/{location_id}/connectionProfiles/{connection_profile_id}"))
    ///         .poller().until_done().await?;
    ///     Ok(())
    /// }
    /// ```
    pub fn delete_connection_profile(
        &self,
    ) -> super::builder::data_migration_service::DeleteConnectionProfile {
        super::builder::data_migration_service::DeleteConnectionProfile::new(self.inner.clone())
    }

    /// Creates a new private connection in a given project and location.
    ///
    /// # Long running operations
    ///
    /// This method is used to start, and/or poll a [long-running Operation].
    /// The [Working with long-running operations] chapter in the [user guide]
    /// covers these operations in detail.
    ///
    /// [long-running operation]: https://google.aip.dev/151
    /// [user guide]: https://googleapis.github.io/google-cloud-rust/
    /// [working with long-running operations]: https://googleapis.github.io/google-cloud-rust/working_with_long_running_operations.html
    ///
    /// # Example
    /// ```
    /// # use google_cloud_clouddms_v1::client::DataMigrationService;
    /// use google_cloud_lro::Poller;
    /// use google_cloud_clouddms_v1::model::PrivateConnection;
    /// use google_cloud_clouddms_v1::Result;
    /// async fn sample(
    ///    client: &DataMigrationService, project_id: &str, location_id: &str
    /// ) -> Result<()> {
    ///     let response = client.create_private_connection()
    ///         .set_parent(format!("projects/{project_id}/locations/{location_id}"))
    ///         .set_private_connection(
    ///             PrivateConnection::new()/* set fields */
    ///         )
    ///         .poller().until_done().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn create_private_connection(
        &self,
    ) -> super::builder::data_migration_service::CreatePrivateConnection {
        super::builder::data_migration_service::CreatePrivateConnection::new(self.inner.clone())
    }

    /// Gets details of a single private connection.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_clouddms_v1::client::DataMigrationService;
    /// use google_cloud_clouddms_v1::Result;
    /// async fn sample(
    ///    client: &DataMigrationService, project_id: &str, location_id: &str, private_connection_id: &str
    /// ) -> Result<()> {
    ///     let response = client.get_private_connection()
    ///         .set_name(format!("projects/{project_id}/locations/{location_id}/privateConnections/{private_connection_id}"))
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn get_private_connection(
        &self,
    ) -> super::builder::data_migration_service::GetPrivateConnection {
        super::builder::data_migration_service::GetPrivateConnection::new(self.inner.clone())
    }

    /// Retrieves a list of private connections in a given project and location.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_clouddms_v1::client::DataMigrationService;
    /// use google_cloud_gax::paginator::ItemPaginator as _;
    /// use google_cloud_clouddms_v1::Result;
    /// async fn sample(
    ///    client: &DataMigrationService, project_id: &str, location_id: &str
    /// ) -> Result<()> {
    ///     let mut list = client.list_private_connections()
    ///         .set_parent(format!("projects/{project_id}/locations/{location_id}"))
    ///         .by_item();
    ///     while let Some(item) = list.next().await.transpose()? {
    ///         println!("{:?}", item);
    ///     }
    ///     Ok(())
    /// }
    /// ```
    pub fn list_private_connections(
        &self,
    ) -> super::builder::data_migration_service::ListPrivateConnections {
        super::builder::data_migration_service::ListPrivateConnections::new(self.inner.clone())
    }

    /// Deletes a single Database Migration Service private connection.
    ///
    /// # Long running operations
    ///
    /// This method is used to start, and/or poll a [long-running Operation].
    /// The [Working with long-running operations] chapter in the [user guide]
    /// covers these operations in detail.
    ///
    /// [long-running operation]: https://google.aip.dev/151
    /// [user guide]: https://googleapis.github.io/google-cloud-rust/
    /// [working with long-running operations]: https://googleapis.github.io/google-cloud-rust/working_with_long_running_operations.html
    ///
    /// # Example
    /// ```
    /// # use google_cloud_clouddms_v1::client::DataMigrationService;
    /// use google_cloud_lro::Poller;
    /// use google_cloud_clouddms_v1::Result;
    /// async fn sample(
    ///    client: &DataMigrationService, project_id: &str, location_id: &str, private_connection_id: &str
    /// ) -> Result<()> {
    ///     client.delete_private_connection()
    ///         .set_name(format!("projects/{project_id}/locations/{location_id}/privateConnections/{private_connection_id}"))
    ///         .poller().until_done().await?;
    ///     Ok(())
    /// }
    /// ```
    pub fn delete_private_connection(
        &self,
    ) -> super::builder::data_migration_service::DeletePrivateConnection {
        super::builder::data_migration_service::DeletePrivateConnection::new(self.inner.clone())
    }

    /// Gets details of a single conversion workspace.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_clouddms_v1::client::DataMigrationService;
    /// use google_cloud_clouddms_v1::Result;
    /// async fn sample(
    ///    client: &DataMigrationService, project_id: &str, location_id: &str, conversion_workspace_id: &str
    /// ) -> Result<()> {
    ///     let response = client.get_conversion_workspace()
    ///         .set_name(format!("projects/{project_id}/locations/{location_id}/conversionWorkspaces/{conversion_workspace_id}"))
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn get_conversion_workspace(
        &self,
    ) -> super::builder::data_migration_service::GetConversionWorkspace {
        super::builder::data_migration_service::GetConversionWorkspace::new(self.inner.clone())
    }

    /// Lists conversion workspaces in a given project and location.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_clouddms_v1::client::DataMigrationService;
    /// use google_cloud_gax::paginator::ItemPaginator as _;
    /// use google_cloud_clouddms_v1::Result;
    /// async fn sample(
    ///    client: &DataMigrationService, project_id: &str, location_id: &str
    /// ) -> Result<()> {
    ///     let mut list = client.list_conversion_workspaces()
    ///         .set_parent(format!("projects/{project_id}/locations/{location_id}"))
    ///         .by_item();
    ///     while let Some(item) = list.next().await.transpose()? {
    ///         println!("{:?}", item);
    ///     }
    ///     Ok(())
    /// }
    /// ```
    pub fn list_conversion_workspaces(
        &self,
    ) -> super::builder::data_migration_service::ListConversionWorkspaces {
        super::builder::data_migration_service::ListConversionWorkspaces::new(self.inner.clone())
    }

    /// Creates a new conversion workspace in a given project and location.
    ///
    /// # Long running operations
    ///
    /// This method is used to start, and/or poll a [long-running Operation].
    /// The [Working with long-running operations] chapter in the [user guide]
    /// covers these operations in detail.
    ///
    /// [long-running operation]: https://google.aip.dev/151
    /// [user guide]: https://googleapis.github.io/google-cloud-rust/
    /// [working with long-running operations]: https://googleapis.github.io/google-cloud-rust/working_with_long_running_operations.html
    ///
    /// # Example
    /// ```
    /// # use google_cloud_clouddms_v1::client::DataMigrationService;
    /// use google_cloud_lro::Poller;
    /// use google_cloud_clouddms_v1::model::ConversionWorkspace;
    /// use google_cloud_clouddms_v1::Result;
    /// async fn sample(
    ///    client: &DataMigrationService, project_id: &str, location_id: &str
    /// ) -> Result<()> {
    ///     let response = client.create_conversion_workspace()
    ///         .set_parent(format!("projects/{project_id}/locations/{location_id}"))
    ///         .set_conversion_workspace(
    ///             ConversionWorkspace::new()/* set fields */
    ///         )
    ///         .poller().until_done().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn create_conversion_workspace(
        &self,
    ) -> super::builder::data_migration_service::CreateConversionWorkspace {
        super::builder::data_migration_service::CreateConversionWorkspace::new(self.inner.clone())
    }

    /// Updates the parameters of a single conversion workspace.
    ///
    /// # Long running operations
    ///
    /// This method is used to start, and/or poll a [long-running Operation].
    /// The [Working with long-running operations] chapter in the [user guide]
    /// covers these operations in detail.
    ///
    /// [long-running operation]: https://google.aip.dev/151
    /// [user guide]: https://googleapis.github.io/google-cloud-rust/
    /// [working with long-running operations]: https://googleapis.github.io/google-cloud-rust/working_with_long_running_operations.html
    ///
    /// # Example
    /// ```
    /// # use google_cloud_clouddms_v1::client::DataMigrationService;
    /// use google_cloud_lro::Poller;
    /// # extern crate wkt as google_cloud_wkt;
    /// use google_cloud_wkt::FieldMask;
    /// use google_cloud_clouddms_v1::model::ConversionWorkspace;
    /// use google_cloud_clouddms_v1::Result;
    /// async fn sample(
    ///    client: &DataMigrationService, project_id: &str, location_id: &str, conversion_workspace_id: &str
    /// ) -> Result<()> {
    ///     let response = client.update_conversion_workspace()
    ///         .set_conversion_workspace(
    ///             ConversionWorkspace::new().set_name(format!("projects/{project_id}/locations/{location_id}/conversionWorkspaces/{conversion_workspace_id}"))/* set fields */
    ///         )
    ///         .set_update_mask(FieldMask::default().set_paths(["updated.field.path1", "updated.field.path2"]))
    ///         .poller().until_done().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn update_conversion_workspace(
        &self,
    ) -> super::builder::data_migration_service::UpdateConversionWorkspace {
        super::builder::data_migration_service::UpdateConversionWorkspace::new(self.inner.clone())
    }

    /// Deletes a single conversion workspace.
    ///
    /// # Long running operations
    ///
    /// This method is used to start, and/or poll a [long-running Operation].
    /// The [Working with long-running operations] chapter in the [user guide]
    /// covers these operations in detail.
    ///
    /// [long-running operation]: https://google.aip.dev/151
    /// [user guide]: https://googleapis.github.io/google-cloud-rust/
    /// [working with long-running operations]: https://googleapis.github.io/google-cloud-rust/working_with_long_running_operations.html
    ///
    /// # Example
    /// ```
    /// # use google_cloud_clouddms_v1::client::DataMigrationService;
    /// use google_cloud_lro::Poller;
    /// use google_cloud_clouddms_v1::Result;
    /// async fn sample(
    ///    client: &DataMigrationService, project_id: &str, location_id: &str, conversion_workspace_id: &str
    /// ) -> Result<()> {
    ///     client.delete_conversion_workspace()
    ///         .set_name(format!("projects/{project_id}/locations/{location_id}/conversionWorkspaces/{conversion_workspace_id}"))
    ///         .poller().until_done().await?;
    ///     Ok(())
    /// }
    /// ```
    pub fn delete_conversion_workspace(
        &self,
    ) -> super::builder::data_migration_service::DeleteConversionWorkspace {
        super::builder::data_migration_service::DeleteConversionWorkspace::new(self.inner.clone())
    }

    /// Creates a new mapping rule for a given conversion workspace.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_clouddms_v1::client::DataMigrationService;
    /// use google_cloud_clouddms_v1::model::MappingRule;
    /// use google_cloud_clouddms_v1::Result;
    /// async fn sample(
    ///    client: &DataMigrationService, project_id: &str, location_id: &str, conversion_workspace_id: &str
    /// ) -> Result<()> {
    ///     let response = client.create_mapping_rule()
    ///         .set_parent(format!("projects/{project_id}/locations/{location_id}/conversionWorkspaces/{conversion_workspace_id}"))
    ///         .set_mapping_rule(
    ///             MappingRule::new()/* set fields */
    ///         )
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn create_mapping_rule(&self) -> super::builder::data_migration_service::CreateMappingRule {
        super::builder::data_migration_service::CreateMappingRule::new(self.inner.clone())
    }

    /// Deletes a single mapping rule.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_clouddms_v1::client::DataMigrationService;
    /// use google_cloud_clouddms_v1::Result;
    /// async fn sample(
    ///    client: &DataMigrationService
    /// ) -> Result<()> {
    ///     client.delete_mapping_rule()
    ///         /* set fields */
    ///         .send().await?;
    ///     Ok(())
    /// }
    /// ```
    pub fn delete_mapping_rule(&self) -> super::builder::data_migration_service::DeleteMappingRule {
        super::builder::data_migration_service::DeleteMappingRule::new(self.inner.clone())
    }

    /// Lists the mapping rules for a specific conversion workspace.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_clouddms_v1::client::DataMigrationService;
    /// use google_cloud_gax::paginator::ItemPaginator as _;
    /// use google_cloud_clouddms_v1::Result;
    /// async fn sample(
    ///    client: &DataMigrationService, project_id: &str, location_id: &str, conversion_workspace_id: &str
    /// ) -> Result<()> {
    ///     let mut list = client.list_mapping_rules()
    ///         .set_parent(format!("projects/{project_id}/locations/{location_id}/conversionWorkspaces/{conversion_workspace_id}"))
    ///         .by_item();
    ///     while let Some(item) = list.next().await.transpose()? {
    ///         println!("{:?}", item);
    ///     }
    ///     Ok(())
    /// }
    /// ```
    pub fn list_mapping_rules(&self) -> super::builder::data_migration_service::ListMappingRules {
        super::builder::data_migration_service::ListMappingRules::new(self.inner.clone())
    }

    /// Gets the details of a mapping rule.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_clouddms_v1::client::DataMigrationService;
    /// use google_cloud_clouddms_v1::Result;
    /// async fn sample(
    ///    client: &DataMigrationService, project_id: &str, location_id: &str, conversion_workspace_id: &str, mapping_rule_id: &str
    /// ) -> Result<()> {
    ///     let response = client.get_mapping_rule()
    ///         .set_name(format!("projects/{project_id}/locations/{location_id}/conversionWorkspaces/{conversion_workspace_id}/mappingRules/{mapping_rule_id}"))
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn get_mapping_rule(&self) -> super::builder::data_migration_service::GetMappingRule {
        super::builder::data_migration_service::GetMappingRule::new(self.inner.clone())
    }

    /// Imports a snapshot of the source database into the
    /// conversion workspace.
    ///
    /// # Long running operations
    ///
    /// This method is used to start, and/or poll a [long-running Operation].
    /// The [Working with long-running operations] chapter in the [user guide]
    /// covers these operations in detail.
    ///
    /// [long-running operation]: https://google.aip.dev/151
    /// [user guide]: https://googleapis.github.io/google-cloud-rust/
    /// [working with long-running operations]: https://googleapis.github.io/google-cloud-rust/working_with_long_running_operations.html
    ///
    /// # Example
    /// ```
    /// # use google_cloud_clouddms_v1::client::DataMigrationService;
    /// use google_cloud_lro::Poller;
    /// use google_cloud_clouddms_v1::Result;
    /// async fn sample(
    ///    client: &DataMigrationService
    /// ) -> Result<()> {
    ///     let response = client.seed_conversion_workspace()
    ///         /* set fields */
    ///         .poller().until_done().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn seed_conversion_workspace(
        &self,
    ) -> super::builder::data_migration_service::SeedConversionWorkspace {
        super::builder::data_migration_service::SeedConversionWorkspace::new(self.inner.clone())
    }

    /// Imports the mapping rules for a given conversion workspace.
    /// Supports various formats of external rules files.
    ///
    /// # Long running operations
    ///
    /// This method is used to start, and/or poll a [long-running Operation].
    /// The [Working with long-running operations] chapter in the [user guide]
    /// covers these operations in detail.
    ///
    /// [long-running operation]: https://google.aip.dev/151
    /// [user guide]: https://googleapis.github.io/google-cloud-rust/
    /// [working with long-running operations]: https://googleapis.github.io/google-cloud-rust/working_with_long_running_operations.html
    ///
    /// # Example
    /// ```
    /// # use google_cloud_clouddms_v1::client::DataMigrationService;
    /// use google_cloud_lro::Poller;
    /// use google_cloud_clouddms_v1::Result;
    /// async fn sample(
    ///    client: &DataMigrationService
    /// ) -> Result<()> {
    ///     let response = client.import_mapping_rules()
    ///         /* set fields */
    ///         .poller().until_done().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn import_mapping_rules(
        &self,
    ) -> super::builder::data_migration_service::ImportMappingRules {
        super::builder::data_migration_service::ImportMappingRules::new(self.inner.clone())
    }

    /// Creates a draft tree schema for the destination database.
    ///
    /// # Long running operations
    ///
    /// This method is used to start, and/or poll a [long-running Operation].
    /// The [Working with long-running operations] chapter in the [user guide]
    /// covers these operations in detail.
    ///
    /// [long-running operation]: https://google.aip.dev/151
    /// [user guide]: https://googleapis.github.io/google-cloud-rust/
    /// [working with long-running operations]: https://googleapis.github.io/google-cloud-rust/working_with_long_running_operations.html
    ///
    /// # Example
    /// ```
    /// # use google_cloud_clouddms_v1::client::DataMigrationService;
    /// use google_cloud_lro::Poller;
    /// use google_cloud_clouddms_v1::Result;
    /// async fn sample(
    ///    client: &DataMigrationService
    /// ) -> Result<()> {
    ///     let response = client.convert_conversion_workspace()
    ///         /* set fields */
    ///         .poller().until_done().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn convert_conversion_workspace(
        &self,
    ) -> super::builder::data_migration_service::ConvertConversionWorkspace {
        super::builder::data_migration_service::ConvertConversionWorkspace::new(self.inner.clone())
    }

    /// Marks all the data in the conversion workspace as committed.
    ///
    /// # Long running operations
    ///
    /// This method is used to start, and/or poll a [long-running Operation].
    /// The [Working with long-running operations] chapter in the [user guide]
    /// covers these operations in detail.
    ///
    /// [long-running operation]: https://google.aip.dev/151
    /// [user guide]: https://googleapis.github.io/google-cloud-rust/
    /// [working with long-running operations]: https://googleapis.github.io/google-cloud-rust/working_with_long_running_operations.html
    ///
    /// # Example
    /// ```
    /// # use google_cloud_clouddms_v1::client::DataMigrationService;
    /// use google_cloud_lro::Poller;
    /// use google_cloud_clouddms_v1::Result;
    /// async fn sample(
    ///    client: &DataMigrationService
    /// ) -> Result<()> {
    ///     let response = client.commit_conversion_workspace()
    ///         /* set fields */
    ///         .poller().until_done().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn commit_conversion_workspace(
        &self,
    ) -> super::builder::data_migration_service::CommitConversionWorkspace {
        super::builder::data_migration_service::CommitConversionWorkspace::new(self.inner.clone())
    }

    /// Rolls back a conversion workspace to the last committed snapshot.
    ///
    /// # Long running operations
    ///
    /// This method is used to start, and/or poll a [long-running Operation].
    /// The [Working with long-running operations] chapter in the [user guide]
    /// covers these operations in detail.
    ///
    /// [long-running operation]: https://google.aip.dev/151
    /// [user guide]: https://googleapis.github.io/google-cloud-rust/
    /// [working with long-running operations]: https://googleapis.github.io/google-cloud-rust/working_with_long_running_operations.html
    ///
    /// # Example
    /// ```
    /// # use google_cloud_clouddms_v1::client::DataMigrationService;
    /// use google_cloud_lro::Poller;
    /// use google_cloud_clouddms_v1::Result;
    /// async fn sample(
    ///    client: &DataMigrationService
    /// ) -> Result<()> {
    ///     let response = client.rollback_conversion_workspace()
    ///         /* set fields */
    ///         .poller().until_done().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn rollback_conversion_workspace(
        &self,
    ) -> super::builder::data_migration_service::RollbackConversionWorkspace {
        super::builder::data_migration_service::RollbackConversionWorkspace::new(self.inner.clone())
    }

    /// Applies draft tree onto a specific destination database.
    ///
    /// # Long running operations
    ///
    /// This method is used to start, and/or poll a [long-running Operation].
    /// The [Working with long-running operations] chapter in the [user guide]
    /// covers these operations in detail.
    ///
    /// [long-running operation]: https://google.aip.dev/151
    /// [user guide]: https://googleapis.github.io/google-cloud-rust/
    /// [working with long-running operations]: https://googleapis.github.io/google-cloud-rust/working_with_long_running_operations.html
    ///
    /// # Example
    /// ```
    /// # use google_cloud_clouddms_v1::client::DataMigrationService;
    /// use google_cloud_lro::Poller;
    /// use google_cloud_clouddms_v1::Result;
    /// async fn sample(
    ///    client: &DataMigrationService
    /// ) -> Result<()> {
    ///     let response = client.apply_conversion_workspace()
    ///         /* set fields */
    ///         .poller().until_done().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn apply_conversion_workspace(
        &self,
    ) -> super::builder::data_migration_service::ApplyConversionWorkspace {
        super::builder::data_migration_service::ApplyConversionWorkspace::new(self.inner.clone())
    }

    /// 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.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_clouddms_v1::client::DataMigrationService;
    /// use google_cloud_gax::paginator::ItemPaginator as _;
    /// use google_cloud_clouddms_v1::Result;
    /// async fn sample(
    ///    client: &DataMigrationService
    /// ) -> Result<()> {
    ///     let mut list = client.describe_database_entities()
    ///         /* set fields */
    ///         .by_item();
    ///     while let Some(item) = list.next().await.transpose()? {
    ///         println!("{:?}", item);
    ///     }
    ///     Ok(())
    /// }
    /// ```
    pub fn describe_database_entities(
        &self,
    ) -> super::builder::data_migration_service::DescribeDatabaseEntities {
        super::builder::data_migration_service::DescribeDatabaseEntities::new(self.inner.clone())
    }

    /// 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.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_clouddms_v1::client::DataMigrationService;
    /// use google_cloud_clouddms_v1::Result;
    /// async fn sample(
    ///    client: &DataMigrationService
    /// ) -> Result<()> {
    ///     let response = client.search_background_jobs()
    ///         /* set fields */
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn search_background_jobs(
        &self,
    ) -> super::builder::data_migration_service::SearchBackgroundJobs {
        super::builder::data_migration_service::SearchBackgroundJobs::new(self.inner.clone())
    }

    /// Retrieves a list of committed revisions of a specific conversion
    /// workspace.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_clouddms_v1::client::DataMigrationService;
    /// use google_cloud_clouddms_v1::Result;
    /// async fn sample(
    ///    client: &DataMigrationService
    /// ) -> Result<()> {
    ///     let response = client.describe_conversion_workspace_revisions()
    ///         /* set fields */
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn describe_conversion_workspace_revisions(
        &self,
    ) -> super::builder::data_migration_service::DescribeConversionWorkspaceRevisions {
        super::builder::data_migration_service::DescribeConversionWorkspaceRevisions::new(
            self.inner.clone(),
        )
    }

    /// Fetches a set of static IP addresses that need to be allowlisted by the
    /// customer when using the static-IP connectivity method.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_clouddms_v1::client::DataMigrationService;
    /// use google_cloud_clouddms_v1::Result;
    /// async fn sample(
    ///    client: &DataMigrationService
    /// ) -> Result<()> {
    ///     let response = client.fetch_static_ips()
    ///         /* set fields */
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn fetch_static_ips(&self) -> super::builder::data_migration_service::FetchStaticIps {
        super::builder::data_migration_service::FetchStaticIps::new(self.inner.clone())
    }

    /// Lists information about the supported locations for this service.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_clouddms_v1::client::DataMigrationService;
    /// use google_cloud_gax::paginator::ItemPaginator as _;
    /// use google_cloud_clouddms_v1::Result;
    /// async fn sample(
    ///    client: &DataMigrationService
    /// ) -> Result<()> {
    ///     let mut list = client.list_locations()
    ///         /* set fields */
    ///         .by_item();
    ///     while let Some(item) = list.next().await.transpose()? {
    ///         println!("{:?}", item);
    ///     }
    ///     Ok(())
    /// }
    /// ```
    pub fn list_locations(&self) -> super::builder::data_migration_service::ListLocations {
        super::builder::data_migration_service::ListLocations::new(self.inner.clone())
    }

    /// Gets information about a location.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_clouddms_v1::client::DataMigrationService;
    /// use google_cloud_clouddms_v1::Result;
    /// async fn sample(
    ///    client: &DataMigrationService
    /// ) -> Result<()> {
    ///     let response = client.get_location()
    ///         /* set fields */
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn get_location(&self) -> super::builder::data_migration_service::GetLocation {
        super::builder::data_migration_service::GetLocation::new(self.inner.clone())
    }

    /// Sets the access control policy on the specified resource. Replaces
    /// any existing policy.
    ///
    /// Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`
    /// errors.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_clouddms_v1::client::DataMigrationService;
    /// use google_cloud_clouddms_v1::Result;
    /// async fn sample(
    ///    client: &DataMigrationService
    /// ) -> Result<()> {
    ///     let response = client.set_iam_policy()
    ///         /* set fields */
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn set_iam_policy(&self) -> super::builder::data_migration_service::SetIamPolicy {
        super::builder::data_migration_service::SetIamPolicy::new(self.inner.clone())
    }

    /// Gets the access control policy for a resource. Returns an empty policy
    /// if the resource exists and does not have a policy set.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_clouddms_v1::client::DataMigrationService;
    /// use google_cloud_clouddms_v1::Result;
    /// async fn sample(
    ///    client: &DataMigrationService
    /// ) -> Result<()> {
    ///     let response = client.get_iam_policy()
    ///         /* set fields */
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn get_iam_policy(&self) -> super::builder::data_migration_service::GetIamPolicy {
        super::builder::data_migration_service::GetIamPolicy::new(self.inner.clone())
    }

    /// Returns permissions that a caller has on the specified resource. If the
    /// resource does not exist, this will return an empty set of
    /// permissions, not a `NOT_FOUND` error.
    ///
    /// Note: This operation is designed to be used for building
    /// permission-aware UIs and command-line tools, not for authorization
    /// checking. This operation may "fail open" without warning.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_clouddms_v1::client::DataMigrationService;
    /// use google_cloud_clouddms_v1::Result;
    /// async fn sample(
    ///    client: &DataMigrationService
    /// ) -> Result<()> {
    ///     let response = client.test_iam_permissions()
    ///         /* set fields */
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn test_iam_permissions(
        &self,
    ) -> super::builder::data_migration_service::TestIamPermissions {
        super::builder::data_migration_service::TestIamPermissions::new(self.inner.clone())
    }

    /// Provides the [Operations][google.longrunning.Operations] service functionality in this service.
    ///
    /// [google.longrunning.Operations]: google-cloud-longrunning::client::Operations
    ///
    /// # Example
    /// ```
    /// # use google_cloud_clouddms_v1::client::DataMigrationService;
    /// use google_cloud_gax::paginator::ItemPaginator as _;
    /// use google_cloud_clouddms_v1::Result;
    /// async fn sample(
    ///    client: &DataMigrationService
    /// ) -> Result<()> {
    ///     let mut list = client.list_operations()
    ///         /* set fields */
    ///         .by_item();
    ///     while let Some(item) = list.next().await.transpose()? {
    ///         println!("{:?}", item);
    ///     }
    ///     Ok(())
    /// }
    /// ```
    pub fn list_operations(&self) -> super::builder::data_migration_service::ListOperations {
        super::builder::data_migration_service::ListOperations::new(self.inner.clone())
    }

    /// Provides the [Operations][google.longrunning.Operations] service functionality in this service.
    ///
    /// [google.longrunning.Operations]: google-cloud-longrunning::client::Operations
    ///
    /// # Example
    /// ```
    /// # use google_cloud_clouddms_v1::client::DataMigrationService;
    /// use google_cloud_clouddms_v1::Result;
    /// async fn sample(
    ///    client: &DataMigrationService
    /// ) -> Result<()> {
    ///     let response = client.get_operation()
    ///         /* set fields */
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn get_operation(&self) -> super::builder::data_migration_service::GetOperation {
        super::builder::data_migration_service::GetOperation::new(self.inner.clone())
    }

    /// Provides the [Operations][google.longrunning.Operations] service functionality in this service.
    ///
    /// [google.longrunning.Operations]: google-cloud-longrunning::client::Operations
    ///
    /// # Example
    /// ```
    /// # use google_cloud_clouddms_v1::client::DataMigrationService;
    /// use google_cloud_clouddms_v1::Result;
    /// async fn sample(
    ///    client: &DataMigrationService
    /// ) -> Result<()> {
    ///     client.delete_operation()
    ///         /* set fields */
    ///         .send().await?;
    ///     Ok(())
    /// }
    /// ```
    pub fn delete_operation(&self) -> super::builder::data_migration_service::DeleteOperation {
        super::builder::data_migration_service::DeleteOperation::new(self.inner.clone())
    }

    /// Provides the [Operations][google.longrunning.Operations] service functionality in this service.
    ///
    /// [google.longrunning.Operations]: google-cloud-longrunning::client::Operations
    ///
    /// # Example
    /// ```
    /// # use google_cloud_clouddms_v1::client::DataMigrationService;
    /// use google_cloud_clouddms_v1::Result;
    /// async fn sample(
    ///    client: &DataMigrationService
    /// ) -> Result<()> {
    ///     client.cancel_operation()
    ///         /* set fields */
    ///         .send().await?;
    ///     Ok(())
    /// }
    /// ```
    pub fn cancel_operation(&self) -> super::builder::data_migration_service::CancelOperation {
        super::builder::data_migration_service::CancelOperation::new(self.inner.clone())
    }
}