Class: Kubernetes::V1beta1CustomResourceDefinitionSpec

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

Overview

CustomResourceDefinitionSpec describes how a user wants their resource to appear

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ V1beta1CustomResourceDefinitionSpec

Initializes the object



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
# File 'lib/kubernetes/models/v1beta1_custom_resource_definition_spec.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?(:additionalPrinterColumns) && (value = attributes[:additionalPrinterColumns]).is_a?(Array)
    self.additional_printer_columns = value
  end

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

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

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

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

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

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

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

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

  self.versions = value
end

Instance Attribute Details

#additional_printer_columnsObject

AdditionalPrinterColumns are additional columns shown e.g. in kubectl next to the name. Defaults to a created-at column. Optional, the global columns for all versions. Top-level and per-version columns are mutually exclusive.



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

def additional_printer_columns
  @additional_printer_columns
end

#conversionObject

‘conversion` defines conversion settings for the CRD.



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

def conversion
  @conversion
end

#groupObject

Group is the group this resource belongs in



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

def group
  @group
end

#namesObject

Names are the names used to describe this custom resource



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

def names
  @names
end

#scopeObject

Scope indicates whether this resource is cluster or namespace scoped. Default is namespaced



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

def scope
  @scope
end

#subresourcesObject

Subresources describes the subresources for CustomResource Optional, the global subresources for all versions. Top-level and per-version subresources are mutually exclusive.



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

def subresources
  @subresources
end

#validationObject

Validation describes the validation methods for CustomResources Optional, the global validation schema for all versions. Top-level and per-version schemas are mutually exclusive.



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

def validation
  @validation
end

#versionObject

Version is the version this resource belongs in Should be always first item in Versions field if provided. Optional, but at least one of Version or Versions must be set. Deprecated: Please use ‘Versions`.



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

def version
  @version
end

#versionsObject

Versions is the list of all supported versions for this resource. If Version field is provided, this field is optional. Validation: All versions must use the same validation schema for now. i.e., top level Validation field is applied to all of these versions. Order: The version name will be used to compute the order. If the version string is "kube-like", it will sort above non "kube-like" version strings, which are ordered lexicographically. "Kube-like" versions start with a "v", then are followed by a number (the major version), then optionally the string "alpha" or "beta" and another number (the minor version). These are sorted first by GA > beta > alpha (where GA is a version with no suffix such as beta or alpha), and then by comparing major version, then minor version. An example sorted list of versions: v10, v2, v1, v11beta2, v10beta3, v3beta1, v12alpha1, v11alpha2, foo1, foo10.



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

def versions
  @versions
end

Class Method Details

.attribute_mapObject

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/v1beta1_custom_resource_definition_spec.rb', line 46

def self.attribute_map
  {
    additional_printer_columns: :additionalPrinterColumns,
    conversion: :conversion,
    group: :group,
    names: :names,
    scope: :scope,
    subresources: :subresources,
    validation: :validation,
    version: :version,
    versions: :versions
  }
end

.swagger_typesObject

Attribute type mapping.



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

def self.swagger_types
  {
    additional_printer_columns: :'Array<V1beta1CustomResourceColumnDefinition>',
    conversion: :V1beta1CustomResourceConversion,
    group: :String,
    names: :V1beta1CustomResourceDefinitionNames,
    scope: :String,
    subresources: :V1beta1CustomResourceSubresources,
    validation: :V1beta1CustomResourceValidation,
    version: :String,
    versions: :'Array<V1beta1CustomResourceDefinitionVersion>'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.



132
133
134
135
136
137
138
139
140
141
142
143
144
145
# File 'lib/kubernetes/models/v1beta1_custom_resource_definition_spec.rb', line 132

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

  self.class == other.class &&
    additional_printer_columns == other.additional_printer_columns &&
    conversion == other.conversion &&
    group == other.group &&
    names == other.names &&
    scope == other.scope &&
    subresources == other.subresources &&
    validation == other.validation &&
    version == other.version &&
    versions == other.versions
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



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
223
# File 'lib/kubernetes/models/v1beta1_custom_resource_definition_spec.rb', line 187

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



254
255
256
257
258
259
260
261
262
263
264
265
266
# File 'lib/kubernetes/models/v1beta1_custom_resource_definition_spec.rb', line 254

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



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

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


149
150
151
# File 'lib/kubernetes/models/v1beta1_custom_resource_definition_spec.rb', line 149

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.



155
156
157
158
# File 'lib/kubernetes/models/v1beta1_custom_resource_definition_spec.rb', line 155

def hash
  [additional_printer_columns, conversion, group, names, scope, subresources, validation,
   version, versions].hash
end

#list_invalid_propertiesObject

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



109
110
111
112
113
114
115
116
117
118
# File 'lib/kubernetes/models/v1beta1_custom_resource_definition_spec.rb', line 109

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

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

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

  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)



233
234
235
# File 'lib/kubernetes/models/v1beta1_custom_resource_definition_spec.rb', line 233

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash



239
240
241
242
243
244
245
246
247
248
# File 'lib/kubernetes/models/v1beta1_custom_resource_definition_spec.rb', line 239

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_sString

Returns the string representation of the object



227
228
229
# File 'lib/kubernetes/models/v1beta1_custom_resource_definition_spec.rb', line 227

def to_s
  to_hash.to_s
end

#valid?Boolean

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



122
123
124
125
126
127
128
# File 'lib/kubernetes/models/v1beta1_custom_resource_definition_spec.rb', line 122

def valid?
  return false if @group.nil?
  return false if @names.nil?
  return false if @scope.nil?

  true
end