Struct Locations

pub struct Locations { /* private fields */ }

Implements a client for the Cloud Metadata API.

Example

let client = Locations::builder().build().await?;
// use `client` to make requests to the Cloud Metadata API.

Service Description

An abstract interface that provides location-related information for a service. Service-specific metadata is provided through the Location.metadata field.

Configuration

To configure Locations 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://cloud.googleapis.com). Applications using regional endpoints or running in restricted networks (e.g. a network configured 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

Locations holds a connection pool internally, it is advised to create one and the reuse it. You do not need to wrap Locations in an Rc or Arc to reuse it, because it already uses an Arc internally.

Implementations

impl Locations

pub fn builder() -> ClientBuilder

Returns a builder for Locations.

let client = Locations::builder().build().await?;

pub fn from_stub<T>(stub: T) -> Self

where T: Locations + '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.

pub fn list_locations(&self) -> ListLocations

Lists information about the supported locations for this service.

pub fn get_location(&self) -> GetLocation

Gets information about a location.

Trait Implementations

impl Clone for Locations

fn clone(&self) -> Locations

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Locations

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.