google-cloud-websecurityscanner-v1 1.7.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 Web Security Scanner API.
///
/// # Example
/// ```
/// # use google_cloud_websecurityscanner_v1::client::WebSecurityScanner;
/// use google_cloud_gax::paginator::ItemPaginator as _;
/// # async fn sample() -> Result<(), Box<dyn std::error::Error>> {
///     let client = WebSecurityScanner::builder().build().await?;
///     let parent = "parent_value";
///     let mut list = client.list_findings()
///         .set_parent(parent)
///         .by_item();
///     while let Some(item) = list.next().await.transpose()? {
///         println!("{:?}", item);
///     }
/// # Ok(()) }
/// ```
///
/// # Service Description
///
/// Web Security Scanner Service identifies security vulnerabilities in web
/// applications hosted on Google Cloud. It crawls your application, and
/// attempts to exercise as many user inputs and event handlers as possible.
///
/// # Configuration
///
/// To configure `WebSecurityScanner` use the `with_*` methods in the type returned
/// by [builder()][WebSecurityScanner::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://websecurityscanner.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::web_security_scanner::ClientBuilder::with_endpoint
/// [with_credentials()]: super::builder::web_security_scanner::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
///
/// `WebSecurityScanner` holds a connection pool internally, it is advised to
/// create one and reuse it. You do not need to wrap `WebSecurityScanner` 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 WebSecurityScanner {
    inner: std::sync::Arc<dyn super::stub::dynamic::WebSecurityScanner>,
}

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

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

    /// Creates a new ScanConfig.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_websecurityscanner_v1::client::WebSecurityScanner;
    /// use google_cloud_websecurityscanner_v1::Result;
    /// async fn sample(
    ///    client: &WebSecurityScanner
    /// ) -> Result<()> {
    ///     let response = client.create_scan_config()
    ///         /* set fields */
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn create_scan_config(&self) -> super::builder::web_security_scanner::CreateScanConfig {
        super::builder::web_security_scanner::CreateScanConfig::new(self.inner.clone())
    }

    /// Deletes an existing ScanConfig and its child resources.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_websecurityscanner_v1::client::WebSecurityScanner;
    /// use google_cloud_websecurityscanner_v1::Result;
    /// async fn sample(
    ///    client: &WebSecurityScanner
    /// ) -> Result<()> {
    ///     client.delete_scan_config()
    ///         /* set fields */
    ///         .send().await?;
    ///     Ok(())
    /// }
    /// ```
    pub fn delete_scan_config(&self) -> super::builder::web_security_scanner::DeleteScanConfig {
        super::builder::web_security_scanner::DeleteScanConfig::new(self.inner.clone())
    }

    /// Gets a ScanConfig.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_websecurityscanner_v1::client::WebSecurityScanner;
    /// use google_cloud_websecurityscanner_v1::Result;
    /// async fn sample(
    ///    client: &WebSecurityScanner
    /// ) -> Result<()> {
    ///     let response = client.get_scan_config()
    ///         /* set fields */
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn get_scan_config(&self) -> super::builder::web_security_scanner::GetScanConfig {
        super::builder::web_security_scanner::GetScanConfig::new(self.inner.clone())
    }

    /// Lists ScanConfigs under a given project.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_websecurityscanner_v1::client::WebSecurityScanner;
    /// use google_cloud_gax::paginator::ItemPaginator as _;
    /// use google_cloud_websecurityscanner_v1::Result;
    /// async fn sample(
    ///    client: &WebSecurityScanner
    /// ) -> Result<()> {
    ///     let mut list = client.list_scan_configs()
    ///         /* set fields */
    ///         .by_item();
    ///     while let Some(item) = list.next().await.transpose()? {
    ///         println!("{:?}", item);
    ///     }
    ///     Ok(())
    /// }
    /// ```
    pub fn list_scan_configs(&self) -> super::builder::web_security_scanner::ListScanConfigs {
        super::builder::web_security_scanner::ListScanConfigs::new(self.inner.clone())
    }

    /// Updates a ScanConfig. This method support partial update of a ScanConfig.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_websecurityscanner_v1::client::WebSecurityScanner;
    /// use google_cloud_websecurityscanner_v1::Result;
    /// async fn sample(
    ///    client: &WebSecurityScanner
    /// ) -> Result<()> {
    ///     let response = client.update_scan_config()
    ///         /* set fields */
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn update_scan_config(&self) -> super::builder::web_security_scanner::UpdateScanConfig {
        super::builder::web_security_scanner::UpdateScanConfig::new(self.inner.clone())
    }

    /// Start a ScanRun according to the given ScanConfig.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_websecurityscanner_v1::client::WebSecurityScanner;
    /// use google_cloud_websecurityscanner_v1::Result;
    /// async fn sample(
    ///    client: &WebSecurityScanner
    /// ) -> Result<()> {
    ///     let response = client.start_scan_run()
    ///         /* set fields */
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn start_scan_run(&self) -> super::builder::web_security_scanner::StartScanRun {
        super::builder::web_security_scanner::StartScanRun::new(self.inner.clone())
    }

    /// Gets a ScanRun.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_websecurityscanner_v1::client::WebSecurityScanner;
    /// use google_cloud_websecurityscanner_v1::Result;
    /// async fn sample(
    ///    client: &WebSecurityScanner
    /// ) -> Result<()> {
    ///     let response = client.get_scan_run()
    ///         /* set fields */
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn get_scan_run(&self) -> super::builder::web_security_scanner::GetScanRun {
        super::builder::web_security_scanner::GetScanRun::new(self.inner.clone())
    }

    /// Lists ScanRuns under a given ScanConfig, in descending order of ScanRun
    /// stop time.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_websecurityscanner_v1::client::WebSecurityScanner;
    /// use google_cloud_gax::paginator::ItemPaginator as _;
    /// use google_cloud_websecurityscanner_v1::Result;
    /// async fn sample(
    ///    client: &WebSecurityScanner
    /// ) -> Result<()> {
    ///     let mut list = client.list_scan_runs()
    ///         /* set fields */
    ///         .by_item();
    ///     while let Some(item) = list.next().await.transpose()? {
    ///         println!("{:?}", item);
    ///     }
    ///     Ok(())
    /// }
    /// ```
    pub fn list_scan_runs(&self) -> super::builder::web_security_scanner::ListScanRuns {
        super::builder::web_security_scanner::ListScanRuns::new(self.inner.clone())
    }

    /// Stops a ScanRun. The stopped ScanRun is returned.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_websecurityscanner_v1::client::WebSecurityScanner;
    /// use google_cloud_websecurityscanner_v1::Result;
    /// async fn sample(
    ///    client: &WebSecurityScanner
    /// ) -> Result<()> {
    ///     let response = client.stop_scan_run()
    ///         /* set fields */
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn stop_scan_run(&self) -> super::builder::web_security_scanner::StopScanRun {
        super::builder::web_security_scanner::StopScanRun::new(self.inner.clone())
    }

    /// List CrawledUrls under a given ScanRun.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_websecurityscanner_v1::client::WebSecurityScanner;
    /// use google_cloud_gax::paginator::ItemPaginator as _;
    /// use google_cloud_websecurityscanner_v1::Result;
    /// async fn sample(
    ///    client: &WebSecurityScanner
    /// ) -> Result<()> {
    ///     let mut list = client.list_crawled_urls()
    ///         /* set fields */
    ///         .by_item();
    ///     while let Some(item) = list.next().await.transpose()? {
    ///         println!("{:?}", item);
    ///     }
    ///     Ok(())
    /// }
    /// ```
    pub fn list_crawled_urls(&self) -> super::builder::web_security_scanner::ListCrawledUrls {
        super::builder::web_security_scanner::ListCrawledUrls::new(self.inner.clone())
    }

    /// Gets a Finding.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_websecurityscanner_v1::client::WebSecurityScanner;
    /// use google_cloud_websecurityscanner_v1::Result;
    /// async fn sample(
    ///    client: &WebSecurityScanner
    /// ) -> Result<()> {
    ///     let response = client.get_finding()
    ///         /* set fields */
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn get_finding(&self) -> super::builder::web_security_scanner::GetFinding {
        super::builder::web_security_scanner::GetFinding::new(self.inner.clone())
    }

    /// List Findings under a given ScanRun.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_websecurityscanner_v1::client::WebSecurityScanner;
    /// use google_cloud_gax::paginator::ItemPaginator as _;
    /// use google_cloud_websecurityscanner_v1::Result;
    /// async fn sample(
    ///    client: &WebSecurityScanner, parent: &str
    /// ) -> Result<()> {
    ///     let mut list = client.list_findings()
    ///         .set_parent(parent)
    ///         .by_item();
    ///     while let Some(item) = list.next().await.transpose()? {
    ///         println!("{:?}", item);
    ///     }
    ///     Ok(())
    /// }
    /// ```
    pub fn list_findings(&self) -> super::builder::web_security_scanner::ListFindings {
        super::builder::web_security_scanner::ListFindings::new(self.inner.clone())
    }

    /// List all FindingTypeStats under a given ScanRun.
    ///
    /// # Example
    /// ```
    /// # use google_cloud_websecurityscanner_v1::client::WebSecurityScanner;
    /// use google_cloud_websecurityscanner_v1::Result;
    /// async fn sample(
    ///    client: &WebSecurityScanner
    /// ) -> Result<()> {
    ///     let response = client.list_finding_type_stats()
    ///         /* set fields */
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn list_finding_type_stats(
        &self,
    ) -> super::builder::web_security_scanner::ListFindingTypeStats {
        super::builder::web_security_scanner::ListFindingTypeStats::new(self.inner.clone())
    }
}