Skip to main content

google_cloud_retail_v2/
lib.rs

1// Copyright 2025 Google LLC
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//     https://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14//
15// Code generated by sidekick. DO NOT EDIT.
16
17//! Google Cloud Client Libraries for Rust - Vertex AI Search for commerce API
18//!
19//! **WARNING:** some RPCs have no corresponding Rust function to call them.
20//! Typically these are streaming RPCs. We expect adding these RPCs in a
21//! way that does not break the existing APIs or changes their behavior in a
22//! significant way. We do anticipate a number of new crate dependencies
23//! will be required. If you need these RPCs please open an issue in our
24//! GitHub repository.
25//!
26//! This crate contains traits, types, and functions to interact with Vertex AI Search for commerce API
27//! Most applications will use the structs defined in the [client] module.
28//!
29//! The client library types and functions are stable and not expected to change.
30//! Please note that Google Cloud services do change from time to time. The client
31//! libraries are designed to preserve backwards compatibility when the service
32//! changes in compatible ways. For example, adding RPCs, or fields to messages
33//! should not introduce breaking changes to the client libraries.
34//!
35//! # Available Clients
36//!
37//! * [AnalyticsService](client/struct.AnalyticsService.html)
38//! * [CatalogService](client/struct.CatalogService.html)
39//! * [CompletionService](client/struct.CompletionService.html)
40//! * [ControlService](client/struct.ControlService.html)
41//! * [ConversationalSearchService](client/struct.ConversationalSearchService.html)
42//! * [GenerativeQuestionService](client/struct.GenerativeQuestionService.html)
43//! * [ModelService](client/struct.ModelService.html)
44//! * [PredictionService](client/struct.PredictionService.html)
45//! * [ProductService](client/struct.ProductService.html)
46//! * [SearchService](client/struct.SearchService.html)
47//! * [ServingConfigService](client/struct.ServingConfigService.html)
48//! * [UserEventService](client/struct.UserEventService.html)
49//!
50//! # Features
51//!
52//! - `default-rustls-provider`: enabled by default. Use the default rustls
53//!   crypto provider ([aws-lc-rs]) for TLS and authentication. Applications
54//!   with specific requirements for cryptography (such as exclusively using the
55//!   [ring] crate) should disable this default and call
56//!   `rustls::crypto::CryptoProvider::install_default()`.
57//!
58//! [aws-lc-rs]: https://crates.io/crates/aws-lc-rs
59//! [ring]: https://crates.io/crates/ring
60
61#![allow(deprecated)]
62
63/// The messages and enums that are part of this client library.
64#[allow(clippy::module_inception)]
65pub mod model;
66
67pub use gax::Result;
68pub use gax::error::Error;
69
70#[allow(rustdoc::invalid_html_tags)]
71#[allow(rustdoc::redundant_explicit_links)]
72pub mod stub;
73
74/// Concrete implementations of this client library traits.
75pub mod client;
76
77/// Request builders.
78pub mod builder;
79
80#[doc(hidden)]
81pub(crate) mod tracing;
82
83#[doc(hidden)]
84pub(crate) mod transport;
85
86/// The default host used by the service.
87const DEFAULT_HOST: &str = "https://retail.googleapis.com/";
88
89pub(crate) mod info {
90    const NAME: &str = env!("CARGO_PKG_NAME");
91    const VERSION: &str = env!("CARGO_PKG_VERSION");
92    lazy_static::lazy_static! {
93        pub(crate) static ref X_GOOG_API_CLIENT_HEADER: String = {
94            let ac = gaxi::api_header::XGoogApiClient{
95                name:          NAME,
96                version:       VERSION,
97                library_type:  gaxi::api_header::GAPIC,
98            };
99            ac.rest_header_value()
100        };
101    }
102}