Class: Zilla::IoK8sApiextensionsApiserverPkgApisApiextensionsV1ValidationRule

Inherits:
Object
  • Object
show all
Defined in:
lib/zilla/models/io_k8s_apiextensions_apiserver_pkg_apis_apiextensions_v1_validation_rule.rb

Overview

ValidationRule describes a validation rule written in the CEL expression language.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ IoK8sApiextensionsApiserverPkgApisApiextensionsV1ValidationRule

Initializes the object

Parameters:

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

    Model attributes in the form of hash



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/zilla/models/io_k8s_apiextensions_apiserver_pkg_apis_apiextensions_v1_validation_rule.rb', line 53

def initialize(attributes = {})
  unless attributes.is_a?(Hash)
    raise ArgumentError,
          'The input argument (attributes) must be a hash in `Zilla::IoK8sApiextensionsApiserverPkgApisApiextensionsV1ValidationRule` initialize method'
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) do |(k, v), h|
    unless self.class.attribute_map.key?(k.to_sym)
      raise ArgumentError,
            "`#{k}` is not a valid attribute in `Zilla::IoK8sApiextensionsApiserverPkgApisApiextensionsV1ValidationRule`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end

    h[k.to_sym] = v
  end

  self.message = attributes[:message] if attributes.key?(:message)

  return unless attributes.key?(:rule)

  self.rule = attributes[:rule]
end

Instance Attribute Details

#message ⇒ Object

Message represents the message displayed when validation fails. The message is required if the Rule contains line breaks. The message must not contain line breaks. If unset, the message is "failed rule: Rule". e.g. "must be a URL with the host matching spec.host"



20
21
22
 
# File 'lib/zilla/models/io_k8s_apiextensions_apiserver_pkg_apis_apiextensions_v1_validation_rule.rb', line 20

def message
  @message
end

#rule ⇒ Object

Rule represents the expression which will be evaluated by CEL. ref: github.com/google/cel-spec The Rule is scoped to the location of the x-kubernetes-validations extension in the schema. The ‘self` variable in the CEL expression is bound to the scoped value. Example: - Rule scoped to the root of a resource with a status subresource: "self.status.actual <= self.spec.maxDesired" If the Rule is scoped to an object with properties, the accessible properties of the object are field selectable via `self.field` and field presence can be checked via `has(self.field)`. Null valued fields are treated as absent fields in CEL expressions. If the Rule is scoped to an object with additionalProperties (i.e. a map) the value of the map are accessible via `self`, map containment can be checked via `mapKey in self` and all entries of the map are accessible via CEL macros and functions such as `self.all(…)`. If the Rule is scoped to an array, the elements of the array are accessible via `self` and also by macros and functions. If the Rule is scoped to a scalar, `self` is bound to the scalar value. Examples: - Rule scoped to a map of objects: "self.components.priority < 10" - Rule scoped to a list of integers: "self.values.all(value, value >= 0 && value < 100)" - Rule scoped to a string value: "self.startsWith(’kube’)" The ‘apiVersion`, `kind`, `metadata.name` and `metadata.generateName` are always accessible from the root of the object and from any x-kubernetes-embedded-resource annotated objects. No other metadata properties are accessible. Unknown data preserved in custom resources via x-kubernetes-preserve-unknown-fields is not accessible in CEL expressions. This includes: - Unknown field values that are preserved by object schemas with x-kubernetes-preserve-unknown-fields. - Object properties where the property schema is of an "unknown type". An "unknown type" is recursively defined as: - A schema with no type and x-kubernetes-preserve-unknown-fields set to true - An array where the items schema is of an "unknown type" - An object where the additionalProperties schema is of an "unknown type" Only property names of the form `[a-zA-Z_.-/]*` are accessible. Accessible property names are escaped according to the following rules when accessed in the expression: - ’__’ escapes to ‘__underscores__’ - ‘.’ escapes to ‘__dot__’ - ‘-’ escapes to ‘__dash__’ - ‘/’ escapes to ‘__slash__’ - Property names that exactly match a CEL RESERVED keyword escape to ‘__keyword__’. The keywords are: "true", "false", "null", "in", "as", "break", "const", "continue", "else", "for", "function", "if", "import", "let", "loop", "package", "namespace", "return". Examples: - Rule accessing a property named "namespace": "self.__namespace__ > 0" - Rule accessing a property named "x-prop": "self.x__dash__prop > 0" - Rule accessing a property named "redact__d": "self.redact__underscores__d > 0" Equality on arrays with x-kubernetes-list-type of ‘set’ or ‘map’ ignores element order, i.e. [1, 2] == [2, 1]. Concatenation on arrays with x-kubernetes-list-type use the semantics of the list type: - ‘set’: ‘X + Y` performs a union where the array positions of all elements in `X` are preserved and non-intersecting elements in `Y` are appended, retaining their partial order. - ’map’: ‘X + Y` performs a merge where the array positions of all keys in `X` are preserved but the values are overwritten by values in `Y` when the key sets of `X` and `Y` intersect. Elements in `Y` with non-intersecting keys are appended, retaining their partial order.



23
24
25
 
# File 'lib/zilla/models/io_k8s_apiextensions_apiserver_pkg_apis_apiextensions_v1_validation_rule.rb', line 23

def rule
  @rule
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



34
35
36
 
# File 'lib/zilla/models/io_k8s_apiextensions_apiserver_pkg_apis_apiextensions_v1_validation_rule.rb', line 34

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



26
27
28
29
30
31
 
# File 'lib/zilla/models/io_k8s_apiextensions_apiserver_pkg_apis_apiextensions_v1_validation_rule.rb', line 26

def self.attribute_map
  {
    message: :message,
    rule: :rule
  }
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



118
119
120
 
# File 'lib/zilla/models/io_k8s_apiextensions_apiserver_pkg_apis_apiextensions_v1_validation_rule.rb', line 118

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



47
48
49
 
# File 'lib/zilla/models/io_k8s_apiextensions_apiserver_pkg_apis_apiextensions_v1_validation_rule.rb', line 47

def self.openapi_nullable
  Set.new([])
end

.openapi_types ⇒ Object

Attribute type mapping.



39
40
41
42
43
44
 
# File 'lib/zilla/models/io_k8s_apiextensions_apiserver_pkg_apis_apiextensions_v1_validation_rule.rb', line 39

def self.openapi_types
  {
    message: :String,
    rule: :String
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



95
96
97
98
99
100
101
 
# File 'lib/zilla/models/io_k8s_apiextensions_apiserver_pkg_apis_apiextensions_v1_validation_rule.rb', line 95

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

  self.class == other.class &&
    message == other.message &&
    rule == other.rule
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/zilla/models/io_k8s_apiextensions_apiserver_pkg_apis_apiextensions_v1_validation_rule.rb', line 152

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = Zilla.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/zilla/models/io_k8s_apiextensions_apiserver_pkg_apis_apiextensions_v1_validation_rule.rb', line 223

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

#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



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/zilla/models/io_k8s_apiextensions_apiserver_pkg_apis_apiextensions_v1_validation_rule.rb', line 125

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      send("#{key}=", nil)
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        send("#{key}=", attributes[self.class.attribute_map[key]].map do |v|
                          _deserialize(::Regexp.last_match(1), v)
                        end)
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


105
106
107
 
# File 'lib/zilla/models/io_k8s_apiextensions_apiserver_pkg_apis_apiextensions_v1_validation_rule.rb', line 105

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



111
112
113
 
# File 'lib/zilla/models/io_k8s_apiextensions_apiserver_pkg_apis_apiextensions_v1_validation_rule.rb', line 111

def hash
  [message, rule].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



78
79
80
81
82
83
 
# File 'lib/zilla/models/io_k8s_apiextensions_apiserver_pkg_apis_apiextensions_v1_validation_rule.rb', line 78

def list_invalid_properties
  invalid_properties = []
  invalid_properties.push('invalid value for "rule", rule cannot be nil.') if @rule.nil?

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



199
200
201
 
# File 'lib/zilla/models/io_k8s_apiextensions_apiserver_pkg_apis_apiextensions_v1_validation_rule.rb', line 199

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/zilla/models/io_k8s_apiextensions_apiserver_pkg_apis_apiextensions_v1_validation_rule.rb', line 205

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    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



193
194
195
 
# File 'lib/zilla/models/io_k8s_apiextensions_apiserver_pkg_apis_apiextensions_v1_validation_rule.rb', line 193

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



87
88
89
90
91
 
# File 'lib/zilla/models/io_k8s_apiextensions_apiserver_pkg_apis_apiextensions_v1_validation_rule.rb', line 87

def valid?
  return false if @rule.nil?

  true
end