Class: OCI::Identity::Models::CreateCompartmentDetails

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateCompartmentDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/oci/identity/models/create_compartment_details.rb', line 37

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}

  if attributes[:'compartmentId']
    self.compartment_id = attributes[:'compartmentId']
  end

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

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

  if attributes[:'freeformTags']
    self.freeform_tags = attributes[:'freeformTags']
  end

  if attributes[:'definedTags']
    self.defined_tags = attributes[:'definedTags']
  end

end

Instance Attribute Details

#compartment_id ⇒ String

The OCID of the tenancy containing the compartment.

Returns:

  • (String) 


9
10
11
 
# File 'lib/oci/identity/models/create_compartment_details.rb', line 9

def compartment_id
  @compartment_id
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: ‘{"bar-key": "foo-value"}`

Returns:

  • (Hash<String, Hash<String, Object>>) 


32
33
34
 
# File 'lib/oci/identity/models/create_compartment_details.rb', line 32

def defined_tags
  @defined_tags
end

#description ⇒ String

The description you assign to the compartment during creation. Does not have to be unique, and it’s changeable.

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/identity/models/create_compartment_details.rb', line 20

def description
  @description
end

#freeform_tags ⇒ Hash<String, String>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: ‘"value"`

Returns:

  • (Hash<String, String>) 


26
27
28
 
# File 'lib/oci/identity/models/create_compartment_details.rb', line 26

def freeform_tags
  @freeform_tags
end

#name ⇒ String

The name you assign to the compartment during creation. The name must be unique across all compartments in the tenancy.

Returns:

  • (String) 


15
16
17
 
# File 'lib/oci/identity/models/create_compartment_details.rb', line 15

def name
  @name
end

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other_object (Object) —

    to be compared



67
68
69
70
71
72
73
74
75
 
# File 'lib/oci/identity/models/create_compartment_details.rb', line 67

def ==(other_object)
  return true if self.equal?(other_object)
  self.class == other_object.class &&
      compartment_id == other_object.compartment_id &&
      name == other_object.name &&
      description == other_object.description &&
      freeform_tags == other_object.freeform_tags &&
      defined_tags == other_object.defined_tags
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



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/oci/identity/models/create_compartment_details.rb', line 92

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)
        self.public_method("#{key}=").call(attributes[self.class.attribute_map[key]].map{ |v| OCI::Internal::Util.convert_to_type($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.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_object) ⇒ Boolean

Parameters:

  • other_object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


79
80
81
 
# File 'lib/oci/identity/models/create_compartment_details.rb', line 79

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



85
86
87
 
# File 'lib/oci/identity/models/create_compartment_details.rb', line 85

def hash
  [compartment_id, name, description, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



117
118
119
120
121
122
123
124
125
 
# File 'lib/oci/identity/models/create_compartment_details.rb', line 117

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



111
112
113
 
# File 'lib/oci/identity/models/create_compartment_details.rb', line 111

def to_s
  to_hash.to_s
end