Class: OCI::FleetAppsManagement::Models::WorkRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/fleet_apps_management/models/work_request.rb

Overview

A description of workrequest status

Constant Summary collapse

OPERATION_TYPE_ENUM = 
[
  OPERATION_TYPE_CREATE_FLEET = 'CREATE_FLEET'.freeze,
  OPERATION_TYPE_UPDATE_FLEET = 'UPDATE_FLEET'.freeze,
  OPERATION_TYPE_DELETE_FLEET = 'DELETE_FLEET'.freeze,
  OPERATION_TYPE_MOVE_FLEET = 'MOVE_FLEET'.freeze,
  OPERATION_TYPE_CONFIRM_TARGET = 'CONFIRM_TARGET'.freeze,
  OPERATION_TYPE_GENERATE_COMPLIANCE = 'GENERATE_COMPLIANCE'.freeze,
  OPERATION_TYPE_REQUEST_TARGET_DISCOVERY = 'REQUEST_TARGET_DISCOVERY'.freeze,
  OPERATION_TYPE_VALIDATE_RESOURCE = 'VALIDATE_RESOURCE'.freeze,
  OPERATION_TYPE_CREATE_CREDENTIAL = 'CREATE_CREDENTIAL'.freeze,
  OPERATION_TYPE_UPDATE_CREDENTIAL = 'UPDATE_CREDENTIAL'.freeze,
  OPERATION_TYPE_DELETE_CREDENTIAL = 'DELETE_CREDENTIAL'.freeze,
  OPERATION_TYPE_CREATE_SCHEDULE = 'CREATE_SCHEDULE'.freeze,
  OPERATION_TYPE_UPDATE_SCHEDULE = 'UPDATE_SCHEDULE'.freeze,
  OPERATION_TYPE_UPDATE_MAINTENANCE_WINDOW = 'UPDATE_MAINTENANCE_WINDOW'.freeze,
  OPERATION_TYPE_DELETE_MAINTENANCE_WINDOW = 'DELETE_MAINTENANCE_WINDOW'.freeze,
  OPERATION_TYPE_CREATE_FLEET_RESOURCE = 'CREATE_FLEET_RESOURCE'.freeze,
  OPERATION_TYPE_UPDATE_FLEET_RESOURCE = 'UPDATE_FLEET_RESOURCE'.freeze,
  OPERATION_TYPE_DELETE_FLEET_RESOURCE = 'DELETE_FLEET_RESOURCE'.freeze,
  OPERATION_TYPE_CREATE_FAMS_ONBOARDING = 'CREATE_FAMS_ONBOARDING'.freeze,
  OPERATION_TYPE_CREATE_RUNBOOK = 'CREATE_RUNBOOK'.freeze,
  OPERATION_TYPE_UPDATE_RUNBOOK = 'UPDATE_RUNBOOK'.freeze,
  OPERATION_TYPE_DELETE_RUNBOOK = 'DELETE_RUNBOOK'.freeze,
  OPERATION_TYPE_PUBLISH_RUNBOOK = 'PUBLISH_RUNBOOK'.freeze,
  OPERATION_TYPE_MOVE_RUNBOOK = 'MOVE_RUNBOOK'.freeze,
  OPERATION_TYPE_CREATE_RUNBOOK_VERSION = 'CREATE_RUNBOOK_VERSION'.freeze,
  OPERATION_TYPE_UPDATE_RUNBOOK_VERSION = 'UPDATE_RUNBOOK_VERSION'.freeze,
  OPERATION_TYPE_DELETE_RUNBOOK_VERSION = 'DELETE_RUNBOOK_VERSION'.freeze,
  OPERATION_TYPE_PUBLISH_RUNBOOK_VERSION = 'PUBLISH_RUNBOOK_VERSION'.freeze,
  OPERATION_TYPE_MOVE_TASK = 'MOVE_TASK'.freeze,
  OPERATION_TYPE_UPDATE_TASK = 'UPDATE_TASK'.freeze,
  OPERATION_TYPE_DELETE_TASK = 'DELETE_TASK'.freeze,
  OPERATION_TYPE_UPDATE_FAMS_ONBOARDING = 'UPDATE_FAMS_ONBOARDING'.freeze,
  OPERATION_TYPE_DELETE_FAMS_ONBOARDING = 'DELETE_FAMS_ONBOARDING'.freeze,
  OPERATION_TYPE_CREATE_COMPLIANCE_POLICY_RULE = 'CREATE_COMPLIANCE_POLICY_RULE'.freeze,
  OPERATION_TYPE_UPDATE_COMPLIANCE_POLICY_RULE = 'UPDATE_COMPLIANCE_POLICY_RULE'.freeze,
  OPERATION_TYPE_DELETE_COMPLIANCE_POLICY_RULE = 'DELETE_COMPLIANCE_POLICY_RULE'.freeze,
  OPERATION_TYPE_UPDATE_PATCH = 'UPDATE_PATCH'.freeze,
  OPERATION_TYPE_DELETE_PATCH = 'DELETE_PATCH'.freeze,
  OPERATION_TYPE_MOVE_PATCH = 'MOVE_PATCH'.freeze,
  OPERATION_TYPE_MANAGE_JOB_EXECUTION = 'MANAGE_JOB_EXECUTION'.freeze,
  OPERATION_TYPE_DELETE_PLATFORM_CONFIGURATION = 'DELETE_PLATFORM_CONFIGURATION'.freeze,
  OPERATION_TYPE_UPDATE_PLATFORM_CONFIGURATION = 'UPDATE_PLATFORM_CONFIGURATION'.freeze,
  OPERATION_TYPE_MOVE_PLATFORM_CONFIGURATION = 'MOVE_PLATFORM_CONFIGURATION'.freeze,
  OPERATION_TYPE_CREATE_PLATFORM_CONFIGURATION = 'CREATE_PLATFORM_CONFIGURATION'.freeze,
  OPERATION_TYPE_MOVE_PROPERTY = 'MOVE_PROPERTY'.freeze,
  OPERATION_TYPE_CREATE_CATALOG_ITEM = 'CREATE_CATALOG_ITEM'.freeze,
  OPERATION_TYPE_UPDATE_CATALOG_ITEM = 'UPDATE_CATALOG_ITEM'.freeze,
  OPERATION_TYPE_DELETE_CATALOG_ITEM = 'DELETE_CATALOG_ITEM'.freeze,
  OPERATION_TYPE_MOVE_CATALOG_ITEM = 'MOVE_CATALOG_ITEM'.freeze,
  OPERATION_TYPE_CLONE_CATALOG_ITEM = 'CLONE_CATALOG_ITEM'.freeze,
  OPERATION_TYPE_CREATE_PROVISION = 'CREATE_PROVISION'.freeze,
  OPERATION_TYPE_UPDATE_PROVISION = 'UPDATE_PROVISION'.freeze,
  OPERATION_TYPE_DELETE_PROVISION = 'DELETE_PROVISION'.freeze,
  OPERATION_TYPE_MOVE_PROVISION = 'MOVE_PROVISION'.freeze,
  OPERATION_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
STATUS_ENUM = 
[
  STATUS_ACCEPTED = 'ACCEPTED'.freeze,
  STATUS_IN_PROGRESS = 'IN_PROGRESS'.freeze,
  STATUS_WAITING = 'WAITING'.freeze,
  STATUS_NEEDS_ATTENTION = 'NEEDS_ATTENTION'.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 = {}) ⇒ WorkRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
 
# File 'lib/oci/fleet_apps_management/models/work_request.rb', line 184

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

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

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


100
101
102
 
# File 'lib/oci/fleet_apps_management/models/work_request.rb', line 100

def compartment_id
  @compartment_id
end

#id ⇒ String

[Required] The id of the work request.

Returns:

  • (String) 


92
93
94
 
# File 'lib/oci/fleet_apps_management/models/work_request.rb', line 92

def id
  @id
end

#operation_type ⇒ String

[Required] Type of the work request

Returns:

  • (String) 


84
85
86
 
# File 'lib/oci/fleet_apps_management/models/work_request.rb', line 84

def operation_type
  @operation_type
end

#percent_complete ⇒ Float

[Required] Percentage of the request completed.

Returns:

  • (Float) 


108
109
110
 
# File 'lib/oci/fleet_apps_management/models/work_request.rb', line 108

def percent_complete
  @percent_complete
end

#resources ⇒ Array<OCI::FleetAppsManagement::Models::WorkRequestResource>

[Required] The resources affected by this work request.

Returns:



104
105
106
 
# File 'lib/oci/fleet_apps_management/models/work_request.rb', line 104

def resources
  @resources
end

#status ⇒ String

[Required] Status of current work request.

Returns:

  • (String) 


88
89
90
 
# File 'lib/oci/fleet_apps_management/models/work_request.rb', line 88

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) 


114
115
116
 
# File 'lib/oci/fleet_apps_management/models/work_request.rb', line 114

def time_accepted
  @time_accepted
end

#time_finished ⇒ DateTime

The date and time the object was finished, as described in RFC 3339.

Returns:

  • (DateTime) 


125
126
127
 
# File 'lib/oci/fleet_apps_management/models/work_request.rb', line 125

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.

Returns:

  • (DateTime) 


120
121
122
 
# File 'lib/oci/fleet_apps_management/models/work_request.rb', line 120

def time_started
  @time_started
end

#time_updated ⇒ DateTime

The date and time the object was updated, as described in RFC 3339.

Returns:

  • (DateTime) 


130
131
132
 
# File 'lib/oci/fleet_apps_management/models/work_request.rb', line 130

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/oci/fleet_apps_management/models/work_request.rb', line 133

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'operation_type': :'operationType',
    'status': :'status',
    'id': :'id',
    'compartment_id': :'compartmentId',
    'resources': :'resources',
    'percent_complete': :'percentComplete',
    'time_accepted': :'timeAccepted',
    'time_started': :'timeStarted',
    'time_finished': :'timeFinished',
    'time_updated': :'timeUpdated'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/oci/fleet_apps_management/models/work_request.rb', line 151

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'operation_type': :'String',
    'status': :'String',
    'id': :'String',
    'compartment_id': :'String',
    'resources': :'Array<OCI::FleetAppsManagement::Models::WorkRequestResource>',
    'percent_complete': :'Float',
    'time_accepted': :'DateTime',
    'time_started': :'DateTime',
    'time_finished': :'DateTime',
    'time_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



272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/oci/fleet_apps_management/models/work_request.rb', line 272

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 &&
    resources == other.resources &&
    percent_complete == other.percent_complete &&
    time_accepted == other.time_accepted &&
    time_started == other.time_started &&
    time_finished == other.time_finished &&
    time_updated == other.time_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



311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/oci/fleet_apps_management/models/work_request.rb', line 311

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


291
292
293
 
# File 'lib/oci/fleet_apps_management/models/work_request.rb', line 291

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



300
301
302
 
# File 'lib/oci/fleet_apps_management/models/work_request.rb', line 300

def hash
  [operation_type, status, id, compartment_id, resources, percent_complete, time_accepted, time_started, time_finished, time_updated].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



344
345
346
347
348
349
350
351
352
353
 
# File 'lib/oci/fleet_apps_management/models/work_request.rb', line 344

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



338
339
340
 
# File 'lib/oci/fleet_apps_management/models/work_request.rb', line 338

def to_s
  to_hash.to_s
end