Class: Kubernetes::V1beta1SubjectRulesReviewStatus

Inherits:
Object
  • Object
show all
Defined in:
lib/kubernetes/models/v1beta1_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 = {}) ⇒ V1beta1SubjectRulesReviewStatus

Initializes the object

Parameters:

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

    Model attributes in the form of hash



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/kubernetes/models/v1beta1_subject_rules_review_status.rb', line 52

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.transform_keys(&:to_sym)

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

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

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

  return unless attributes.key?(:resourceRules)
  return unless (value = attributes[:resourceRules]).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.



19
20
21
 
# File 'lib/kubernetes/models/v1beta1_subject_rules_review_status.rb', line 19

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.



22
23
24
 
# File 'lib/kubernetes/models/v1beta1_subject_rules_review_status.rb', line 22

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.



25
26
27
 
# File 'lib/kubernetes/models/v1beta1_subject_rules_review_status.rb', line 25

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.



28
29
30
 
# File 'lib/kubernetes/models/v1beta1_subject_rules_review_status.rb', line 28

def resource_rules
  @resource_rules
end

Class Method Details

.attribute_map ⇒ Object

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



31
32
33
34
35
36
37
38
 
# File 'lib/kubernetes/models/v1beta1_subject_rules_review_status.rb', line 31

def self.attribute_map
  {
    evaluation_error: :evaluationError,
    incomplete: :incomplete,
    non_resource_rules: :nonResourceRules,
    resource_rules: :resourceRules
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



41
42
43
44
45
46
47
48
 
# File 'lib/kubernetes/models/v1beta1_subject_rules_review_status.rb', line 41

def self.swagger_types
  {
    evaluation_error: :String,
    incomplete: :BOOLEAN,
    non_resource_rules: :'Array<V1beta1NonResourceRule>',
    resource_rules: :'Array<V1beta1ResourceRule>'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



103
104
105
106
107
108
109
110
111
 
# File 'lib/kubernetes/models/v1beta1_subject_rules_review_status.rb', line 103

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



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
 
# File 'lib/kubernetes/models/v1beta1_subject_rules_review_status.rb', line 152

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    temp_model = Kubernetes.const_get(type).new
    temp_model.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



219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/kubernetes/models/v1beta1_subject_rules_review_status.rb', line 219

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



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

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

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/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)
        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


115
116
117
 
# File 'lib/kubernetes/models/v1beta1_subject_rules_review_status.rb', line 115

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



121
122
123
 
# File 'lib/kubernetes/models/v1beta1_subject_rules_review_status.rb', line 121

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 properies with the reasons



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/kubernetes/models/v1beta1_subject_rules_review_status.rb', line 74

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

  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



198
199
200
 
# File 'lib/kubernetes/models/v1beta1_subject_rules_review_status.rb', line 198

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



204
205
206
207
208
209
210
211
212
213
 
# File 'lib/kubernetes/models/v1beta1_subject_rules_review_status.rb', line 204

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = send(attr)
    next if value.nil?

    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



192
193
194
 
# File 'lib/kubernetes/models/v1beta1_subject_rules_review_status.rb', line 192

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



93
94
95
96
97
98
99
 
# File 'lib/kubernetes/models/v1beta1_subject_rules_review_status.rb', line 93

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

  true
end