Struct CloudMemcache 

pub struct CloudMemcache { /* private fields */ }

Implements a client for the Cloud Memorystore for Memcached API.

Example

let client = CloudMemcache::builder().build().await?;
// use `client` to make requests to the Cloud Memorystore for Memcached API.

Service Description

Configures and manages Cloud Memorystore for Memcached instances.

The memcache.googleapis.com service implements the Google Cloud Memorystore for Memcached API and defines the following resource model for managing Memorystore Memcached (also called Memcached below) instances:

• The service works with a collection of cloud projects, named: /projects/*
• Each project has a collection of available locations, named: /locations/*
• Each location has a collection of Memcached instances, named: /instances/*
• As such, Memcached instances are resources of the form: /projects/{project_id}/locations/{location_id}/instances/{instance_id}

Note that location_id must be a GCP region; for example:

• projects/my-memcached-project/locations/us-central1/instances/my-memcached

Configuration

To configure CloudMemcache 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://memcache.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

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

Implementations

impl CloudMemcache

pub fn builder() -> ClientBuilder

Returns a builder for CloudMemcache.

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

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

where T: CloudMemcache + '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_instances(&self) -> ListInstances

Lists Instances in a given location.

pub fn get_instance(&self) -> GetInstance

Gets details of a single Instance.

pub fn create_instance(&self) -> CreateInstance

Creates a new Instance in a given location.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn update_instance(&self) -> UpdateInstance

Updates an existing Instance in a given project and location.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn update_parameters(&self) -> UpdateParameters

Updates the defined Memcached parameters for an existing instance. This method only stages the parameters, it must be followed by ApplyParameters to apply the parameters to nodes of the Memcached instance.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn delete_instance(&self) -> DeleteInstance

Deletes a single Instance.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn apply_parameters(&self) -> ApplyParameters

ApplyParameters restarts the set of specified nodes in order to update them to the current set of parameters for the Memcached Instance.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn reschedule_maintenance(&self) -> RescheduleMaintenance

Reschedules upcoming maintenance event.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

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.

pub fn list_operations(&self) -> ListOperations

Provides the Operations service functionality in this service.

pub fn get_operation(&self) -> GetOperation

Provides the Operations service functionality in this service.

pub fn delete_operation(&self) -> DeleteOperation

Provides the Operations service functionality in this service.

pub fn cancel_operation(&self) -> CancelOperation

Provides the Operations service functionality in this service.

Trait Implementations

impl Clone for CloudMemcache

fn clone(&self) -> CloudMemcache

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CloudMemcache

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

Formats the value using the given formatter.