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

/// Implements a client for the Cloud Functions API.
///
/// # Example
/// ```
/// # use google_cloud_functions_v2::client::FunctionService;
/// use google_cloud_gax::paginator::ItemPaginator as _;
/// async fn sample(
///    project_id: &str,
///    location_id: &str,
/// ) -> anyhow::Result<()> {
///     let client = FunctionService::builder().build().await?;
///     let mut list = client.list_functions()
///         .set_parent(format!("projects/{project_id}/locations/{location_id}"))
///         .by_item();
///     while let Some(item) = list.next().await.transpose()? {
///         println!("{:?}", item);
///     }
///     Ok(())
/// }
/// ```
///
/// # Service Description
///
/// Google Cloud Functions is used to deploy functions that are executed by
/// Google in response to various events. Data connected with that event is
/// passed to a function as the input data.
///
/// A **function** is a resource which describes a function that should be
/// executed and how it is triggered.
///
/// # Configuration
///
/// To configure `FunctionService` use the `with_*` methods in the type returned
/// by [builder()][FunctionService::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://cloudfunctions.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::function_service::ClientBuilder::with_endpoint
/// [with_credentials()]: super::builder::function_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
///
/// `FunctionService` holds a connection pool internally, it is advised to
/// create one and reuse it. You do not need to wrap `FunctionService` 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 FunctionService {
    inner: std::sync::Arc<dyn super::stub::dynamic::FunctionService>,
}

impl FunctionService {
    /// Returns a builder for [FunctionService].
    ///
    /// ```
    /// # async fn sample() -> google_cloud_gax::client_builder::Result<()> {
    /// # use google_cloud_functions_v2::client::FunctionService;
    /// let client = FunctionService::builder().build().await?;
    /// # Ok(()) }
    /// ```
    pub fn builder() -> super::builder::function_service::ClientBuilder {
        crate::new_client_builder(super::builder::function_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: impl Into<std::sync::Arc<T>>) -> Self
    where
        T: super::stub::FunctionService + '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::FunctionService>> {
        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::FunctionService> {
        super::transport::FunctionService::new(conf).await
    }

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

    /// Returns a function with the given name from the requested project.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_functions_v2::client::FunctionService;
    /// use google_cloud_functions_v2::Result;
    /// async fn sample(
    ///    client: &FunctionService, project_id: &str, location_id: &str, function_id: &str
    /// ) -> Result<()> {
    ///     let response = client.get_function()
    ///         .set_name(format!("projects/{project_id}/locations/{location_id}/functions/{function_id}"))
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn get_function(&self) -> super::builder::function_service::GetFunction {
        super::builder::function_service::GetFunction::new(self.inner.clone())
    }

    /// Returns a list of functions that belong to the requested project.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_functions_v2::client::FunctionService;
    /// use google_cloud_gax::paginator::ItemPaginator as _;
    /// use google_cloud_functions_v2::Result;
    /// async fn sample(
    ///    client: &FunctionService, project_id: &str, location_id: &str
    /// ) -> Result<()> {
    ///     let mut list = client.list_functions()
    ///         .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_functions(&self) -> super::builder::function_service::ListFunctions {
        super::builder::function_service::ListFunctions::new(self.inner.clone())
    }

    /// Creates a new function. If a function with the given name already exists in
    /// the specified project, the long running operation will return
    /// `ALREADY_EXISTS` error.
    ///
    /// # 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_functions_v2::client::FunctionService;
    /// use google_cloud_lro::Poller;
    /// use google_cloud_functions_v2::model::Function;
    /// use google_cloud_functions_v2::Result;
    /// async fn sample(
    ///    client: &FunctionService, parent: &str
    /// ) -> Result<()> {
    ///     let response = client.create_function()
    ///         .set_parent(parent)
    ///         .set_function_id("function_id_value")
    ///         .set_function(
    ///             Function::new()/* set fields */
    ///         )
    ///         .poller().until_done().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn create_function(&self) -> super::builder::function_service::CreateFunction {
        super::builder::function_service::CreateFunction::new(self.inner.clone())
    }

    /// Updates existing function.
    ///
    /// # 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_functions_v2::client::FunctionService;
    /// use google_cloud_lro::Poller;
    /// # extern crate wkt as google_cloud_wkt;
    /// use google_cloud_wkt::FieldMask;
    /// use google_cloud_functions_v2::model::Function;
    /// use google_cloud_functions_v2::Result;
    /// async fn sample(
    ///    client: &FunctionService, project_id: &str, location_id: &str, function_id: &str
    /// ) -> Result<()> {
    ///     let response = client.update_function()
    ///         .set_function(
    ///             Function::new().set_name(format!("projects/{project_id}/locations/{location_id}/functions/{function_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_function(&self) -> super::builder::function_service::UpdateFunction {
        super::builder::function_service::UpdateFunction::new(self.inner.clone())
    }

    /// Deletes a function with the given name from the specified project. If the
    /// given function is used by some trigger, the trigger will be updated to
    /// remove this function.
    ///
    /// # 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_functions_v2::client::FunctionService;
    /// use google_cloud_lro::Poller;
    /// use google_cloud_functions_v2::Result;
    /// async fn sample(
    ///    client: &FunctionService, project_id: &str, location_id: &str, function_id: &str
    /// ) -> Result<()> {
    ///     client.delete_function()
    ///         .set_name(format!("projects/{project_id}/locations/{location_id}/functions/{function_id}"))
    ///         .poller().until_done().await?;
    ///     Ok(())
    /// }
    /// ```
    pub fn delete_function(&self) -> super::builder::function_service::DeleteFunction {
        super::builder::function_service::DeleteFunction::new(self.inner.clone())
    }

    /// Returns a signed URL for uploading a function source code.
    /// For more information about the signed URL usage see:
    /// <https://cloud.google.com/storage/docs/access-control/signed-urls>.
    /// Once the function source code upload is complete, the used signed
    /// URL should be provided in CreateFunction or UpdateFunction request
    /// as a reference to the function source code.
    ///
    /// When uploading source code to the generated signed URL, please follow
    /// these restrictions:
    ///
    /// * Source file type should be a zip file.
    /// * No credentials should be attached - the signed URLs provide access to the
    ///   target bucket using internal service identity; if credentials were
    ///   attached, the identity from the credentials would be used, but that
    ///   identity does not have permissions to upload files to the URL.
    ///
    /// When making a HTTP PUT request, specify this header:
    ///
    /// * `content-type: application/zip`
    ///
    /// Do not specify this header:
    ///
    /// * `Authorization: Bearer YOUR_TOKEN`
    ///
    /// # Example
    /// ```
    /// # use google_cloud_functions_v2::client::FunctionService;
    /// use google_cloud_functions_v2::Result;
    /// async fn sample(
    ///    client: &FunctionService
    /// ) -> Result<()> {
    ///     let response = client.generate_upload_url()
    ///         /* set fields */
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn generate_upload_url(&self) -> super::builder::function_service::GenerateUploadUrl {
        super::builder::function_service::GenerateUploadUrl::new(self.inner.clone())
    }

    /// Returns a signed URL for downloading deployed function source code.
    /// The URL is only valid for a limited period and should be used within
    /// 30 minutes of generation.
    /// For more information about the signed URL usage see:
    /// <https://cloud.google.com/storage/docs/access-control/signed-urls>
    ///
    /// # Example
    /// ```
    /// # use google_cloud_functions_v2::client::FunctionService;
    /// use google_cloud_functions_v2::Result;
    /// async fn sample(
    ///    client: &FunctionService
    /// ) -> Result<()> {
    ///     let response = client.generate_download_url()
    ///         /* set fields */
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn generate_download_url(&self) -> super::builder::function_service::GenerateDownloadUrl {
        super::builder::function_service::GenerateDownloadUrl::new(self.inner.clone())
    }

    /// Returns a list of runtimes that are supported for the requested project.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_functions_v2::client::FunctionService;
    /// use google_cloud_functions_v2::Result;
    /// async fn sample(
    ///    client: &FunctionService
    /// ) -> Result<()> {
    ///     let response = client.list_runtimes()
    ///         /* set fields */
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn list_runtimes(&self) -> super::builder::function_service::ListRuntimes {
        super::builder::function_service::ListRuntimes::new(self.inner.clone())
    }

    /// Lists information about the supported locations for this service.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_functions_v2::client::FunctionService;
    /// use google_cloud_gax::paginator::ItemPaginator as _;
    /// use google_cloud_functions_v2::Result;
    /// async fn sample(
    ///    client: &FunctionService
    /// ) -> 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::function_service::ListLocations {
        super::builder::function_service::ListLocations::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_functions_v2::client::FunctionService;
    /// use google_cloud_functions_v2::Result;
    /// async fn sample(
    ///    client: &FunctionService
    /// ) -> Result<()> {
    ///     let response = client.set_iam_policy()
    ///         /* set fields */
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn set_iam_policy(&self) -> super::builder::function_service::SetIamPolicy {
        super::builder::function_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_functions_v2::client::FunctionService;
    /// use google_cloud_functions_v2::Result;
    /// async fn sample(
    ///    client: &FunctionService
    /// ) -> Result<()> {
    ///     let response = client.get_iam_policy()
    ///         /* set fields */
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn get_iam_policy(&self) -> super::builder::function_service::GetIamPolicy {
        super::builder::function_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_functions_v2::client::FunctionService;
    /// use google_cloud_functions_v2::Result;
    /// async fn sample(
    ///    client: &FunctionService
    /// ) -> Result<()> {
    ///     let response = client.test_iam_permissions()
    ///         /* set fields */
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn test_iam_permissions(&self) -> super::builder::function_service::TestIamPermissions {
        super::builder::function_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_functions_v2::client::FunctionService;
    /// use google_cloud_gax::paginator::ItemPaginator as _;
    /// use google_cloud_functions_v2::Result;
    /// async fn sample(
    ///    client: &FunctionService
    /// ) -> 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::function_service::ListOperations {
        super::builder::function_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_functions_v2::client::FunctionService;
    /// use google_cloud_functions_v2::Result;
    /// async fn sample(
    ///    client: &FunctionService
    /// ) -> Result<()> {
    ///     let response = client.get_operation()
    ///         /* set fields */
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn get_operation(&self) -> super::builder::function_service::GetOperation {
        super::builder::function_service::GetOperation::new(self.inner.clone())
    }
}