Struct aws_sdk_quicksight::types::RefreshFrequency

#[non_exhaustive]
pub struct RefreshFrequency {
    pub interval: RefreshInterval,
    pub refresh_on_day: Option<ScheduleRefreshOnEntity>,
    pub timezone: Option<String>,
    pub time_of_the_day: Option<String>,
}

Specifies the interval between each scheduled refresh of a dataset.

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.

interval: RefreshInterval

The interval between scheduled refreshes. Valid values are as follows:

• MINUTE15: The dataset refreshes every 15 minutes. This value is only supported for incremental refreshes. This interval can only be used for one schedule per dataset.

• MINUTE30:The dataset refreshes every 30 minutes. This value is only supported for incremental refreshes. This interval can only be used for one schedule per dataset.

• HOURLY: The dataset refreshes every hour. This interval can only be used for one schedule per dataset.

• DAILY: The dataset refreshes every day.

• WEEKLY: The dataset refreshes every week.

• MONTHLY: The dataset refreshes every month.

refresh_on_day: Option<ScheduleRefreshOnEntity>

The day of the week that you want to schedule the refresh on. This value is required for weekly and monthly refresh intervals.

timezone: Option<String>

The timezone that you want the refresh schedule to use. The timezone ID must match a corresponding ID found on java.util.time.getAvailableIDs().

time_of_the_day: Option<String>

The time of day that you want the datset to refresh. This value is expressed in HH:MM format. This field is not required for schedules that refresh hourly.

Implementations

impl RefreshFrequency

pub fn interval(&self) -> &RefreshInterval

The interval between scheduled refreshes. Valid values are as follows:

• MINUTE15: The dataset refreshes every 15 minutes. This value is only supported for incremental refreshes. This interval can only be used for one schedule per dataset.

• MINUTE30:The dataset refreshes every 30 minutes. This value is only supported for incremental refreshes. This interval can only be used for one schedule per dataset.

• HOURLY: The dataset refreshes every hour. This interval can only be used for one schedule per dataset.

• DAILY: The dataset refreshes every day.

• WEEKLY: The dataset refreshes every week.

• MONTHLY: The dataset refreshes every month.

pub fn refresh_on_day(&self) -> Option<&ScheduleRefreshOnEntity>

The day of the week that you want to schedule the refresh on. This value is required for weekly and monthly refresh intervals.

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

The timezone that you want the refresh schedule to use. The timezone ID must match a corresponding ID found on java.util.time.getAvailableIDs().

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

The time of day that you want the datset to refresh. This value is expressed in HH:MM format. This field is not required for schedules that refresh hourly.

impl RefreshFrequency

pub fn builder() -> RefreshFrequencyBuilder

Creates a new builder-style object to manufacture RefreshFrequency.

Trait Implementations

impl Clone for RefreshFrequency

fn clone(&self) -> RefreshFrequency

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RefreshFrequency

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

Formats the value using the given formatter.

impl PartialEq for RefreshFrequency

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for RefreshFrequency