Struct Redis 

pub struct Redis { /* private fields */ }

Represents the Redis service, encapsulating the client information required to interact with the Volcengine Redis service.

Trait Implementations

impl Clone for Redis

fn clone(&self) -> Redis

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Redis

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

Formats the value using the given formatter.

impl RedisService for Redis

Implementation of RedisService trait for Redis struct. Provides core functionality for interacting with Volcengine Redis service, including instance lifecycle management and security configurations.

fn new_redis(session: Session) -> Result<Self, Error>

Initializes a new Redis service client from a session configuration.

Parameters

• session: Authenticated session containing credentials and regional configuration

Workflow

1. Creates service-specific client configuration
2. Constructs client information (service metadata)
3. Initializes network handles
4. Builds complete client instance

Returns

• Ok(Redis): Configured Redis client ready for API operations
• Err(error::Error): Configuration errors during client setup

async fn new_create_db_instance( &self, request: RedisCreateDbInstanceReq, ) -> Result<RedisCreateDbInstanceResp, Error>

Creates a new Redis database instance with specified configuration.

Parameters

• request: CreateDbInstanceReq containing:
  • Instance specifications (memory, version, etc.)
  • Network configuration (VPC, subnet)
  • Authentication parameters

Returns

• Ok(CreateDbInstanceResp): Contains created instance ID and status
• Err(error::Error): Creation failures (quota exceeded, invalid params)

async fn new_describe_db_instance_detail( &self, request: RedisDescribeDbInstanceDetailReq, ) -> Result<RedisDescribeDbInstanceDetailResp, Error>

Retrieves detailed configuration and status of a Redis instance.

Parameters

• request: DescribeDbInstanceDetailReq with target instance ID

Returns

• Ok(DescribeDbInstanceDetailResp): Detailed instance metadata including:
  • Current state (running/creating/error)
  • Connection endpoints
  • Resource utilization metrics
  • Configuration parameters

async fn new_modify_allow_list( &self, request: RedisModifyAllowListReq, ) -> Result<RedisModifyAllowListResp, Error>

Updates network access rules (allow list) for a Redis instance.

Security Note

• Modifies IP whitelist rules controlling instance access
• Supports CIDR ranges and individual IP addresses

Parameters

• request: ModifyAllowListReq containing:
  • Allow list ID to modify
  • New IP/CIDR rules
  • Optional rule description

Returns

• Ok(ModifyAllowListResp): Updated allow list version and status

async fn new_increase_db_instance_node_number( &self, request: RedisIncreaseDbInstanceNodeNumberReq, ) -> Result<RedisIncreaseDbInstanceNodeNumberResp, Error>

Increases the node number of a Redis database instance.

This function sends a request to the Volcengine Redis service to increase the number of nodes in a Redis database instance. It delegates the actual request handling to the ApiIncreaseDbInstanceNodeNumber struct.

Arguments

• request - A IncreaseDbInstanceNodeNumberReq structure containing the request parameters.

Returns

• Result<IncreaseDbInstanceNodeNumberResp, error::Error> - On success, returns a IncreaseDbInstanceNodeNumberResp structure containing the response from the Redis service. On failure, returns an error::Error indicating the cause of the failure.

async fn new_decrease_db_instance_node_number( &self, request: RedisDecreaseDbInstanceNodeNumberReq, ) -> Result<RedisDecreaseDbInstanceNodeNumberResp, Error>

Decreases the node number of a Redis database instance.

This function sends a request to the Volcengine Redis service to decrease the number of nodes in a Redis database instance. It delegates the actual request handling to the ApiDecreaseDBInstanceNodeNumber struct.

Arguments

• request - A DecreaseDbInstanceNodeNumberReq structure containing the request parameters.

Returns

• Result<DecreaseDbInstanceNodeNumberResp, error::Error> - On success, returns a DecreaseDbInstanceNodeNumberResp structure containing the response from the Redis service. On failure, returns an error::Error indicating the cause of the failure.

async fn new_modify_db_instance_shard_capacity( &self, request: RedisModifyDbInstanceShardCapacityReq, ) -> Result<RedisModifyDbInstanceShardCapacityResp, Error>

Modifies the shard capacity of a Redis database instance.

This function sends a request to the Volcengine Redis service to modify the shard capacity of a Redis database instance. It delegates the actual request handling to the ApiModifyDBInstanceShardCapacity struct.

Arguments

• request - A ModifyDbInstanceShardCapacityReq structure containing the request parameters.

Returns

• Result<ModifyDbInstanceShardCapacityResp, error::Error> - On success, returns a ModifyDbInstanceShardCapacityResp structure containing the response from the Redis service. On failure, returns an error::Error indicating the cause of the failure.

async fn new_modify_db_instance_shard_number( &self, request: RedisModifyDbInstanceShardNumberReq, ) -> Result<RedisModifyDbInstanceShardNumberResp, Error>

Modifies the shard number of a Redis database instance.

This function sends a request to the Volcengine Redis service to modify the shard number of a Redis database instance. It delegates the actual request handling to the ApiModifyDBInstanceShardNumber struct.

Arguments

• request - A ModifyDbInstanceShardNumberReq structure containing the request parameters.

Returns

• Result<ModifyDbInstanceShardNumberResp, error::Error> - On success, returns a ModifyDbInstanceShardNumberResp structure containing the response from the Redis service. On failure, returns an error::Error indicating the cause of the failure.

async fn new_enable_sharded_cluster( &self, request: RedisEnableShardedClusterReq, ) -> Result<RedisEnableShardedClusterResp, Error>

Enables sharded cluster mode for a Redis database instance.

This function sends a request to the Volcengine Redis service to enable sharded cluster mode for a Redis database instance. It delegates the actual request handling to the ApiEnableShardedCluster struct.

Arguments

• request - A EnableShardedClusterReq structure containing the request parameters.

Returns

• Result<EnableShardedClusterResp, error::Error> - On success, returns a EnableShardedClusterResp structure containing the response from the Redis service. On failure, returns an error::Error indicating the cause of the failure.

async fn new_describe_db_instances( &self, request: RedisDescribeDbInstancesReq, ) -> Result<RedisDescribeDbInstancesResp, Error>

Public method to describe the details of a Redis database instance.

This method acts as a wrapper to call the new_describe_db_instances method of the ApiDescribeDBInstancesRedis struct. It is used to send a request to the Volcengine Redis service to retrieve detailed information about Redis database instances.

Arguments

• &self: Reference to the current instance of the struct.
• request: A RedisDescribeDbInstancesReq structure containing the request parameters.

Returns

• Result<RedisDescribeDbInstancesResp, error::Error>: On success, returns a RedisDescribeDbInstancesResp structure containing the response from the Redis service. On failure, returns an error::Error indicating the cause of the failure.