pub struct Maintenance { /* private fields */ }Expand description
Implements a client for the Maintenance API.
§Example
use google_cloud_gax::paginator::ItemPaginator as _;
async fn sample(
project_id: &str,
location_id: &str,
) -> anyhow::Result<()> {
let client = Maintenance::builder().build().await?;
let mut list = client.list_resource_maintenances()
.set_parent(format!("projects/{project_id}/locations/{location_id}"))
.by_item();
while let Some(item) = list.next().await.transpose()? {
println!("{:?}", item);
}
Ok(())
}§Service Description
Unified Maintenance service
§Configuration
To configure Maintenance use the with_* methods in the type returned
by builder(). The default configuration should
work for most applications. Common configuration changes include
- with_endpoint(): by default this client uses the global default endpoint
(
https://maintenance.googleapis.com). Applications using regional endpoints or running in restricted networks (e.g. a network configured with Private Google Access with VPC Service Controls) may want to override this default. - with_credentials(): by default this client uses Application Default Credentials. Applications using custom authentication may need to override this default.
§Pooling and Cloning
Maintenance holds a connection pool internally, it is advised to
create one and reuse it. You do not need to wrap Maintenance in
an Rc or Arc to reuse it, because it
already uses an Arc internally.
Implementations§
Source§impl Maintenance
impl Maintenance
Sourcepub fn builder() -> ClientBuilder
pub fn builder() -> ClientBuilder
Returns a builder for Maintenance.
let client = Maintenance::builder().build().await?;Sourcepub fn from_stub<T>(stub: impl Into<Arc<T>>) -> Selfwhere
T: Maintenance + 'static,
pub fn from_stub<T>(stub: impl Into<Arc<T>>) -> Selfwhere
T: Maintenance + 'static,
Creates a new client from the provided stub.
The most common case for calling this function is in tests mocking the client’s behavior.
Sourcepub fn summarize_maintenances(&self) -> SummarizeMaintenances
pub fn summarize_maintenances(&self) -> SummarizeMaintenances
Retrieves the statistics of a specific maintenance.
§Example
use google_cloud_gax::paginator::ItemPaginator as _;
use google_cloud_maintenance_api_v1::Result;
async fn sample(
client: &Maintenance
) -> Result<()> {
let mut list = client.summarize_maintenances()
/* set fields */
.by_item();
while let Some(item) = list.next().await.transpose()? {
println!("{:?}", item);
}
Ok(())
}Sourcepub fn list_resource_maintenances(&self) -> ListResourceMaintenances
pub fn list_resource_maintenances(&self) -> ListResourceMaintenances
Retrieve a collection of resource maintenances.
§Example
use google_cloud_gax::paginator::ItemPaginator as _;
use google_cloud_maintenance_api_v1::Result;
async fn sample(
client: &Maintenance, project_id: &str, location_id: &str
) -> Result<()> {
let mut list = client.list_resource_maintenances()
.set_parent(format!("projects/{project_id}/locations/{location_id}"))
.by_item();
while let Some(item) = list.next().await.transpose()? {
println!("{:?}", item);
}
Ok(())
}Sourcepub fn get_resource_maintenance(&self) -> GetResourceMaintenance
pub fn get_resource_maintenance(&self) -> GetResourceMaintenance
Retrieve a single resource maintenance.
§Example
use google_cloud_maintenance_api_v1::Result;
async fn sample(
client: &Maintenance, project_id: &str, location_id: &str, resource_maintenance_id: &str
) -> Result<()> {
let response = client.get_resource_maintenance()
.set_name(format!("projects/{project_id}/locations/{location_id}/resourceMaintenances/{resource_maintenance_id}"))
.send().await?;
println!("response {:?}", response);
Ok(())
}Sourcepub fn list_locations(&self) -> ListLocations
pub fn list_locations(&self) -> ListLocations
Lists information about the supported locations for this service.
§Example
use google_cloud_gax::paginator::ItemPaginator as _;
use google_cloud_maintenance_api_v1::Result;
async fn sample(
client: &Maintenance
) -> Result<()> {
let mut list = client.list_locations()
/* set fields */
.by_item();
while let Some(item) = list.next().await.transpose()? {
println!("{:?}", item);
}
Ok(())
}Sourcepub fn get_location(&self) -> GetLocation
pub fn get_location(&self) -> GetLocation
Gets information about a location.
§Example
use google_cloud_maintenance_api_v1::Result;
async fn sample(
client: &Maintenance
) -> Result<()> {
let response = client.get_location()
/* set fields */
.send().await?;
println!("response {:?}", response);
Ok(())
}