redis-enterprise 0.8.7

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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115

//! Scheduled job management
//!
//! ## Overview
//! - Configure scheduled jobs
//! - Query job history
//! - Manage job execution

use crate::error::Result;
use serde::{Deserialize, Serialize};
use serde_json::Value;
use typed_builder::TypedBuilder;

/// Scheduled job information
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ScheduledJob {
    /// Unique identifier for the scheduled job
    pub job_id: String,
    /// Human-readable name for the job
    pub name: String,
    /// Type of job (backup, cleanup, rotation, etc.)
    pub job_type: String,
    /// Cron-style schedule expression for when the job runs
    pub schedule: String,
    /// Whether the scheduled job is currently enabled
    #[serde(skip_serializing_if = "Option::is_none")]
    pub enabled: Option<bool>,
    /// Timestamp of the last job execution (ISO 8601 format)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub last_run: Option<String>,
    /// Timestamp of the next scheduled job execution (ISO 8601 format)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub next_run: Option<String>,
    /// Job-specific parameters and configuration
    #[serde(skip_serializing_if = "Option::is_none")]
    pub params: Option<Value>,
}

/// Create scheduled job request
#[derive(Debug, Clone, Serialize, Deserialize, TypedBuilder)]
pub struct CreateScheduledJobRequest {
    /// Human-readable name for the new job
    #[builder(setter(into))]
    pub name: String,
    /// Type of job to create (backup, cleanup, rotation, etc.)
    #[builder(setter(into))]
    pub job_type: String,
    /// Cron-style schedule expression defining when the job should run
    #[builder(setter(into))]
    pub schedule: String,
    /// Whether the job should be enabled immediately upon creation
    #[serde(skip_serializing_if = "Option::is_none")]
    #[builder(default, setter(strip_option))]
    pub enabled: Option<bool>,
    /// Job-specific parameters and configuration
    #[serde(skip_serializing_if = "Option::is_none")]
    #[builder(default, setter(strip_option))]
    pub params: Option<Value>,
}

/// Job execution history
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct JobExecution {
    /// Unique identifier for this job execution instance
    pub execution_id: String,
    /// ID of the scheduled job that was executed
    pub job_id: String,
    /// Timestamp when the job execution started (ISO 8601 format)
    pub start_time: String,
    /// Timestamp when the job execution finished (ISO 8601 format)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub end_time: Option<String>,
    /// Execution status (running, completed, failed, cancelled)
    pub status: String,
    /// Error description if the job execution failed
    #[serde(skip_serializing_if = "Option::is_none")]
    pub error: Option<String>,
}

define_handler!(
    /// Job scheduler handler
    pub struct JobSchedulerHandler;
);

impl_crud!(JobSchedulerHandler {
    list => ScheduledJob, "/v1/job_scheduler";
    get(&str) => ScheduledJob, "/v1/job_scheduler/{}";
    delete(&str), "/v1/job_scheduler/{}";
    create(CreateScheduledJobRequest) => ScheduledJob, "/v1/job_scheduler";
    update(&str, CreateScheduledJobRequest) => ScheduledJob, "/v1/job_scheduler/{}";
});

// Custom methods
impl JobSchedulerHandler {
    /// Trigger job execution
    pub async fn trigger(&self, job_id: &str) -> Result<JobExecution> {
        self.client
            .post(
                &format!("/v1/job_scheduler/{}/trigger", job_id),
                &Value::Null,
            )
            .await
    }

    /// Get job execution history
    pub async fn history(&self, job_id: &str) -> Result<Vec<JobExecution>> {
        self.client
            .get(&format!("/v1/job_scheduler/{}/history", job_id))
            .await
    }

    /// Update job scheduler globally - PUT /v1/job_scheduler
    pub async fn update_all(&self, body: Value) -> Result<Vec<ScheduledJob>> {
        self.client.put("/v1/job_scheduler", &body).await
    }
}