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 (See [Limits on Tags](docs.cloud.oracle.com/Content/Identity/Concepts/taggingoverview.htm#Limits).

If a validator is defined after a value has been set for a definedTag, then any UPDATE operation that attempts to change the value must pass the additional validation defined by this rule. Previously set values, that would fail validation, are not updated and it is possible to update other attributes of an OCI resource that contains a non-valid definedTag.

To clear the validator call the UPDATE operation 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 = '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



72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/oci/identity/models/base_tag_definition_validator.rb', line 72

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] The primitive that any value set for this definedTag must be parseable as.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/identity/models/base_tag_definition_validator.rb', line 29

def validator_type
  @validator_type
end

Class Method Details

.attribute_map ⇒ Object

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



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

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.



54
55
56
57
58
59
60
61
62
 
# File 'lib/oci/identity/models/base_tag_definition_validator.rb', line 54

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.



41
42
43
44
45
46
47
 
# File 'lib/oci/identity/models/base_tag_definition_validator.rb', line 41

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



105
106
107
108
109
110
 
# File 'lib/oci/identity/models/base_tag_definition_validator.rb', line 105

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



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

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


115
116
117
 
# File 'lib/oci/identity/models/base_tag_definition_validator.rb', line 115

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



124
125
126
 
# File 'lib/oci/identity/models/base_tag_definition_validator.rb', line 124

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



168
169
170
171
172
173
174
175
176
177
 
# File 'lib/oci/identity/models/base_tag_definition_validator.rb', line 168

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



162
163
164
 
# File 'lib/oci/identity/models/base_tag_definition_validator.rb', line 162

def to_s
  to_hash.to_s
end