Class: OCI::OsManagement::Models::WorkRequestSummary

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

Overview

A work request summary

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

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

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :description (String) —

    The value to assign to the #description property

  • :message (String) —

    The value to assign to the #message 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

  • :os_family (String) —

    The value to assign to the #os_family property



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/oci/os_management/models/work_request_summary.rb', line 134

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

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

Instance Attribute Details

#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) 


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

def compartment_id
  @compartment_id
end

#description ⇒ String

Description of the type of work.

Returns:

  • (String) 


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

def description
  @description
end

#id ⇒ String

[Required] The id of the work request.

Returns:

  • (String) 


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

def id
  @id
end

#message ⇒ String

A progress or error message, if there is any.

Returns:

  • (String) 


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

def message
  @message
end

#operation_type ⇒ String

[Required] the type of operation this Work Request performs

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/os_management/models/work_request_summary.rb', line 45

def operation_type
  @operation_type
end

#os_family ⇒ String

The Operating System type of the managed instance.

Returns:

  • (String) 


83
84
85
 
# File 'lib/oci/os_management/models/work_request_summary.rb', line 83

def os_family
  @os_family
end

#percent_complete ⇒ Float

Percentage of the request completed.

Returns:

  • (Float) 


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

def percent_complete
  @percent_complete
end

#status ⇒ String

[Required] status of current work request.

Returns:

  • (String) 


49
50
51
 
# File 'lib/oci/os_management/models/work_request_summary.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.

Returns:

  • (DateTime) 


79
80
81
 
# File 'lib/oci/os_management/models/work_request_summary.rb', line 79

def time_accepted
  @time_accepted
end

Class Method Details

.attribute_map ⇒ Object

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



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/oci/os_management/models/work_request_summary.rb', line 86

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'operation_type': :'operationType',
    'status': :'status',
    'id': :'id',
    'compartment_id': :'compartmentId',
    'description': :'description',
    'message': :'message',
    'percent_complete': :'percentComplete',
    'time_accepted': :'timeAccepted',
    'os_family': :'osFamily'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'operation_type': :'String',
    'status': :'String',
    'id': :'String',
    'compartment_id': :'String',
    'description': :'String',
    'message': :'String',
    'percent_complete': :'Float',
    'time_accepted': :'DateTime',
    'os_family': :'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



225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/oci/os_management/models/work_request_summary.rb', line 225

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 &&
    message == other.message &&
    percent_complete == other.percent_complete &&
    time_accepted == other.time_accepted &&
    os_family == other.os_family
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



263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/oci/os_management/models/work_request_summary.rb', line 263

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


243
244
245
 
# File 'lib/oci/os_management/models/work_request_summary.rb', line 243

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



252
253
254
 
# File 'lib/oci/os_management/models/work_request_summary.rb', line 252

def hash
  [operation_type, status, id, compartment_id, description, message, percent_complete, time_accepted, os_family].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



296
297
298
299
300
301
302
303
304
305
 
# File 'lib/oci/os_management/models/work_request_summary.rb', line 296

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



290
291
292
 
# File 'lib/oci/os_management/models/work_request_summary.rb', line 290

def to_s
  to_hash.to_s
end