google-cloud-eventarc-v1 1.6.0

// 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 Eventarc API.
///
/// # Example
/// ```
/// # async fn sample() -> google_cloud_gax::client_builder::Result<()> {
/// # use google_cloud_eventarc_v1::client::Eventarc;
/// let client = Eventarc::builder().build().await?;
/// // use `client` to make requests to the Eventarc API.
/// # Ok(()) }
/// ```
///
/// # Service Description
///
/// Eventarc allows users to subscribe to various events that are provided by
/// Google Cloud services and forward them to supported destinations.
///
/// # Configuration
///
/// To configure `Eventarc` use the `with_*` methods in the type returned
/// by [builder()][Eventarc::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://eventarc.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::eventarc::ClientBuilder::with_endpoint
/// [with_credentials()]: super::builder::eventarc::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
///
/// `Eventarc` holds a connection pool internally, it is advised to
/// create one and the reuse it.  You do not need to wrap `Eventarc` 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 Eventarc {
    inner: std::sync::Arc<dyn super::stub::dynamic::Eventarc>,
}

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

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

    /// Get a single trigger.
    pub fn get_trigger(&self) -> super::builder::eventarc::GetTrigger {
        super::builder::eventarc::GetTrigger::new(self.inner.clone())
    }

    /// List triggers.
    pub fn list_triggers(&self) -> super::builder::eventarc::ListTriggers {
        super::builder::eventarc::ListTriggers::new(self.inner.clone())
    }

    /// Create a new trigger in a particular 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_trigger(&self) -> super::builder::eventarc::CreateTrigger {
        super::builder::eventarc::CreateTrigger::new(self.inner.clone())
    }

    /// Update a single trigger.
    ///
    /// # 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_trigger(&self) -> super::builder::eventarc::UpdateTrigger {
        super::builder::eventarc::UpdateTrigger::new(self.inner.clone())
    }

    /// Delete a single trigger.
    ///
    /// # 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_trigger(&self) -> super::builder::eventarc::DeleteTrigger {
        super::builder::eventarc::DeleteTrigger::new(self.inner.clone())
    }

    /// Get a single Channel.
    pub fn get_channel(&self) -> super::builder::eventarc::GetChannel {
        super::builder::eventarc::GetChannel::new(self.inner.clone())
    }

    /// List channels.
    pub fn list_channels(&self) -> super::builder::eventarc::ListChannels {
        super::builder::eventarc::ListChannels::new(self.inner.clone())
    }

    /// Create a new channel in a particular 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_channel(&self) -> super::builder::eventarc::CreateChannel {
        super::builder::eventarc::CreateChannel::new(self.inner.clone())
    }

    /// Update a single channel.
    ///
    /// # 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_channel(&self) -> super::builder::eventarc::UpdateChannel {
        super::builder::eventarc::UpdateChannel::new(self.inner.clone())
    }

    /// Delete a single channel.
    ///
    /// # 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_channel(&self) -> super::builder::eventarc::DeleteChannel {
        super::builder::eventarc::DeleteChannel::new(self.inner.clone())
    }

    /// Get a single Provider.
    pub fn get_provider(&self) -> super::builder::eventarc::GetProvider {
        super::builder::eventarc::GetProvider::new(self.inner.clone())
    }

    /// List providers.
    pub fn list_providers(&self) -> super::builder::eventarc::ListProviders {
        super::builder::eventarc::ListProviders::new(self.inner.clone())
    }

    /// Get a single ChannelConnection.
    pub fn get_channel_connection(&self) -> super::builder::eventarc::GetChannelConnection {
        super::builder::eventarc::GetChannelConnection::new(self.inner.clone())
    }

    /// List channel connections.
    pub fn list_channel_connections(&self) -> super::builder::eventarc::ListChannelConnections {
        super::builder::eventarc::ListChannelConnections::new(self.inner.clone())
    }

    /// Create a new ChannelConnection in a particular 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_channel_connection(&self) -> super::builder::eventarc::CreateChannelConnection {
        super::builder::eventarc::CreateChannelConnection::new(self.inner.clone())
    }

    /// Delete a single ChannelConnection.
    ///
    /// # 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_channel_connection(&self) -> super::builder::eventarc::DeleteChannelConnection {
        super::builder::eventarc::DeleteChannelConnection::new(self.inner.clone())
    }

    /// Get a GoogleChannelConfig.
    /// The name of the GoogleChannelConfig in the response is ALWAYS coded with
    /// projectID.
    pub fn get_google_channel_config(&self) -> super::builder::eventarc::GetGoogleChannelConfig {
        super::builder::eventarc::GetGoogleChannelConfig::new(self.inner.clone())
    }

    /// Update a single GoogleChannelConfig
    pub fn update_google_channel_config(
        &self,
    ) -> super::builder::eventarc::UpdateGoogleChannelConfig {
        super::builder::eventarc::UpdateGoogleChannelConfig::new(self.inner.clone())
    }

    /// Get a single MessageBus.
    pub fn get_message_bus(&self) -> super::builder::eventarc::GetMessageBus {
        super::builder::eventarc::GetMessageBus::new(self.inner.clone())
    }

    /// List message buses.
    pub fn list_message_buses(&self) -> super::builder::eventarc::ListMessageBuses {
        super::builder::eventarc::ListMessageBuses::new(self.inner.clone())
    }

    /// List message bus enrollments.
    pub fn list_message_bus_enrollments(
        &self,
    ) -> super::builder::eventarc::ListMessageBusEnrollments {
        super::builder::eventarc::ListMessageBusEnrollments::new(self.inner.clone())
    }

    /// Create a new MessageBus in a particular 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_message_bus(&self) -> super::builder::eventarc::CreateMessageBus {
        super::builder::eventarc::CreateMessageBus::new(self.inner.clone())
    }

    /// Update a single message bus.
    ///
    /// # 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_message_bus(&self) -> super::builder::eventarc::UpdateMessageBus {
        super::builder::eventarc::UpdateMessageBus::new(self.inner.clone())
    }

    /// Delete a single message bus.
    ///
    /// # 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_message_bus(&self) -> super::builder::eventarc::DeleteMessageBus {
        super::builder::eventarc::DeleteMessageBus::new(self.inner.clone())
    }

    /// Get a single Enrollment.
    pub fn get_enrollment(&self) -> super::builder::eventarc::GetEnrollment {
        super::builder::eventarc::GetEnrollment::new(self.inner.clone())
    }

    /// List Enrollments.
    pub fn list_enrollments(&self) -> super::builder::eventarc::ListEnrollments {
        super::builder::eventarc::ListEnrollments::new(self.inner.clone())
    }

    /// Create a new Enrollment in a particular 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_enrollment(&self) -> super::builder::eventarc::CreateEnrollment {
        super::builder::eventarc::CreateEnrollment::new(self.inner.clone())
    }

    /// Update a single Enrollment.
    ///
    /// # 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_enrollment(&self) -> super::builder::eventarc::UpdateEnrollment {
        super::builder::eventarc::UpdateEnrollment::new(self.inner.clone())
    }

    /// Delete a single Enrollment.
    ///
    /// # 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_enrollment(&self) -> super::builder::eventarc::DeleteEnrollment {
        super::builder::eventarc::DeleteEnrollment::new(self.inner.clone())
    }

    /// Get a single Pipeline.
    pub fn get_pipeline(&self) -> super::builder::eventarc::GetPipeline {
        super::builder::eventarc::GetPipeline::new(self.inner.clone())
    }

    /// List pipelines.
    pub fn list_pipelines(&self) -> super::builder::eventarc::ListPipelines {
        super::builder::eventarc::ListPipelines::new(self.inner.clone())
    }

    /// Create a new Pipeline in a particular 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_pipeline(&self) -> super::builder::eventarc::CreatePipeline {
        super::builder::eventarc::CreatePipeline::new(self.inner.clone())
    }

    /// Update a single pipeline.
    ///
    /// # 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_pipeline(&self) -> super::builder::eventarc::UpdatePipeline {
        super::builder::eventarc::UpdatePipeline::new(self.inner.clone())
    }

    /// Delete a single pipeline.
    ///
    /// # 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_pipeline(&self) -> super::builder::eventarc::DeletePipeline {
        super::builder::eventarc::DeletePipeline::new(self.inner.clone())
    }

    /// Get a single GoogleApiSource.
    pub fn get_google_api_source(&self) -> super::builder::eventarc::GetGoogleApiSource {
        super::builder::eventarc::GetGoogleApiSource::new(self.inner.clone())
    }

    /// List GoogleApiSources.
    pub fn list_google_api_sources(&self) -> super::builder::eventarc::ListGoogleApiSources {
        super::builder::eventarc::ListGoogleApiSources::new(self.inner.clone())
    }

    /// Create a new GoogleApiSource in a particular 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_google_api_source(&self) -> super::builder::eventarc::CreateGoogleApiSource {
        super::builder::eventarc::CreateGoogleApiSource::new(self.inner.clone())
    }

    /// Update a single GoogleApiSource.
    ///
    /// # 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_google_api_source(&self) -> super::builder::eventarc::UpdateGoogleApiSource {
        super::builder::eventarc::UpdateGoogleApiSource::new(self.inner.clone())
    }

    /// Delete a single GoogleApiSource.
    ///
    /// # 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_google_api_source(&self) -> super::builder::eventarc::DeleteGoogleApiSource {
        super::builder::eventarc::DeleteGoogleApiSource::new(self.inner.clone())
    }

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

    /// Gets information about a location.
    pub fn get_location(&self) -> super::builder::eventarc::GetLocation {
        super::builder::eventarc::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.
    pub fn set_iam_policy(&self) -> super::builder::eventarc::SetIamPolicy {
        super::builder::eventarc::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.
    pub fn get_iam_policy(&self) -> super::builder::eventarc::GetIamPolicy {
        super::builder::eventarc::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.
    pub fn test_iam_permissions(&self) -> super::builder::eventarc::TestIamPermissions {
        super::builder::eventarc::TestIamPermissions::new(self.inner.clone())
    }

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

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

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

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