google-cloud-discoveryengine-v1 2.8.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.

//! Google Cloud Client Libraries for Rust - Discovery Engine API
//!
//! **WARNING:** some RPCs have no corresponding Rust function to call them.
//! Typically these are streaming RPCs. We expect adding these RPCs in a
//! way that does not break the existing APIs or changes their behavior in a
//! significant way. We do anticipate a number of new crate dependencies
//! will be required. If you need these RPCs please open an issue in our
//! GitHub repository.
//!
//! This crate contains traits, types, and functions to interact with Discovery Engine API
//! Most applications will use the structs defined in the [client] module.
//!
//! The client library types and functions are stable and not expected to change.
//! Please note that Google Cloud services do change from time to time. The client
//! libraries are designed to preserve backwards compatibility when the service
//! changes in compatible ways. For example, adding RPCs, or fields to messages
//! should not introduce breaking changes to the client libraries.
//!
//! # Available Clients
//!
//! * [AssistantService](client/struct.AssistantService.html)
//! * [CmekConfigService](client/struct.CmekConfigService.html)
//! * [CompletionService](client/struct.CompletionService.html)
//! * [ControlService](client/struct.ControlService.html)
//! * [ConversationalSearchService](client/struct.ConversationalSearchService.html)
//! * [DataStoreService](client/struct.DataStoreService.html)
//! * [DocumentService](client/struct.DocumentService.html)
//! * [EngineService](client/struct.EngineService.html)
//! * [GroundedGenerationService](client/struct.GroundedGenerationService.html)
//! * [IdentityMappingStoreService](client/struct.IdentityMappingStoreService.html)
//! * [ProjectService](client/struct.ProjectService.html)
//! * [RankService](client/struct.RankService.html)
//! * [RecommendationService](client/struct.RecommendationService.html)
//! * [SchemaService](client/struct.SchemaService.html)
//! * [SearchService](client/struct.SearchService.html)
//! * [SearchTuningService](client/struct.SearchTuningService.html)
//! * [ServingConfigService](client/struct.ServingConfigService.html)
//! * [SessionService](client/struct.SessionService.html)
//! * [SiteSearchEngineService](client/struct.SiteSearchEngineService.html)
//! * [UserEventService](client/struct.UserEventService.html)
//! * [UserLicenseService](client/struct.UserLicenseService.html)
//!
//! # Features
//!
//! - `default-rustls-provider`: enabled by default. Use the default rustls
//!   crypto provider ([aws-lc-rs]) for TLS and authentication. Applications
//!   with specific requirements for cryptography (such as exclusively using the
//!   [ring] crate) should disable this default and call
//!   `rustls::crypto::CryptoProvider::install_default()`.
//! - Each client can be enabled using its own feature. Use the client's name
//!   in `kebab-case` to enable the client.
//!
//! [aws-lc-rs]: https://crates.io/crates/aws-lc-rs
//! [ring]: https://crates.io/crates/ring

#![cfg_attr(docsrs, feature(doc_cfg))]
#![allow(deprecated)]

/// The messages and enums that are part of this client library.
#[allow(clippy::module_inception)]
pub mod model;

pub use google_cloud_gax::Result;
pub use google_cloud_gax::error::Error;

#[allow(rustdoc::invalid_html_tags)]
#[allow(rustdoc::redundant_explicit_links)]
pub mod stub;

///
/// # Example
/// ```
/// # use google_cloud_discoveryengine_v1::client::CmekConfigService;
/// # async fn sample() -> Result<(), Box<dyn std::error::Error>> {
///     let client = CmekConfigService::builder().build().await?;
///     let name = "name_value";
///     let response = client.get_cmek_config()
///         .set_name(name)
///         .send().await?;
///     println!("response {:?}", response);
/// # Ok(()) }
/// ```
/// Concrete implementations of this client library traits.
pub mod client;

/// Request builders.
pub mod builder;

#[doc(hidden)]
pub(crate) mod tracing;

#[doc(hidden)]
pub(crate) mod transport;

/// The default host used by the service.
#[cfg(any(
    feature = "assistant-service",
    feature = "cmek-config-service",
    feature = "completion-service",
    feature = "control-service",
    feature = "conversational-search-service",
    feature = "data-store-service",
    feature = "document-service",
    feature = "engine-service",
    feature = "grounded-generation-service",
    feature = "identity-mapping-store-service",
    feature = "project-service",
    feature = "rank-service",
    feature = "recommendation-service",
    feature = "schema-service",
    feature = "search-service",
    feature = "search-tuning-service",
    feature = "serving-config-service",
    feature = "session-service",
    feature = "site-search-engine-service",
    feature = "user-event-service",
    feature = "user-license-service",
))]
const DEFAULT_HOST: &str = "https://discoveryengine.googleapis.com/";

#[cfg(any(
    feature = "assistant-service",
    feature = "cmek-config-service",
    feature = "completion-service",
    feature = "control-service",
    feature = "conversational-search-service",
    feature = "data-store-service",
    feature = "document-service",
    feature = "engine-service",
    feature = "grounded-generation-service",
    feature = "identity-mapping-store-service",
    feature = "project-service",
    feature = "rank-service",
    feature = "recommendation-service",
    feature = "schema-service",
    feature = "search-service",
    feature = "search-tuning-service",
    feature = "serving-config-service",
    feature = "session-service",
    feature = "site-search-engine-service",
    feature = "user-event-service",
    feature = "user-license-service",
))]
pub(crate) mod info {
    const NAME: &str = env!("CARGO_PKG_NAME");
    const VERSION: &str = env!("CARGO_PKG_VERSION");
    pub(crate) static X_GOOG_API_CLIENT_HEADER: std::sync::LazyLock<String> =
        std::sync::LazyLock::new(|| {
            let ac = gaxi::api_header::XGoogApiClient {
                name: NAME,
                version: VERSION,
                library_type: gaxi::api_header::GAPIC,
            };
            ac.rest_header_value()
        });
}

// Define some shortcuts for imported crates.
pub(crate) use google_cloud_gax::client_builder::ClientBuilder;
pub(crate) use google_cloud_gax::client_builder::Result as ClientBuilderResult;
pub(crate) use google_cloud_gax::client_builder::internal::ClientFactory;
pub(crate) use google_cloud_gax::client_builder::internal::new_builder as new_client_builder;
pub(crate) use google_cloud_gax::options::RequestOptions;
pub(crate) use google_cloud_gax::options::internal::RequestBuilder;
pub(crate) use google_cloud_gax::response::Response;