Class: Kubernetes::V1alpha1Subject

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

Overview

Subject contains a reference to the object or user identities a role binding applies to. This can either hold a direct API object reference, or a value for non-objects such as user and group names.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ V1alpha1Subject

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
 
# File 'lib/kubernetes/models/v1alpha1_subject.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.api_version = attributes[:apiVersion] if attributes.key?(:apiVersion)

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

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

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

Instance Attribute Details

#api_version ⇒ Object

APIVersion holds the API group and version of the referenced subject. Defaults to "v1" for ServiceAccount subjects. Defaults to "rbac.authorization.k8s.io/v1alpha1" for User and Group subjects.



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

def api_version
  @api_version
end

#kind ⇒ Object

Kind of object being referenced. Values defined by this API group are "User", "Group", and "ServiceAccount". If the Authorizer does not recognized the kind value, the Authorizer should report an error.



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

def kind
  @kind
end

#name ⇒ Object

Name of the object being referenced.



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

def name
  @name
end

#namespace ⇒ Object

Namespace of the referenced object. If the object kind is non-namespace, such as "User" or "Group", and this value is not empty the Authorizer should report an error.



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

def namespace
  @namespace
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/v1alpha1_subject.rb', line 31

def self.attribute_map
  {
    api_version: :apiVersion,
    kind: :kind,
    name: :name,
    namespace: :namespace
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    api_version: :String,
    kind: :String,
    name: :String,
    namespace: :String
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



89
90
91
92
93
94
95
96
97
 
# File 'lib/kubernetes/models/v1alpha1_subject.rb', line 89

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

  self.class == other.class &&
    api_version == other.api_version &&
    kind == other.kind &&
    name == other.name &&
    namespace == other.namespace
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



138
139
140
141
142
143
144
145
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
 
# File 'lib/kubernetes/models/v1alpha1_subject.rb', line 138

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



205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/kubernetes/models/v1alpha1_subject.rb', line 205

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



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/kubernetes/models/v1alpha1_subject.rb', line 114

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


101
102
103
 
# File 'lib/kubernetes/models/v1alpha1_subject.rb', line 101

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



107
108
109
 
# File 'lib/kubernetes/models/v1alpha1_subject.rb', line 107

def hash
  [api_version, kind, name, namespace].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



69
70
71
72
73
74
75
76
 
# File 'lib/kubernetes/models/v1alpha1_subject.rb', line 69

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

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



184
185
186
 
# File 'lib/kubernetes/models/v1alpha1_subject.rb', line 184

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



190
191
192
193
194
195
196
197
198
199
 
# File 'lib/kubernetes/models/v1alpha1_subject.rb', line 190

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



178
179
180
 
# File 'lib/kubernetes/models/v1alpha1_subject.rb', line 178

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



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

def valid?
  return false if @kind.nil?
  return false if @name.nil?

  true
end