Class: OCI::LogAnalytics::Models::FixedFrequencySchedule

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

Overview

Fixed frequency 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 = {}) ⇒ FixedFrequencySchedule

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/oci/log_analytics/models/fixed_frequency_schedule.rb', line 63

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

  attributes['type'] = 'FIXED_FREQUENCY'

  super(attributes)

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

  self.recurring_interval = attributes[:'recurringInterval'] if attributes[:'recurringInterval']

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

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

  self.repeat_count = attributes[:'repeatCount'] if attributes[:'repeatCount']
  self.repeat_count = -1 if repeat_count.nil? && !attributes.key?(:'repeatCount') # rubocop:disable Style/StringLiterals

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

  self.repeat_count = attributes[:'repeat_count'] if attributes[:'repeat_count']
  self.repeat_count = -1 if repeat_count.nil? && !attributes.key?(:'repeatCount') && !attributes.key?(:'repeat_count') # rubocop:disable Style/StringLiterals
end

Instance Attribute Details

#recurring_interval ⇒ String

[Required] Recurring interval in ISO 8601 extended format as described in en.wikipedia.org/wiki/ISO_8601#Durations. The largest supported unit is D, e.g. P14D (not P2W). The value must be at least 5 minutes (PT5M) and at most 3 weeks (P21D or PT30240M).

Returns:

  • (String) 


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

def recurring_interval
  @recurring_interval
end

#repeat_count ⇒ Integer

Number of times (0-based) to execute until auto-stop. Default value -1 will execute indefinitely. Value 0 will execute once.

Returns:

  • (Integer) 


25
26
27
 
# File 'lib/oci/log_analytics/models/fixed_frequency_schedule.rb', line 25

def repeat_count
  @repeat_count
end

Class Method Details

.attribute_map ⇒ Object

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



28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/oci/log_analytics/models/fixed_frequency_schedule.rb', line 28

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'type',
    'misfire_policy': :'misfirePolicy',
    'time_of_first_execution': :'timeOfFirstExecution',
    'recurring_interval': :'recurringInterval',
    'repeat_count': :'repeatCount'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

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



95
96
97
98
99
100
101
102
103
104
 
# File 'lib/oci/log_analytics/models/fixed_frequency_schedule.rb', line 95

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 &&
    recurring_interval == other.recurring_interval &&
    repeat_count == other.repeat_count
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



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/oci/log_analytics/models/fixed_frequency_schedule.rb', line 129

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


109
110
111
 
# File 'lib/oci/log_analytics/models/fixed_frequency_schedule.rb', line 109

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



118
119
120
 
# File 'lib/oci/log_analytics/models/fixed_frequency_schedule.rb', line 118

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

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



162
163
164
165
166
167
168
169
170
171
 
# File 'lib/oci/log_analytics/models/fixed_frequency_schedule.rb', line 162

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



156
157
158
 
# File 'lib/oci/log_analytics/models/fixed_frequency_schedule.rb', line 156

def to_s
  to_hash.to_s
end