Class: OCI::OsManagementHub::Models::WorkRequestSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/os_management_hub/models/work_request_summary.rb

Overview

The summary of a work request.

Constant Summary collapse

OPERATION_TYPE_ENUM = 
[
  OPERATION_TYPE_INSTALL_PACKAGES = 'INSTALL_PACKAGES'.freeze,
  OPERATION_TYPE_REMOVE_PACKAGES = 'REMOVE_PACKAGES'.freeze,
  OPERATION_TYPE_UPDATE_PACKAGES = 'UPDATE_PACKAGES'.freeze,
  OPERATION_TYPE_UPDATE_ALL_PACKAGES = 'UPDATE_ALL_PACKAGES'.freeze,
  OPERATION_TYPE_UPDATE_SECURITY = 'UPDATE_SECURITY'.freeze,
  OPERATION_TYPE_UPDATE_BUGFIX = 'UPDATE_BUGFIX'.freeze,
  OPERATION_TYPE_UPDATE_ENHANCEMENT = 'UPDATE_ENHANCEMENT'.freeze,
  OPERATION_TYPE_UPDATE_OTHER = 'UPDATE_OTHER'.freeze,
  OPERATION_TYPE_UPDATE_KSPLICE_KERNEL = 'UPDATE_KSPLICE_KERNEL'.freeze,
  OPERATION_TYPE_UPDATE_KSPLICE_USERSPACE = 'UPDATE_KSPLICE_USERSPACE'.freeze,
  OPERATION_TYPE_ENABLE_MODULE_STREAMS = 'ENABLE_MODULE_STREAMS'.freeze,
  OPERATION_TYPE_DISABLE_MODULE_STREAMS = 'DISABLE_MODULE_STREAMS'.freeze,
  OPERATION_TYPE_SWITCH_MODULE_STREAM = 'SWITCH_MODULE_STREAM'.freeze,
  OPERATION_TYPE_INSTALL_MODULE_PROFILES = 'INSTALL_MODULE_PROFILES'.freeze,
  OPERATION_TYPE_REMOVE_MODULE_PROFILES = 'REMOVE_MODULE_PROFILES'.freeze,
  OPERATION_TYPE_SET_SOFTWARE_SOURCES = 'SET_SOFTWARE_SOURCES'.freeze,
  OPERATION_TYPE_LIST_PACKAGES = 'LIST_PACKAGES'.freeze,
  OPERATION_TYPE_SET_MANAGEMENT_STATION_CONFIG = 'SET_MANAGEMENT_STATION_CONFIG'.freeze,
  OPERATION_TYPE_SYNC_MANAGEMENT_STATION_MIRROR = 'SYNC_MANAGEMENT_STATION_MIRROR'.freeze,
  OPERATION_TYPE_UPDATE_MANAGEMENT_STATION_SOFTWARE = 'UPDATE_MANAGEMENT_STATION_SOFTWARE'.freeze,
  OPERATION_TYPE_UPDATE = 'UPDATE'.freeze,
  OPERATION_TYPE_MODULE_ACTIONS = 'MODULE_ACTIONS'.freeze,
  OPERATION_TYPE_LIFECYCLE_PROMOTION = 'LIFECYCLE_PROMOTION'.freeze,
  OPERATION_TYPE_CREATE_SOFTWARE_SOURCE = 'CREATE_SOFTWARE_SOURCE'.freeze,
  OPERATION_TYPE_UPDATE_SOFTWARE_SOURCE = 'UPDATE_SOFTWARE_SOURCE'.freeze,
  OPERATION_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
STATUS_ENUM = 
[
  STATUS_ACCEPTED = 'ACCEPTED'.freeze,
  STATUS_IN_PROGRESS = 'IN_PROGRESS'.freeze,
  STATUS_FAILED = 'FAILED'.freeze,
  STATUS_SUCCEEDED = 'SUCCEEDED'.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 = {}) ⇒ WorkRequestSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :operation_type (String) —

    The value to assign to the #operation_type property

  • :status (String) —

    The value to assign to the #status property

  • :id (String) —

    The value to assign to the #id property

  • :description (String) —

    The value to assign to the #description property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :message (String) —

    The value to assign to the #message property

  • :parent_id (String) —

    The value to assign to the #parent_id property

  • :children_id (Array<String>) —

    The value to assign to the #children_id property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :percent_complete (Float) —

    The value to assign to the #percent_complete property

  • :time_created (DateTime) —

    The value to assign to the #time_created property



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/oci/os_management_hub/models/work_request_summary.rb', line 156

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

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

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

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

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

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

  self.display_name = attributes[:'displayName'] if attributes[:'displayName']

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

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

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

  self.parent_id = attributes[:'parentId'] if attributes[:'parentId']

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

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

  self.children_id = attributes[:'childrenId'] if attributes[:'childrenId']

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

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

  self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

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

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

  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_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']
end

Instance Attribute Details

#children_id ⇒ Array<String>

The list of OCIDs for the child work requests.

Returns:

  • (Array<String>) 


81
82
83
 
# File 'lib/oci/os_management_hub/models/work_request_summary.rb', line 81

def children_id
  @children_id
end

#compartment_id ⇒ String

[Required] The OCID of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request affects multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used.

Returns:

  • (String) 


89
90
91
 
# File 'lib/oci/os_management_hub/models/work_request_summary.rb', line 89

def compartment_id
  @compartment_id
end

#description ⇒ String

A short description about the work request.

Returns:

  • (String) 


65
66
67
 
# File 'lib/oci/os_management_hub/models/work_request_summary.rb', line 65

def description
  @description
end

#display_name ⇒ String

A short display name for the work request.

Returns:

  • (String) 


69
70
71
 
# File 'lib/oci/os_management_hub/models/work_request_summary.rb', line 69

def display_name
  @display_name
end

#id ⇒ String

[Required] The OCID of the work request.

Returns:

  • (String) 


61
62
63
 
# File 'lib/oci/os_management_hub/models/work_request_summary.rb', line 61

def id
  @id
end

#message ⇒ String

A progress or error message, if there is any.

Returns:

  • (String) 


73
74
75
 
# File 'lib/oci/os_management_hub/models/work_request_summary.rb', line 73

def message
  @message
end

#operation_type ⇒ String

[Required] Type of the work request.

Returns:

  • (String) 


53
54
55
 
# File 'lib/oci/os_management_hub/models/work_request_summary.rb', line 53

def operation_type
  @operation_type
end

#parent_id ⇒ String

The OCID of the parent work request.

Returns:

  • (String) 


77
78
79
 
# File 'lib/oci/os_management_hub/models/work_request_summary.rb', line 77

def parent_id
  @parent_id
end

#percent_complete ⇒ Float

The percentage complete of the operation tracked by this work request.

Returns:

  • (Float) 


93
94
95
 
# File 'lib/oci/os_management_hub/models/work_request_summary.rb', line 93

def percent_complete
  @percent_complete
end

#status ⇒ String

[Required] Status of the work request.

Returns:

  • (String) 


57
58
59
 
# File 'lib/oci/os_management_hub/models/work_request_summary.rb', line 57

def status
  @status
end

#time_created ⇒ DateTime

[Required] The date and time the request was created - as described in RFC 3339, section 14.29.

Returns:

  • (DateTime) 


99
100
101
 
# File 'lib/oci/os_management_hub/models/work_request_summary.rb', line 99

def time_created
  @time_created
end

Class Method Details

.attribute_map ⇒ Object

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



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/oci/os_management_hub/models/work_request_summary.rb', line 102

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'operation_type': :'operationType',
    'status': :'status',
    'id': :'id',
    'description': :'description',
    'display_name': :'displayName',
    'message': :'message',
    'parent_id': :'parentId',
    'children_id': :'childrenId',
    'compartment_id': :'compartmentId',
    'percent_complete': :'percentComplete',
    'time_created': :'timeCreated'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/oci/os_management_hub/models/work_request_summary.rb', line 121

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'operation_type': :'String',
    'status': :'String',
    'id': :'String',
    'description': :'String',
    'display_name': :'String',
    'message': :'String',
    'parent_id': :'String',
    'children_id': :'Array<String>',
    'compartment_id': :'String',
    'percent_complete': :'Float',
    'time_created': :'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



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/oci/os_management_hub/models/work_request_summary.rb', line 246

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

  self.class == other.class &&
    operation_type == other.operation_type &&
    status == other.status &&
    id == other.id &&
    description == other.description &&
    display_name == other.display_name &&
    message == other.message &&
    parent_id == other.parent_id &&
    children_id == other.children_id &&
    compartment_id == other.compartment_id &&
    percent_complete == other.percent_complete &&
    time_created == other.time_created
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



286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/oci/os_management_hub/models/work_request_summary.rb', line 286

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


266
267
268
 
# File 'lib/oci/os_management_hub/models/work_request_summary.rb', line 266

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



275
276
277
 
# File 'lib/oci/os_management_hub/models/work_request_summary.rb', line 275

def hash
  [operation_type, status, id, description, display_name, message, parent_id, children_id, compartment_id, percent_complete, time_created].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



319
320
321
322
323
324
325
326
327
328
 
# File 'lib/oci/os_management_hub/models/work_request_summary.rb', line 319

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



313
314
315
 
# File 'lib/oci/os_management_hub/models/work_request_summary.rb', line 313

def to_s
  to_hash.to_s
end