google-cloud-osconfig-v1 1.7.0

Google Cloud Client Libraries for Rust - OS Config API
Documentation
// 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::OsConfigService].
///
/// Application developers may need to implement this trait to mock
/// `client::OsConfigService`.  In other use-cases, application developers only
/// use `client::OsConfigService` 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 OsConfigService: std::fmt::Debug + Send + Sync {
    /// Implements [super::client::OsConfigService::execute_patch_job].
    fn execute_patch_job(
        &self,
        _req: crate::model::ExecutePatchJobRequest,
        _options: crate::RequestOptions,
    ) -> impl std::future::Future<Output = crate::Result<crate::Response<crate::model::PatchJob>>> + Send
    {
        gaxi::unimplemented::unimplemented_stub()
    }

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

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

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

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

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

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

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

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

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

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

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

    /// Implements [super::client::OsConfigService::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()
    }

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

/// Defines the trait used to implement [super::client::OsConfigZonalService].
///
/// Application developers may need to implement this trait to mock
/// `client::OsConfigZonalService`.  In other use-cases, application developers only
/// use `client::OsConfigZonalService` 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 OsConfigZonalService: std::fmt::Debug + Send + Sync {
    /// Implements [super::client::OsConfigZonalService::create_os_policy_assignment].
    fn create_os_policy_assignment(
        &self,
        _req: crate::model::CreateOSPolicyAssignmentRequest,
        _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::OsConfigZonalService::update_os_policy_assignment].
    fn update_os_policy_assignment(
        &self,
        _req: crate::model::UpdateOSPolicyAssignmentRequest,
        _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::OsConfigZonalService::get_os_policy_assignment].
    fn get_os_policy_assignment(
        &self,
        _req: crate::model::GetOSPolicyAssignmentRequest,
        _options: crate::RequestOptions,
    ) -> impl std::future::Future<
        Output = crate::Result<crate::Response<crate::model::OSPolicyAssignment>>,
    > + Send {
        gaxi::unimplemented::unimplemented_stub()
    }

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

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

    /// Implements [super::client::OsConfigZonalService::delete_os_policy_assignment].
    fn delete_os_policy_assignment(
        &self,
        _req: crate::model::DeleteOSPolicyAssignmentRequest,
        _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::OsConfigZonalService::get_os_policy_assignment_report].
    fn get_os_policy_assignment_report(
        &self,
        _req: crate::model::GetOSPolicyAssignmentReportRequest,
        _options: crate::RequestOptions,
    ) -> impl std::future::Future<
        Output = crate::Result<crate::Response<crate::model::OSPolicyAssignmentReport>>,
    > + Send {
        gaxi::unimplemented::unimplemented_stub()
    }

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

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

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

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

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

    /// Implements [super::client::OsConfigZonalService::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()
    }

    /// Implements [super::client::OsConfigZonalService::cancel_operation].
    fn cancel_operation(
        &self,
        _req: google_cloud_longrunning::model::CancelOperationRequest,
        _options: crate::RequestOptions,
    ) -> impl std::future::Future<Output = crate::Result<crate::Response<()>>> + 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())
    }
}