Class: OCI::UsageApi::Models::ScheduledRun

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/usage_api/models/scheduled_run.rb

Overview

The saved schedule run.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_SUCCEEDED = 'SUCCEEDED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ScheduledRun

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String) —

    The value to assign to the #id property

  • :schedule_id (String) —

    The value to assign to the #schedule_id property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :time_finished (DateTime) —

    The value to assign to the #time_finished property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :lifecycle_details (String) —

    The value to assign to the #lifecycle_details property



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/oci/usage_api/models/scheduled_run.rb', line 82

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

  self.schedule_id = attributes[:'scheduleId'] if attributes[:'scheduleId']

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

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

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

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

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

  self.time_finished = attributes[:'timeFinished'] if attributes[:'timeFinished']

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

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

  self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']

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

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

  self.lifecycle_details = attributes[:'lifecycleDetails'] if attributes[:'lifecycleDetails']

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

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

Instance Attribute Details

#id ⇒ String

[Required] The ocid representing unique shedule run

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/usage_api/models/scheduled_run.rb', line 20

def id
  @id
end

#lifecycle_details ⇒ String

[Required] Additional details about scheduled run failure

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/usage_api/models/scheduled_run.rb', line 40

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] Specifies if the schedule job was run successfully or not.

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/usage_api/models/scheduled_run.rb', line 36

def lifecycle_state
  @lifecycle_state
end

#schedule_id ⇒ String

[Required] The ocid representing unique shedule

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/usage_api/models/scheduled_run.rb', line 24

def schedule_id
  @schedule_id
end

#time_created ⇒ DateTime

[Required] The time when schedule started executing

Returns:

  • (DateTime) 


28
29
30
 
# File 'lib/oci/usage_api/models/scheduled_run.rb', line 28

def time_created
  @time_created
end

#time_finished ⇒ DateTime

[Required] The time when schedule finished executing

Returns:

  • (DateTime) 


32
33
34
 
# File 'lib/oci/usage_api/models/scheduled_run.rb', line 32

def time_finished
  @time_finished
end

Class Method Details

.attribute_map ⇒ Object

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



43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/oci/usage_api/models/scheduled_run.rb', line 43

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'schedule_id': :'scheduleId',
    'time_created': :'timeCreated',
    'time_finished': :'timeFinished',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/oci/usage_api/models/scheduled_run.rb', line 57

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'schedule_id': :'String',
    'time_created': :'DateTime',
    'time_finished': :'DateTime',
    'lifecycle_state': :'String',
    'lifecycle_details': :'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



141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/oci/usage_api/models/scheduled_run.rb', line 141

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

  self.class == other.class &&
    id == other.id &&
    schedule_id == other.schedule_id &&
    time_created == other.time_created &&
    time_finished == other.time_finished &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details
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



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

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


156
157
158
 
# File 'lib/oci/usage_api/models/scheduled_run.rb', line 156

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



165
166
167
 
# File 'lib/oci/usage_api/models/scheduled_run.rb', line 165

def hash
  [id, schedule_id, time_created, time_finished, lifecycle_state, lifecycle_details].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



209
210
211
212
213
214
215
216
217
218
 
# File 'lib/oci/usage_api/models/scheduled_run.rb', line 209

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



203
204
205
 
# File 'lib/oci/usage_api/models/scheduled_run.rb', line 203

def to_s
  to_hash.to_s
end