google-cloud-apikeys-v2 1.13.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.

//! Traits to mock the clients in this library.
//!
//! Application developers may need to mock the clients in this library to test
//! how their application works with different (and sometimes hard to trigger)
//! client and service behavior. Such test can define mocks implementing the
//! trait(s) defined in this module, initialize the client with an instance of
//! this mock in their tests, and verify their application responds as expected.

#![allow(rustdoc::broken_intra_doc_links)]

pub(crate) mod dynamic;

/// Defines the trait used to implement [super::client::ApiKeys].
///
/// Application developers may need to implement this trait to mock
/// `client::ApiKeys`.  In other use-cases, application developers only
/// use `client::ApiKeys` and need not be concerned with this trait or
/// its implementations.
///
/// Services gain new RPCs routinely. Consequently, this trait gains new methods
/// too. To avoid breaking applications the trait provides a default
/// implementation of each method. Most of these implementations just return an
/// error.
pub trait ApiKeys: std::fmt::Debug + Send + Sync {
    /// Implements [super::client::ApiKeys::create_key].
    fn create_key(
        &self,
        _req: crate::model::CreateKeyRequest,
        _options: crate::RequestOptions,
    ) -> impl std::future::Future<
        Output = crate::Result<crate::Response<google_cloud_longrunning::model::Operation>>,
    > + Send {
        gaxi::unimplemented::unimplemented_stub()
    }

    /// Implements [super::client::ApiKeys::list_keys].
    fn list_keys(
        &self,
        _req: crate::model::ListKeysRequest,
        _options: crate::RequestOptions,
    ) -> impl std::future::Future<
        Output = crate::Result<crate::Response<crate::model::ListKeysResponse>>,
    > + Send {
        gaxi::unimplemented::unimplemented_stub()
    }

    /// Implements [super::client::ApiKeys::get_key].
    fn get_key(
        &self,
        _req: crate::model::GetKeyRequest,
        _options: crate::RequestOptions,
    ) -> impl std::future::Future<Output = crate::Result<crate::Response<crate::model::Key>>> + Send
    {
        gaxi::unimplemented::unimplemented_stub()
    }

    /// Implements [super::client::ApiKeys::get_key_string].
    fn get_key_string(
        &self,
        _req: crate::model::GetKeyStringRequest,
        _options: crate::RequestOptions,
    ) -> impl std::future::Future<
        Output = crate::Result<crate::Response<crate::model::GetKeyStringResponse>>,
    > + Send {
        gaxi::unimplemented::unimplemented_stub()
    }

    /// Implements [super::client::ApiKeys::update_key].
    fn update_key(
        &self,
        _req: crate::model::UpdateKeyRequest,
        _options: crate::RequestOptions,
    ) -> impl std::future::Future<
        Output = crate::Result<crate::Response<google_cloud_longrunning::model::Operation>>,
    > + Send {
        gaxi::unimplemented::unimplemented_stub()
    }

    /// Implements [super::client::ApiKeys::delete_key].
    fn delete_key(
        &self,
        _req: crate::model::DeleteKeyRequest,
        _options: crate::RequestOptions,
    ) -> impl std::future::Future<
        Output = crate::Result<crate::Response<google_cloud_longrunning::model::Operation>>,
    > + Send {
        gaxi::unimplemented::unimplemented_stub()
    }

    /// Implements [super::client::ApiKeys::undelete_key].
    fn undelete_key(
        &self,
        _req: crate::model::UndeleteKeyRequest,
        _options: crate::RequestOptions,
    ) -> impl std::future::Future<
        Output = crate::Result<crate::Response<google_cloud_longrunning::model::Operation>>,
    > + Send {
        gaxi::unimplemented::unimplemented_stub()
    }

    /// Implements [super::client::ApiKeys::lookup_key].
    fn lookup_key(
        &self,
        _req: crate::model::LookupKeyRequest,
        _options: crate::RequestOptions,
    ) -> impl std::future::Future<
        Output = crate::Result<crate::Response<crate::model::LookupKeyResponse>>,
    > + Send {
        gaxi::unimplemented::unimplemented_stub()
    }

    /// Implements [super::client::ApiKeys::get_operation].
    fn get_operation(
        &self,
        _req: google_cloud_longrunning::model::GetOperationRequest,
        _options: crate::RequestOptions,
    ) -> impl std::future::Future<
        Output = crate::Result<crate::Response<google_cloud_longrunning::model::Operation>>,
    > + Send {
        gaxi::unimplemented::unimplemented_stub()
    }

    /// Returns the polling error policy.
    ///
    /// When mocking, this method is typically irrelevant. Do not try to verify
    /// it is called by your mocks.
    fn get_polling_error_policy(
        &self,
        _options: &crate::RequestOptions,
    ) -> std::sync::Arc<dyn google_cloud_gax::polling_error_policy::PollingErrorPolicy> {
        std::sync::Arc::new(google_cloud_gax::polling_error_policy::Aip194Strict)
    }

    /// Returns the polling backoff policy.
    ///
    /// When mocking, this method is typically irrelevant. Do not try to verify
    /// it is called by your mocks.
    fn get_polling_backoff_policy(
        &self,
        _options: &crate::RequestOptions,
    ) -> std::sync::Arc<dyn google_cloud_gax::polling_backoff_policy::PollingBackoffPolicy> {
        std::sync::Arc::new(google_cloud_gax::exponential_backoff::ExponentialBackoff::default())
    }

    #[doc(hidden)]
    /// Returns the poller options.
    ///
    /// When mocking, this method is typically irrelevant. Do not try to verify
    /// it is called by your mocks.
    fn get_poller_options(
        &self,
        _options: &crate::RequestOptions,
    ) -> google_cloud_lro::PollerOptions {
        google_cloud_lro::PollerOptions::default()
    }
}