Class: OCI::OsManagementHub::Models::UpdateWorkRequestDetails

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

Overview

Provides the information used to update a work request.

Constant Summary collapse

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
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateWorkRequestDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :status (String) —

    The value to assign to the #status property

  • :percent_complete (Float) —

    The value to assign to the #percent_complete property

  • :time_finished (DateTime) —

    The value to assign to the #time_finished property

  • :description (String) —

    The value to assign to the #description property

  • :display_name (String) —

    The value to assign to the #display_name property



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/oci/os_management_hub/models/update_work_request_details.rb', line 78

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

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

Instance Attribute Details

#description ⇒ String

A short description about the work request.

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/os_management_hub/models/update_work_request_details.rb', line 35

def description
  @description
end

#display_name ⇒ String

A short display for about the work request.

Returns:

  • (String) 


39
40
41
 
# File 'lib/oci/os_management_hub/models/update_work_request_details.rb', line 39

def display_name
  @display_name
end

#percent_complete ⇒ Float

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

Returns:

  • (Float) 


26
27
28
 
# File 'lib/oci/os_management_hub/models/update_work_request_details.rb', line 26

def percent_complete
  @percent_complete
end

#status ⇒ String

[Required] status of current work request.

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/os_management_hub/models/update_work_request_details.rb', line 22

def status
  @status
end

#time_finished ⇒ DateTime

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

Returns:

  • (DateTime) 


31
32
33
 
# File 'lib/oci/os_management_hub/models/update_work_request_details.rb', line 31

def time_finished
  @time_finished
end

Class Method Details

.attribute_map ⇒ Object

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



42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/oci/os_management_hub/models/update_work_request_details.rb', line 42

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'status': :'status',
    'percent_complete': :'percentComplete',
    'time_finished': :'timeFinished',
    'description': :'description',
    'display_name': :'displayName'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/oci/os_management_hub/models/update_work_request_details.rb', line 55

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'status': :'String',
    'percent_complete': :'Float',
    'time_finished': :'DateTime',
    'description': :'String',
    'display_name': :'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



122
123
124
125
126
127
128
129
130
131
 
# File 'lib/oci/os_management_hub/models/update_work_request_details.rb', line 122

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

  self.class == other.class &&
    status == other.status &&
    percent_complete == other.percent_complete &&
    time_finished == other.time_finished &&
    description == other.description &&
    display_name == other.display_name
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



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/oci/os_management_hub/models/update_work_request_details.rb', line 156

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


136
137
138
 
# File 'lib/oci/os_management_hub/models/update_work_request_details.rb', line 136

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



145
146
147
 
# File 'lib/oci/os_management_hub/models/update_work_request_details.rb', line 145

def hash
  [status, percent_complete, time_finished, description, display_name].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



189
190
191
192
193
194
195
196
197
198
 
# File 'lib/oci/os_management_hub/models/update_work_request_details.rb', line 189

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



183
184
185
 
# File 'lib/oci/os_management_hub/models/update_work_request_details.rb', line 183

def to_s
  to_hash.to_s
end