Class: Zilla::IoK8sApiFlowcontrolV1beta1ResourcePolicyRule

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

Overview

ResourcePolicyRule is a predicate that matches some resource requests, testing the request’s verb and the target resource. A ResourcePolicyRule matches a resource request if and only if: (a) at least one member of verbs matches the request, (b) at least one member of apiGroups matches the request, © at least one member of resources matches the request, and (d) either (d1) the request does not specify a namespace (i.e., ‘Namespace==""`) and clusterScope is true or (d2) the request specifies a namespace and least one member of namespaces matches the request’s namespace.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ IoK8sApiFlowcontrolV1beta1ResourcePolicyRule

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
 
# File 'lib/zilla/models/io_k8s_api_flowcontrol_v1beta1_resource_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::IoK8sApiFlowcontrolV1beta1ResourcePolicyRule` 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::IoK8sApiFlowcontrolV1beta1ResourcePolicyRule`. 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

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

  if attributes.key?(:namespaces) && (value = attributes[:namespaces]).is_a?(Array)
    self.namespaces = 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_groups ⇒ Object

‘apiGroups` is a list of matching API groups and may not be empty. "*" matches all API groups and, if present, must be the only entry. Required.



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

def api_groups
  @api_groups
end

#cluster_scope ⇒ Object

‘clusterScope` indicates whether to match requests that do not specify a namespace (which happens either because the resource is not namespaced or the request targets all namespaces). If this field is omitted or false then the `namespaces` field must contain a non-empty list.



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

def cluster_scope
  @cluster_scope
end

#namespaces ⇒ Object

‘namespaces` is a list of target namespaces that restricts matches. A request that specifies a target namespace matches only if either (a) this list contains that target namespace or (b) this list contains "*". Note that "*" matches any specified namespace but does not match a request that _does not specify_ a namespace (see the `clusterScope` field for that). This list may be empty, but only if `clusterScope` is true.



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

def namespaces
  @namespaces
end

#resources ⇒ Object

‘resources` is a list of matching resources (i.e., lowercase and plural) with, if desired, subresource. For example, [ "services", "nodes/status" ]. This list may not be empty. "*" matches all resources and, if present, must be the only entry. Required.



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

def resources
  @resources
end

#verbs ⇒ Object

‘verbs` is a list of matching verbs and may not be empty. "*" matches all verbs and, if present, must be the only entry. Required.



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

def verbs
  @verbs
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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_flowcontrol_v1beta1_resource_policy_rule.rb', line 35

def self.attribute_map
  {
    api_groups: :apiGroups,
    cluster_scope: :clusterScope,
    namespaces: :namespaces,
    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



155
156
157
 
# File 'lib/zilla/models/io_k8s_api_flowcontrol_v1beta1_resource_policy_rule.rb', line 155

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    api_groups: :'Array<String>',
    cluster_scope: :Boolean,
    namespaces: :'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



129
130
131
132
133
134
135
136
137
138
 
# File 'lib/zilla/models/io_k8s_api_flowcontrol_v1beta1_resource_policy_rule.rb', line 129

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

  self.class == other.class &&
    api_groups == other.api_groups &&
    cluster_scope == other.cluster_scope &&
    namespaces == other.namespaces &&
    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



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
223
224
225
226
 
# File 'lib/zilla/models/io_k8s_api_flowcontrol_v1beta1_resource_policy_rule.rb', line 189

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



260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/zilla/models/io_k8s_api_flowcontrol_v1beta1_resource_policy_rule.rb', line 260

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



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/zilla/models/io_k8s_api_flowcontrol_v1beta1_resource_policy_rule.rb', line 162

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


142
143
144
 
# File 'lib/zilla/models/io_k8s_api_flowcontrol_v1beta1_resource_policy_rule.rb', line 142

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



148
149
150
 
# File 'lib/zilla/models/io_k8s_api_flowcontrol_v1beta1_resource_policy_rule.rb', line 148

def hash
  [api_groups, cluster_scope, namespaces, resources, verbs].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



106
107
108
109
110
111
112
113
114
115
 
# File 'lib/zilla/models/io_k8s_api_flowcontrol_v1beta1_resource_policy_rule.rb', line 106

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

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

  invalid_properties.push('invalid value for "verbs", verbs cannot be nil.') if @verbs.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



236
237
238
 
# File 'lib/zilla/models/io_k8s_api_flowcontrol_v1beta1_resource_policy_rule.rb', line 236

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



242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/zilla/models/io_k8s_api_flowcontrol_v1beta1_resource_policy_rule.rb', line 242

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



230
231
232
 
# File 'lib/zilla/models/io_k8s_api_flowcontrol_v1beta1_resource_policy_rule.rb', line 230

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



119
120
121
122
123
124
125
 
# File 'lib/zilla/models/io_k8s_api_flowcontrol_v1beta1_resource_policy_rule.rb', line 119

def valid?
  return false if @api_groups.nil?
  return false if @resources.nil?
  return false if @verbs.nil?

  true
end