Class: Zilla::IoK8sApiRbacV1PolicyRule

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

Overview

PolicyRule holds information that describes a policy rule, but does not contain information about who the rule applies to or which namespace the rule applies to.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ IoK8sApiRbacV1PolicyRule

Initializes the object

Parameters:

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

    Model attributes in the form of hash



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
# File 'lib/zilla/models/io_k8s_api_rbac_v1_policy_rule.rb', line 68

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

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

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

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

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

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

  self.verbs = value
end

Instance Attribute Details

#api_groupsObject

APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed. "" represents the core API group and "*" represents all API groups.



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

def api_groups
  @api_groups
end

#non_resource_urlsObject

NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path Since non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding. Rules can either apply to API resources (such as "pods" or "secrets") or non-resource URL paths (such as "/api"), but not both.



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

def non_resource_urls
  @non_resource_urls
end

#resource_namesObject

ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.



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

def resource_names
  @resource_names
end

#resourcesObject

Resources is a list of resources this rule applies to. ‘*’ represents all resources.



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

def resources
  @resources
end

#verbsObject

Verbs is a list of Verbs that apply to ALL the ResourceKinds contained in this rule. ‘*’ represents all verbs.



32
33
34
# File 'lib/zilla/models/io_k8s_api_rbac_v1_policy_rule.rb', line 32

def verbs
  @verbs
end

Class Method Details

.acceptable_attributesObject

Returns all the JSON keys this model knows about



46
47
48
# File 'lib/zilla/models/io_k8s_api_rbac_v1_policy_rule.rb', line 46

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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



35
36
37
38
39
40
41
42
43
# File 'lib/zilla/models/io_k8s_api_rbac_v1_policy_rule.rb', line 35

def self.attribute_map
  {
    api_groups: :apiGroups,
    non_resource_urls: :nonResourceURLs,
    resource_names: :resourceNames,
    resources: :resources,
    verbs: :verbs
  }
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



151
152
153
# File 'lib/zilla/models/io_k8s_api_rbac_v1_policy_rule.rb', line 151

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

.openapi_nullableObject

List of attributes with nullable: true



62
63
64
# File 'lib/zilla/models/io_k8s_api_rbac_v1_policy_rule.rb', line 62

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

.openapi_typesObject

Attribute type mapping.



51
52
53
54
55
56
57
58
59
# File 'lib/zilla/models/io_k8s_api_rbac_v1_policy_rule.rb', line 51

def self.openapi_types
  {
    api_groups: :'Array<String>',
    non_resource_urls: :'Array<String>',
    resource_names: :'Array<String>',
    resources: :'Array<String>',
    verbs: :'Array<String>'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



125
126
127
128
129
130
131
132
133
134
# File 'lib/zilla/models/io_k8s_api_rbac_v1_policy_rule.rb', line 125

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

  self.class == other.class &&
    api_groups == other.api_groups &&
    non_resource_urls == other.non_resource_urls &&
    resource_names == other.resource_names &&
    resources == other.resources &&
    verbs == other.verbs
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



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
219
220
221
222
# File 'lib/zilla/models/io_k8s_api_rbac_v1_policy_rule.rb', line 185

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



256
257
258
259
260
261
262
263
264
265
266
267
268
# File 'lib/zilla/models/io_k8s_api_rbac_v1_policy_rule.rb', line 256

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



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
# File 'lib/zilla/models/io_k8s_api_rbac_v1_policy_rule.rb', line 158

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


138
139
140
# File 'lib/zilla/models/io_k8s_api_rbac_v1_policy_rule.rb', line 138

def eql?(other)
  self == other
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



144
145
146
# File 'lib/zilla/models/io_k8s_api_rbac_v1_policy_rule.rb', line 144

def hash
  [api_groups, non_resource_urls, resource_names, resources, verbs].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



108
109
110
111
112
113
# File 'lib/zilla/models/io_k8s_api_rbac_v1_policy_rule.rb', line 108

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

  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



232
233
234
# File 'lib/zilla/models/io_k8s_api_rbac_v1_policy_rule.rb', line 232

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



238
239
240
241
242
243
244
245
246
247
248
249
250
# File 'lib/zilla/models/io_k8s_api_rbac_v1_policy_rule.rb', line 238

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



226
227
228
# File 'lib/zilla/models/io_k8s_api_rbac_v1_policy_rule.rb', line 226

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



117
118
119
120
121
# File 'lib/zilla/models/io_k8s_api_rbac_v1_policy_rule.rb', line 117

def valid?
  return false if @verbs.nil?

  true
end