Class: OCI::Identity::Models::AddLockDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/identity/models/add_lock_details.rb

Overview

Request payload to add lock to the resource.

Constant Summary collapse

TYPE_ENUM = 
[
  TYPE_FULL = 'FULL'.freeze,
  TYPE_DELETE = 'DELETE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AddLockDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :type (String) —

    The value to assign to the #type property

  • :related_resource_id (String) —

    The value to assign to the #related_resource_id property

  • :message (String) —

    The value to assign to the #message property



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/oci/identity/models/add_lock_details.rb', line 63

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

  self.related_resource_id = attributes[:'relatedResourceId'] if attributes[:'relatedResourceId']

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

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

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

Instance Attribute Details

#message ⇒ String

A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/identity/models/add_lock_details.rb', line 30

def message
  @message
end

#related_resource_id ⇒ String

The ID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/identity/models/add_lock_details.rb', line 24

def related_resource_id
  @related_resource_id
end

#type ⇒ String

[Required] Type of the lock.

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/identity/models/add_lock_details.rb', line 19

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



33
34
35
36
37
38
39
40
41
 
# File 'lib/oci/identity/models/add_lock_details.rb', line 33

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'type',
    'related_resource_id': :'relatedResourceId',
    'message': :'message'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



44
45
46
47
48
49
50
51
52
 
# File 'lib/oci/identity/models/add_lock_details.rb', line 44

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'String',
    'related_resource_id': :'String',
    'message': :'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



95
96
97
98
99
100
101
102
 
# File 'lib/oci/identity/models/add_lock_details.rb', line 95

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

  self.class == other.class &&
    type == other.type &&
    related_resource_id == other.related_resource_id &&
    message == other.message
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



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/oci/identity/models/add_lock_details.rb', line 127

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


107
108
109
 
# File 'lib/oci/identity/models/add_lock_details.rb', line 107

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



116
117
118
 
# File 'lib/oci/identity/models/add_lock_details.rb', line 116

def hash
  [type, related_resource_id, message].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



160
161
162
163
164
165
166
167
168
169
 
# File 'lib/oci/identity/models/add_lock_details.rb', line 160

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



154
155
156
 
# File 'lib/oci/identity/models/add_lock_details.rb', line 154

def to_s
  to_hash.to_s
end