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

Direct Known Subclasses

CronSchedule, FixedFrequencySchedule

Constant Summary collapse

TYPE_ENUM = 
[
  TYPE_FIXED_FREQUENCY = 'FIXED_FREQUENCY'.freeze,
  TYPE_CRON = 'CRON'.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



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/oci/log_analytics/models/schedule.rb', line 87

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.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']
end

Instance Attribute Details

#misfire_policy ⇒ String

Schedule misfire retry policy.

Returns:

  • (String) 


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

def misfire_policy
  @misfire_policy
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) 


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

def time_of_first_execution
  @time_of_first_execution
end

#type ⇒ String

[Required] Schedule type discriminator.

Returns:

  • (String) 


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

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



41
42
43
44
45
46
47
48
49
 
# File 'lib/oci/log_analytics/models/schedule.rb', line 41

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'type',
    'misfire_policy': :'misfirePolicy',
    'time_of_first_execution': :'timeOfFirstExecution'
    # 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.



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

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::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.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'String',
    'misfire_policy': :'String',
    'time_of_first_execution': :'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



143
144
145
146
147
148
149
150
 
# File 'lib/oci/log_analytics/models/schedule.rb', line 143

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
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



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/oci/log_analytics/models/schedule.rb', line 175

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


155
156
157
 
# File 'lib/oci/log_analytics/models/schedule.rb', line 155

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



164
165
166
 
# File 'lib/oci/log_analytics/models/schedule.rb', line 164

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

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



208
209
210
211
212
213
214
215
216
217
 
# File 'lib/oci/log_analytics/models/schedule.rb', line 208

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



202
203
204
 
# File 'lib/oci/log_analytics/models/schedule.rb', line 202

def to_s
  to_hash.to_s
end