Class: Kubernetes::V1ClusterRole

Inherits:
Object
  • Object
show all
Defined in:
lib/kubernetes/models/v1_cluster_role.rb

Overview

ClusterRole is a cluster level, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding or ClusterRoleBinding.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ V1ClusterRole

Initializes the object



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/kubernetes/models/v1_cluster_role.rb', line 57

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

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

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

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

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

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

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

  self.rules = value
end

Instance Attribute Details

#aggregation_rule ⇒ Object

AggregationRule is an optional field that describes how to build the Rules for this ClusterRole. If AggregationRule is set, then the Rules are controller managed and direct changes to Rules will be stomped by the controller.



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

def aggregation_rule
  @aggregation_rule
end

#api_version ⇒ Object

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: git.k8s.io/community/contributors/devel/api-conventions.md#resources



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

def api_version
  @api_version
end

#kind ⇒ Object

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds



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

def kind
  @kind
end

#metadata ⇒ Object

Standard object’s metadata.



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

def metadata
  @metadata
end

#rules ⇒ Object

Rules holds all the PolicyRules for this ClusterRole



31
32
33
 
# File 'lib/kubernetes/models/v1_cluster_role.rb', line 31

def rules
  @rules
end

Class Method Details

.attribute_map ⇒ Object

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



34
35
36
37
38
39
40
41
42
 
# File 'lib/kubernetes/models/v1_cluster_role.rb', line 34

def self.attribute_map
  {
    aggregation_rule: :aggregationRule,
    api_version: :apiVersion,
    kind: :kind,
    metadata: :metadata,
    rules: :rules
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



45
46
47
48
49
50
51
52
53
 
# File 'lib/kubernetes/models/v1_cluster_role.rb', line 45

def self.swagger_types
  {
    aggregation_rule: :V1AggregationRule,
    api_version: :String,
    kind: :String,
    metadata: :V1ObjectMeta,
    rules: :'Array<V1PolicyRule>'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.



96
97
98
99
100
101
102
103
104
105
 
# File 'lib/kubernetes/models/v1_cluster_role.rb', line 96

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

  self.class == other.class &&
    aggregation_rule == other.aggregation_rule &&
    api_version == other.api_version &&
    kind == other.kind &&
    metadata == other.metadata &&
    rules == other.rules
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



146
147
148
149
150
151
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
 
# File 'lib/kubernetes/models/v1_cluster_role.rb', line 146

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



213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/kubernetes/models/v1_cluster_role.rb', line 213

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



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/kubernetes/models/v1_cluster_role.rb', line 122

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

See Also:

  • `==` method


109
110
111
 
# File 'lib/kubernetes/models/v1_cluster_role.rb', line 109

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.



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

def hash
  [aggregation_rule, api_version, kind, metadata, rules].hash
end

#list_invalid_properties ⇒ Object

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



79
80
81
82
83
84
 
# File 'lib/kubernetes/models/v1_cluster_role.rb', line 79

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

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



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

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



198
199
200
201
202
203
204
205
206
207
 
# File 'lib/kubernetes/models/v1_cluster_role.rb', line 198

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



186
187
188
 
# File 'lib/kubernetes/models/v1_cluster_role.rb', line 186

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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



88
89
90
91
92
 
# File 'lib/kubernetes/models/v1_cluster_role.rb', line 88

def valid?
  return false if @rules.nil?

  true
end