google-developers-knowledge-v1 1.1.0

// Copyright 2026 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 Developer Knowledge API.
///
/// # Example
/// ```
/// # use google_developers_knowledge_v1::client::DeveloperKnowledge;
/// async fn sample(
///    document_id: &str,
/// ) -> anyhow::Result<()> {
///     let client = DeveloperKnowledge::builder().build().await?;
///     let response = client.get_document()
///         .set_name(format!("documents/{document_id}"))
///         .send().await?;
///     println!("response {:?}", response);
///     Ok(())
/// }
/// ```
///
/// # Service Description
///
/// The Developer Knowledge API provides programmatic access to Google's public
/// developer documentation, enabling you to integrate this knowledge base into
/// your own applications and workflows.
///
/// The API is designed to be the canonical source for machine-readable access to
/// Google's developer documentation.
///
/// A typical use case is to first use
/// [DeveloperKnowledge.SearchDocumentChunks][google.developers.knowledge.v1.DeveloperKnowledge.SearchDocumentChunks]
/// to find relevant page URIs based on a query, and then use
/// [DeveloperKnowledge.GetDocument][google.developers.knowledge.v1.DeveloperKnowledge.GetDocument]
/// or
/// [DeveloperKnowledge.BatchGetDocuments][google.developers.knowledge.v1.DeveloperKnowledge.BatchGetDocuments]
/// to fetch the full content of the top results.
///
/// All document content is provided in Markdown format.
///
/// [google.developers.knowledge.v1.DeveloperKnowledge.BatchGetDocuments]: crate::client::DeveloperKnowledge::batch_get_documents
/// [google.developers.knowledge.v1.DeveloperKnowledge.GetDocument]: crate::client::DeveloperKnowledge::get_document
/// [google.developers.knowledge.v1.DeveloperKnowledge.SearchDocumentChunks]: crate::client::DeveloperKnowledge::search_document_chunks
///
/// # Configuration
///
/// To configure `DeveloperKnowledge` use the `with_*` methods in the type returned
/// by [builder()][DeveloperKnowledge::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://developerknowledge.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_knowledge::ClientBuilder::with_endpoint
/// [with_credentials()]: super::builder::developer_knowledge::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
///
/// `DeveloperKnowledge` holds a connection pool internally, it is advised to
/// create one and reuse it. You do not need to wrap `DeveloperKnowledge` 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 DeveloperKnowledge {
    inner: std::sync::Arc<dyn super::stub::dynamic::DeveloperKnowledge>,
}

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

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

    /// Searches for developer knowledge across Google's developer documentation.
    /// Returns [DocumentChunk][google.developers.knowledge.v1.DocumentChunk]s
    /// based on the user's query. There may be many chunks from the same
    /// [Document][google.developers.knowledge.v1.Document].  To retrieve full
    /// documents, use
    /// [DeveloperKnowledge.GetDocument][google.developers.knowledge.v1.DeveloperKnowledge.GetDocument]
    /// or
    /// [DeveloperKnowledge.BatchGetDocuments][google.developers.knowledge.v1.DeveloperKnowledge.BatchGetDocuments]
    /// with the
    /// [DocumentChunk.parent][google.developers.knowledge.v1.DocumentChunk.parent]
    /// returned in the
    /// [SearchDocumentChunksResponse.results][google.developers.knowledge.v1.SearchDocumentChunksResponse.results].
    ///
    /// [google.developers.knowledge.v1.DeveloperKnowledge.BatchGetDocuments]: crate::client::DeveloperKnowledge::batch_get_documents
    /// [google.developers.knowledge.v1.DeveloperKnowledge.GetDocument]: crate::client::DeveloperKnowledge::get_document
    /// [google.developers.knowledge.v1.Document]: crate::model::Document
    /// [google.developers.knowledge.v1.DocumentChunk]: crate::model::DocumentChunk
    /// [google.developers.knowledge.v1.DocumentChunk.parent]: crate::model::DocumentChunk::parent
    /// [google.developers.knowledge.v1.SearchDocumentChunksResponse.results]: crate::model::SearchDocumentChunksResponse::results
    ///
    /// # Example
    /// ```
    /// # use google_developers_knowledge_v1::client::DeveloperKnowledge;
    /// use google_cloud_gax::paginator::ItemPaginator as _;
    /// use google_developers_knowledge_v1::Result;
    /// async fn sample(
    ///    client: &DeveloperKnowledge
    /// ) -> Result<()> {
    ///     let mut list = client.search_document_chunks()
    ///         /* set fields */
    ///         .by_item();
    ///     while let Some(item) = list.next().await.transpose()? {
    ///         println!("{:?}", item);
    ///     }
    ///     Ok(())
    /// }
    /// ```
    pub fn search_document_chunks(
        &self,
    ) -> super::builder::developer_knowledge::SearchDocumentChunks {
        super::builder::developer_knowledge::SearchDocumentChunks::new(self.inner.clone())
    }

    /// Retrieves a single document with its full Markdown content.
    ///
    /// # Example
    /// ```
    /// # use google_developers_knowledge_v1::client::DeveloperKnowledge;
    /// use google_developers_knowledge_v1::Result;
    /// async fn sample(
    ///    client: &DeveloperKnowledge, document_id: &str
    /// ) -> Result<()> {
    ///     let response = client.get_document()
    ///         .set_name(format!("documents/{document_id}"))
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn get_document(&self) -> super::builder::developer_knowledge::GetDocument {
        super::builder::developer_knowledge::GetDocument::new(self.inner.clone())
    }

    /// Retrieves multiple documents, each with its full Markdown content.
    ///
    /// # Example
    /// ```
    /// # use google_developers_knowledge_v1::client::DeveloperKnowledge;
    /// use google_developers_knowledge_v1::Result;
    /// async fn sample(
    ///    client: &DeveloperKnowledge
    /// ) -> Result<()> {
    ///     let response = client.batch_get_documents()
    ///         /* set fields */
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn batch_get_documents(&self) -> super::builder::developer_knowledge::BatchGetDocuments {
        super::builder::developer_knowledge::BatchGetDocuments::new(self.inner.clone())
    }

    /// Answers a query using grounded generation.
    ///
    /// # Example
    /// ```
    /// # use google_developers_knowledge_v1::client::DeveloperKnowledge;
    /// use google_developers_knowledge_v1::Result;
    /// async fn sample(
    ///    client: &DeveloperKnowledge
    /// ) -> Result<()> {
    ///     let response = client.answer_query()
    ///         /* set fields */
    ///         .send().await?;
    ///     println!("response {:?}", response);
    ///     Ok(())
    /// }
    /// ```
    pub fn answer_query(&self) -> super::builder::developer_knowledge::AnswerQuery {
        super::builder::developer_knowledge::AnswerQuery::new(self.inner.clone())
    }
}