Class: OCI::OsManagement::Models::WorkRequest
- Inherits:
-
Object
- Object
- OCI::OsManagement::Models::WorkRequest
- Defined in:
- lib/oci/os_management/models/work_request.rb
Overview
A description of workrequest status
Constant Summary collapse
- OPERATION_TYPE_ENUM =
[ OPERATION_TYPE_INSTALL = 'INSTALL'.freeze, OPERATION_TYPE_UPDATE = 'UPDATE'.freeze, OPERATION_TYPE_REMOVE = 'REMOVE'.freeze, OPERATION_TYPE_UPDATEALL = 'UPDATEALL'.freeze, OPERATION_TYPE_ENABLEMODULESTREAM = 'ENABLEMODULESTREAM'.freeze, OPERATION_TYPE_DISABLEMODULESTREAM = 'DISABLEMODULESTREAM'.freeze, OPERATION_TYPE_SWITCHMODULESTREAM = 'SWITCHMODULESTREAM'.freeze, OPERATION_TYPE_INSTALLMODULESTREAMPROFILE = 'INSTALLMODULESTREAMPROFILE'.freeze, OPERATION_TYPE_REMOVEMODULESTREAMPROFILE = 'REMOVEMODULESTREAMPROFILE'.freeze, OPERATION_TYPE_COMPOUND = 'COMPOUND'.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_CANCELLING = 'CANCELLING'.freeze, STATUS_CANCELED = 'CANCELED'.freeze, STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
- OS_FAMILY_ENUM =
[ OS_FAMILY_LINUX = 'LINUX'.freeze, OS_FAMILY_WINDOWS = 'WINDOWS'.freeze, OS_FAMILY_ALL = 'ALL'.freeze, OS_FAMILY_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
Instance Attribute Summary collapse
-
#children_ids ⇒ Array<String>
A list of the IDs of any children of this work request.
-
#compartment_id ⇒ String
[Required] The ocid of the compartment that contains the work request.
-
#description ⇒ String
Description of the type of work.
-
#id ⇒ String
[Required] The id of the work request.
- #managed_instance_id ⇒ OCI::OsManagement::Models::Id
-
#message ⇒ String
A progress or error message, if there is any.
-
#operation_type ⇒ String
[Required] the type of operation this Work Request performs.
-
#os_family ⇒ String
The Operating System type of the managed instance.
-
#parent_id ⇒ String
The parent of this work request, if one exists.
-
#percent_complete ⇒ Float
[Required] Percentage of the request completed.
-
#resources ⇒ Array<OCI::OsManagement::Models::WorkRequestResource>
[Required] The resources affected by this work request.
-
#status ⇒ String
[Required] status of current work request.
-
#time_accepted ⇒ DateTime
[Required] The date and time the request was created, as described in RFC 3339, section 14.29.
-
#time_finished ⇒ DateTime
The date and time the object was finished, as described in RFC 3339.
-
#time_started ⇒ DateTime
The date and time the request was started, as described in RFC 3339, section 14.29.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ WorkRequest
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ WorkRequest
Initializes the object
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 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 |
# File 'lib/oci/os_management/models/work_request.rb', line 178 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.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.description = attributes[:'description'] if attributes[:'description'] self. = attributes[:'message'] if attributes[:'message'] self.managed_instance_id = attributes[:'managedInstanceId'] if attributes[:'managedInstanceId'] raise 'You cannot provide both :managedInstanceId and :managed_instance_id' if attributes.key?(:'managedInstanceId') && attributes.key?(:'managed_instance_id') self.managed_instance_id = attributes[:'managed_instance_id'] if attributes[:'managed_instance_id'] self.resources = attributes[:'resources'] if attributes[:'resources'] 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.os_family = attributes[:'osFamily'] if attributes[:'osFamily'] raise 'You cannot provide both :osFamily and :os_family' if attributes.key?(:'osFamily') && attributes.key?(:'os_family') self.os_family = attributes[:'os_family'] if attributes[:'os_family'] 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_ids = attributes[:'childrenIds'] if attributes[:'childrenIds'] raise 'You cannot provide both :childrenIds and :children_ids' if attributes.key?(:'childrenIds') && attributes.key?(:'children_ids') self.children_ids = attributes[:'children_ids'] if attributes[:'children_ids'] end |
Instance Attribute Details
#children_ids ⇒ Array<String>
A list of the IDs of any children of this work request
109 110 111 |
# File 'lib/oci/os_management/models/work_request.rb', line 109 def children_ids @children_ids 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
61 62 63 |
# File 'lib/oci/os_management/models/work_request.rb', line 61 def compartment_id @compartment_id end |
#description ⇒ String
Description of the type of work.
65 66 67 |
# File 'lib/oci/os_management/models/work_request.rb', line 65 def description @description end |
#id ⇒ String
[Required] The id of the work request.
53 54 55 |
# File 'lib/oci/os_management/models/work_request.rb', line 53 def id @id end |
#managed_instance_id ⇒ OCI::OsManagement::Models::Id
72 73 74 |
# File 'lib/oci/os_management/models/work_request.rb', line 72 def managed_instance_id @managed_instance_id end |
#message ⇒ String
A progress or error message, if there is any.
69 70 71 |
# File 'lib/oci/os_management/models/work_request.rb', line 69 def @message end |
#operation_type ⇒ String
[Required] the type of operation this Work Request performs
45 46 47 |
# File 'lib/oci/os_management/models/work_request.rb', line 45 def operation_type @operation_type end |
#os_family ⇒ String
The Operating System type of the managed instance.
101 102 103 |
# File 'lib/oci/os_management/models/work_request.rb', line 101 def os_family @os_family end |
#parent_id ⇒ String
The parent of this work request, if one exists.
105 106 107 |
# File 'lib/oci/os_management/models/work_request.rb', line 105 def parent_id @parent_id end |
#percent_complete ⇒ Float
[Required] Percentage of the request completed.
80 81 82 |
# File 'lib/oci/os_management/models/work_request.rb', line 80 def percent_complete @percent_complete end |
#resources ⇒ Array<OCI::OsManagement::Models::WorkRequestResource>
[Required] The resources affected by this work request.
76 77 78 |
# File 'lib/oci/os_management/models/work_request.rb', line 76 def resources @resources end |
#status ⇒ String
[Required] status of current work request.
49 50 51 |
# File 'lib/oci/os_management/models/work_request.rb', line 49 def status @status end |
#time_accepted ⇒ DateTime
[Required] The date and time the request was created, as described in RFC 3339, section 14.29.
86 87 88 |
# File 'lib/oci/os_management/models/work_request.rb', line 86 def time_accepted @time_accepted end |
#time_finished ⇒ DateTime
The date and time the object was finished, as described in RFC 3339.
97 98 99 |
# File 'lib/oci/os_management/models/work_request.rb', line 97 def time_finished @time_finished end |
#time_started ⇒ DateTime
The date and time the request was started, as described in RFC 3339, section 14.29.
92 93 94 |
# File 'lib/oci/os_management/models/work_request.rb', line 92 def time_started @time_started end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 |
# File 'lib/oci/os_management/models/work_request.rb', line 112 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'operation_type': :'operationType', 'status': :'status', 'id': :'id', 'compartment_id': :'compartmentId', 'description': :'description', 'message': :'message', 'managed_instance_id': :'managedInstanceId', 'resources': :'resources', 'percent_complete': :'percentComplete', 'time_accepted': :'timeAccepted', 'time_started': :'timeStarted', 'time_finished': :'timeFinished', 'os_family': :'osFamily', 'parent_id': :'parentId', 'children_ids': :'childrenIds' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 |
# File 'lib/oci/os_management/models/work_request.rb', line 135 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'operation_type': :'String', 'status': :'String', 'id': :'String', 'compartment_id': :'String', 'description': :'String', 'message': :'String', 'managed_instance_id': :'OCI::OsManagement::Models::Id', 'resources': :'Array<OCI::OsManagement::Models::WorkRequestResource>', 'percent_complete': :'Float', 'time_accepted': :'DateTime', 'time_started': :'DateTime', 'time_finished': :'DateTime', 'os_family': :'String', 'parent_id': :'String', 'children_ids': :'Array<String>' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 |
# File 'lib/oci/os_management/models/work_request.rb', line 301 def ==(other) return true if equal?(other) self.class == other.class && operation_type == other.operation_type && status == other.status && id == other.id && compartment_id == other.compartment_id && description == other.description && == other. && managed_instance_id == other.managed_instance_id && resources == other.resources && percent_complete == other.percent_complete && time_accepted == other.time_accepted && time_started == other.time_started && time_finished == other.time_finished && os_family == other.os_family && parent_id == other.parent_id && children_ids == other.children_ids end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 |
# File 'lib/oci/os_management/models/work_request.rb', line 345 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
325 326 327 |
# File 'lib/oci/os_management/models/work_request.rb', line 325 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
334 335 336 |
# File 'lib/oci/os_management/models/work_request.rb', line 334 def hash [operation_type, status, id, compartment_id, description, , managed_instance_id, resources, percent_complete, time_accepted, time_started, time_finished, os_family, parent_id, children_ids].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
378 379 380 381 382 383 384 385 386 387 |
# File 'lib/oci/os_management/models/work_request.rb', line 378 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
372 373 374 |
# File 'lib/oci/os_management/models/work_request.rb', line 372 def to_s to_hash.to_s end |