class OCI::Identity::Models::BaseTagDefinitionValidator
Validates a definedTag value. Each validator performs validation steps in addition to the standard validation for definedTag values. For more information, see [Limits on Tags](docs.cloud.oracle.com/Content/Identity/Concepts/taggingoverview.htm#Limits).
If you define a validator after a value has been set for a defined tag, then any updates that attempt to change the value must pass the additional validation defined by the current rule. Previously set values (even those that would fail the current validation) are not updated. You can still update other attributes to resources that contain a non-valid defined tag.
To clear the validator call UpdateTag with [DefaultTagDefinitionValidator](docs.cloud.oracle.com/api/#/en/identity/latest/datatypes/DefaultTagDefinitionValidator).
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
- VALIDATOR_TYPE_ENUM
Attributes
[Required] Specifies the type of validation: a static value (no validation) or a list.
@return [String]
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/oci/identity/models/base_tag_definition_validator.rb, line 35 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'validator_type': :'validatorType' # 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/base_tag_definition_validator.rb, line 57 def self.get_subtype(object_hash) type = object_hash[:'validatorType'] # rubocop:disable Style/SymbolLiteral return 'OCI::Identity::Models::DefaultTagDefinitionValidator' if type == 'DEFAULT' return 'OCI::Identity::Models::EnumTagDefinitionValidator' if type == 'ENUM' # TODO: Log a warning when the subtype is not found. 'OCI::Identity::Models::BaseTagDefinitionValidator' end
Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :validator_type The value to assign to the {#validator_type} property
# File lib/oci/identity/models/base_tag_definition_validator.rb, line 75 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.validator_type = attributes[:'validatorType'] if attributes[:'validatorType'] raise 'You cannot provide both :validatorType and :validator_type' if attributes.key?(:'validatorType') && attributes.key?(:'validator_type') self.validator_type = attributes[:'validator_type'] if attributes[:'validator_type'] end
Attribute type mapping.
# File lib/oci/identity/models/base_tag_definition_validator.rb, line 44 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'validator_type': :'String' # 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/base_tag_definition_validator.rb, line 108 def ==(other) return true if equal?(other) self.class == other.class && validator_type == other.validator_type 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/base_tag_definition_validator.rb, line 138 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/base_tag_definition_validator.rb, line 118 def eql?(other) self == other end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/oci/identity/models/base_tag_definition_validator.rb, line 127 def hash [validator_type].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/base_tag_definition_validator.rb, line 171 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/base_tag_definition_validator.rb, line 165 def to_s to_hash.to_s end
Custom attribute writer method checking allowed values (enum). @param [Object] validator_type
Object
to be assigned
# File lib/oci/identity/models/base_tag_definition_validator.rb, line 92 def validator_type=(validator_type) # rubocop:disable Style/ConditionalAssignment if validator_type && !VALIDATOR_TYPE_ENUM.include?(validator_type) OCI.logger.debug("Unknown value for 'validator_type' [" + validator_type + "]. Mapping to 'VALIDATOR_TYPE_UNKNOWN_ENUM_VALUE'") if OCI.logger @validator_type = VALIDATOR_TYPE_UNKNOWN_ENUM_VALUE else @validator_type = validator_type end # rubocop:enable Style/ConditionalAssignment 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/base_tag_definition_validator.rb, line 188 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