class OCI::Identity::Models::CreateIdentityProviderDetails
CreateIdentityProviderDetails
model. This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class
Constants
- PRODUCT_TYPE_ENUM
- PROTOCOL_ENUM
Attributes
[Required] The OCID of your tenancy. @return [String]
[Required] The description you assign to the `IdentityProvider` during creation. Does not have to be unique, and it's changeable.
@return [String]
[Required] The name you assign to the `IdentityProvider` during creation. The name must be unique across all `IdentityProvider` objects in the tenancy and cannot be changed.
@return [String]
[Required] The identity provider service or product. Supported identity providers are Oracle Identity
Cloud Service (IDCS) and Microsoft Active Directory Federation Services (ADFS).
Example: `IDCS`
@return [String]
[Required] The protocol used for federation.
Example: `SAML2`
@return [String]
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/oci/identity/models/create_identity_provider_details.rb, line 69 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'compartment_id': :'compartmentId', 'name': :'name', 'description': :'description', 'product_type': :'productType', 'protocol': :'protocol', 'freeform_tags': :'freeformTags', 'defined_tags': :'definedTags' # rubocop:enable Style/SymbolLiteral } end
Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.
# File lib/oci/identity/models/create_identity_provider_details.rb, line 103 def self.get_subtype(object_hash) type = object_hash[:'protocol'] # rubocop:disable Style/SymbolLiteral return 'OCI::Identity::Models::CreateSaml2IdentityProviderDetails' if type == 'SAML2' # TODO: Log a warning when the subtype is not found. 'OCI::Identity::Models::CreateIdentityProviderDetails' end
Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :compartment_id The value to assign to the {#compartment_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] :product_type The value to assign to the {#product_type} property @option attributes [String] :protocol The value to assign to the {#protocol} 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/create_identity_provider_details.rb, line 126 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.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId'] raise 'You cannot provide both :compartmentId and :compartment_id' if attributes.key?(:'compartmentId') && attributes.key?(:'compartment_id') self.compartment_id = attributes[:'compartment_id'] if attributes[:'compartment_id'] self.name = attributes[:'name'] if attributes[:'name'] self.description = attributes[:'description'] if attributes[:'description'] self.product_type = attributes[:'productType'] if attributes[:'productType'] raise 'You cannot provide both :productType and :product_type' if attributes.key?(:'productType') && attributes.key?(:'product_type') self.product_type = attributes[:'product_type'] if attributes[:'product_type'] self.protocol = attributes[:'protocol'] if attributes[:'protocol'] 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/create_identity_provider_details.rb, line 84 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'compartment_id': :'String', 'name': :'String', 'description': :'String', 'product_type': :'String', 'protocol': :'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/create_identity_provider_details.rb, line 186 def ==(other) return true if equal?(other) self.class == other.class && compartment_id == other.compartment_id && name == other.name && description == other.description && product_type == other.product_type && protocol == other.protocol && 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/create_identity_provider_details.rb, line 222 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/create_identity_provider_details.rb, line 202 def eql?(other) self == other end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/oci/identity/models/create_identity_provider_details.rb, line 211 def hash [compartment_id, name, description, product_type, protocol, freeform_tags, defined_tags].hash end
Custom attribute writer method checking allowed values (enum). @param [Object] product_type
Object
to be assigned
# File lib/oci/identity/models/create_identity_provider_details.rb, line 167 def product_type=(product_type) raise "Invalid value for 'product_type': this must be one of the values in PRODUCT_TYPE_ENUM." if product_type && !PRODUCT_TYPE_ENUM.include?(product_type) @product_type = product_type end
Custom attribute writer method checking allowed values (enum). @param [Object] protocol Object
to be assigned
# File lib/oci/identity/models/create_identity_provider_details.rb, line 175 def protocol=(protocol) raise "Invalid value for 'protocol': this must be one of the values in PROTOCOL_ENUM." if protocol && !PROTOCOL_ENUM.include?(protocol) @protocol = protocol end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/oci/identity/models/create_identity_provider_details.rb, line 255 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/create_identity_provider_details.rb, line 249 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/create_identity_provider_details.rb, line 272 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