Class: Aws::QuickSight::Types::TopicRefreshSchedule

Inherits:

Struct

• Object
• Struct
• Aws::QuickSight::Types::TopicRefreshSchedule

Defined in:

gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb

Overview

A structure that represents a topic refresh schedule.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #based_on_spice_schedule ⇒ Boolean

  A Boolean value that controls whether to schedule runs at the same schedule that is specified in SPICE dataset.

• #is_enabled ⇒ Boolean

  A Boolean value that controls whether to schedule is enabled.

• #repeat_at ⇒ String

  The time of day when the refresh should run, for example, Monday-Sunday.

• #starting_at ⇒ Time

  The starting date and time for the refresh schedule.

• #timezone ⇒ String

  The timezone that you want the refresh schedule to use.

• #topic_schedule_type ⇒ String

  The type of refresh schedule.

Instance Attribute Details

#based_on_spice_schedule ⇒ Boolean

A Boolean value that controls whether to schedule runs at the same schedule that is specified in SPICE dataset.

Returns:

• (Boolean)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 29795

class TopicRefreshSchedule < Struct.new(
  :is_enabled,
  :based_on_spice_schedule,
  :starting_at,
  :timezone,
  :repeat_at,
  :topic_schedule_type)
  SENSITIVE = []
  include Aws::Structure
end

#is_enabled ⇒ Boolean

A Boolean value that controls whether to schedule is enabled.

Returns:

• (Boolean)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 29795

class TopicRefreshSchedule < Struct.new(
  :is_enabled,
  :based_on_spice_schedule,
  :starting_at,
  :timezone,
  :repeat_at,
  :topic_schedule_type)
  SENSITIVE = []
  include Aws::Structure
end

#repeat_at ⇒ String

The time of day when the refresh should run, for example, Monday-Sunday.

Returns:

• (String)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 29795

class TopicRefreshSchedule < Struct.new(
  :is_enabled,
  :based_on_spice_schedule,
  :starting_at,
  :timezone,
  :repeat_at,
  :topic_schedule_type)
  SENSITIVE = []
  include Aws::Structure
end

#starting_at ⇒ Time

The starting date and time for the refresh schedule.

Returns:

• (Time)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 29795

class TopicRefreshSchedule < Struct.new(
  :is_enabled,
  :based_on_spice_schedule,
  :starting_at,
  :timezone,
  :repeat_at,
  :topic_schedule_type)
  SENSITIVE = []
  include Aws::Structure
end

#timezone ⇒ String

The timezone that you want the refresh schedule to use.

Returns:

• (String)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 29795

class TopicRefreshSchedule < Struct.new(
  :is_enabled,
  :based_on_spice_schedule,
  :starting_at,
  :timezone,
  :repeat_at,
  :topic_schedule_type)
  SENSITIVE = []
  include Aws::Structure
end

#topic_schedule_type ⇒ String

The type of refresh schedule. Valid values for this structure are HOURLY, DAILY, WEEKLY, and MONTHLY.

Returns:

• (String)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 29795

class TopicRefreshSchedule < Struct.new(
  :is_enabled,
  :based_on_spice_schedule,
  :starting_at,
  :timezone,
  :repeat_at,
  :topic_schedule_type)
  SENSITIVE = []
  include Aws::Structure
end