redis-enterprise 0.10.0

Redis Enterprise REST API client library
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98

//! Database name suffix management
//!
//! ## Overview
//! - Configure database suffixes
//! - Manage suffix rules
//! - Query suffix usage

use crate::client::RestClient;
use crate::error::Result;
use serde::{Deserialize, Serialize};
use typed_builder::TypedBuilder;

/// DNS suffix configuration
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Suffix {
    /// Unique name identifier for the DNS suffix
    pub name: String,
    /// The DNS suffix string to be used for database endpoints
    #[serde(skip_serializing_if = "Option::is_none")]
    pub dns_suffix: Option<String>,
    /// Whether to use internal addresses for this suffix
    #[serde(skip_serializing_if = "Option::is_none")]
    pub use_internal_addr: Option<bool>,
    /// Whether to use external addresses for this suffix
    #[serde(skip_serializing_if = "Option::is_none")]
    pub use_external_addr: Option<bool>,
}

/// Create suffix request
#[derive(Debug, Clone, Serialize, Deserialize, TypedBuilder)]
pub struct CreateSuffixRequest {
    /// Unique name identifier for the DNS suffix
    #[builder(setter(into))]
    pub name: String,
    /// The DNS suffix string to be used for database endpoints
    #[builder(setter(into))]
    pub dns_suffix: String,
    /// Whether to use internal addresses for this suffix
    #[serde(skip_serializing_if = "Option::is_none")]
    #[builder(default, setter(strip_option))]
    pub use_internal_addr: Option<bool>,
    /// Whether to use external addresses for this suffix
    #[serde(skip_serializing_if = "Option::is_none")]
    #[builder(default, setter(strip_option))]
    pub use_external_addr: Option<bool>,
}

/// Suffixes handler
pub struct SuffixesHandler {
    client: RestClient,
}

impl SuffixesHandler {
    /// Create a new handler bound to the given REST client.
    pub fn new(client: RestClient) -> Self {
        SuffixesHandler { client }
    }

    /// List all DNS suffixes
    pub async fn list(&self) -> Result<Vec<Suffix>> {
        self.client.get("/v1/suffixes").await
    }

    /// Get specific suffix
    pub async fn get(&self, name: &str) -> Result<Suffix> {
        self.client.get(&format!("/v1/suffix/{}", name)).await
    }

    /// Retired suffix creation helper.
    #[deprecated(note = "supported Redis Software versions do not register suffix creation")]
    pub async fn create(&self, _request: CreateSuffixRequest) -> Result<Suffix> {
        crate::error::unsupported_operation("create suffix")
    }

    /// Update a suffix with the method registered by Redis Software 8.0+.
    ///
    /// Redis Software 7.x does not register a suffix update method. The old
    /// SDK implementation sent `PUT`, which is not registered by any supported
    /// family; current 8.x releases register `PATCH`.
    pub async fn update(&self, name: &str, request: CreateSuffixRequest) -> Result<Suffix> {
        let body = serde_json::to_value(request)?;
        let value = self
            .client
            .patch_raw(&format!("/v1/suffix/{}", name), body)
            .await?;
        serde_json::from_value(value).map_err(Into::into)
    }

    /// Delete a suffix
    pub async fn delete(&self, name: &str) -> Result<()> {
        self.client.delete(&format!("/v1/suffix/{}", name)).await
    }

    /// Get cluster DNS suffixes through the canonical suffix collection.
    pub async fn cluster_suffixes(&self) -> Result<Vec<Suffix>> {
        self.list().await
    }
}