Class: OCI::DatabaseManagement::Models::WorkRequestSubResource

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/database_management/models/work_request_sub_resource.rb

Overview

The resource that is created or operated on by a work request.

Constant Summary collapse

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_ACCEPTED = 'ACCEPTED'.freeze,
  ACTION_TYPE_ENABLED = 'ENABLED'.freeze,
  ACTION_TYPE_DISABLED = 'DISABLED'.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 = {}) ⇒ WorkRequestSubResource

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :entity_name (String) —

    The value to assign to the #entity_name property

  • :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

  • :description (String) —

    The value to assign to the #description property



93
94
95
96
97
98
99
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
 
# File 'lib/oci/database_management/models/work_request_sub_resource.rb', line 93

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_name = attributes[:'entityName'] if attributes[:'entityName']

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

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

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


39
40
41
 
# File 'lib/oci/database_management/models/work_request_sub_resource.rb', line 39

def action_type
  @action_type
end

#description ⇒ String

Description of the entity

Returns:

  • (String) 


51
52
53
 
# File 'lib/oci/database_management/models/work_request_sub_resource.rb', line 51

def description
  @description
end

#entity_name ⇒ String

[Required] The name of the subresource entity.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/database_management/models/work_request_sub_resource.rb', line 27

def entity_name
  @entity_name
end

#entity_type ⇒ String

[Required] The resource type the work request affects.

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/database_management/models/work_request_sub_resource.rb', line 31

def entity_type
  @entity_type
end

#entity_uri ⇒ String

The URI path that is used in a GET request to access the resource metadata.

Returns:

  • (String) 


47
48
49
 
# File 'lib/oci/database_management/models/work_request_sub_resource.rb', line 47

def entity_uri
  @entity_uri
end

#identifier ⇒ String

The OCID or other unique identifier of the resource the work request affects.

Returns:

  • (String) 


43
44
45
 
# File 'lib/oci/database_management/models/work_request_sub_resource.rb', line 43

def identifier
  @identifier
end

Class Method Details

.attribute_map ⇒ Object

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



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

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

.swagger_types ⇒ Object

Attribute type mapping.



68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/oci/database_management/models/work_request_sub_resource.rb', line 68

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



148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/oci/database_management/models/work_request_sub_resource.rb', line 148

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

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



183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/oci/database_management/models/work_request_sub_resource.rb', line 183

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


163
164
165
 
# File 'lib/oci/database_management/models/work_request_sub_resource.rb', line 163

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



172
173
174
 
# File 'lib/oci/database_management/models/work_request_sub_resource.rb', line 172

def hash
  [entity_name, entity_type, action_type, identifier, entity_uri, description].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



216
217
218
219
220
221
222
223
224
225
 
# File 'lib/oci/database_management/models/work_request_sub_resource.rb', line 216

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



210
211
212
 
# File 'lib/oci/database_management/models/work_request_sub_resource.rb', line 210

def to_s
  to_hash.to_s
end