Class: OCI::LogAnalytics::Models::Schedule

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/log_analytics/models/schedule.rb

Overview

Schedule for scheduled task. This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class

Constant Summary collapse

TYPE_ENUM = 
[
  TYPE_FIXED_FREQUENCY = 'FIXED_FREQUENCY'.freeze,
  TYPE_CRON = 'CRON'.freeze,
  TYPE_AUTO = 'AUTO'.freeze,
  TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
MISFIRE_POLICY_ENUM = 
[
  MISFIRE_POLICY_RETRY_ONCE = 'RETRY_ONCE'.freeze,
  MISFIRE_POLICY_RETRY_INDEFINITELY = 'RETRY_INDEFINITELY'.freeze,
  MISFIRE_POLICY_SKIP = 'SKIP'.freeze,
  MISFIRE_POLICY_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Schedule

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):

  • :type (String) —

    The value to assign to the #type property

  • :misfire_policy (String) —

    The value to assign to the #misfire_policy property

  • :time_of_first_execution (DateTime) —

    The value to assign to the #time_of_first_execution property

  • :query_offset_secs (Integer) —

    The value to assign to the #query_offset_secs property

  • :time_end (DateTime) —

    The value to assign to the #time_end property



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/oci/log_analytics/models/schedule.rb', line 104

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.type = attributes[:'type'] if attributes[:'type']
  self.type = "AUTO" if type.nil? && !attributes.key?(:'type') # rubocop:disable Style/StringLiterals

  self.misfire_policy = attributes[:'misfirePolicy'] if attributes[:'misfirePolicy']
  self.misfire_policy = "RETRY_INDEFINITELY" if misfire_policy.nil? && !attributes.key?(:'misfirePolicy') # rubocop:disable Style/StringLiterals

  raise 'You cannot provide both :misfirePolicy and :misfire_policy' if attributes.key?(:'misfirePolicy') && attributes.key?(:'misfire_policy')

  self.misfire_policy = attributes[:'misfire_policy'] if attributes[:'misfire_policy']
  self.misfire_policy = "RETRY_INDEFINITELY" if misfire_policy.nil? && !attributes.key?(:'misfirePolicy') && !attributes.key?(:'misfire_policy') # rubocop:disable Style/StringLiterals

  self.time_of_first_execution = attributes[:'timeOfFirstExecution'] if attributes[:'timeOfFirstExecution']

  raise 'You cannot provide both :timeOfFirstExecution and :time_of_first_execution' if attributes.key?(:'timeOfFirstExecution') && attributes.key?(:'time_of_first_execution')

  self.time_of_first_execution = attributes[:'time_of_first_execution'] if attributes[:'time_of_first_execution']

  self.query_offset_secs = attributes[:'queryOffsetSecs'] if attributes[:'queryOffsetSecs']
  self.query_offset_secs = 0 if query_offset_secs.nil? && !attributes.key?(:'queryOffsetSecs') # rubocop:disable Style/StringLiterals

  raise 'You cannot provide both :queryOffsetSecs and :query_offset_secs' if attributes.key?(:'queryOffsetSecs') && attributes.key?(:'query_offset_secs')

  self.query_offset_secs = attributes[:'query_offset_secs'] if attributes[:'query_offset_secs']
  self.query_offset_secs = 0 if query_offset_secs.nil? && !attributes.key?(:'queryOffsetSecs') && !attributes.key?(:'query_offset_secs') # rubocop:disable Style/StringLiterals

  self.time_end = attributes[:'timeEnd'] if attributes[:'timeEnd']

  raise 'You cannot provide both :timeEnd and :time_end' if attributes.key?(:'timeEnd') && attributes.key?(:'time_end')

  self.time_end = attributes[:'time_end'] if attributes[:'time_end']
end

Instance Attribute Details

#misfire_policy ⇒ String

Schedule misfire retry policy.

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/log_analytics/models/schedule.rb', line 33

def misfire_policy
  @misfire_policy
end

#query_offset_secs ⇒ Integer

Number of seconds to offset the query time window by to accommodate capture late arriving data. For example, a schedule run at 12:00 with a 10 minute interval and queryOffsetSecs=120 will use the query time window of 11:48-11:58 rather than 11:50-12:00 without queryOffsetSecs.

Returns:

  • (Integer) 


43
44
45
 
# File 'lib/oci/log_analytics/models/schedule.rb', line 43

def query_offset_secs
  @query_offset_secs
end

#time_end ⇒ DateTime

End time for the schedule, even if the schedule would otherwise have remaining executions.

Returns:

  • (DateTime) 


48
49
50
 
# File 'lib/oci/log_analytics/models/schedule.rb', line 48

def time_end
  @time_end
end

#time_of_first_execution ⇒ DateTime

The date and time the scheduled task should execute first time after create or update; thereafter the task will execute as specified in the schedule.

Returns:

  • (DateTime) 


39
40
41
 
# File 'lib/oci/log_analytics/models/schedule.rb', line 39

def time_of_first_execution
  @time_of_first_execution
end

#type ⇒ String

[Required] Schedule type discriminator.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/log_analytics/models/schedule.rb', line 29

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/oci/log_analytics/models/schedule.rb', line 51

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'type',
    'misfire_policy': :'misfirePolicy',
    'time_of_first_execution': :'timeOfFirstExecution',
    'query_offset_secs': :'queryOffsetSecs',
    'time_end': :'timeEnd'
    # rubocop:enable Style/SymbolLiteral
  }
end

.get_subtype(object_hash) ⇒ Object

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.



81
82
83
84
85
86
87
88
89
90
 
# File 'lib/oci/log_analytics/models/schedule.rb', line 81

def self.get_subtype(object_hash)
  type = object_hash[:'type'] # rubocop:disable Style/SymbolLiteral

  return 'OCI::LogAnalytics::Models::CronSchedule' if type == 'CRON'
  return 'OCI::LogAnalytics::Models::AutoSchedule' if type == 'AUTO'
  return 'OCI::LogAnalytics::Models::FixedFrequencySchedule' if type == 'FIXED_FREQUENCY'

  # TODO: Log a warning when the subtype is not found.
  'OCI::LogAnalytics::Models::Schedule'
end

.swagger_types ⇒ Object

Attribute type mapping.



64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/oci/log_analytics/models/schedule.rb', line 64

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'String',
    'misfire_policy': :'String',
    'time_of_first_execution': :'DateTime',
    'query_offset_secs': :'Integer',
    'time_end': :'DateTime'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



175
176
177
178
179
180
181
182
183
184
 
# File 'lib/oci/log_analytics/models/schedule.rb', line 175

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    type == other.type &&
    misfire_policy == other.misfire_policy &&
    time_of_first_execution == other.time_of_first_execution &&
    query_offset_secs == other.query_offset_secs &&
    time_end == other.time_end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/oci/log_analytics/models/schedule.rb', line 209

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


189
190
191
 
# File 'lib/oci/log_analytics/models/schedule.rb', line 189

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



198
199
200
 
# File 'lib/oci/log_analytics/models/schedule.rb', line 198

def hash
  [type, misfire_policy, time_of_first_execution, query_offset_secs, time_end].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



242
243
244
245
246
247
248
249
250
251
 
# File 'lib/oci/log_analytics/models/schedule.rb', line 242

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



236
237
238
 
# File 'lib/oci/log_analytics/models/schedule.rb', line 236

def to_s
  to_hash.to_s
end