google_cloud_workflows_executions_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 Workflow Executions API.
///
/// # Example
/// ```
/// # use google_cloud_workflows_executions_v1::client::Executions;
/// use google_cloud_gax::paginator::ItemPaginator as _;
/// async fn sample(
///    parent: &str,
/// ) -> anyhow::Result<()> {
///     let client = Executions::builder().build().await?;
///     let mut list = client.list_executions()
///         .set_parent(parent)
///         .by_item();
///     while let Some(item) = list.next().await.transpose()? {
///         println!("{:?}", item);
///     }
///     Ok(())
/// }
/// ```
///
/// # Service Description
///
/// Executions is used to start and manage running instances of
/// [Workflows][google.cloud.workflows.v1.Workflow] called executions.
///
/// # Configuration
///
/// To configure `Executions` use the `with_*` methods in the type returned
/// by [builder()][Executions::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://workflowexecutions.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::executions::ClientBuilder::with_endpoint
/// [with_credentials()]: super::builder::executions::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
///
/// `Executions` holds a connection pool internally, it is advised to
/// create one and reuse it. You do not need to wrap `Executions` 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 Executions {
    inner: std::sync::Arc<dyn super::stub::dynamic::Executions>,
}

impl Executions {
    /// Returns a builder for [Executions].
    ///
    /// ```
    /// # async fn sample() -> google_cloud_gax::client_builder::Result<()> {
    /// # use google_cloud_workflows_executions_v1::client::Executions;
    /// let client = Executions::builder().build().await?;
    /// # Ok(()) }
    /// ```
    pub fn builder() -> super::builder::executions::ClientBuilder {
        crate::new_client_builder(super::builder::executions::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::Executions + '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::Executions>> {
        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::Executions> {
        super::transport::Executions::new(conf).await
    }

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

    /// Returns a list of executions which belong to the workflow with
    /// the given name. The method returns executions of all workflow
    /// revisions. Returned executions are ordered by their start time (newest
    /// first).
    ///
    /// # Example
    /// ```
    /// # use google_cloud_workflows_executions_v1::client::Executions;
    /// use google_cloud_gax::paginator::ItemPaginator as _;
    /// use google_cloud_workflows_executions_v1::Result;
    /// async fn sample(
    ///    client: &Executions, parent: &str
    /// ) -> Result<()> {
    ///     let mut list = client.list_executions()
    ///         .set_parent(parent)
    ///         .by_item();
    ///     while let Some(item) = list.next().await.transpose()? {
    ///         println!("{:?}", item);
    ///     }
    ///     Ok(())
    /// }
    /// ```
    pub fn list_executions(&self) -> super::builder::executions::ListExecutions {
        super::builder::executions::ListExecutions::new(self.inner.clone())
    }

    /// Creates a new execution using the latest revision of the given workflow.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_workflows_executions_v1::client::Executions;
    /// use google_cloud_workflows_executions_v1::model::Execution;
    /// use google_cloud_workflows_executions_v1::Result;
    /// async fn sample(
    ///    client: &Executions, parent: &str
    /// ) -> Result<()> {
    ///     let response = client.create_execution()
    ///         .set_parent(parent)
    ///         .set_execution(
    ///             Execution::new()/* set fields */
    ///         )
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn create_execution(&self) -> super::builder::executions::CreateExecution {
        super::builder::executions::CreateExecution::new(self.inner.clone())
    }

    /// Returns an execution of the given name.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_workflows_executions_v1::client::Executions;
    /// use google_cloud_workflows_executions_v1::Result;
    /// async fn sample(
    ///    client: &Executions, project_id: &str, location_id: &str, workflow_id: &str, execution_id: &str
    /// ) -> Result<()> {
    ///     let response = client.get_execution()
    ///         .set_name(format!("projects/{project_id}/locations/{location_id}/workflows/{workflow_id}/executions/{execution_id}"))
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn get_execution(&self) -> super::builder::executions::GetExecution {
        super::builder::executions::GetExecution::new(self.inner.clone())
    }

    /// Cancels an execution of the given name.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_workflows_executions_v1::client::Executions;
    /// use google_cloud_workflows_executions_v1::Result;
    /// async fn sample(
    ///    client: &Executions
    /// ) -> Result<()> {
    ///     let response = client.cancel_execution()
    ///         /* set fields */
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn cancel_execution(&self) -> super::builder::executions::CancelExecution {
        super::builder::executions::CancelExecution::new(self.inner.clone())
    }
}