Class: OCI::Identity::Models::BaseTagDefinitionValidator

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

Overview

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.

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.

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

Constant Summary collapse

VALIDATOR_TYPE_ENUM = 
[
  VALIDATOR_TYPE_ENUM_VALUE = 'ENUM'.freeze,
  VALIDATOR_TYPE_DEFAULT = 'DEFAULT'.freeze,
  VALIDATOR_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BaseTagDefinitionValidator

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :validator_type (String) —

    The value to assign to the #validator_type property



76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/oci/identity/models/base_tag_definition_validator.rb', line 76

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

Instance Attribute Details

#validator_type ⇒ String

[Required] Specifies the type of validation: a static value (no validation) or a list.

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/identity/models/base_tag_definition_validator.rb', line 33

def validator_type
  @validator_type
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



36
37
38
39
40
41
42
 
# File 'lib/oci/identity/models/base_tag_definition_validator.rb', line 36

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'validator_type': :'validatorType'
    # rubocop:enable Style/SymbolLiteral
  }
end

.get_subtype(object_hash) ⇒ Object

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.



58
59
60
61
62
63
64
65
66
 
# File 'lib/oci/identity/models/base_tag_definition_validator.rb', line 58

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

.swagger_types ⇒ Object

Attribute type mapping.



45
46
47
48
49
50
51
 
# File 'lib/oci/identity/models/base_tag_definition_validator.rb', line 45

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'validator_type': :'String'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



109
110
111
112
113
114
 
# File 'lib/oci/identity/models/base_tag_definition_validator.rb', line 109

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    validator_type == other.validator_type
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



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/oci/identity/models/base_tag_definition_validator.rb', line 139

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

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


119
120
121
 
# File 'lib/oci/identity/models/base_tag_definition_validator.rb', line 119

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



128
129
130
 
# File 'lib/oci/identity/models/base_tag_definition_validator.rb', line 128

def hash
  [validator_type].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



172
173
174
175
176
177
178
179
180
181
 
# File 'lib/oci/identity/models/base_tag_definition_validator.rb', line 172

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



166
167
168
 
# File 'lib/oci/identity/models/base_tag_definition_validator.rb', line 166

def to_s
  to_hash.to_s
end