Class: OCI::Rover::Models::RoverBundleStatus

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/rover/models/rover_bundle_status.rb

Overview

The status of the rover bundle status by a specified work request id.

Constant Summary collapse

STATUS_ENUM =
[
  STATUS_ACCEPTED = 'ACCEPTED'.freeze,
  STATUS_IN_PROGRESS = 'IN_PROGRESS'.freeze,
  STATUS_FAILED = 'FAILED'.freeze,
  STATUS_COMPLETED = 'COMPLETED'.freeze,
  STATUS_CANCELING = 'CANCELING'.freeze,
  STATUS_CANCELED = 'CANCELED'.freeze,
  STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RoverBundleStatus

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :status (String)

    The value to assign to the #status property

  • :percent_complete (Float)

    The value to assign to the #percent_complete property

  • :time_accepted (DateTime)

    The value to assign to the #time_accepted property

  • :time_started (DateTime)

    The value to assign to the #time_started property

  • :time_finished (DateTime)

    The value to assign to the #time_finished property

  • :bundle_name (String)

    The value to assign to the #bundle_name property

  • :error_message (String)

    The value to assign to the #error_message property



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
# File 'lib/oci/rover/models/rover_bundle_status.rb', line 96

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

  self.percent_complete = attributes[:'percentComplete'] if attributes[:'percentComplete']

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

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

  self.time_accepted = attributes[:'timeAccepted'] if attributes[:'timeAccepted']

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

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

  self.time_started = attributes[:'timeStarted'] if attributes[:'timeStarted']

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

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

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

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

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

  self.error_message = attributes[:'errorMessage'] if attributes[:'errorMessage']

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

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

Instance Attribute Details

#bundle_nameString

The full name of the bundle.

Returns:

  • (String)


47
48
49
# File 'lib/oci/rover/models/rover_bundle_status.rb', line 47

def bundle_name
  @bundle_name
end

#error_messageString

The error message if work request fails.

Returns:

  • (String)


51
52
53
# File 'lib/oci/rover/models/rover_bundle_status.rb', line 51

def error_message
  @error_message
end

#percent_completeFloat

Percentage of the work request completed.

Returns:

  • (Float)


28
29
30
# File 'lib/oci/rover/models/rover_bundle_status.rb', line 28

def percent_complete
  @percent_complete
end

#statusString

[Required] The progress of the workflow.

Returns:

  • (String)


24
25
26
# File 'lib/oci/rover/models/rover_bundle_status.rb', line 24

def status
  @status
end

#time_acceptedDateTime

The date and time the work request was created. An RFC3339 formatted datetime string.

Returns:

  • (DateTime)


33
34
35
# File 'lib/oci/rover/models/rover_bundle_status.rb', line 33

def time_accepted
  @time_accepted
end

#time_finishedDateTime

The date and time the work request was finished. An RFC3339 formatted datetime string.

Returns:

  • (DateTime)


43
44
45
# File 'lib/oci/rover/models/rover_bundle_status.rb', line 43

def time_finished
  @time_finished
end

#time_startedDateTime

The date and time the work request was started. An RFC3339 formatted datetime string.

Returns:

  • (DateTime)


38
39
40
# File 'lib/oci/rover/models/rover_bundle_status.rb', line 38

def time_started
  @time_started
end

Class Method Details

.attribute_mapObject

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



54
55
56
57
58
59
60
61
62
63
64
65
66
# File 'lib/oci/rover/models/rover_bundle_status.rb', line 54

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'status': :'status',
    'percent_complete': :'percentComplete',
    'time_accepted': :'timeAccepted',
    'time_started': :'timeStarted',
    'time_finished': :'timeFinished',
    'bundle_name': :'bundleName',
    'error_message': :'errorMessage'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



69
70
71
72
73
74
75
76
77
78
79
80
81
# File 'lib/oci/rover/models/rover_bundle_status.rb', line 69

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'status': :'String',
    'percent_complete': :'Float',
    'time_accepted': :'DateTime',
    'time_started': :'DateTime',
    'time_finished': :'DateTime',
    'bundle_name': :'String',
    'error_message': :'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



161
162
163
164
165
166
167
168
169
170
171
172
# File 'lib/oci/rover/models/rover_bundle_status.rb', line 161

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

  self.class == other.class &&
    status == other.status &&
    percent_complete == other.percent_complete &&
    time_accepted == other.time_accepted &&
    time_started == other.time_started &&
    time_finished == other.time_finished &&
    bundle_name == other.bundle_name &&
    error_message == other.error_message
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



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
# File 'lib/oci/rover/models/rover_bundle_status.rb', line 197

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


177
178
179
# File 'lib/oci/rover/models/rover_bundle_status.rb', line 177

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



186
187
188
# File 'lib/oci/rover/models/rover_bundle_status.rb', line 186

def hash
  [status, percent_complete, time_accepted, time_started, time_finished, bundle_name, error_message].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



230
231
232
233
234
235
236
237
238
239
# File 'lib/oci/rover/models/rover_bundle_status.rb', line 230

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



224
225
226
# File 'lib/oci/rover/models/rover_bundle_status.rb', line 224

def to_s
  to_hash.to_s
end