google-cloud-blockchainnodeengine-v1 1.1.0

// Copyright 2026 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 Blockchain Node Engine API.
///
/// # Example
/// ```
/// # use google_cloud_blockchainnodeengine_v1::client::BlockchainNodeEngine;
/// use google_cloud_gax::paginator::ItemPaginator as _;
/// async fn sample(
///    project_id: &str,
///    location_id: &str,
/// ) -> anyhow::Result<()> {
///     let client = BlockchainNodeEngine::builder().build().await?;
///     let mut list = client.list_blockchain_nodes()
///         .set_parent(format!("projects/{project_id}/locations/{location_id}"))
///         .by_item();
///     while let Some(item) = list.next().await.transpose()? {
///         println!("{:?}", item);
///     }
///     Ok(())
/// }
/// ```
///
/// # Service Description
///
/// This service is the control plane API for Blockchain Node Engine,
/// and can be used to create, read, and delete blockchain nodes.
///
/// # Configuration
///
/// To configure `BlockchainNodeEngine` use the `with_*` methods in the type returned
/// by [builder()][BlockchainNodeEngine::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://blockchainnodeengine.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::blockchain_node_engine::ClientBuilder::with_endpoint
/// [with_credentials()]: super::builder::blockchain_node_engine::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
///
/// `BlockchainNodeEngine` holds a connection pool internally, it is advised to
/// create one and reuse it. You do not need to wrap `BlockchainNodeEngine` 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 BlockchainNodeEngine {
    inner: std::sync::Arc<dyn super::stub::dynamic::BlockchainNodeEngine>,
}

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

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

    /// Lists blockchain nodes in a given project and location.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_blockchainnodeengine_v1::client::BlockchainNodeEngine;
    /// use google_cloud_gax::paginator::ItemPaginator as _;
    /// use google_cloud_blockchainnodeengine_v1::Result;
    /// async fn sample(
    ///    client: &BlockchainNodeEngine, project_id: &str, location_id: &str
    /// ) -> Result<()> {
    ///     let mut list = client.list_blockchain_nodes()
    ///         .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_blockchain_nodes(
        &self,
    ) -> super::builder::blockchain_node_engine::ListBlockchainNodes {
        super::builder::blockchain_node_engine::ListBlockchainNodes::new(self.inner.clone())
    }

    /// Gets details of a single blockchain node.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_blockchainnodeengine_v1::client::BlockchainNodeEngine;
    /// use google_cloud_blockchainnodeengine_v1::Result;
    /// async fn sample(
    ///    client: &BlockchainNodeEngine, project_id: &str, location_id: &str, blockchain_node_id: &str
    /// ) -> Result<()> {
    ///     let response = client.get_blockchain_node()
    ///         .set_name(format!("projects/{project_id}/locations/{location_id}/blockchainNodes/{blockchain_node_id}"))
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn get_blockchain_node(&self) -> super::builder::blockchain_node_engine::GetBlockchainNode {
        super::builder::blockchain_node_engine::GetBlockchainNode::new(self.inner.clone())
    }

    /// Creates a new blockchain node 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_blockchainnodeengine_v1::client::BlockchainNodeEngine;
    /// use google_cloud_lro::Poller;
    /// use google_cloud_blockchainnodeengine_v1::model::BlockchainNode;
    /// use google_cloud_blockchainnodeengine_v1::Result;
    /// async fn sample(
    ///    client: &BlockchainNodeEngine, project_id: &str, location_id: &str
    /// ) -> Result<()> {
    ///     let response = client.create_blockchain_node()
    ///         .set_parent(format!("projects/{project_id}/locations/{location_id}"))
    ///         .set_blockchain_node(
    ///             BlockchainNode::new()/* set fields */
    ///         )
    ///         .poller().until_done().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn create_blockchain_node(
        &self,
    ) -> super::builder::blockchain_node_engine::CreateBlockchainNode {
        super::builder::blockchain_node_engine::CreateBlockchainNode::new(self.inner.clone())
    }

    /// Updates the parameters of a single blockchain node.
    ///
    /// # 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_blockchainnodeengine_v1::client::BlockchainNodeEngine;
    /// use google_cloud_lro::Poller;
    /// # extern crate wkt as google_cloud_wkt;
    /// use google_cloud_wkt::FieldMask;
    /// use google_cloud_blockchainnodeengine_v1::model::BlockchainNode;
    /// use google_cloud_blockchainnodeengine_v1::Result;
    /// async fn sample(
    ///    client: &BlockchainNodeEngine, project_id: &str, location_id: &str, blockchain_node_id: &str
    /// ) -> Result<()> {
    ///     let response = client.update_blockchain_node()
    ///         .set_blockchain_node(
    ///             BlockchainNode::new().set_name(format!("projects/{project_id}/locations/{location_id}/blockchainNodes/{blockchain_node_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_blockchain_node(
        &self,
    ) -> super::builder::blockchain_node_engine::UpdateBlockchainNode {
        super::builder::blockchain_node_engine::UpdateBlockchainNode::new(self.inner.clone())
    }

    /// Deletes a single blockchain node.
    ///
    /// # 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_blockchainnodeengine_v1::client::BlockchainNodeEngine;
    /// use google_cloud_lro::Poller;
    /// use google_cloud_blockchainnodeengine_v1::Result;
    /// async fn sample(
    ///    client: &BlockchainNodeEngine, project_id: &str, location_id: &str, blockchain_node_id: &str
    /// ) -> Result<()> {
    ///     client.delete_blockchain_node()
    ///         .set_name(format!("projects/{project_id}/locations/{location_id}/blockchainNodes/{blockchain_node_id}"))
    ///         .poller().until_done().await?;
    ///     Ok(())
    /// }
    /// ```
    pub fn delete_blockchain_node(
        &self,
    ) -> super::builder::blockchain_node_engine::DeleteBlockchainNode {
        super::builder::blockchain_node_engine::DeleteBlockchainNode::new(self.inner.clone())
    }

    /// Lists information about the supported locations for this service.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_blockchainnodeengine_v1::client::BlockchainNodeEngine;
    /// use google_cloud_gax::paginator::ItemPaginator as _;
    /// use google_cloud_blockchainnodeengine_v1::Result;
    /// async fn sample(
    ///    client: &BlockchainNodeEngine
    /// ) -> 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::blockchain_node_engine::ListLocations {
        super::builder::blockchain_node_engine::ListLocations::new(self.inner.clone())
    }

    /// Gets information about a location.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_blockchainnodeengine_v1::client::BlockchainNodeEngine;
    /// use google_cloud_blockchainnodeengine_v1::Result;
    /// async fn sample(
    ///    client: &BlockchainNodeEngine
    /// ) -> Result<()> {
    ///     let response = client.get_location()
    ///         /* set fields */
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn get_location(&self) -> super::builder::blockchain_node_engine::GetLocation {
        super::builder::blockchain_node_engine::GetLocation::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_blockchainnodeengine_v1::client::BlockchainNodeEngine;
    /// use google_cloud_gax::paginator::ItemPaginator as _;
    /// use google_cloud_blockchainnodeengine_v1::Result;
    /// async fn sample(
    ///    client: &BlockchainNodeEngine
    /// ) -> 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::blockchain_node_engine::ListOperations {
        super::builder::blockchain_node_engine::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_blockchainnodeengine_v1::client::BlockchainNodeEngine;
    /// use google_cloud_blockchainnodeengine_v1::Result;
    /// async fn sample(
    ///    client: &BlockchainNodeEngine
    /// ) -> Result<()> {
    ///     let response = client.get_operation()
    ///         /* set fields */
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn get_operation(&self) -> super::builder::blockchain_node_engine::GetOperation {
        super::builder::blockchain_node_engine::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_blockchainnodeengine_v1::client::BlockchainNodeEngine;
    /// use google_cloud_blockchainnodeengine_v1::Result;
    /// async fn sample(
    ///    client: &BlockchainNodeEngine
    /// ) -> Result<()> {
    ///     client.delete_operation()
    ///         /* set fields */
    ///         .send().await?;
    ///     Ok(())
    /// }
    /// ```
    pub fn delete_operation(&self) -> super::builder::blockchain_node_engine::DeleteOperation {
        super::builder::blockchain_node_engine::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_blockchainnodeengine_v1::client::BlockchainNodeEngine;
    /// use google_cloud_blockchainnodeengine_v1::Result;
    /// async fn sample(
    ///    client: &BlockchainNodeEngine
    /// ) -> Result<()> {
    ///     client.cancel_operation()
    ///         /* set fields */
    ///         .send().await?;
    ///     Ok(())
    /// }
    /// ```
    pub fn cancel_operation(&self) -> super::builder::blockchain_node_engine::CancelOperation {
        super::builder::blockchain_node_engine::CancelOperation::new(self.inner.clone())
    }
}