Class: Zilla::IoK8sApiAuthorizationV1SubjectRulesReviewStatus

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

Overview

SubjectRulesReviewStatus contains the result of a rules check. This check can be incomplete depending on the set of authorizers the server is configured with and any errors experienced during evaluation. Because authorization rules are additive, if a rule appears in a list it’s safe to assume the subject has that permission, even if that list is incomplete.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ IoK8sApiAuthorizationV1SubjectRulesReviewStatus

Initializes the object

Parameters:

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

    Model attributes in the form of hash



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/zilla/models/io_k8s_api_authorization_v1_subject_rules_review_status.rb', line 63

def initialize(attributes = {})
  unless attributes.is_a?(Hash)
    raise ArgumentError,
          'The input argument (attributes) must be a hash in `Zilla::IoK8sApiAuthorizationV1SubjectRulesReviewStatus` 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::IoK8sApiAuthorizationV1SubjectRulesReviewStatus`. 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.evaluation_error = attributes[:evaluation_error] if attributes.key?(:evaluation_error)

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

  if attributes.key?(:non_resource_rules) && (value = attributes[:non_resource_rules]).is_a?(Array)
    self.non_resource_rules = value
  end

  return unless attributes.key?(:resource_rules)
  return unless (value = attributes[:resource_rules]).is_a?(Array)

  self.resource_rules = value
end

Instance Attribute Details

#evaluation_error ⇒ Object

EvaluationError can appear in combination with Rules. It indicates an error occurred during rule evaluation, such as an authorizer that doesn’t support rule evaluation, and that ResourceRules and/or NonResourceRules may be incomplete.



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

def evaluation_error
  @evaluation_error
end

#incomplete ⇒ Object

Incomplete is true when the rules returned by this call are incomplete. This is most commonly encountered when an authorizer, such as an external authorizer, doesn’t support rules evaluation.



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

def incomplete
  @incomplete
end

#non_resource_rules ⇒ Object

NonResourceRules is the list of actions the subject is allowed to perform on non-resources. The list ordering isn’t significant, may contain duplicates, and possibly be incomplete.



26
27
28
 
# File 'lib/zilla/models/io_k8s_api_authorization_v1_subject_rules_review_status.rb', line 26

def non_resource_rules
  @non_resource_rules
end

#resource_rules ⇒ Object

ResourceRules is the list of actions the subject is allowed to perform on resources. The list ordering isn’t significant, may contain duplicates, and possibly be incomplete.



29
30
31
 
# File 'lib/zilla/models/io_k8s_api_authorization_v1_subject_rules_review_status.rb', line 29

def resource_rules
  @resource_rules
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



42
43
44
 
# File 'lib/zilla/models/io_k8s_api_authorization_v1_subject_rules_review_status.rb', line 42

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



32
33
34
35
36
37
38
39
 
# File 'lib/zilla/models/io_k8s_api_authorization_v1_subject_rules_review_status.rb', line 32

def self.attribute_map
  {
    evaluation_error: :evaluationError,
    incomplete: :incomplete,
    non_resource_rules: :nonResourceRules,
    resource_rules: :resourceRules
  }
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



147
148
149
 
# File 'lib/zilla/models/io_k8s_api_authorization_v1_subject_rules_review_status.rb', line 147

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



57
58
59
 
# File 'lib/zilla/models/io_k8s_api_authorization_v1_subject_rules_review_status.rb', line 57

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

.openapi_types ⇒ Object

Attribute type mapping.



47
48
49
50
51
52
53
54
 
# File 'lib/zilla/models/io_k8s_api_authorization_v1_subject_rules_review_status.rb', line 47

def self.openapi_types
  {
    evaluation_error: :String,
    incomplete: :Boolean,
    non_resource_rules: :'Array<IoK8sApiAuthorizationV1NonResourceRule>',
    resource_rules: :'Array<IoK8sApiAuthorizationV1ResourceRule>'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



122
123
124
125
126
127
128
129
130
 
# File 'lib/zilla/models/io_k8s_api_authorization_v1_subject_rules_review_status.rb', line 122

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

  self.class == other.class &&
    evaluation_error == other.evaluation_error &&
    incomplete == other.incomplete &&
    non_resource_rules == other.non_resource_rules &&
    resource_rules == other.resource_rules
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



181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/zilla/models/io_k8s_api_authorization_v1_subject_rules_review_status.rb', line 181

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



252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/zilla/models/io_k8s_api_authorization_v1_subject_rules_review_status.rb', line 252

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



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/zilla/models/io_k8s_api_authorization_v1_subject_rules_review_status.rb', line 154

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


134
135
136
 
# File 'lib/zilla/models/io_k8s_api_authorization_v1_subject_rules_review_status.rb', line 134

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



140
141
142
 
# File 'lib/zilla/models/io_k8s_api_authorization_v1_subject_rules_review_status.rb', line 140

def hash
  [evaluation_error, incomplete, non_resource_rules, resource_rules].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



95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/zilla/models/io_k8s_api_authorization_v1_subject_rules_review_status.rb', line 95

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

  if @non_resource_rules.nil?
    invalid_properties.push('invalid value for "non_resource_rules", non_resource_rules cannot be nil.')
  end

  if @resource_rules.nil?
    invalid_properties.push('invalid value for "resource_rules", resource_rules cannot be nil.')
  end

  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



228
229
230
 
# File 'lib/zilla/models/io_k8s_api_authorization_v1_subject_rules_review_status.rb', line 228

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



234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/zilla/models/io_k8s_api_authorization_v1_subject_rules_review_status.rb', line 234

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



222
223
224
 
# File 'lib/zilla/models/io_k8s_api_authorization_v1_subject_rules_review_status.rb', line 222

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



112
113
114
115
116
117
118
 
# File 'lib/zilla/models/io_k8s_api_authorization_v1_subject_rules_review_status.rb', line 112

def valid?
  return false if @incomplete.nil?
  return false if @non_resource_rules.nil?
  return false if @resource_rules.nil?

  true
end