google-cloud-video-transcoder-v1 1.9.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 Transcoder API.
///
/// # Example
/// ```
/// # use google_cloud_video_transcoder_v1::client::TranscoderService;
/// use google_cloud_gax::paginator::ItemPaginator as _;
/// async fn sample(
///    parent: &str,
/// ) -> anyhow::Result<()> {
///     let client = TranscoderService::builder().build().await?;
///     let mut list = client.list_jobs()
///         .set_parent(parent)
///         .by_item();
///     while let Some(item) = list.next().await.transpose()? {
///         println!("{:?}", item);
///     }
///     Ok(())
/// }
/// ```
///
/// # Service Description
///
/// Using the Transcoder API, you can queue asynchronous jobs for transcoding
/// media into various output formats. Output formats may include different
/// streaming standards such as HTTP Live Streaming (HLS) and Dynamic Adaptive
/// Streaming over HTTP (DASH). You can also customize jobs using advanced
/// features such as Digital Rights Management (DRM), audio equalization, content
/// concatenation, and digital ad-stitch ready content generation.
///
/// # Configuration
///
/// To configure `TranscoderService` use the `with_*` methods in the type returned
/// by [builder()][TranscoderService::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://transcoder.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::transcoder_service::ClientBuilder::with_endpoint
/// [with_credentials()]: super::builder::transcoder_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
///
/// `TranscoderService` holds a connection pool internally, it is advised to
/// create one and reuse it. You do not need to wrap `TranscoderService` 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 TranscoderService {
    inner: std::sync::Arc<dyn super::stub::dynamic::TranscoderService>,
}

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

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

    /// Creates a job in the specified region.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_video_transcoder_v1::client::TranscoderService;
    /// use google_cloud_video_transcoder_v1::model::Job;
    /// use google_cloud_video_transcoder_v1::Result;
    /// async fn sample(
    ///    client: &TranscoderService, parent: &str
    /// ) -> Result<()> {
    ///     let response = client.create_job()
    ///         .set_parent(parent)
    ///         .set_job(
    ///             Job::new()/* set fields */
    ///         )
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn create_job(&self) -> super::builder::transcoder_service::CreateJob {
        super::builder::transcoder_service::CreateJob::new(self.inner.clone())
    }

    /// Lists jobs in the specified region.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_video_transcoder_v1::client::TranscoderService;
    /// use google_cloud_gax::paginator::ItemPaginator as _;
    /// use google_cloud_video_transcoder_v1::Result;
    /// async fn sample(
    ///    client: &TranscoderService, parent: &str
    /// ) -> Result<()> {
    ///     let mut list = client.list_jobs()
    ///         .set_parent(parent)
    ///         .by_item();
    ///     while let Some(item) = list.next().await.transpose()? {
    ///         println!("{:?}", item);
    ///     }
    ///     Ok(())
    /// }
    /// ```
    pub fn list_jobs(&self) -> super::builder::transcoder_service::ListJobs {
        super::builder::transcoder_service::ListJobs::new(self.inner.clone())
    }

    /// Returns the job data.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_video_transcoder_v1::client::TranscoderService;
    /// use google_cloud_video_transcoder_v1::Result;
    /// async fn sample(
    ///    client: &TranscoderService, project_id: &str, location_id: &str, job_id: &str
    /// ) -> Result<()> {
    ///     let response = client.get_job()
    ///         .set_name(format!("projects/{project_id}/locations/{location_id}/jobs/{job_id}"))
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn get_job(&self) -> super::builder::transcoder_service::GetJob {
        super::builder::transcoder_service::GetJob::new(self.inner.clone())
    }

    /// Deletes a job.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_video_transcoder_v1::client::TranscoderService;
    /// use google_cloud_video_transcoder_v1::Result;
    /// async fn sample(
    ///    client: &TranscoderService, project_id: &str, location_id: &str, job_id: &str
    /// ) -> Result<()> {
    ///     client.delete_job()
    ///         .set_name(format!("projects/{project_id}/locations/{location_id}/jobs/{job_id}"))
    ///         .send().await?;
    ///     Ok(())
    /// }
    /// ```
    pub fn delete_job(&self) -> super::builder::transcoder_service::DeleteJob {
        super::builder::transcoder_service::DeleteJob::new(self.inner.clone())
    }

    /// Creates a job template in the specified region.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_video_transcoder_v1::client::TranscoderService;
    /// use google_cloud_video_transcoder_v1::model::JobTemplate;
    /// use google_cloud_video_transcoder_v1::Result;
    /// async fn sample(
    ///    client: &TranscoderService, parent: &str
    /// ) -> Result<()> {
    ///     let response = client.create_job_template()
    ///         .set_parent(parent)
    ///         .set_job_template(
    ///             JobTemplate::new()/* set fields */
    ///         )
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn create_job_template(&self) -> super::builder::transcoder_service::CreateJobTemplate {
        super::builder::transcoder_service::CreateJobTemplate::new(self.inner.clone())
    }

    /// Lists job templates in the specified region.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_video_transcoder_v1::client::TranscoderService;
    /// use google_cloud_gax::paginator::ItemPaginator as _;
    /// use google_cloud_video_transcoder_v1::Result;
    /// async fn sample(
    ///    client: &TranscoderService, parent: &str
    /// ) -> Result<()> {
    ///     let mut list = client.list_job_templates()
    ///         .set_parent(parent)
    ///         .by_item();
    ///     while let Some(item) = list.next().await.transpose()? {
    ///         println!("{:?}", item);
    ///     }
    ///     Ok(())
    /// }
    /// ```
    pub fn list_job_templates(&self) -> super::builder::transcoder_service::ListJobTemplates {
        super::builder::transcoder_service::ListJobTemplates::new(self.inner.clone())
    }

    /// Returns the job template data.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_video_transcoder_v1::client::TranscoderService;
    /// use google_cloud_video_transcoder_v1::Result;
    /// async fn sample(
    ///    client: &TranscoderService, project_id: &str, location_id: &str, job_template_id: &str
    /// ) -> Result<()> {
    ///     let response = client.get_job_template()
    ///         .set_name(format!("projects/{project_id}/locations/{location_id}/jobTemplates/{job_template_id}"))
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn get_job_template(&self) -> super::builder::transcoder_service::GetJobTemplate {
        super::builder::transcoder_service::GetJobTemplate::new(self.inner.clone())
    }

    /// Deletes a job template.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_video_transcoder_v1::client::TranscoderService;
    /// use google_cloud_video_transcoder_v1::Result;
    /// async fn sample(
    ///    client: &TranscoderService, project_id: &str, location_id: &str, job_template_id: &str
    /// ) -> Result<()> {
    ///     client.delete_job_template()
    ///         .set_name(format!("projects/{project_id}/locations/{location_id}/jobTemplates/{job_template_id}"))
    ///         .send().await?;
    ///     Ok(())
    /// }
    /// ```
    pub fn delete_job_template(&self) -> super::builder::transcoder_service::DeleteJobTemplate {
        super::builder::transcoder_service::DeleteJobTemplate::new(self.inner.clone())
    }
}