class OCI::Identity::Models::Tenancy
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.cloud.oracle.com/Content/Identity/Concepts/policygetstarted.htm).
Attributes
The description of the tenancy. @return [String]
The region key for the tenancy's home region. For the full list of supported regions, see [Regions and Availability Domains](docs.cloud.oracle.com/Content/General/Concepts/regions.htm).
Example: `PHX`
@return [String]
The OCID of the tenancy. @return [String]
The name of the tenancy. @return [String]
Url which refers to the UPI IDCS compatibility layer endpoint configured for this Tenant's home region. @return [String]
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/oci/identity/models/tenancy.rb, line 57 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
Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :id The value to assign to the {#id} property @option attributes [String] :name The value to assign to the {#name} property @option attributes [String] :description The value to assign to the {#description} property @option attributes [String] :home_region_key The value to assign to the {#home_region_key} property @option attributes [String] :upi_idcs_compatibility_layer_endpoint The value to assign to the {#upi_idcs_compatibility_layer_endpoint} property @option attributes [Hash<String, String>] :freeform_tags The value to assign to the {#freeform_tags} property @option attributes [Hash<String, Hash<String, Object>>] :defined_tags The value to assign to the {#defined_tags} property
# File lib/oci/identity/models/tenancy.rb, line 99 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.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags'] raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags') self.freeform_tags = attributes[:'freeform_tags'] if attributes[:'freeform_tags'] self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags'] raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags') self.defined_tags = attributes[:'defined_tags'] if attributes[:'defined_tags'] end
Attribute type mapping.
# File lib/oci/identity/models/tenancy.rb, line 72 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
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] other the other object to be compared
# File lib/oci/identity/models/tenancy.rb, line 143 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 && freeform_tags == other.freeform_tags && defined_tags == other.defined_tags end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/oci/identity/models/tenancy.rb, line 179 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
@see the `==` method @param [Object] other the other object to be compared
# File lib/oci/identity/models/tenancy.rb, line 159 def eql?(other) self == other end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/oci/identity/models/tenancy.rb, line 168 def hash [id, name, description, home_region_key, upi_idcs_compatibility_layer_endpoint, freeform_tags, defined_tags].hash end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/oci/identity/models/tenancy.rb, line 212 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/oci/identity/models/tenancy.rb, line 206 def to_s to_hash.to_s end
Private Instance Methods
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# File lib/oci/identity/models/tenancy.rb, line 229 def _to_hash(value) if value.is_a?(Array) value.compact.map { |v| _to_hash(v) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v) } end elsif value.respond_to? :to_hash value.to_hash else value end end