Class: OCI::Identity::Models::Tenancy

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

Overview

The root compartment that contains all of your organization’s compartments and other Oracle Cloud Infrastructure cloud resources. When you sign up for Oracle Cloud Infrastructure, Oracle creates a tenancy for your company, which is a secure and isolated partition where you can create, organize, and administer your cloud resources.

To use any of the API operations, you must be authorized in an IAM policy. If you’re not authorized, talk to an administrator. If you’re an administrator who needs to write policies to give users access, see [Getting Started with Policies](docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm).

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Tenancy

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String) —

    The value to assign to the #id property

  • :name (String) —

    The value to assign to the #name property

  • :description (String) —

    The value to assign to the #description property

  • :homeRegionKey (String) —

    The value to assign to the #home_region_key property

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

    The value to assign to the #freeform_tags property

  • :definedTags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/oci/identity/models/tenancy.rb', line 61

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[:'id']
    self.id = attributes[:'id']
  end

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

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

  if attributes[:'homeRegionKey']
    self.home_region_key = attributes[:'homeRegionKey']
  end

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

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

end

Instance Attribute Details

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

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm). Example: ‘{"CostCenter": "42"}`

Returns:

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


50
51
52
 
# File 'lib/oci/identity/models/tenancy.rb', line 50

def defined_tags
  @defined_tags
end

#description ⇒ String

The description of the tenancy.

Returns:

  • (String) 


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

def description
  @description
end

#freeform_tags ⇒ Hash<String, String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm). Example: ‘"Finance"`

Returns:

  • (Hash<String, String>) 


43
44
45
 
# File 'lib/oci/identity/models/tenancy.rb', line 43

def freeform_tags
  @freeform_tags
end

#home_region_key ⇒ String

The region key for the tenancy’s home region.

Allowed values are:

  • ‘IAD`

  • ‘PHX`

  • ‘FRA`

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/identity/models/tenancy.rb', line 36

def home_region_key
  @home_region_key
end

#id ⇒ String

The OCID of the tenancy.

Returns:

  • (String) 


18
19
20
 
# File 'lib/oci/identity/models/tenancy.rb', line 18

def id
  @id
end

#name ⇒ String

The name of the tenancy.

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/identity/models/tenancy.rb', line 22

def name
  @name
end

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other_object (Object) —

    to be compared



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

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



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/oci/identity/models/tenancy.rb', line 121

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


108
109
110
 
# File 'lib/oci/identity/models/tenancy.rb', line 108

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



114
115
116
 
# File 'lib/oci/identity/models/tenancy.rb', line 114

def hash
  [id, name, description, home_region_key, 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



146
147
148
149
150
151
152
153
154
 
# File 'lib/oci/identity/models/tenancy.rb', line 146

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



140
141
142
 
# File 'lib/oci/identity/models/tenancy.rb', line 140

def to_s
  to_hash.to_s
end