google_cloud_bigquery_migration_v2/
client.rs

1// Copyright 2025 Google LLC
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//     https://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14//
15// Code generated by sidekick. DO NOT EDIT.
16#![allow(rustdoc::redundant_explicit_links)]
17#![allow(rustdoc::broken_intra_doc_links)]
18
19/// Implements a client for the BigQuery Migration API.
20///
21/// # Example
22/// ```
23/// # tokio_test::block_on(async {
24/// # use google_cloud_bigquery_migration_v2::client::MigrationService;
25/// let client = MigrationService::builder().build().await?;
26/// // use `client` to make requests to the BigQuery Migration API.
27/// # gax::client_builder::Result::<()>::Ok(()) });
28/// ```
29///
30/// # Service Description
31///
32/// Service to handle EDW migrations.
33///
34/// # Configuration
35///
36/// To configure `MigrationService` use the `with_*` methods in the type returned
37/// by [builder()][MigrationService::builder]. The default configuration should
38/// work for most applications. Common configuration changes include
39///
40/// * [with_endpoint()]: by default this client uses the global default endpoint
41///   (`https://bigquerymigration.googleapis.com`). Applications using regional
42///   endpoints or running in restricted networks (e.g. a network configured
43//    with [Private Google Access with VPC Service Controls]) may want to
44///   override this default.
45/// * [with_credentials()]: by default this client uses
46///   [Application Default Credentials]. Applications using custom
47///   authentication may need to override this default.
48///
49/// [with_endpoint()]: super::builder::migration_service::ClientBuilder::with_endpoint
50/// [with_credentials()]: super::builder::migration_service::ClientBuilder::credentials
51/// [Private Google Access with VPC Service Controls]: https://cloud.google.com/vpc-service-controls/docs/private-connectivity
52/// [Application Default Credentials]: https://cloud.google.com/docs/authentication#adc
53///
54/// # Pooling and Cloning
55///
56/// `MigrationService` holds a connection pool internally, it is advised to
57/// create one and the reuse it.  You do not need to wrap `MigrationService` in
58/// an [Rc](std::rc::Rc) or [Arc](std::sync::Arc) to reuse it, because it
59/// already uses an `Arc` internally.
60#[derive(Clone, Debug)]
61pub struct MigrationService {
62    inner: std::sync::Arc<dyn super::stub::dynamic::MigrationService>,
63}
64
65impl MigrationService {
66    /// Returns a builder for [MigrationService].
67    ///
68    /// ```
69    /// # tokio_test::block_on(async {
70    /// # use google_cloud_bigquery_migration_v2::client::MigrationService;
71    /// let client = MigrationService::builder().build().await?;
72    /// # gax::client_builder::Result::<()>::Ok(()) });
73    /// ```
74    pub fn builder() -> super::builder::migration_service::ClientBuilder {
75        gax::client_builder::internal::new_builder(
76            super::builder::migration_service::client::Factory,
77        )
78    }
79
80    /// Creates a new client from the provided stub.
81    ///
82    /// The most common case for calling this function is in tests mocking the
83    /// client's behavior.
84    pub fn from_stub<T>(stub: T) -> Self
85    where
86        T: super::stub::MigrationService + 'static,
87    {
88        Self {
89            inner: std::sync::Arc::new(stub),
90        }
91    }
92
93    pub(crate) async fn new(
94        config: gaxi::options::ClientConfig,
95    ) -> gax::client_builder::Result<Self> {
96        let inner = Self::build_inner(config).await?;
97        Ok(Self { inner })
98    }
99
100    async fn build_inner(
101        conf: gaxi::options::ClientConfig,
102    ) -> gax::client_builder::Result<std::sync::Arc<dyn super::stub::dynamic::MigrationService>>
103    {
104        if gaxi::options::tracing_enabled(&conf) {
105            return Ok(std::sync::Arc::new(Self::build_with_tracing(conf).await?));
106        }
107        Ok(std::sync::Arc::new(Self::build_transport(conf).await?))
108    }
109
110    async fn build_transport(
111        conf: gaxi::options::ClientConfig,
112    ) -> gax::client_builder::Result<impl super::stub::MigrationService> {
113        super::transport::MigrationService::new(conf).await
114    }
115
116    async fn build_with_tracing(
117        conf: gaxi::options::ClientConfig,
118    ) -> gax::client_builder::Result<impl super::stub::MigrationService> {
119        Self::build_transport(conf)
120            .await
121            .map(super::tracing::MigrationService::new)
122    }
123
124    /// Creates a migration workflow.
125    pub fn create_migration_workflow(
126        &self,
127    ) -> super::builder::migration_service::CreateMigrationWorkflow {
128        super::builder::migration_service::CreateMigrationWorkflow::new(self.inner.clone())
129    }
130
131    /// Gets a previously created migration workflow.
132    pub fn get_migration_workflow(
133        &self,
134    ) -> super::builder::migration_service::GetMigrationWorkflow {
135        super::builder::migration_service::GetMigrationWorkflow::new(self.inner.clone())
136    }
137
138    /// Lists previously created migration workflow.
139    pub fn list_migration_workflows(
140        &self,
141    ) -> super::builder::migration_service::ListMigrationWorkflows {
142        super::builder::migration_service::ListMigrationWorkflows::new(self.inner.clone())
143    }
144
145    /// Deletes a migration workflow by name.
146    pub fn delete_migration_workflow(
147        &self,
148    ) -> super::builder::migration_service::DeleteMigrationWorkflow {
149        super::builder::migration_service::DeleteMigrationWorkflow::new(self.inner.clone())
150    }
151
152    /// Starts a previously created migration workflow. I.e., the state transitions
153    /// from DRAFT to RUNNING. This is a no-op if the state is already RUNNING.
154    /// An error will be signaled if the state is anything other than DRAFT or
155    /// RUNNING.
156    pub fn start_migration_workflow(
157        &self,
158    ) -> super::builder::migration_service::StartMigrationWorkflow {
159        super::builder::migration_service::StartMigrationWorkflow::new(self.inner.clone())
160    }
161
162    /// Gets a previously created migration subtask.
163    pub fn get_migration_subtask(&self) -> super::builder::migration_service::GetMigrationSubtask {
164        super::builder::migration_service::GetMigrationSubtask::new(self.inner.clone())
165    }
166
167    /// Lists previously created migration subtasks.
168    pub fn list_migration_subtasks(
169        &self,
170    ) -> super::builder::migration_service::ListMigrationSubtasks {
171        super::builder::migration_service::ListMigrationSubtasks::new(self.inner.clone())
172    }
173}
google_cloud_bigquery_migration_v2/client.rs

google_cloud_bigquery_migration_v2/
client.rs
