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

/// Implements a client for the Developer Connect API.
///
/// # Example
/// ```
/// # tokio_test::block_on(async {
/// # use google_cloud_developerconnect_v1::client::DeveloperConnect;
/// let client = DeveloperConnect::builder().build().await?;
/// // use `client` to make requests to the Developer Connect API.
/// # gax::client_builder::Result::<()>::Ok(()) });
/// ```
///
/// # Service Description
///
/// Service describing handlers for resources
///
/// # Configuration
///
/// To configure `DeveloperConnect` use the `with_*` methods in the type returned
/// by [builder()][DeveloperConnect::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://developerconnect.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::developer_connect::ClientBuilder::with_endpoint
/// [with_credentials()]: super::builder::developer_connect::ClientBuilder::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
///
/// `DeveloperConnect` holds a connection pool internally, it is advised to
/// create one and the reuse it.  You do not need to wrap `DeveloperConnect` 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 DeveloperConnect {
    inner: std::sync::Arc<dyn super::stub::dynamic::DeveloperConnect>,
}

impl DeveloperConnect {
    /// Returns a builder for [DeveloperConnect].
    ///
    /// ```
    /// # tokio_test::block_on(async {
    /// # use google_cloud_developerconnect_v1::client::DeveloperConnect;
    /// let client = DeveloperConnect::builder().build().await?;
    /// # gax::client_builder::Result::<()>::Ok(()) });
    /// ```
    pub fn builder() -> super::builder::developer_connect::ClientBuilder {
        gax::client_builder::internal::new_builder(
            super::builder::developer_connect::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::DeveloperConnect + 'static,
    {
        Self {
            inner: std::sync::Arc::new(stub),
        }
    }

    pub(crate) async fn new(
        config: gaxi::options::ClientConfig,
    ) -> gax::client_builder::Result<Self> {
        let inner = Self::build_inner(config).await?;
        Ok(Self { inner })
    }

    async fn build_inner(
        conf: gaxi::options::ClientConfig,
    ) -> gax::client_builder::Result<std::sync::Arc<dyn super::stub::dynamic::DeveloperConnect>>
    {
        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,
    ) -> gax::client_builder::Result<impl super::stub::DeveloperConnect> {
        super::transport::DeveloperConnect::new(conf).await
    }

    async fn build_with_tracing(
        conf: gaxi::options::ClientConfig,
    ) -> gax::client_builder::Result<impl super::stub::DeveloperConnect> {
        Self::build_transport(conf)
            .await
            .map(super::tracing::DeveloperConnect::new)
    }

    /// Lists Connections in a given project and location.
    pub fn list_connections(&self) -> super::builder::developer_connect::ListConnections {
        super::builder::developer_connect::ListConnections::new(self.inner.clone())
    }

    /// Gets details of a single Connection.
    pub fn get_connection(&self) -> super::builder::developer_connect::GetConnection {
        super::builder::developer_connect::GetConnection::new(self.inner.clone())
    }

    /// Creates a new Connection 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
    pub fn create_connection(&self) -> super::builder::developer_connect::CreateConnection {
        super::builder::developer_connect::CreateConnection::new(self.inner.clone())
    }

    /// Updates the parameters of a single Connection.
    ///
    /// # 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
    pub fn update_connection(&self) -> super::builder::developer_connect::UpdateConnection {
        super::builder::developer_connect::UpdateConnection::new(self.inner.clone())
    }

    /// Deletes a single Connection.
    ///
    /// # 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
    pub fn delete_connection(&self) -> super::builder::developer_connect::DeleteConnection {
        super::builder::developer_connect::DeleteConnection::new(self.inner.clone())
    }

    /// Creates a GitRepositoryLink. Upon linking a Git Repository, Developer
    /// Connect will configure the Git Repository to send webhook events to
    /// Developer Connect. Connections that use Firebase GitHub Application will
    /// have events forwarded to the Firebase service. All other Connections will
    /// have events forwarded to Cloud Build.
    ///
    /// # 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
    pub fn create_git_repository_link(
        &self,
    ) -> super::builder::developer_connect::CreateGitRepositoryLink {
        super::builder::developer_connect::CreateGitRepositoryLink::new(self.inner.clone())
    }

    /// Deletes a single GitRepositoryLink.
    ///
    /// # 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
    pub fn delete_git_repository_link(
        &self,
    ) -> super::builder::developer_connect::DeleteGitRepositoryLink {
        super::builder::developer_connect::DeleteGitRepositoryLink::new(self.inner.clone())
    }

    /// Lists GitRepositoryLinks in a given project, location, and connection.
    pub fn list_git_repository_links(
        &self,
    ) -> super::builder::developer_connect::ListGitRepositoryLinks {
        super::builder::developer_connect::ListGitRepositoryLinks::new(self.inner.clone())
    }

    /// Gets details of a single GitRepositoryLink.
    pub fn get_git_repository_link(
        &self,
    ) -> super::builder::developer_connect::GetGitRepositoryLink {
        super::builder::developer_connect::GetGitRepositoryLink::new(self.inner.clone())
    }

    /// Fetches read/write token of a given gitRepositoryLink.
    pub fn fetch_read_write_token(&self) -> super::builder::developer_connect::FetchReadWriteToken {
        super::builder::developer_connect::FetchReadWriteToken::new(self.inner.clone())
    }

    /// Fetches read token of a given gitRepositoryLink.
    pub fn fetch_read_token(&self) -> super::builder::developer_connect::FetchReadToken {
        super::builder::developer_connect::FetchReadToken::new(self.inner.clone())
    }

    /// FetchLinkableGitRepositories returns a list of git repositories from an SCM
    /// that are available to be added to a Connection.
    pub fn fetch_linkable_git_repositories(
        &self,
    ) -> super::builder::developer_connect::FetchLinkableGitRepositories {
        super::builder::developer_connect::FetchLinkableGitRepositories::new(self.inner.clone())
    }

    /// FetchGitHubInstallations returns the list of GitHub Installations that
    /// are available to be added to a Connection.
    /// For github.com, only installations accessible to the authorizer token
    /// are returned. For GitHub Enterprise, all installations are returned.
    pub fn fetch_git_hub_installations(
        &self,
    ) -> super::builder::developer_connect::FetchGitHubInstallations {
        super::builder::developer_connect::FetchGitHubInstallations::new(self.inner.clone())
    }

    /// Fetch the list of branches or tags for a given repository.
    pub fn fetch_git_refs(&self) -> super::builder::developer_connect::FetchGitRefs {
        super::builder::developer_connect::FetchGitRefs::new(self.inner.clone())
    }

    /// Lists information about the supported locations for this service.
    pub fn list_locations(&self) -> super::builder::developer_connect::ListLocations {
        super::builder::developer_connect::ListLocations::new(self.inner.clone())
    }

    /// Gets information about a location.
    pub fn get_location(&self) -> super::builder::developer_connect::GetLocation {
        super::builder::developer_connect::GetLocation::new(self.inner.clone())
    }

    /// Provides the [Operations][google.longrunning.Operations] service functionality in this service.
    ///
    /// [google.longrunning.Operations]: longrunning::client::Operations
    pub fn list_operations(&self) -> super::builder::developer_connect::ListOperations {
        super::builder::developer_connect::ListOperations::new(self.inner.clone())
    }

    /// Provides the [Operations][google.longrunning.Operations] service functionality in this service.
    ///
    /// [google.longrunning.Operations]: longrunning::client::Operations
    pub fn get_operation(&self) -> super::builder::developer_connect::GetOperation {
        super::builder::developer_connect::GetOperation::new(self.inner.clone())
    }

    /// Provides the [Operations][google.longrunning.Operations] service functionality in this service.
    ///
    /// [google.longrunning.Operations]: longrunning::client::Operations
    pub fn delete_operation(&self) -> super::builder::developer_connect::DeleteOperation {
        super::builder::developer_connect::DeleteOperation::new(self.inner.clone())
    }

    /// Provides the [Operations][google.longrunning.Operations] service functionality in this service.
    ///
    /// [google.longrunning.Operations]: longrunning::client::Operations
    pub fn cancel_operation(&self) -> super::builder::developer_connect::CancelOperation {
        super::builder::developer_connect::CancelOperation::new(self.inner.clone())
    }
}