Class: OCI::OsManagementHub::Models::WorkRequestResource

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

Overview

A resource created or operated on by a work request.

Constant Summary collapse

ENTITY_TYPE_ENUM = 
[
  ENTITY_TYPE_INSTANCE = 'INSTANCE'.freeze,
  ENTITY_TYPE_GROUP = 'GROUP'.freeze,
  ENTITY_TYPE_COMPARTMENT = 'COMPARTMENT'.freeze,
  ENTITY_TYPE_LIFECYCLE_ENVIRONMENT = 'LIFECYCLE_ENVIRONMENT'.freeze,
  ENTITY_TYPE_SOFTWARE_SOURCE = 'SOFTWARE_SOURCE'.freeze,
  ENTITY_TYPE_DYNAMIC_SET = 'DYNAMIC_SET'.freeze,
  ENTITY_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
ACTION_TYPE_ENUM = 
[
  ACTION_TYPE_CREATED = 'CREATED'.freeze,
  ACTION_TYPE_UPDATED = 'UPDATED'.freeze,
  ACTION_TYPE_DELETED = 'DELETED'.freeze,
  ACTION_TYPE_IN_PROGRESS = 'IN_PROGRESS'.freeze,
  ACTION_TYPE_RELATED = 'RELATED'.freeze,
  ACTION_TYPE_FAILED = 'FAILED'.freeze,
  ACTION_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ WorkRequestResource

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :entity_type (String) —

    The value to assign to the #entity_type property

  • :action_type (String) —

    The value to assign to the #action_type property

  • :identifier (String) —

    The value to assign to the #identifier property

  • :entity_uri (String) —

    The value to assign to the #entity_uri property

  • :name (String) —

    The value to assign to the #name property

  • :metadata (Hash<String, String>) —

    The value to assign to the #metadata property



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/oci/os_management_hub/models/work_request_resource.rb', line 100

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

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

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

  self.action_type = attributes[:'actionType'] if attributes[:'actionType']

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

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

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

  self.entity_uri = attributes[:'entityUri'] if attributes[:'entityUri']

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

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

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

  self.metadata = attributes[:'metadata'] if attributes[:'metadata']
end

Instance Attribute Details

#action_type ⇒ String

[Required] The way in which this resource is affected by the work tracked in the work request. A resource being created, updated, or deleted will remain in the IN_PROGRESS state until work is complete for that resource at which point it will transition to CREATED, UPDATED, or DELETED, respectively.

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/os_management_hub/models/work_request_resource.rb', line 42

def action_type
  @action_type
end

#entity_type ⇒ String

[Required] The resource type that the work request affects.

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/os_management_hub/models/work_request_resource.rb', line 34

def entity_type
  @entity_type
end

#entity_uri ⇒ String

The URI path that the user can do a GET on to access the resource metadata.

Returns:

  • (String) 


50
51
52
 
# File 'lib/oci/os_management_hub/models/work_request_resource.rb', line 50

def entity_uri
  @entity_uri
end

#identifier ⇒ String

[Required] The identifier of the resource the work request affects.

Returns:

  • (String) 


46
47
48
 
# File 'lib/oci/os_management_hub/models/work_request_resource.rb', line 46

def identifier
  @identifier
end

#metadata ⇒ Hash<String, String>

Additional information that helps to explain the resource.

Returns:

  • (Hash<String, String>) 


58
59
60
 
# File 'lib/oci/os_management_hub/models/work_request_resource.rb', line 58

def metadata
  @metadata
end

#name ⇒ String

The name of the resource. Not all resources will have a name specified.

Returns:

  • (String) 


54
55
56
 
# File 'lib/oci/os_management_hub/models/work_request_resource.rb', line 54

def name
  @name
end

Class Method Details

.attribute_map ⇒ Object

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



61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/oci/os_management_hub/models/work_request_resource.rb', line 61

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'entity_type': :'entityType',
    'action_type': :'actionType',
    'identifier': :'identifier',
    'entity_uri': :'entityUri',
    'name': :'name',
    'metadata': :'metadata'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/oci/os_management_hub/models/work_request_resource.rb', line 75

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'entity_type': :'String',
    'action_type': :'String',
    'identifier': :'String',
    'entity_uri': :'String',
    'name': :'String',
    'metadata': :'Hash<String, 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



164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/oci/os_management_hub/models/work_request_resource.rb', line 164

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

  self.class == other.class &&
    entity_type == other.entity_type &&
    action_type == other.action_type &&
    identifier == other.identifier &&
    entity_uri == other.entity_uri &&
    name == other.name &&
    metadata == other.metadata
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



199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/oci/os_management_hub/models/work_request_resource.rb', line 199

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


179
180
181
 
# File 'lib/oci/os_management_hub/models/work_request_resource.rb', line 179

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



188
189
190
 
# File 'lib/oci/os_management_hub/models/work_request_resource.rb', line 188

def hash
  [entity_type, action_type, identifier, entity_uri, name, metadata].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



232
233
234
235
236
237
238
239
240
241
 
# File 'lib/oci/os_management_hub/models/work_request_resource.rb', line 232

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



226
227
228
 
# File 'lib/oci/os_management_hub/models/work_request_resource.rb', line 226

def to_s
  to_hash.to_s
end