google_cloud_notebooks_v2/

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::redundant_explicit_links)]
#![allow(rustdoc::broken_intra_doc_links)]

/// Implements a client for the Notebooks API.
///
/// # Example
/// ```
/// # use google_cloud_notebooks_v2::client::NotebookService;
/// use google_cloud_gax::paginator::ItemPaginator as _;
/// # async fn sample() -> Result<(), Box<dyn std::error::Error>> {
///     let client = NotebookService::builder().build().await?;
///     let parent = "parent_value";
///     let mut list = client.list_instances()
///         .set_parent(parent)
///         .by_item();
///     while let Some(item) = list.next().await.transpose()? {
///         println!("{:?}", item);
///     }
/// # Ok(()) }
/// ```
///
/// # Service Description
///
/// API v2 service for Workbench Notebooks Instances.
///
/// # Configuration
///
/// To configure `NotebookService` use the `with_*` methods in the type returned
/// by [builder()][NotebookService::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://notebooks.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::notebook_service::ClientBuilder::with_endpoint
/// [with_credentials()]: super::builder::notebook_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
///
/// `NotebookService` holds a connection pool internally, it is advised to
/// create one and reuse it. You do not need to wrap `NotebookService` 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 NotebookService {
    inner: std::sync::Arc<dyn super::stub::dynamic::NotebookService>,
}

impl NotebookService {
    /// Returns a builder for [NotebookService].
    ///
    /// ```
    /// # async fn sample() -> google_cloud_gax::client_builder::Result<()> {
    /// # use google_cloud_notebooks_v2::client::NotebookService;
    /// let client = NotebookService::builder().build().await?;
    /// # Ok(()) }
    /// ```
    pub fn builder() -> super::builder::notebook_service::ClientBuilder {
        crate::new_client_builder(super::builder::notebook_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: T) -> Self
    where
        T: super::stub::NotebookService + 'static,
    {
        Self {
            inner: std::sync::Arc::new(stub),
        }
    }

    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::NotebookService>> {
        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::NotebookService> {
        super::transport::NotebookService::new(conf).await
    }

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

    /// Lists instances in a given project and location.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_notebooks_v2::client::NotebookService;
    /// use google_cloud_gax::paginator::ItemPaginator as _;
    /// use google_cloud_notebooks_v2::Result;
    /// async fn sample(
    ///    client: &NotebookService, parent: &str
    /// ) -> Result<()> {
    ///     let mut list = client.list_instances()
    ///         .set_parent(parent)
    ///         .by_item();
    ///     while let Some(item) = list.next().await.transpose()? {
    ///         println!("{:?}", item);
    ///     }
    ///     Ok(())
    /// }
    /// ```
    pub fn list_instances(&self) -> super::builder::notebook_service::ListInstances {
        super::builder::notebook_service::ListInstances::new(self.inner.clone())
    }

    /// Gets details of a single Instance.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_notebooks_v2::client::NotebookService;
    /// use google_cloud_notebooks_v2::Result;
    /// async fn sample(
    ///    client: &NotebookService, name: &str
    /// ) -> Result<()> {
    ///     let response = client.get_instance()
    ///         .set_name(name)
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn get_instance(&self) -> super::builder::notebook_service::GetInstance {
        super::builder::notebook_service::GetInstance::new(self.inner.clone())
    }

    /// Creates a new Instance 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_notebooks_v2::client::NotebookService;
    /// use google_cloud_lro::Poller;
    /// use google_cloud_notebooks_v2::model::Instance;
    /// use google_cloud_notebooks_v2::Result;
    /// async fn sample(
    ///    client: &NotebookService, parent: &str
    /// ) -> Result<()> {
    ///     let response = client.create_instance()
    ///         .set_parent(parent)
    ///         .set_instance_id("instance_id_value")
    ///         .set_instance(
    ///             Instance::new()/* set fields */
    ///         )
    ///         .poller().until_done().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn create_instance(&self) -> super::builder::notebook_service::CreateInstance {
        super::builder::notebook_service::CreateInstance::new(self.inner.clone())
    }

    /// UpdateInstance updates an Instance.
    ///
    /// # 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_notebooks_v2::client::NotebookService;
    /// use google_cloud_lro::Poller;
    /// # extern crate wkt as google_cloud_wkt;
    /// use google_cloud_wkt::FieldMask;
    /// use google_cloud_notebooks_v2::model::Instance;
    /// use google_cloud_notebooks_v2::Result;
    /// async fn sample(
    ///    client: &NotebookService, name: &str
    /// ) -> Result<()> {
    ///     let response = client.update_instance()
    ///         .set_instance(
    ///             Instance::new().set_name(name)/* 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_instance(&self) -> super::builder::notebook_service::UpdateInstance {
        super::builder::notebook_service::UpdateInstance::new(self.inner.clone())
    }

    /// Deletes a single Instance.
    ///
    /// # 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_notebooks_v2::client::NotebookService;
    /// use google_cloud_lro::Poller;
    /// use google_cloud_notebooks_v2::Result;
    /// async fn sample(
    ///    client: &NotebookService, name: &str
    /// ) -> Result<()> {
    ///     client.delete_instance()
    ///         .set_name(name)
    ///         .poller().until_done().await?;
    ///     Ok(())
    /// }
    /// ```
    pub fn delete_instance(&self) -> super::builder::notebook_service::DeleteInstance {
        super::builder::notebook_service::DeleteInstance::new(self.inner.clone())
    }

    /// Starts a notebook instance.
    ///
    /// # 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_notebooks_v2::client::NotebookService;
    /// use google_cloud_lro::Poller;
    /// use google_cloud_notebooks_v2::Result;
    /// async fn sample(
    ///    client: &NotebookService
    /// ) -> Result<()> {
    ///     let response = client.start_instance()
    ///         /* set fields */
    ///         .poller().until_done().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn start_instance(&self) -> super::builder::notebook_service::StartInstance {
        super::builder::notebook_service::StartInstance::new(self.inner.clone())
    }

    /// Stops a notebook instance.
    ///
    /// # 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_notebooks_v2::client::NotebookService;
    /// use google_cloud_lro::Poller;
    /// use google_cloud_notebooks_v2::Result;
    /// async fn sample(
    ///    client: &NotebookService
    /// ) -> Result<()> {
    ///     let response = client.stop_instance()
    ///         /* set fields */
    ///         .poller().until_done().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn stop_instance(&self) -> super::builder::notebook_service::StopInstance {
        super::builder::notebook_service::StopInstance::new(self.inner.clone())
    }

    /// Resets a notebook instance.
    ///
    /// # 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_notebooks_v2::client::NotebookService;
    /// use google_cloud_lro::Poller;
    /// use google_cloud_notebooks_v2::Result;
    /// async fn sample(
    ///    client: &NotebookService
    /// ) -> Result<()> {
    ///     let response = client.reset_instance()
    ///         /* set fields */
    ///         .poller().until_done().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn reset_instance(&self) -> super::builder::notebook_service::ResetInstance {
        super::builder::notebook_service::ResetInstance::new(self.inner.clone())
    }

    /// Checks whether a notebook instance is upgradable.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_notebooks_v2::client::NotebookService;
    /// use google_cloud_notebooks_v2::Result;
    /// async fn sample(
    ///    client: &NotebookService
    /// ) -> Result<()> {
    ///     let response = client.check_instance_upgradability()
    ///         /* set fields */
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn check_instance_upgradability(
        &self,
    ) -> super::builder::notebook_service::CheckInstanceUpgradability {
        super::builder::notebook_service::CheckInstanceUpgradability::new(self.inner.clone())
    }

    /// Upgrades a notebook instance to the latest version.
    ///
    /// # 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_notebooks_v2::client::NotebookService;
    /// use google_cloud_lro::Poller;
    /// use google_cloud_notebooks_v2::Result;
    /// async fn sample(
    ///    client: &NotebookService
    /// ) -> Result<()> {
    ///     let response = client.upgrade_instance()
    ///         /* set fields */
    ///         .poller().until_done().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn upgrade_instance(&self) -> super::builder::notebook_service::UpgradeInstance {
        super::builder::notebook_service::UpgradeInstance::new(self.inner.clone())
    }

    /// Rollbacks a notebook instance to the previous version.
    ///
    /// # 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_notebooks_v2::client::NotebookService;
    /// use google_cloud_lro::Poller;
    /// use google_cloud_notebooks_v2::Result;
    /// async fn sample(
    ///    client: &NotebookService
    /// ) -> Result<()> {
    ///     let response = client.rollback_instance()
    ///         /* set fields */
    ///         .poller().until_done().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn rollback_instance(&self) -> super::builder::notebook_service::RollbackInstance {
        super::builder::notebook_service::RollbackInstance::new(self.inner.clone())
    }

    /// Creates a Diagnostic File and runs Diagnostic Tool given an Instance.
    ///
    /// # 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_notebooks_v2::client::NotebookService;
    /// use google_cloud_lro::Poller;
    /// use google_cloud_notebooks_v2::Result;
    /// async fn sample(
    ///    client: &NotebookService
    /// ) -> Result<()> {
    ///     let response = client.diagnose_instance()
    ///         /* set fields */
    ///         .poller().until_done().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn diagnose_instance(&self) -> super::builder::notebook_service::DiagnoseInstance {
        super::builder::notebook_service::DiagnoseInstance::new(self.inner.clone())
    }

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

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