google_developers_knowledge_v1/

model.rs

// 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)]
#![no_implicit_prelude]
extern crate async_trait;
extern crate bytes;
extern crate gaxi;
extern crate google_cloud_gax;
extern crate serde;
extern crate serde_json;
extern crate serde_with;
extern crate std;
extern crate tracing;
extern crate wkt;

mod debug;
mod deserialize;
mod serialize;

/// A Document represents a page of documentation in the Developer Knowledge
/// corpus, like the page at
/// <https://docs.cloud.google.com/storage/docs/creating-buckets>.
#[derive(Clone, Default, PartialEq)]
#[non_exhaustive]
pub struct Document {
    /// Identifier. Contains the resource name of the document.
    /// Format: `documents/{uri_without_scheme}`
    /// Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets`
    pub name: std::string::String,

    /// Output only. Provides the URI of the content, such as
    /// `<https://docs.cloud.google.com/storage/docs/creating-buckets>`.
    pub uri: std::string::String,

    /// Output only. Contains the full content of the document in Markdown format.
    pub content: std::string::String,

    /// Output only. Provides a description of the document.
    pub description: std::string::String,

    /// Output only. Specifies the data source of the document.
    /// Example data source: `firebase.google.com`
    pub data_source: std::string::String,

    /// Output only. Provides the title of the document.
    pub title: std::string::String,

    /// Output only. Represents the timestamp when the content or metadata of the
    /// document was last updated.
    pub update_time: std::option::Option<wkt::Timestamp>,

    /// Output only. Specifies the
    /// [DocumentView][google.developers.knowledge.v1.DocumentView] of the
    /// document.
    ///
    /// [google.developers.knowledge.v1.DocumentView]: crate::model::DocumentView
    pub view: crate::model::DocumentView,

    /// Output only. The length of the `content` field in bytes.
    pub content_length_bytes: i32,

    pub(crate) _unknown_fields: serde_json::Map<std::string::String, serde_json::Value>,
}

impl Document {
    /// Creates a new default instance.
    pub fn new() -> Self {
        std::default::Default::default()
    }

    /// Sets the value of [name][crate::model::Document::name].
    ///
    /// # Example
    /// ```ignore,no_run
    /// # use google_developers_knowledge_v1::model::Document;
    /// # let document_id = "document_id";
    /// let x = Document::new().set_name(format!("documents/{document_id}"));
    /// ```
    pub fn set_name<T: std::convert::Into<std::string::String>>(mut self, v: T) -> Self {
        self.name = v.into();
        self
    }

    /// Sets the value of [uri][crate::model::Document::uri].
    ///
    /// # Example
    /// ```ignore,no_run
    /// # use google_developers_knowledge_v1::model::Document;
    /// let x = Document::new().set_uri("example");
    /// ```
    pub fn set_uri<T: std::convert::Into<std::string::String>>(mut self, v: T) -> Self {
        self.uri = v.into();
        self
    }

    /// Sets the value of [content][crate::model::Document::content].
    ///
    /// # Example
    /// ```ignore,no_run
    /// # use google_developers_knowledge_v1::model::Document;
    /// let x = Document::new().set_content("example");
    /// ```
    pub fn set_content<T: std::convert::Into<std::string::String>>(mut self, v: T) -> Self {
        self.content = v.into();
        self
    }

    /// Sets the value of [description][crate::model::Document::description].
    ///
    /// # Example
    /// ```ignore,no_run
    /// # use google_developers_knowledge_v1::model::Document;
    /// let x = Document::new().set_description("example");
    /// ```
    pub fn set_description<T: std::convert::Into<std::string::String>>(mut self, v: T) -> Self {
        self.description = v.into();
        self
    }

    /// Sets the value of [data_source][crate::model::Document::data_source].
    ///
    /// # Example
    /// ```ignore,no_run
    /// # use google_developers_knowledge_v1::model::Document;
    /// let x = Document::new().set_data_source("example");
    /// ```
    pub fn set_data_source<T: std::convert::Into<std::string::String>>(mut self, v: T) -> Self {
        self.data_source = v.into();
        self
    }

    /// Sets the value of [title][crate::model::Document::title].
    ///
    /// # Example
    /// ```ignore,no_run
    /// # use google_developers_knowledge_v1::model::Document;
    /// let x = Document::new().set_title("example");
    /// ```
    pub fn set_title<T: std::convert::Into<std::string::String>>(mut self, v: T) -> Self {
        self.title = v.into();
        self
    }

    /// Sets the value of [update_time][crate::model::Document::update_time].
    ///
    /// # Example
    /// ```ignore,no_run
    /// # use google_developers_knowledge_v1::model::Document;
    /// use wkt::Timestamp;
    /// let x = Document::new().set_update_time(Timestamp::default()/* use setters */);
    /// ```
    pub fn set_update_time<T>(mut self, v: T) -> Self
    where
        T: std::convert::Into<wkt::Timestamp>,
    {
        self.update_time = std::option::Option::Some(v.into());
        self
    }

    /// Sets or clears the value of [update_time][crate::model::Document::update_time].
    ///
    /// # Example
    /// ```ignore,no_run
    /// # use google_developers_knowledge_v1::model::Document;
    /// use wkt::Timestamp;
    /// let x = Document::new().set_or_clear_update_time(Some(Timestamp::default()/* use setters */));
    /// let x = Document::new().set_or_clear_update_time(None::<Timestamp>);
    /// ```
    pub fn set_or_clear_update_time<T>(mut self, v: std::option::Option<T>) -> Self
    where
        T: std::convert::Into<wkt::Timestamp>,
    {
        self.update_time = v.map(|x| x.into());
        self
    }

    /// Sets the value of [view][crate::model::Document::view].
    ///
    /// # Example
    /// ```ignore,no_run
    /// # use google_developers_knowledge_v1::model::Document;
    /// use google_developers_knowledge_v1::model::DocumentView;
    /// let x0 = Document::new().set_view(DocumentView::Basic);
    /// let x1 = Document::new().set_view(DocumentView::Full);
    /// let x2 = Document::new().set_view(DocumentView::Content);
    /// ```
    pub fn set_view<T: std::convert::Into<crate::model::DocumentView>>(mut self, v: T) -> Self {
        self.view = v.into();
        self
    }

    /// Sets the value of [content_length_bytes][crate::model::Document::content_length_bytes].
    ///
    /// # Example
    /// ```ignore,no_run
    /// # use google_developers_knowledge_v1::model::Document;
    /// let x = Document::new().set_content_length_bytes(42);
    /// ```
    pub fn set_content_length_bytes<T: std::convert::Into<i32>>(mut self, v: T) -> Self {
        self.content_length_bytes = v.into();
        self
    }
}

impl wkt::message::Message for Document {
    fn typename() -> &'static str {
        "type.googleapis.com/google.developers.knowledge.v1.Document"
    }
}

/// Request message for
/// [DeveloperKnowledge.SearchDocumentChunks][google.developers.knowledge.v1.DeveloperKnowledge.SearchDocumentChunks].
///
/// [google.developers.knowledge.v1.DeveloperKnowledge.SearchDocumentChunks]: crate::client::DeveloperKnowledge::search_document_chunks
#[derive(Clone, Default, PartialEq)]
#[non_exhaustive]
pub struct SearchDocumentChunksRequest {
    /// Required. Provides the raw query string provided by the user, such as "How
    /// to create a Cloud Storage bucket?". The query must not exceed 500
    /// characters; values longer than 500 characters will result in an
    /// `INVALID_ARGUMENT` error.
    pub query: std::string::String,

    /// Optional. Specifies the maximum number of results to return. The service
    /// may return fewer than this value.
    ///
    /// If unspecified, at most 5 results will be returned.
    ///
    /// The maximum value is 100; values above 100 will be coerced to 100.
    pub page_size: i32,

    /// Optional. Contains a page token, received from a previous
    /// `SearchDocumentChunks` call. Provide this to retrieve the subsequent page.
    pub page_token: std::string::String,

    /// Optional. Applies a strict filter to the search results. The expression
    /// supports a subset of the syntax described at <https://google.aip.dev/160>.
    ///
    /// While `SearchDocumentChunks` returns
    /// [DocumentChunk][google.developers.knowledge.v1.DocumentChunk]s, the filter
    /// is applied to `DocumentChunk.document` fields.
    ///
    /// Supported fields for filtering:
    ///
    /// * `content_length_bytes` (INTEGER): The length of the `Document.content`
    ///   field in bytes.
    /// * `data_source` (STRING): The source of the document, e.g.
    ///   `docs.cloud.google.com`. See
    ///   <https://developers.google.com/knowledge/reference/corpus-reference> for
    ///   the complete list of data sources in the corpus.
    /// * `update_time` (TIMESTAMP): The timestamp of when the document was last
    ///   meaningfully updated. A meaningful update is one that changes document's
    ///   markdown content or metadata.
    /// * `uri` (STRING): The document URI, e.g.
    ///   `<https://docs.cloud.google.com/bigquery/docs/tables>`.
    ///
    /// INTEGER fields support `=`, `<`, `<=`, `>`, and `>=` operators.
    ///
    /// STRING fields support `=` (equals) and `!=` (not equals) operators for
    /// **exact match** on the whole string. Partial match, prefix match, and
    /// regexp match are not supported.
    ///
    /// TIMESTAMP fields support `=`, `<`, `<=`, `>`, and `>=` operators.
    /// Timestamps must be in RFC-3339 format, e.g., `"2025-01-01T00:00:00Z"`.
    ///
    /// Note: Field names must be in `snake_case` (e.g., `data_source`). Values on
    /// the right-hand side of filtering expressions must be string literals
    /// enclosed in double quotes (e.g., `"docs.cloud.google.com"`).
    ///
    /// You can combine expressions using `AND`, `OR`, and `NOT` (or `-`) logical
    /// operators. `OR` has higher precedence than `AND`. Use parentheses for
    /// explicit precedence grouping.
    ///
    /// Examples:
    ///
    /// * Filter by `Document.content_length_bytes`:
    ///   `content_length_bytes < 50000`
    /// * `data_source = "docs.cloud.google.com" OR data_source =
    ///   "firebase.google.com"`
    /// * `data_source != "firebase.google.com"`
    /// * `update_time < "2024-01-01T00:00:00Z"`
    /// * `update_time >= "2025-01-22T00:00:00Z" AND (data_source =
    ///   "developer.chrome.com" OR data_source = "web.dev")`
    /// * `uri = `https://docs.cloud.google.com/release-notes``
    ///
    /// The `filter` string must not exceed 500 characters; values longer than 500
    /// characters will result in an `INVALID_ARGUMENT` error.
    ///
    /// [google.developers.knowledge.v1.DocumentChunk]: crate::model::DocumentChunk
    pub filter: std::string::String,

    pub(crate) _unknown_fields: serde_json::Map<std::string::String, serde_json::Value>,
}

impl SearchDocumentChunksRequest {
    /// Creates a new default instance.
    pub fn new() -> Self {
        std::default::Default::default()
    }

    /// Sets the value of [query][crate::model::SearchDocumentChunksRequest::query].
    ///
    /// # Example
    /// ```ignore,no_run
    /// # use google_developers_knowledge_v1::model::SearchDocumentChunksRequest;
    /// let x = SearchDocumentChunksRequest::new().set_query("example");
    /// ```
    pub fn set_query<T: std::convert::Into<std::string::String>>(mut self, v: T) -> Self {
        self.query = v.into();
        self
    }

    /// Sets the value of [page_size][crate::model::SearchDocumentChunksRequest::page_size].
    ///
    /// # Example
    /// ```ignore,no_run
    /// # use google_developers_knowledge_v1::model::SearchDocumentChunksRequest;
    /// let x = SearchDocumentChunksRequest::new().set_page_size(42);
    /// ```
    pub fn set_page_size<T: std::convert::Into<i32>>(mut self, v: T) -> Self {
        self.page_size = v.into();
        self
    }

    /// Sets the value of [page_token][crate::model::SearchDocumentChunksRequest::page_token].
    ///
    /// # Example
    /// ```ignore,no_run
    /// # use google_developers_knowledge_v1::model::SearchDocumentChunksRequest;
    /// let x = SearchDocumentChunksRequest::new().set_page_token("example");
    /// ```
    pub fn set_page_token<T: std::convert::Into<std::string::String>>(mut self, v: T) -> Self {
        self.page_token = v.into();
        self
    }

    /// Sets the value of [filter][crate::model::SearchDocumentChunksRequest::filter].
    ///
    /// # Example
    /// ```ignore,no_run
    /// # use google_developers_knowledge_v1::model::SearchDocumentChunksRequest;
    /// let x = SearchDocumentChunksRequest::new().set_filter("example");
    /// ```
    pub fn set_filter<T: std::convert::Into<std::string::String>>(mut self, v: T) -> Self {
        self.filter = v.into();
        self
    }
}

impl wkt::message::Message for SearchDocumentChunksRequest {
    fn typename() -> &'static str {
        "type.googleapis.com/google.developers.knowledge.v1.SearchDocumentChunksRequest"
    }
}

/// Response message for
/// [DeveloperKnowledge.SearchDocumentChunks][google.developers.knowledge.v1.DeveloperKnowledge.SearchDocumentChunks].
///
/// [google.developers.knowledge.v1.DeveloperKnowledge.SearchDocumentChunks]: crate::client::DeveloperKnowledge::search_document_chunks
#[derive(Clone, Default, PartialEq)]
#[non_exhaustive]
pub struct SearchDocumentChunksResponse {
    /// Contains the search results for the given query. Each
    /// [DocumentChunk][google.developers.knowledge.v1.DocumentChunk] in this list
    /// contains a snippet of content relevant to the search query. Use the
    /// [DocumentChunk.parent][google.developers.knowledge.v1.DocumentChunk.parent]
    /// field of each result with
    /// [DeveloperKnowledge.GetDocument][google.developers.knowledge.v1.DeveloperKnowledge.GetDocument]
    /// or
    /// [DeveloperKnowledge.BatchGetDocuments][google.developers.knowledge.v1.DeveloperKnowledge.BatchGetDocuments]
    /// to retrieve the full document content.
    ///
    /// [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.DocumentChunk]: crate::model::DocumentChunk
    /// [google.developers.knowledge.v1.DocumentChunk.parent]: crate::model::DocumentChunk::parent
    pub results: std::vec::Vec<crate::model::DocumentChunk>,

    /// Provides a token that can be sent as `page_token` to retrieve the next
    /// page.
    /// If this field is omitted, there are no subsequent pages.
    pub next_page_token: std::string::String,

    pub(crate) _unknown_fields: serde_json::Map<std::string::String, serde_json::Value>,
}

impl SearchDocumentChunksResponse {
    /// Creates a new default instance.
    pub fn new() -> Self {
        std::default::Default::default()
    }

    /// Sets the value of [results][crate::model::SearchDocumentChunksResponse::results].
    ///
    /// # Example
    /// ```ignore,no_run
    /// # use google_developers_knowledge_v1::model::SearchDocumentChunksResponse;
    /// use google_developers_knowledge_v1::model::DocumentChunk;
    /// let x = SearchDocumentChunksResponse::new()
    ///     .set_results([
    ///         DocumentChunk::default()/* use setters */,
    ///         DocumentChunk::default()/* use (different) setters */,
    ///     ]);
    /// ```
    pub fn set_results<T, V>(mut self, v: T) -> Self
    where
        T: std::iter::IntoIterator<Item = V>,
        V: std::convert::Into<crate::model::DocumentChunk>,
    {
        use std::iter::Iterator;
        self.results = v.into_iter().map(|i| i.into()).collect();
        self
    }

    /// Sets the value of [next_page_token][crate::model::SearchDocumentChunksResponse::next_page_token].
    ///
    /// # Example
    /// ```ignore,no_run
    /// # use google_developers_knowledge_v1::model::SearchDocumentChunksResponse;
    /// let x = SearchDocumentChunksResponse::new().set_next_page_token("example");
    /// ```
    pub fn set_next_page_token<T: std::convert::Into<std::string::String>>(mut self, v: T) -> Self {
        self.next_page_token = v.into();
        self
    }
}

impl wkt::message::Message for SearchDocumentChunksResponse {
    fn typename() -> &'static str {
        "type.googleapis.com/google.developers.knowledge.v1.SearchDocumentChunksResponse"
    }
}

#[doc(hidden)]
impl google_cloud_gax::paginator::internal::PageableResponse for SearchDocumentChunksResponse {
    type PageItem = crate::model::DocumentChunk;

    fn items(self) -> std::vec::Vec<Self::PageItem> {
        self.results
    }

    fn next_page_token(&self) -> std::string::String {
        use std::clone::Clone;
        self.next_page_token.clone()
    }
}

/// Request message for
/// [DeveloperKnowledge.GetDocument][google.developers.knowledge.v1.DeveloperKnowledge.GetDocument].
///
/// [google.developers.knowledge.v1.DeveloperKnowledge.GetDocument]: crate::client::DeveloperKnowledge::get_document
#[derive(Clone, Default, PartialEq)]
#[non_exhaustive]
pub struct GetDocumentRequest {
    /// Required. Specifies the name of the document to retrieve.
    /// Format: `documents/{uri_without_scheme}`
    /// Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets`
    ///
    /// The name must not exceed 500 characters; values longer than 500 characters
    /// will result in an `INVALID_ARGUMENT` error.
    pub name: std::string::String,

    /// Optional. Specifies the
    /// [DocumentView][google.developers.knowledge.v1.DocumentView] of the
    /// document. If unspecified,
    /// [DeveloperKnowledge.GetDocument][google.developers.knowledge.v1.DeveloperKnowledge.GetDocument]
    /// defaults to `DOCUMENT_VIEW_CONTENT`.
    ///
    /// [google.developers.knowledge.v1.DeveloperKnowledge.GetDocument]: crate::client::DeveloperKnowledge::get_document
    /// [google.developers.knowledge.v1.DocumentView]: crate::model::DocumentView
    pub view: crate::model::DocumentView,

    pub(crate) _unknown_fields: serde_json::Map<std::string::String, serde_json::Value>,
}

impl GetDocumentRequest {
    /// Creates a new default instance.
    pub fn new() -> Self {
        std::default::Default::default()
    }

    /// Sets the value of [name][crate::model::GetDocumentRequest::name].
    ///
    /// # Example
    /// ```ignore,no_run
    /// # use google_developers_knowledge_v1::model::GetDocumentRequest;
    /// # let document_id = "document_id";
    /// let x = GetDocumentRequest::new().set_name(format!("documents/{document_id}"));
    /// ```
    pub fn set_name<T: std::convert::Into<std::string::String>>(mut self, v: T) -> Self {
        self.name = v.into();
        self
    }

    /// Sets the value of [view][crate::model::GetDocumentRequest::view].
    ///
    /// # Example
    /// ```ignore,no_run
    /// # use google_developers_knowledge_v1::model::GetDocumentRequest;
    /// use google_developers_knowledge_v1::model::DocumentView;
    /// let x0 = GetDocumentRequest::new().set_view(DocumentView::Basic);
    /// let x1 = GetDocumentRequest::new().set_view(DocumentView::Full);
    /// let x2 = GetDocumentRequest::new().set_view(DocumentView::Content);
    /// ```
    pub fn set_view<T: std::convert::Into<crate::model::DocumentView>>(mut self, v: T) -> Self {
        self.view = v.into();
        self
    }
}

impl wkt::message::Message for GetDocumentRequest {
    fn typename() -> &'static str {
        "type.googleapis.com/google.developers.knowledge.v1.GetDocumentRequest"
    }
}

/// Request message for
/// [DeveloperKnowledge.BatchGetDocuments][google.developers.knowledge.v1.DeveloperKnowledge.BatchGetDocuments].
///
/// [google.developers.knowledge.v1.DeveloperKnowledge.BatchGetDocuments]: crate::client::DeveloperKnowledge::batch_get_documents
#[derive(Clone, Default, PartialEq)]
#[non_exhaustive]
pub struct BatchGetDocumentsRequest {
    /// Required. Specifies the names of the documents to retrieve. A maximum of 20
    /// documents can be retrieved in a batch. The documents are returned in the
    /// same order as the `names` in the request.
    ///
    /// Format: `documents/{uri_without_scheme}`
    /// Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets`
    ///
    /// Each name must not exceed 500 characters; values longer than 500 characters
    /// will result in an `INVALID_ARGUMENT` error.
    pub names: std::vec::Vec<std::string::String>,

    /// Optional. Specifies the
    /// [DocumentView][google.developers.knowledge.v1.DocumentView] of the
    /// document. If unspecified,
    /// [DeveloperKnowledge.BatchGetDocuments][google.developers.knowledge.v1.DeveloperKnowledge.BatchGetDocuments]
    /// defaults to `DOCUMENT_VIEW_CONTENT`.
    ///
    /// [google.developers.knowledge.v1.DeveloperKnowledge.BatchGetDocuments]: crate::client::DeveloperKnowledge::batch_get_documents
    /// [google.developers.knowledge.v1.DocumentView]: crate::model::DocumentView
    pub view: crate::model::DocumentView,

    pub(crate) _unknown_fields: serde_json::Map<std::string::String, serde_json::Value>,
}

impl BatchGetDocumentsRequest {
    /// Creates a new default instance.
    pub fn new() -> Self {
        std::default::Default::default()
    }

    /// Sets the value of [names][crate::model::BatchGetDocumentsRequest::names].
    ///
    /// # Example
    /// ```ignore,no_run
    /// # use google_developers_knowledge_v1::model::BatchGetDocumentsRequest;
    /// let x = BatchGetDocumentsRequest::new().set_names(["a", "b", "c"]);
    /// ```
    pub fn set_names<T, V>(mut self, v: T) -> Self
    where
        T: std::iter::IntoIterator<Item = V>,
        V: std::convert::Into<std::string::String>,
    {
        use std::iter::Iterator;
        self.names = v.into_iter().map(|i| i.into()).collect();
        self
    }

    /// Sets the value of [view][crate::model::BatchGetDocumentsRequest::view].
    ///
    /// # Example
    /// ```ignore,no_run
    /// # use google_developers_knowledge_v1::model::BatchGetDocumentsRequest;
    /// use google_developers_knowledge_v1::model::DocumentView;
    /// let x0 = BatchGetDocumentsRequest::new().set_view(DocumentView::Basic);
    /// let x1 = BatchGetDocumentsRequest::new().set_view(DocumentView::Full);
    /// let x2 = BatchGetDocumentsRequest::new().set_view(DocumentView::Content);
    /// ```
    pub fn set_view<T: std::convert::Into<crate::model::DocumentView>>(mut self, v: T) -> Self {
        self.view = v.into();
        self
    }
}

impl wkt::message::Message for BatchGetDocumentsRequest {
    fn typename() -> &'static str {
        "type.googleapis.com/google.developers.knowledge.v1.BatchGetDocumentsRequest"
    }
}

/// Response message for
/// [DeveloperKnowledge.BatchGetDocuments][google.developers.knowledge.v1.DeveloperKnowledge.BatchGetDocuments].
///
/// [google.developers.knowledge.v1.DeveloperKnowledge.BatchGetDocuments]: crate::client::DeveloperKnowledge::batch_get_documents
#[derive(Clone, Default, PartialEq)]
#[non_exhaustive]
pub struct BatchGetDocumentsResponse {
    /// Contains the documents requested.
    pub documents: std::vec::Vec<crate::model::Document>,

    pub(crate) _unknown_fields: serde_json::Map<std::string::String, serde_json::Value>,
}

impl BatchGetDocumentsResponse {
    /// Creates a new default instance.
    pub fn new() -> Self {
        std::default::Default::default()
    }

    /// Sets the value of [documents][crate::model::BatchGetDocumentsResponse::documents].
    ///
    /// # Example
    /// ```ignore,no_run
    /// # use google_developers_knowledge_v1::model::BatchGetDocumentsResponse;
    /// use google_developers_knowledge_v1::model::Document;
    /// let x = BatchGetDocumentsResponse::new()
    ///     .set_documents([
    ///         Document::default()/* use setters */,
    ///         Document::default()/* use (different) setters */,
    ///     ]);
    /// ```
    pub fn set_documents<T, V>(mut self, v: T) -> Self
    where
        T: std::iter::IntoIterator<Item = V>,
        V: std::convert::Into<crate::model::Document>,
    {
        use std::iter::Iterator;
        self.documents = v.into_iter().map(|i| i.into()).collect();
        self
    }
}

impl wkt::message::Message for BatchGetDocumentsResponse {
    fn typename() -> &'static str {
        "type.googleapis.com/google.developers.knowledge.v1.BatchGetDocumentsResponse"
    }
}

/// Request message for
/// [DeveloperKnowledge.AnswerQuery][google.developers.knowledge.v1.DeveloperKnowledge.AnswerQuery].
///
/// [google.developers.knowledge.v1.DeveloperKnowledge.AnswerQuery]: crate::client::DeveloperKnowledge::answer_query
#[derive(Clone, Default, PartialEq)]
#[non_exhaustive]
pub struct AnswerQueryRequest {
    /// Required. The query to answer.
    pub query: std::string::String,

    /// Optional. Applies a strict filter to the search results used to ground the
    /// answer. The expression supports a subset of the syntax described at
    /// <https://google.aip.dev/160>.
    ///
    /// Supported fields for filtering:
    ///
    /// * `content_length_bytes` (INTEGER): The length of the `Document.content`
    ///   field in bytes.
    /// * `data_source` (STRING): The source of the document, e.g.
    ///   `docs.cloud.google.com`. See
    ///   <https://developers.google.com/knowledge/reference/corpus-reference> for
    ///   the complete list of data sources in the corpus.
    /// * `update_time` (TIMESTAMP): The timestamp of when the document was last
    ///   meaningfully updated. A meaningful update is one that changes document's
    ///   markdown content or metadata.
    /// * `uri` (STRING): The document URI, e.g.
    ///   `<https://docs.cloud.google.com/bigquery/docs/tables>`.
    ///
    /// INTEGER fields support `=`, `<`, `<=`, `>`, and `>=` operators.
    ///
    /// STRING fields support `=` (equals) and `!=` (not equals) operators for
    /// **exact match** on the whole string. Partial match, prefix match, and
    /// regexp match are not supported.
    ///
    /// TIMESTAMP fields support `=`, `<`, `<=`, `>`, and `>=` operators.
    /// Timestamps must be in RFC-3339 format, e.g., `"2025-01-01T00:00:00Z"`.
    ///
    /// You can combine expressions using `AND`, `OR`, and `NOT` (or `-`) logical
    /// operators. `OR` has higher precedence than `AND`. Use parentheses for
    /// explicit precedence grouping.
    ///
    /// Examples:
    ///
    /// * Filter by `Document.content_length_bytes`:
    ///   `content_length_bytes < 50000`
    /// * `data_source = "docs.cloud.google.com" OR data_source =
    ///   "firebase.google.com"`
    /// * `data_source != "firebase.google.com"`
    /// * `update_time < "2024-01-01T00:00:00Z"`
    /// * `update_time >= "2025-01-22T00:00:00Z" AND (data_source =
    ///   "developer.chrome.com" OR data_source = "web.dev")`
    /// * `uri = `https://docs.cloud.google.com/release-notes``
    ///
    /// The `filter` string must not exceed 500 characters; values longer than 500
    /// characters will result in an `INVALID_ARGUMENT` error.
    pub filter: std::string::String,

    pub(crate) _unknown_fields: serde_json::Map<std::string::String, serde_json::Value>,
}

impl AnswerQueryRequest {
    /// Creates a new default instance.
    pub fn new() -> Self {
        std::default::Default::default()
    }

    /// Sets the value of [query][crate::model::AnswerQueryRequest::query].
    ///
    /// # Example
    /// ```ignore,no_run
    /// # use google_developers_knowledge_v1::model::AnswerQueryRequest;
    /// let x = AnswerQueryRequest::new().set_query("example");
    /// ```
    pub fn set_query<T: std::convert::Into<std::string::String>>(mut self, v: T) -> Self {
        self.query = v.into();
        self
    }

    /// Sets the value of [filter][crate::model::AnswerQueryRequest::filter].
    ///
    /// # Example
    /// ```ignore,no_run
    /// # use google_developers_knowledge_v1::model::AnswerQueryRequest;
    /// let x = AnswerQueryRequest::new().set_filter("example");
    /// ```
    pub fn set_filter<T: std::convert::Into<std::string::String>>(mut self, v: T) -> Self {
        self.filter = v.into();
        self
    }
}

impl wkt::message::Message for AnswerQueryRequest {
    fn typename() -> &'static str {
        "type.googleapis.com/google.developers.knowledge.v1.AnswerQueryRequest"
    }
}

/// Response message for
/// [DeveloperKnowledge.AnswerQuery][google.developers.knowledge.v1.DeveloperKnowledge.AnswerQuery].
///
/// [google.developers.knowledge.v1.DeveloperKnowledge.AnswerQuery]: crate::client::DeveloperKnowledge::answer_query
#[derive(Clone, Default, PartialEq)]
#[non_exhaustive]
pub struct AnswerQueryResponse {
    /// The answer to the query.
    pub answer: std::option::Option<crate::model::Answer>,

    pub(crate) _unknown_fields: serde_json::Map<std::string::String, serde_json::Value>,
}

impl AnswerQueryResponse {
    /// Creates a new default instance.
    pub fn new() -> Self {
        std::default::Default::default()
    }

    /// Sets the value of [answer][crate::model::AnswerQueryResponse::answer].
    ///
    /// # Example
    /// ```ignore,no_run
    /// # use google_developers_knowledge_v1::model::AnswerQueryResponse;
    /// use google_developers_knowledge_v1::model::Answer;
    /// let x = AnswerQueryResponse::new().set_answer(Answer::default()/* use setters */);
    /// ```
    pub fn set_answer<T>(mut self, v: T) -> Self
    where
        T: std::convert::Into<crate::model::Answer>,
    {
        self.answer = std::option::Option::Some(v.into());
        self
    }

    /// Sets or clears the value of [answer][crate::model::AnswerQueryResponse::answer].
    ///
    /// # Example
    /// ```ignore,no_run
    /// # use google_developers_knowledge_v1::model::AnswerQueryResponse;
    /// use google_developers_knowledge_v1::model::Answer;
    /// let x = AnswerQueryResponse::new().set_or_clear_answer(Some(Answer::default()/* use setters */));
    /// let x = AnswerQueryResponse::new().set_or_clear_answer(None::<Answer>);
    /// ```
    pub fn set_or_clear_answer<T>(mut self, v: std::option::Option<T>) -> Self
    where
        T: std::convert::Into<crate::model::Answer>,
    {
        self.answer = v.map(|x| x.into());
        self
    }
}

impl wkt::message::Message for AnswerQueryResponse {
    fn typename() -> &'static str {
        "type.googleapis.com/google.developers.knowledge.v1.AnswerQueryResponse"
    }
}

/// An answer to a query.
#[derive(Clone, Default, PartialEq)]
#[non_exhaustive]
pub struct Answer {
    /// Contains the text of the answer.
    pub answer_text: std::string::String,

    /// Output only. Contains citations for the answer.
    pub citations: std::vec::Vec<crate::model::answer::AnswerCitation>,

    /// Output only. Contains references for the answer.
    pub references: std::vec::Vec<crate::model::answer::AnswerReference>,

    pub(crate) _unknown_fields: serde_json::Map<std::string::String, serde_json::Value>,
}

impl Answer {
    /// Creates a new default instance.
    pub fn new() -> Self {
        std::default::Default::default()
    }

    /// Sets the value of [answer_text][crate::model::Answer::answer_text].
    ///
    /// # Example
    /// ```ignore,no_run
    /// # use google_developers_knowledge_v1::model::Answer;
    /// let x = Answer::new().set_answer_text("example");
    /// ```
    pub fn set_answer_text<T: std::convert::Into<std::string::String>>(mut self, v: T) -> Self {
        self.answer_text = v.into();
        self
    }

    /// Sets the value of [citations][crate::model::Answer::citations].
    ///
    /// # Example
    /// ```ignore,no_run
    /// # use google_developers_knowledge_v1::model::Answer;
    /// use google_developers_knowledge_v1::model::answer::AnswerCitation;
    /// let x = Answer::new()
    ///     .set_citations([
    ///         AnswerCitation::default()/* use setters */,
    ///         AnswerCitation::default()/* use (different) setters */,
    ///     ]);
    /// ```
    pub fn set_citations<T, V>(mut self, v: T) -> Self
    where
        T: std::iter::IntoIterator<Item = V>,
        V: std::convert::Into<crate::model::answer::AnswerCitation>,
    {
        use std::iter::Iterator;
        self.citations = v.into_iter().map(|i| i.into()).collect();
        self
    }

    /// Sets the value of [references][crate::model::Answer::references].
    ///
    /// # Example
    /// ```ignore,no_run
    /// # use google_developers_knowledge_v1::model::Answer;
    /// use google_developers_knowledge_v1::model::answer::AnswerReference;
    /// let x = Answer::new()
    ///     .set_references([
    ///         AnswerReference::default()/* use setters */,
    ///         AnswerReference::default()/* use (different) setters */,
    ///     ]);
    /// ```
    pub fn set_references<T, V>(mut self, v: T) -> Self
    where
        T: std::iter::IntoIterator<Item = V>,
        V: std::convert::Into<crate::model::answer::AnswerReference>,
    {
        use std::iter::Iterator;
        self.references = v.into_iter().map(|i| i.into()).collect();
        self
    }
}

impl wkt::message::Message for Answer {
    fn typename() -> &'static str {
        "type.googleapis.com/google.developers.knowledge.v1.Answer"
    }
}

/// Defines additional types related to [Answer].
pub mod answer {
    #[allow(unused_imports)]
    use super::*;

    /// Citation info for a segment.
    #[derive(Clone, Default, PartialEq)]
    #[non_exhaustive]
    pub struct AnswerCitation {
        /// Output only. Indicates the start of the segment, measured in bytes (UTF-8
        /// unicode), inclusive. If there are multi-byte characters, such as
        /// non-ASCII characters, the index measurement is longer than the string
        /// length.
        pub start_index: i32,

        /// Output only. Indicates the end of the segment, measured in bytes (UTF-8
        /// unicode), exclusive. If there are multi-byte characters, such as
        /// non-ASCII characters, the index measurement is longer than the string
        /// length.
        pub end_index: i32,

        /// Output only. Contains citation sources for the attributed segment.
        pub sources: std::vec::Vec<crate::model::answer::CitationSource>,

        pub(crate) _unknown_fields: serde_json::Map<std::string::String, serde_json::Value>,
    }

    impl AnswerCitation {
        /// Creates a new default instance.
        pub fn new() -> Self {
            std::default::Default::default()
        }

        /// Sets the value of [start_index][crate::model::answer::AnswerCitation::start_index].
        ///
        /// # Example
        /// ```ignore,no_run
        /// # use google_developers_knowledge_v1::model::answer::AnswerCitation;
        /// let x = AnswerCitation::new().set_start_index(42);
        /// ```
        pub fn set_start_index<T: std::convert::Into<i32>>(mut self, v: T) -> Self {
            self.start_index = v.into();
            self
        }

        /// Sets the value of [end_index][crate::model::answer::AnswerCitation::end_index].
        ///
        /// # Example
        /// ```ignore,no_run
        /// # use google_developers_knowledge_v1::model::answer::AnswerCitation;
        /// let x = AnswerCitation::new().set_end_index(42);
        /// ```
        pub fn set_end_index<T: std::convert::Into<i32>>(mut self, v: T) -> Self {
            self.end_index = v.into();
            self
        }

        /// Sets the value of [sources][crate::model::answer::AnswerCitation::sources].
        ///
        /// # Example
        /// ```ignore,no_run
        /// # use google_developers_knowledge_v1::model::answer::AnswerCitation;
        /// use google_developers_knowledge_v1::model::answer::CitationSource;
        /// let x = AnswerCitation::new()
        ///     .set_sources([
        ///         CitationSource::default()/* use setters */,
        ///         CitationSource::default()/* use (different) setters */,
        ///     ]);
        /// ```
        pub fn set_sources<T, V>(mut self, v: T) -> Self
        where
            T: std::iter::IntoIterator<Item = V>,
            V: std::convert::Into<crate::model::answer::CitationSource>,
        {
            use std::iter::Iterator;
            self.sources = v.into_iter().map(|i| i.into()).collect();
            self
        }
    }

    impl wkt::message::Message for AnswerCitation {
        fn typename() -> &'static str {
            "type.googleapis.com/google.developers.knowledge.v1.Answer.AnswerCitation"
        }
    }

    /// Citation source.
    #[derive(Clone, Default, PartialEq)]
    #[non_exhaustive]
    pub struct CitationSource {
        /// Output only. Contains the index of the
        /// [Answer.AnswerReference][google.developers.knowledge.v1.Answer.AnswerReference]
        /// in the `references` repeated field.
        ///
        /// [google.developers.knowledge.v1.Answer.AnswerReference]: crate::model::answer::AnswerReference
        pub reference_index: i32,

        pub(crate) _unknown_fields: serde_json::Map<std::string::String, serde_json::Value>,
    }

    impl CitationSource {
        /// Creates a new default instance.
        pub fn new() -> Self {
            std::default::Default::default()
        }

        /// Sets the value of [reference_index][crate::model::answer::CitationSource::reference_index].
        ///
        /// # Example
        /// ```ignore,no_run
        /// # use google_developers_knowledge_v1::model::answer::CitationSource;
        /// let x = CitationSource::new().set_reference_index(42);
        /// ```
        pub fn set_reference_index<T: std::convert::Into<i32>>(mut self, v: T) -> Self {
            self.reference_index = v.into();
            self
        }
    }

    impl wkt::message::Message for CitationSource {
        fn typename() -> &'static str {
            "type.googleapis.com/google.developers.knowledge.v1.Answer.CitationSource"
        }
    }

    /// Represents a reference to a source.
    #[derive(Clone, Default, PartialEq)]
    #[non_exhaustive]
    pub struct AnswerReference {
        /// Contains the content of the reference.
        pub content: std::option::Option<crate::model::answer::answer_reference::Content>,

        pub(crate) _unknown_fields: serde_json::Map<std::string::String, serde_json::Value>,
    }

    impl AnswerReference {
        /// Creates a new default instance.
        pub fn new() -> Self {
            std::default::Default::default()
        }

        /// Sets the value of [content][crate::model::answer::AnswerReference::content].
        ///
        /// Note that all the setters affecting `content` are mutually
        /// exclusive.
        ///
        /// # Example
        /// ```ignore,no_run
        /// # use google_developers_knowledge_v1::model::answer::AnswerReference;
        /// use google_developers_knowledge_v1::model::answer::DocumentReference;
        /// let x = AnswerReference::new().set_content(Some(
        ///     google_developers_knowledge_v1::model::answer::answer_reference::Content::DocumentReference(DocumentReference::default().into())));
        /// ```
        pub fn set_content<
            T: std::convert::Into<
                    std::option::Option<crate::model::answer::answer_reference::Content>,
                >,
        >(
            mut self,
            v: T,
        ) -> Self {
            self.content = v.into();
            self
        }

        /// The value of [content][crate::model::answer::AnswerReference::content]
        /// if it holds a `DocumentReference`, `None` if the field is not set or
        /// holds a different branch.
        pub fn document_reference(
            &self,
        ) -> std::option::Option<&std::boxed::Box<crate::model::answer::DocumentReference>>
        {
            #[allow(unreachable_patterns)]
            self.content.as_ref().and_then(|v| match v {
                crate::model::answer::answer_reference::Content::DocumentReference(v) => {
                    std::option::Option::Some(v)
                }
                _ => std::option::Option::None,
            })
        }

        /// Sets the value of [content][crate::model::answer::AnswerReference::content]
        /// to hold a `DocumentReference`.
        ///
        /// Note that all the setters affecting `content` are
        /// mutually exclusive.
        ///
        /// # Example
        /// ```ignore,no_run
        /// # use google_developers_knowledge_v1::model::answer::AnswerReference;
        /// use google_developers_knowledge_v1::model::answer::DocumentReference;
        /// let x = AnswerReference::new().set_document_reference(DocumentReference::default()/* use setters */);
        /// assert!(x.document_reference().is_some());
        /// ```
        pub fn set_document_reference<
            T: std::convert::Into<std::boxed::Box<crate::model::answer::DocumentReference>>,
        >(
            mut self,
            v: T,
        ) -> Self {
            self.content = std::option::Option::Some(
                crate::model::answer::answer_reference::Content::DocumentReference(v.into()),
            );
            self
        }
    }

    impl wkt::message::Message for AnswerReference {
        fn typename() -> &'static str {
            "type.googleapis.com/google.developers.knowledge.v1.Answer.AnswerReference"
        }
    }

    /// Defines additional types related to [AnswerReference].
    pub mod answer_reference {
        #[allow(unused_imports)]
        use super::*;

        /// Contains the content of the reference.
        #[derive(Clone, Debug, PartialEq)]
        #[non_exhaustive]
        pub enum Content {
            /// Output only. The reference document.
            DocumentReference(std::boxed::Box<crate::model::answer::DocumentReference>),
        }
    }

    /// Represents a reference to a document.
    #[derive(Clone, Default, PartialEq)]
    #[non_exhaustive]
    pub struct DocumentReference {
        /// Output only. Contains the document chunk. The `document_chunk.id` field
        /// is not set and will be empty.
        pub document_chunk: std::option::Option<crate::model::DocumentChunk>,

        pub(crate) _unknown_fields: serde_json::Map<std::string::String, serde_json::Value>,
    }

    impl DocumentReference {
        /// Creates a new default instance.
        pub fn new() -> Self {
            std::default::Default::default()
        }

        /// Sets the value of [document_chunk][crate::model::answer::DocumentReference::document_chunk].
        ///
        /// # Example
        /// ```ignore,no_run
        /// # use google_developers_knowledge_v1::model::answer::DocumentReference;
        /// use google_developers_knowledge_v1::model::DocumentChunk;
        /// let x = DocumentReference::new().set_document_chunk(DocumentChunk::default()/* use setters */);
        /// ```
        pub fn set_document_chunk<T>(mut self, v: T) -> Self
        where
            T: std::convert::Into<crate::model::DocumentChunk>,
        {
            self.document_chunk = std::option::Option::Some(v.into());
            self
        }

        /// Sets or clears the value of [document_chunk][crate::model::answer::DocumentReference::document_chunk].
        ///
        /// # Example
        /// ```ignore,no_run
        /// # use google_developers_knowledge_v1::model::answer::DocumentReference;
        /// use google_developers_knowledge_v1::model::DocumentChunk;
        /// let x = DocumentReference::new().set_or_clear_document_chunk(Some(DocumentChunk::default()/* use setters */));
        /// let x = DocumentReference::new().set_or_clear_document_chunk(None::<DocumentChunk>);
        /// ```
        pub fn set_or_clear_document_chunk<T>(mut self, v: std::option::Option<T>) -> Self
        where
            T: std::convert::Into<crate::model::DocumentChunk>,
        {
            self.document_chunk = v.map(|x| x.into());
            self
        }
    }

    impl wkt::message::Message for DocumentReference {
        fn typename() -> &'static str {
            "type.googleapis.com/google.developers.knowledge.v1.Answer.DocumentReference"
        }
    }
}

/// A DocumentChunk represents a piece of content from a
/// [Document][google.developers.knowledge.v1.Document] in the DeveloperKnowledge
/// corpus. To fetch the entire document content, pass the `parent` to
/// [DeveloperKnowledge.GetDocument][google.developers.knowledge.v1.DeveloperKnowledge.GetDocument]
/// or
/// [DeveloperKnowledge.BatchGetDocuments][google.developers.knowledge.v1.DeveloperKnowledge.BatchGetDocuments].
///
/// [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
#[derive(Clone, Default, PartialEq)]
#[non_exhaustive]
pub struct DocumentChunk {
    /// Output only. Contains the resource name of the document this chunk is from.
    /// Format: `documents/{uri_without_scheme}`
    /// Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets`
    pub parent: std::string::String,

    /// Output only. Specifies the ID of this chunk within the document. The chunk
    /// ID is unique within a document, but not globally unique across documents.
    /// The chunk ID is not stable and may change over time.
    pub id: std::string::String,

    /// Output only. Contains the content of the document chunk.
    pub content: std::string::String,

    /// Output only. Represents metadata about the
    /// [Document][google.developers.knowledge.v1.Document] this chunk is from. The
    /// [DocumentView][google.developers.knowledge.v1.DocumentView] of this
    /// [Document][google.developers.knowledge.v1.Document] message will be set to
    /// `DOCUMENT_VIEW_BASIC`. It is included here for convenience so that clients
    /// do not need to call
    /// [DeveloperKnowledge.GetDocument][google.developers.knowledge.v1.DeveloperKnowledge.GetDocument]
    /// or
    /// [DeveloperKnowledge.BatchGetDocuments][google.developers.knowledge.v1.DeveloperKnowledge.BatchGetDocuments]
    /// if they only need the metadata fields. Otherwise, clients should use
    /// [DeveloperKnowledge.GetDocument][google.developers.knowledge.v1.DeveloperKnowledge.GetDocument]
    /// or
    /// [DeveloperKnowledge.BatchGetDocuments][google.developers.knowledge.v1.DeveloperKnowledge.BatchGetDocuments]
    /// to fetch the full document content.
    ///
    /// [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.DocumentView]: crate::model::DocumentView
    pub document: std::option::Option<crate::model::Document>,

    /// Output only. Represents the relevance score of the chunk to the search
    /// query. Higher score indicates higher chunk relevance. The score is in range
    /// [0.0, 1.0].
    pub relevance_score: std::option::Option<f64>,

    pub(crate) _unknown_fields: serde_json::Map<std::string::String, serde_json::Value>,
}

impl DocumentChunk {
    /// Creates a new default instance.
    pub fn new() -> Self {
        std::default::Default::default()
    }

    /// Sets the value of [parent][crate::model::DocumentChunk::parent].
    ///
    /// # Example
    /// ```ignore,no_run
    /// # use google_developers_knowledge_v1::model::DocumentChunk;
    /// # let document_id = "document_id";
    /// let x = DocumentChunk::new().set_parent(format!("documents/{document_id}"));
    /// ```
    pub fn set_parent<T: std::convert::Into<std::string::String>>(mut self, v: T) -> Self {
        self.parent = v.into();
        self
    }

    /// Sets the value of [id][crate::model::DocumentChunk::id].
    ///
    /// # Example
    /// ```ignore,no_run
    /// # use google_developers_knowledge_v1::model::DocumentChunk;
    /// let x = DocumentChunk::new().set_id("example");
    /// ```
    pub fn set_id<T: std::convert::Into<std::string::String>>(mut self, v: T) -> Self {
        self.id = v.into();
        self
    }

    /// Sets the value of [content][crate::model::DocumentChunk::content].
    ///
    /// # Example
    /// ```ignore,no_run
    /// # use google_developers_knowledge_v1::model::DocumentChunk;
    /// let x = DocumentChunk::new().set_content("example");
    /// ```
    pub fn set_content<T: std::convert::Into<std::string::String>>(mut self, v: T) -> Self {
        self.content = v.into();
        self
    }

    /// Sets the value of [document][crate::model::DocumentChunk::document].
    ///
    /// # Example
    /// ```ignore,no_run
    /// # use google_developers_knowledge_v1::model::DocumentChunk;
    /// use google_developers_knowledge_v1::model::Document;
    /// let x = DocumentChunk::new().set_document(Document::default()/* use setters */);
    /// ```
    pub fn set_document<T>(mut self, v: T) -> Self
    where
        T: std::convert::Into<crate::model::Document>,
    {
        self.document = std::option::Option::Some(v.into());
        self
    }

    /// Sets or clears the value of [document][crate::model::DocumentChunk::document].
    ///
    /// # Example
    /// ```ignore,no_run
    /// # use google_developers_knowledge_v1::model::DocumentChunk;
    /// use google_developers_knowledge_v1::model::Document;
    /// let x = DocumentChunk::new().set_or_clear_document(Some(Document::default()/* use setters */));
    /// let x = DocumentChunk::new().set_or_clear_document(None::<Document>);
    /// ```
    pub fn set_or_clear_document<T>(mut self, v: std::option::Option<T>) -> Self
    where
        T: std::convert::Into<crate::model::Document>,
    {
        self.document = v.map(|x| x.into());
        self
    }

    /// Sets the value of [relevance_score][crate::model::DocumentChunk::relevance_score].
    ///
    /// # Example
    /// ```ignore,no_run
    /// # use google_developers_knowledge_v1::model::DocumentChunk;
    /// let x = DocumentChunk::new().set_relevance_score(42.0);
    /// ```
    pub fn set_relevance_score<T>(mut self, v: T) -> Self
    where
        T: std::convert::Into<f64>,
    {
        self.relevance_score = std::option::Option::Some(v.into());
        self
    }

    /// Sets or clears the value of [relevance_score][crate::model::DocumentChunk::relevance_score].
    ///
    /// # Example
    /// ```ignore,no_run
    /// # use google_developers_knowledge_v1::model::DocumentChunk;
    /// let x = DocumentChunk::new().set_or_clear_relevance_score(Some(42.0));
    /// let x = DocumentChunk::new().set_or_clear_relevance_score(None::<f32>);
    /// ```
    pub fn set_or_clear_relevance_score<T>(mut self, v: std::option::Option<T>) -> Self
    where
        T: std::convert::Into<f64>,
    {
        self.relevance_score = v.map(|x| x.into());
        self
    }
}

impl wkt::message::Message for DocumentChunk {
    fn typename() -> &'static str {
        "type.googleapis.com/google.developers.knowledge.v1.DocumentChunk"
    }
}

/// Specifies which fields of the
/// [Document][google.developers.knowledge.v1.Document] are included.
///
/// [google.developers.knowledge.v1.Document]: crate::model::Document
///
/// # Working with unknown values
///
/// This enum is defined as `#[non_exhaustive]` because Google Cloud may add
/// additional enum variants at any time. Adding new variants is not considered
/// a breaking change. Applications should write their code in anticipation of:
///
/// - New values appearing in future releases of the client library, **and**
/// - New values received dynamically, without application changes.
///
/// Please consult the [Working with enums] section in the user guide for some
/// guidelines.
///
/// [Working with enums]: https://googleapis.github.io/google-cloud-rust/working_with_enums.html
#[derive(Clone, Debug, PartialEq)]
#[non_exhaustive]
pub enum DocumentView {
    /// The default / unset value. See each API method for its default value if
    /// [DocumentView][google.developers.knowledge.v1.DocumentView] is not
    /// specified.
    ///
    /// [google.developers.knowledge.v1.DocumentView]: crate::model::DocumentView
    Unspecified,
    /// Includes only the basic metadata fields:
    ///
    /// - `name`
    /// - `uri`
    /// - `data_source`
    /// - `title`
    /// - `description`
    /// - `update_time`
    /// - `view`
    /// - `content_length_bytes`
    ///
    /// This is the default of view for
    /// [DeveloperKnowledge.SearchDocumentChunks][google.developers.knowledge.v1.DeveloperKnowledge.SearchDocumentChunks].
    ///
    /// [google.developers.knowledge.v1.DeveloperKnowledge.SearchDocumentChunks]: crate::client::DeveloperKnowledge::search_document_chunks
    Basic,
    /// Includes all [Document][google.developers.knowledge.v1.Document] fields.
    ///
    /// [google.developers.knowledge.v1.Document]: crate::model::Document
    Full,
    /// Includes the `DOCUMENT_VIEW_BASIC` fields and the `content` field.
    ///
    /// This is the default of view for
    /// [DeveloperKnowledge.GetDocument][google.developers.knowledge.v1.DeveloperKnowledge.GetDocument]
    /// and
    /// [DeveloperKnowledge.BatchGetDocuments][google.developers.knowledge.v1.DeveloperKnowledge.BatchGetDocuments].
    ///
    /// [google.developers.knowledge.v1.DeveloperKnowledge.BatchGetDocuments]: crate::client::DeveloperKnowledge::batch_get_documents
    /// [google.developers.knowledge.v1.DeveloperKnowledge.GetDocument]: crate::client::DeveloperKnowledge::get_document
    Content,
    /// If set, the enum was initialized with an unknown value.
    ///
    /// Applications can examine the value using [DocumentView::value] or
    /// [DocumentView::name].
    UnknownValue(document_view::UnknownValue),
}

#[doc(hidden)]
pub mod document_view {
    #[allow(unused_imports)]
    use super::*;
    #[derive(Clone, Debug, PartialEq)]
    pub struct UnknownValue(pub(crate) wkt::internal::UnknownEnumValue);
}

impl DocumentView {
    /// Gets the enum value.
    ///
    /// Returns `None` if the enum contains an unknown value deserialized from
    /// the string representation of enums.
    pub fn value(&self) -> std::option::Option<i32> {
        match self {
            Self::Unspecified => std::option::Option::Some(0),
            Self::Basic => std::option::Option::Some(1),
            Self::Full => std::option::Option::Some(2),
            Self::Content => std::option::Option::Some(3),
            Self::UnknownValue(u) => u.0.value(),
        }
    }

    /// Gets the enum value as a string.
    ///
    /// Returns `None` if the enum contains an unknown value deserialized from
    /// the integer representation of enums.
    pub fn name(&self) -> std::option::Option<&str> {
        match self {
            Self::Unspecified => std::option::Option::Some("DOCUMENT_VIEW_UNSPECIFIED"),
            Self::Basic => std::option::Option::Some("DOCUMENT_VIEW_BASIC"),
            Self::Full => std::option::Option::Some("DOCUMENT_VIEW_FULL"),
            Self::Content => std::option::Option::Some("DOCUMENT_VIEW_CONTENT"),
            Self::UnknownValue(u) => u.0.name(),
        }
    }
}

impl std::default::Default for DocumentView {
    fn default() -> Self {
        use std::convert::From;
        Self::from(0)
    }
}

impl std::fmt::Display for DocumentView {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::result::Result<(), std::fmt::Error> {
        wkt::internal::display_enum(f, self.name(), self.value())
    }
}

impl std::convert::From<i32> for DocumentView {
    fn from(value: i32) -> Self {
        match value {
            0 => Self::Unspecified,
            1 => Self::Basic,
            2 => Self::Full,
            3 => Self::Content,
            _ => Self::UnknownValue(document_view::UnknownValue(
                wkt::internal::UnknownEnumValue::Integer(value),
            )),
        }
    }
}

impl std::convert::From<&str> for DocumentView {
    fn from(value: &str) -> Self {
        use std::string::ToString;
        match value {
            "DOCUMENT_VIEW_UNSPECIFIED" => Self::Unspecified,
            "DOCUMENT_VIEW_BASIC" => Self::Basic,
            "DOCUMENT_VIEW_FULL" => Self::Full,
            "DOCUMENT_VIEW_CONTENT" => Self::Content,
            _ => Self::UnknownValue(document_view::UnknownValue(
                wkt::internal::UnknownEnumValue::String(value.to_string()),
            )),
        }
    }
}

impl serde::ser::Serialize for DocumentView {
    fn serialize<S>(&self, serializer: S) -> std::result::Result<S::Ok, S::Error>
    where
        S: serde::Serializer,
    {
        match self {
            Self::Unspecified => serializer.serialize_i32(0),
            Self::Basic => serializer.serialize_i32(1),
            Self::Full => serializer.serialize_i32(2),
            Self::Content => serializer.serialize_i32(3),
            Self::UnknownValue(u) => u.0.serialize(serializer),
        }
    }
}

impl<'de> serde::de::Deserialize<'de> for DocumentView {
    fn deserialize<D>(deserializer: D) -> std::result::Result<Self, D::Error>
    where
        D: serde::Deserializer<'de>,
    {
        deserializer.deserialize_any(wkt::internal::EnumVisitor::<DocumentView>::new(
            ".google.developers.knowledge.v1.DocumentView",
        ))
    }
}