Class: OCI::LogAnalytics::Models::CronSchedule

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

Overview

Cron schedule for a scheduled task.

Constant Summary

Constants inherited from Schedule

Schedule::MISFIRE_POLICY_ENUM, Schedule::TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from Schedule

#misfire_policy, #time_of_first_execution, #type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Schedule

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ CronSchedule

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :misfire_policy (String) —

    The value to assign to the #misfire_policy proprety

  • :time_of_first_execution (DateTime) —

    The value to assign to the #time_of_first_execution proprety

  • :expression (String) —

    The value to assign to the #expression property

  • :time_zone (String) —

    The value to assign to the #time_zone property



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/oci/log_analytics/models/cron_schedule.rb', line 56

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

  attributes['type'] = 'CRON'

  super(attributes)

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

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

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

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

  self.time_zone = attributes[:'time_zone'] if attributes[:'time_zone']
  self.time_zone = "UTC" if time_zone.nil? && !attributes.key?(:'timeZone') && !attributes.key?(:'time_zone') # rubocop:disable Style/StringLiterals
end

Instance Attribute Details

#expression ⇒ String

[Required] Value in cron format.

Returns:

  • (String) 


14
15
16
 
# File 'lib/oci/log_analytics/models/cron_schedule.rb', line 14

def expression
  @expression
end

#time_zone ⇒ String

[Required] Time zone, by default UTC.

Returns:

  • (String) 


18
19
20
 
# File 'lib/oci/log_analytics/models/cron_schedule.rb', line 18

def time_zone
  @time_zone
end

Class Method Details

.attribute_map ⇒ Object

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



21
22
23
24
25
26
27
28
29
30
31
 
# File 'lib/oci/log_analytics/models/cron_schedule.rb', line 21

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'type',
    'misfire_policy': :'misfirePolicy',
    'time_of_first_execution': :'timeOfFirstExecution',
    'expression': :'expression',
    'time_zone': :'timeZone'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/oci/log_analytics/models/cron_schedule.rb', line 34

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



84
85
86
87
88
89
90
91
92
93
 
# File 'lib/oci/log_analytics/models/cron_schedule.rb', line 84

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 &&
    expression == other.expression &&
    time_zone == other.time_zone
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



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/cron_schedule.rb', line 118

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


98
99
100
 
# File 'lib/oci/log_analytics/models/cron_schedule.rb', line 98

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



107
108
109
 
# File 'lib/oci/log_analytics/models/cron_schedule.rb', line 107

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

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



151
152
153
154
155
156
157
158
159
160
 
# File 'lib/oci/log_analytics/models/cron_schedule.rb', line 151

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



145
146
147
 
# File 'lib/oci/log_analytics/models/cron_schedule.rb', line 145

def to_s
  to_hash.to_s
end