Class: Kubernetes::V1APIResource

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

Overview

APIResource specifies the name of a resource and whether it is namespaced.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ V1APIResource

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
105
106
 
# File 'lib/kubernetes/models/v1_api_resource.rb', line 77

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#categories ⇒ Object

categories is a list of the grouped resources this resource belongs to (e.g. ‘all’)



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

def categories
  @categories
end

#group ⇒ Object

group is the preferred group of the resource. Empty implies the group of the containing resource list. For subresources, this may have a different value, for example: Scale".



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

def group
  @group
end

#kind ⇒ Object

kind is the kind for the resource (e.g. ‘Foo’ is the kind for a resource ‘foo’)



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

def kind
  @kind
end

#name ⇒ Object

name is the plural name of the resource.



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

def name
  @name
end

#namespaced ⇒ Object

namespaced indicates if a resource is namespaced or not.



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

def namespaced
  @namespaced
end

#short_names ⇒ Object

shortNames is a list of suggested short names of the resource.



34
35
36
 
# File 'lib/kubernetes/models/v1_api_resource.rb', line 34

def short_names
  @short_names
end

#singular_name ⇒ Object

singularName is the singular name of the resource. This allows clients to handle plural and singular opaquely. The singularName is more correct for reporting status on a single item and both singular and plural are allowed from the kubectl CLI interface.



37
38
39
 
# File 'lib/kubernetes/models/v1_api_resource.rb', line 37

def singular_name
  @singular_name
end

#verbs ⇒ Object

verbs is a list of supported kube verbs (this includes get, list, watch, create, update, patch, delete, deletecollection, and proxy)



40
41
42
 
# File 'lib/kubernetes/models/v1_api_resource.rb', line 40

def verbs
  @verbs
end

#version ⇒ Object

version is the preferred version of the resource. Empty implies the version of the containing resource list For subresources, this may have a different value, for example: v1 (while inside a v1beta1 version of the core resource’s group)".



43
44
45
 
# File 'lib/kubernetes/models/v1_api_resource.rb', line 43

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/kubernetes/models/v1_api_resource.rb', line 46

def self.attribute_map
  {
    categories: :categories,
    group: :group,
    kind: :kind,
    name: :name,
    namespaced: :namespaced,
    short_names: :shortNames,
    singular_name: :singularName,
    verbs: :verbs,
    version: :version
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/kubernetes/models/v1_api_resource.rb', line 61

def self.swagger_types
  {
    categories: :'Array<String>',
    group: :String,
    kind: :String,
    name: :String,
    namespaced: :BOOLEAN,
    short_names: :'Array<String>',
    singular_name: :String,
    verbs: :'Array<String>',
    version: :String
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/kubernetes/models/v1_api_resource.rb', line 143

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

  self.class == other.class &&
    categories == other.categories &&
    group == other.group &&
    kind == other.kind &&
    name == other.name &&
    namespaced == other.namespaced &&
    short_names == other.short_names &&
    singular_name == other.singular_name &&
    verbs == other.verbs &&
    version == other.version
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



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
227
228
229
230
231
232
233
 
# File 'lib/kubernetes/models/v1_api_resource.rb', line 197

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



264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/kubernetes/models/v1_api_resource.rb', line 264

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



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/kubernetes/models/v1_api_resource.rb', line 173

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


160
161
162
 
# File 'lib/kubernetes/models/v1_api_resource.rb', line 160

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



166
167
168
 
# File 'lib/kubernetes/models/v1_api_resource.rb', line 166

def hash
  [categories, group, kind, name, namespaced, short_names, singular_name, verbs, version].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



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/kubernetes/models/v1_api_resource.rb', line 110

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?

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

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

  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



243
244
245
 
# File 'lib/kubernetes/models/v1_api_resource.rb', line 243

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



249
250
251
252
253
254
255
256
257
258
 
# File 'lib/kubernetes/models/v1_api_resource.rb', line 249

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



237
238
239
 
# File 'lib/kubernetes/models/v1_api_resource.rb', line 237

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



131
132
133
134
135
136
137
138
139
 
# File 'lib/kubernetes/models/v1_api_resource.rb', line 131

def valid?
  return false if @kind.nil?
  return false if @name.nil?
  return false if @namespaced.nil?
  return false if @singular_name.nil?
  return false if @verbs.nil?

  true
end