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/// # async fn sample() -> google_cloud_gax::client_builder::Result<()> {
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/// # 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    /// # async fn sample() -> google_cloud_gax::client_builder::Result<()> {
70    /// # use google_cloud_bigquery_migration_v2::client::MigrationService;
71    /// let client = MigrationService::builder().build().await?;
72    /// # Ok(()) }
73    /// ```
74    pub fn builder() -> super::builder::migration_service::ClientBuilder {
75        crate::new_client_builder(super::builder::migration_service::client::Factory)
76    }
77
78    /// Creates a new client from the provided stub.
79    ///
80    /// The most common case for calling this function is in tests mocking the
81    /// client's behavior.
82    pub fn from_stub<T>(stub: T) -> Self
83    where
84        T: super::stub::MigrationService + 'static,
85    {
86        Self {
87            inner: std::sync::Arc::new(stub),
88        }
89    }
90
91    pub(crate) async fn new(
92        config: gaxi::options::ClientConfig,
93    ) -> crate::ClientBuilderResult<Self> {
94        let inner = Self::build_inner(config).await?;
95        Ok(Self { inner })
96    }
97
98    async fn build_inner(
99        conf: gaxi::options::ClientConfig,
100    ) -> crate::ClientBuilderResult<std::sync::Arc<dyn super::stub::dynamic::MigrationService>>
101    {
102        if gaxi::options::tracing_enabled(&conf) {
103            return Ok(std::sync::Arc::new(Self::build_with_tracing(conf).await?));
104        }
105        Ok(std::sync::Arc::new(Self::build_transport(conf).await?))
106    }
107
108    async fn build_transport(
109        conf: gaxi::options::ClientConfig,
110    ) -> crate::ClientBuilderResult<impl super::stub::MigrationService> {
111        super::transport::MigrationService::new(conf).await
112    }
113
114    async fn build_with_tracing(
115        conf: gaxi::options::ClientConfig,
116    ) -> crate::ClientBuilderResult<impl super::stub::MigrationService> {
117        Self::build_transport(conf)
118            .await
119            .map(super::tracing::MigrationService::new)
120    }
121
122    /// Creates a migration workflow.
123    pub fn create_migration_workflow(
124        &self,
125    ) -> super::builder::migration_service::CreateMigrationWorkflow {
126        super::builder::migration_service::CreateMigrationWorkflow::new(self.inner.clone())
127    }
128
129    /// Gets a previously created migration workflow.
130    pub fn get_migration_workflow(
131        &self,
132    ) -> super::builder::migration_service::GetMigrationWorkflow {
133        super::builder::migration_service::GetMigrationWorkflow::new(self.inner.clone())
134    }
135
136    /// Lists previously created migration workflow.
137    pub fn list_migration_workflows(
138        &self,
139    ) -> super::builder::migration_service::ListMigrationWorkflows {
140        super::builder::migration_service::ListMigrationWorkflows::new(self.inner.clone())
141    }
142
143    /// Deletes a migration workflow by name.
144    pub fn delete_migration_workflow(
145        &self,
146    ) -> super::builder::migration_service::DeleteMigrationWorkflow {
147        super::builder::migration_service::DeleteMigrationWorkflow::new(self.inner.clone())
148    }
149
150    /// Starts a previously created migration workflow. I.e., the state transitions
151    /// from DRAFT to RUNNING. This is a no-op if the state is already RUNNING.
152    /// An error will be signaled if the state is anything other than DRAFT or
153    /// RUNNING.
154    pub fn start_migration_workflow(
155        &self,
156    ) -> super::builder::migration_service::StartMigrationWorkflow {
157        super::builder::migration_service::StartMigrationWorkflow::new(self.inner.clone())
158    }
159
160    /// Gets a previously created migration subtask.
161    pub fn get_migration_subtask(&self) -> super::builder::migration_service::GetMigrationSubtask {
162        super::builder::migration_service::GetMigrationSubtask::new(self.inner.clone())
163    }
164
165    /// Lists previously created migration subtasks.
166    pub fn list_migration_subtasks(
167        &self,
168    ) -> super::builder::migration_service::ListMigrationSubtasks {
169        super::builder::migration_service::ListMigrationSubtasks::new(self.inner.clone())
170    }
171}
google_cloud_bigquery_migration_v2/client.rs

google_cloud_bigquery_migration_v2/
client.rs
