Class: OCI::DataScience::Models::ScheduleTrigger

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/data_science/models/schedule_trigger.rb

Overview

The trigger of the schedule can be UNIX cron or iCal expression or simple interval 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

TRIGGER_TYPE_ENUM = 
[
  TRIGGER_TYPE_CRON = 'CRON'.freeze,
  TRIGGER_TYPE_INTERVAL = 'INTERVAL'.freeze,
  TRIGGER_TYPE_ICAL = 'ICAL'.freeze,
  TRIGGER_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ScheduleTrigger

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :trigger_type (String) —

    The value to assign to the #trigger_type property

  • :time_start (DateTime) —

    The value to assign to the #time_start property

  • :time_end (DateTime) —

    The value to assign to the #time_end property



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

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.trigger_type = attributes[:'triggerType'] if attributes[:'triggerType']

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

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

  self.time_start = attributes[:'timeStart'] if attributes[:'timeStart']

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

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

  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

#time_end ⇒ DateTime

The schedule end date time, if null, the schedule will never expire. Format is defined by RFC3339.

Returns:

  • (DateTime) 


34
35
36
 
# File 'lib/oci/data_science/models/schedule_trigger.rb', line 34

def time_end
  @time_end
end

#time_start ⇒ DateTime

The schedule starting date time, if null, System set the time when schedule is created. Format is defined by RFC3339.

Returns:

  • (DateTime) 


28
29
30
 
# File 'lib/oci/data_science/models/schedule_trigger.rb', line 28

def time_start
  @time_start
end

#trigger_type ⇒ String

[Required] The schedule trigger type

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/data_science/models/schedule_trigger.rb', line 22

def trigger_type
  @trigger_type
end

Class Method Details

.attribute_map ⇒ Object

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



37
38
39
40
41
42
43
44
45
 
# File 'lib/oci/data_science/models/schedule_trigger.rb', line 37

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'trigger_type': :'triggerType',
    'time_start': :'timeStart',
    '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.



63
64
65
66
67
68
69
70
71
72
 
# File 'lib/oci/data_science/models/schedule_trigger.rb', line 63

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

  return 'OCI::DataScience::Models::ScheduleICalTrigger' if type == 'ICAL'
  return 'OCI::DataScience::Models::ScheduleIntervalTrigger' if type == 'INTERVAL'
  return 'OCI::DataScience::Models::ScheduleCronTrigger' if type == 'CRON'

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

.swagger_types ⇒ Object

Attribute type mapping.



48
49
50
51
52
53
54
55
56
 
# File 'lib/oci/data_science/models/schedule_trigger.rb', line 48

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'trigger_type': :'String',
    'time_start': :'DateTime',
    '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



129
130
131
132
133
134
135
136
 
# File 'lib/oci/data_science/models/schedule_trigger.rb', line 129

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

  self.class == other.class &&
    trigger_type == other.trigger_type &&
    time_start == other.time_start &&
    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



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/oci/data_science/models/schedule_trigger.rb', line 161

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


141
142
143
 
# File 'lib/oci/data_science/models/schedule_trigger.rb', line 141

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



150
151
152
 
# File 'lib/oci/data_science/models/schedule_trigger.rb', line 150

def hash
  [trigger_type, time_start, 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



194
195
196
197
198
199
200
201
202
203
 
# File 'lib/oci/data_science/models/schedule_trigger.rb', line 194

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



188
189
190
 
# File 'lib/oci/data_science/models/schedule_trigger.rb', line 188

def to_s
  to_hash.to_s
end