Struct ScheduledAction

#[non_exhaustive]
pub struct ScheduledAction {
    pub id: String,
    pub type: ActionType,
    pub severity: ActionSeverity,
    pub scheduled_time: i64,
    pub description: Option<String>,
    pub scheduled_by: Option<ScheduledBy>,
    pub status: Option<ActionStatus>,
    pub mandatory: Option<bool>,
    pub cancellable: Option<bool>,
}

Information about a scheduled configuration change for an OpenSearch Service domain. This actions can be a service software update or a blue/green Auto-Tune enhancement.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

id: String

The unique identifier of the scheduled action.

type: ActionType

The type of action that will be taken on the domain.

severity: ActionSeverity

The severity of the action.

scheduled_time: i64

The time when the change is scheduled to happen.

description: Option<String>

A description of the action to be taken.

scheduled_by: Option<ScheduledBy>

Whether the action was scheduled manually (CUSTOMER, or by OpenSearch Service automatically (SYSTEM).

status: Option<ActionStatus>

The current status of the scheduled action.

mandatory: Option<bool>

Whether the action is required or optional.

cancellable: Option<bool>

Whether or not the scheduled action is cancellable.

Implementations

impl ScheduledAction

pub fn id(&self) -> &str

The unique identifier of the scheduled action.

pub fn type(&self) -> &ActionType

The type of action that will be taken on the domain.

pub fn severity(&self) -> &ActionSeverity

The severity of the action.

pub fn scheduled_time(&self) -> i64

The time when the change is scheduled to happen.

pub fn description(&self) -> Option<&str>

A description of the action to be taken.

pub fn scheduled_by(&self) -> Option<&ScheduledBy>

Whether the action was scheduled manually (CUSTOMER, or by OpenSearch Service automatically (SYSTEM).

pub fn status(&self) -> Option<&ActionStatus>

The current status of the scheduled action.

pub fn mandatory(&self) -> Option<bool>

Whether the action is required or optional.

pub fn cancellable(&self) -> Option<bool>

Whether or not the scheduled action is cancellable.

impl ScheduledAction

pub fn builder() -> ScheduledActionBuilder

Creates a new builder-style object to manufacture ScheduledAction.

Trait Implementations

impl Clone for ScheduledAction

fn clone(&self) -> ScheduledAction

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScheduledAction

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

Formats the value using the given formatter.

impl PartialEq for ScheduledAction

fn eq(&self, other: &ScheduledAction) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ScheduledAction