Class: OCI::Identity::Models::Tenancy
- Inherits:
-
Object
- Object
- OCI::Identity::Models::Tenancy
- 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 Get Started with Policies.
Instance Attribute Summary collapse
-
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource.
-
#description ⇒ String
The description of the tenancy.
-
#freeform_tags ⇒ Hash<String, String>
Free-form tags for this resource.
-
#home_region_key ⇒ String
The region key for the tenancy's home region.
-
#id ⇒ String
The OCID of the tenancy.
-
#name ⇒ String
The name of the tenancy.
-
#upi_idcs_compatibility_layer_endpoint ⇒ String
Url which refers to the UPI IDCS compatibility layer endpoint configured for this Tenant's home region.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ Tenancy
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ Tenancy
Initializes the object
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 130 131 132 133 134 135 |
# File 'lib/oci/identity/models/tenancy.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.id = attributes[:'id'] if attributes[:'id'] self.name = attributes[:'name'] if attributes[:'name'] self.description = attributes[:'description'] if attributes[:'description'] self.home_region_key = attributes[:'homeRegionKey'] if attributes[:'homeRegionKey'] raise 'You cannot provide both :homeRegionKey and :home_region_key' if attributes.key?(:'homeRegionKey') && attributes.key?(:'home_region_key') self.home_region_key = attributes[:'home_region_key'] if attributes[:'home_region_key'] self.upi_idcs_compatibility_layer_endpoint = attributes[:'upiIdcsCompatibilityLayerEndpoint'] if attributes[:'upiIdcsCompatibilityLayerEndpoint'] raise 'You cannot provide both :upiIdcsCompatibilityLayerEndpoint and :upi_idcs_compatibility_layer_endpoint' if attributes.key?(:'upiIdcsCompatibilityLayerEndpoint') && attributes.key?(:'upi_idcs_compatibility_layer_endpoint') self.upi_idcs_compatibility_layer_endpoint = attributes[:'upi_idcs_compatibility_layer_endpoint'] if attributes[:'upi_idcs_compatibility_layer_endpoint'] self. = attributes[:'freeformTags'] if attributes[:'freeformTags'] raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags') self. = attributes[:'freeform_tags'] if attributes[:'freeform_tags'] self. = attributes[:'definedTags'] if attributes[:'definedTags'] raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags') self. = attributes[:'defined_tags'] if attributes[:'defined_tags'] 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. Example: {\"Operations\": {\"CostCenter\": \"42\"}}
55 56 57 |
# File 'lib/oci/identity/models/tenancy.rb', line 55 def @defined_tags end |
#description ⇒ String
The description of the tenancy.
29 30 31 |
# File 'lib/oci/identity/models/tenancy.rb', line 29 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. Example: {\"Department\": \"Finance\"}
48 49 50 |
# File 'lib/oci/identity/models/tenancy.rb', line 48 def @freeform_tags end |
#home_region_key ⇒ String
The region key for the tenancy's home region. For the full list of supported regions, see Regions and Availability Domains.
Example: PHX
37 38 39 |
# File 'lib/oci/identity/models/tenancy.rb', line 37 def home_region_key @home_region_key end |
#id ⇒ String
The OCID of the tenancy.
21 22 23 |
# File 'lib/oci/identity/models/tenancy.rb', line 21 def id @id end |
#name ⇒ String
The name of the tenancy.
25 26 27 |
# File 'lib/oci/identity/models/tenancy.rb', line 25 def name @name end |
#upi_idcs_compatibility_layer_endpoint ⇒ String
Url which refers to the UPI IDCS compatibility layer endpoint configured for this Tenant's home region.
41 42 43 |
# File 'lib/oci/identity/models/tenancy.rb', line 41 def upi_idcs_compatibility_layer_endpoint @upi_idcs_compatibility_layer_endpoint end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
58 59 60 61 62 63 64 65 66 67 68 69 70 |
# File 'lib/oci/identity/models/tenancy.rb', line 58 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'id': :'id', 'name': :'name', 'description': :'description', 'home_region_key': :'homeRegionKey', 'upi_idcs_compatibility_layer_endpoint': :'upiIdcsCompatibilityLayerEndpoint', 'freeform_tags': :'freeformTags', 'defined_tags': :'definedTags' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
73 74 75 76 77 78 79 80 81 82 83 84 85 |
# File 'lib/oci/identity/models/tenancy.rb', line 73 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'id': :'String', 'name': :'String', 'description': :'String', 'home_region_key': :'String', 'upi_idcs_compatibility_layer_endpoint': :'String', 'freeform_tags': :'Hash<String, String>', 'defined_tags': :'Hash<String, Hash<String, Object>>' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
144 145 146 147 148 149 150 151 152 153 154 155 |
# File 'lib/oci/identity/models/tenancy.rb', line 144 def ==(other) return true if equal?(other) self.class == other.class && id == other.id && name == other.name && description == other.description && home_region_key == other.home_region_key && upi_idcs_compatibility_layer_endpoint == other.upi_idcs_compatibility_layer_endpoint && == other. && == other. end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 |
# File 'lib/oci/identity/models/tenancy.rb', line 180 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
160 161 162 |
# File 'lib/oci/identity/models/tenancy.rb', line 160 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
169 170 171 |
# File 'lib/oci/identity/models/tenancy.rb', line 169 def hash [id, name, description, home_region_key, upi_idcs_compatibility_layer_endpoint, , ].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
213 214 215 216 217 218 219 220 221 222 |
# File 'lib/oci/identity/models/tenancy.rb', line 213 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
207 208 209 |
# File 'lib/oci/identity/models/tenancy.rb', line 207 def to_s to_hash.to_s end |