Class: OCI::JmsUtils::Models::WorkItemSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/jms_utils/models/work_item_summary.rb

Overview

Work item to complete a work request.

Constant Summary collapse

STATUS_ENUM = 
[
  STATUS_ACCEPTED = 'ACCEPTED'.freeze,
  STATUS_IN_PROGRESS = 'IN_PROGRESS'.freeze,
  STATUS_CANCELING = 'CANCELING'.freeze,
  STATUS_CANCELED = 'CANCELED'.freeze,
  STATUS_SUCCEEDED = 'SUCCEEDED'.freeze,
  STATUS_NEEDS_ATTENTION = 'NEEDS_ATTENTION'.freeze,
  STATUS_RETRYING = 'RETRYING'.freeze,
  STATUS_SKIPPED = 'SKIPPED'.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 = {}) ⇒ WorkItemSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
 
# File 'lib/oci/jms_utils/models/work_item_summary.rb', line 89

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

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

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

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

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

  self.retry_count = attributes[:'retryCount'] if attributes[:'retryCount']

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

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

  self.time_last_updated = attributes[:'timeLastUpdated'] if attributes[:'timeLastUpdated']

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

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

Instance Attribute Details

#details ⇒ OCI::JmsUtils::Models::WorkItemDetails

This attribute is required.

Returns:



38
39
40
 
# File 'lib/oci/jms_utils/models/work_item_summary.rb', line 38

def details
  @details
end

#id ⇒ String

[Required] The unique ID of ths work item.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/jms_utils/models/work_item_summary.rb', line 26

def id
  @id
end

#retry_count ⇒ Integer

[Required] Number of times this work item is retried.

Returns:

  • (Integer) 


42
43
44
 
# File 'lib/oci/jms_utils/models/work_item_summary.rb', line 42

def retry_count
  @retry_count
end

#status ⇒ String

[Required] The status of the work item.

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/jms_utils/models/work_item_summary.rb', line 34

def status
  @status
end

#time_last_updated ⇒ DateTime

The date and time the work item was last updated. (formatted according to RFC3339).

Returns:

  • (DateTime) 


47
48
49
 
# File 'lib/oci/jms_utils/models/work_item_summary.rb', line 47

def time_last_updated
  @time_last_updated
end

#work_request_id ⇒ String

[Required] The OCID of the work request created this work item.

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/jms_utils/models/work_item_summary.rb', line 30

def work_request_id
  @work_request_id
end

Class Method Details

.attribute_map ⇒ Object

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



50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/oci/jms_utils/models/work_item_summary.rb', line 50

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'work_request_id': :'workRequestId',
    'status': :'status',
    'details': :'details',
    'retry_count': :'retryCount',
    'time_last_updated': :'timeLastUpdated'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/oci/jms_utils/models/work_item_summary.rb', line 64

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'work_request_id': :'String',
    'status': :'String',
    'details': :'OCI::JmsUtils::Models::WorkItemDetails',
    'retry_count': :'Integer',
    'time_last_updated': :'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



140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/oci/jms_utils/models/work_item_summary.rb', line 140

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

  self.class == other.class &&
    id == other.id &&
    work_request_id == other.work_request_id &&
    status == other.status &&
    details == other.details &&
    retry_count == other.retry_count &&
    time_last_updated == other.time_last_updated
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



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

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


155
156
157
 
# File 'lib/oci/jms_utils/models/work_item_summary.rb', line 155

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



164
165
166
 
# File 'lib/oci/jms_utils/models/work_item_summary.rb', line 164

def hash
  [id, work_request_id, status, details, retry_count, time_last_updated].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



208
209
210
211
212
213
214
215
216
217
 
# File 'lib/oci/jms_utils/models/work_item_summary.rb', line 208

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



202
203
204
 
# File 'lib/oci/jms_utils/models/work_item_summary.rb', line 202

def to_s
  to_hash.to_s
end