Struct CloudClient 

pub struct CloudClient { /* private fields */ }

Redis Cloud API client

Implementations

impl CloudClient

pub fn builder() -> CloudClientBuilder

Create a new builder for the client

pub fn timeout(&self) -> Duration

Get the configured request timeout

Returns the timeout duration that was set when building the client. This timeout is applied to all HTTP requests made by this client.

pub fn account(&self) -> AccountHandler

Get an account handler for account management operations

Example

let client = CloudClient::builder()
    .api_key("key")
    .api_secret("secret")
    .build()?;

let account = client.account().get_current_account().await?;

pub fn subscriptions(&self) -> SubscriptionHandler

Get a subscription handler for Pro subscription operations

Example

let client = CloudClient::builder()
    .api_key("key")
    .api_secret("secret")
    .build()?;

let subscriptions = client.subscriptions().get_all_subscriptions().await?;

pub fn databases(&self) -> DatabaseHandler

Get a database handler for Pro database operations

Example

let client = CloudClient::builder()
    .api_key("key")
    .api_secret("secret")
    .build()?;

let databases = client.databases().get_subscription_databases(123, None, None).await?;

pub fn fixed_subscriptions(&self) -> FixedSubscriptionHandler

Get a fixed subscription handler for Essentials subscription operations

Example

let client = CloudClient::builder()
    .api_key("key")
    .api_secret("secret")
    .build()?;

let subscriptions = client.fixed_subscriptions().list().await?;

pub fn fixed_databases(&self) -> FixedDatabaseHandler

Get a fixed database handler for Essentials database operations

Example

let client = CloudClient::builder()
    .api_key("key")
    .api_secret("secret")
    .build()?;

let databases = client.fixed_databases().list(123, None, None).await?;

pub fn acl(&self) -> AclHandler

Get an ACL handler for access control operations

Example

let client = CloudClient::builder()
    .api_key("key")
    .api_secret("secret")
    .build()?;

let users = client.acl().get_all_acl_users().await?;

pub fn users(&self) -> UserHandler

Get a users handler for user management operations

Example

let client = CloudClient::builder()
    .api_key("key")
    .api_secret("secret")
    .build()?;

let users = client.users().get_all_users().await?;

pub fn tasks(&self) -> TaskHandler

Get a tasks handler for async operation tracking

Example

let client = CloudClient::builder()
    .api_key("key")
    .api_secret("secret")
    .build()?;

let tasks = client.tasks().get_all_tasks().await?;

pub fn cloud_accounts(&self) -> CloudAccountHandler

Get a cloud accounts handler for cloud provider integration

Example

let client = CloudClient::builder()
    .api_key("key")
    .api_secret("secret")
    .build()?;

let accounts = client.cloud_accounts().get_cloud_accounts().await?;

pub fn vpc_peering(&self) -> VpcPeeringHandler

Get a VPC peering handler for VPC peering operations

Example

let client = CloudClient::builder()
    .api_key("key")
    .api_secret("secret")
    .build()?;

let peering = client.vpc_peering().get(123).await?;

pub fn transit_gateway(&self) -> TransitGatewayHandler

Get a transit gateway handler for AWS Transit Gateway operations

Example

let client = CloudClient::builder()
    .api_key("key")
    .api_secret("secret")
    .build()?;

let attachments = client.transit_gateway().get_attachments(123).await?;

pub fn psc(&self) -> PscHandler

Get a Private Service Connect handler for GCP PSC operations

Example

let client = CloudClient::builder()
    .api_key("key")
    .api_secret("secret")
    .build()?;

let service = client.psc().get_service(123).await?;

pub fn private_link(&self) -> PrivateLinkHandler

Get a PrivateLink handler for AWS PrivateLink operations

Example

let client = CloudClient::builder()
    .api_key("key")
    .api_secret("secret")
    .build()?;

let config = client.private_link().get(123).await?;

pub fn cost_reports(&self) -> CostReportHandler

Get a cost report handler for generating cost reports

Example

let client = CloudClient::builder()
    .api_key("key")
    .api_secret("secret")
    .build()?;

let handler = client.cost_reports();

pub async fn get<T: DeserializeOwned>(&self, path: &str) -> Result<T>

Make a GET request with API key authentication

pub async fn post<B: Serialize, T: DeserializeOwned>( &self, path: &str, body: &B, ) -> Result<T>

Make a POST request

pub async fn put<B: Serialize, T: DeserializeOwned>( &self, path: &str, body: &B, ) -> Result<T>

Make a PUT request

pub async fn delete(&self, path: &str) -> Result<()>

Make a DELETE request

pub async fn get_raw(&self, path: &str) -> Result<Value>

Execute raw GET request returning JSON Value

pub async fn get_bytes(&self, path: &str) -> Result<Vec<u8>>

Execute GET request returning raw bytes

Useful for downloading binary content like cost reports or other files.

pub async fn post_raw(&self, path: &str, body: Value) -> Result<Value>

Execute raw POST request with JSON body

pub async fn put_raw(&self, path: &str, body: Value) -> Result<Value>

Execute raw PUT request with JSON body

pub async fn patch_raw(&self, path: &str, body: Value) -> Result<Value>

Execute raw PATCH request with JSON body

pub async fn delete_raw(&self, path: &str) -> Result<Value>

Execute raw DELETE request returning any response body

pub async fn delete_with_body<T: DeserializeOwned>( &self, path: &str, body: Value, ) -> Result<T>

Execute DELETE request with JSON body (used by some endpoints like PrivateLink principals)

Trait Implementations

impl Clone for CloudClient

fn clone(&self) -> CloudClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.