Class: Zilla::IoK8sApiNetworkingV1IngressSpec

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

Overview

IngressSpec describes the Ingress the user wishes to exist.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ IoK8sApiNetworkingV1IngressSpec

Initializes the object

Parameters:

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

    Model attributes in the form of hash



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/zilla/models/io_k8s_api_networking_v1_ingress_spec.rb', line 62

def initialize(attributes = {})
  unless attributes.is_a?(Hash)
    raise ArgumentError,
          'The input argument (attributes) must be a hash in `Zilla::IoK8sApiNetworkingV1IngressSpec` 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::IoK8sApiNetworkingV1IngressSpec`. 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

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

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

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

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

  self.tls = value
end

Instance Attribute Details

#default_backend ⇒ Object

Returns the value of attribute default_backend.



19
20
21
 
# File 'lib/zilla/models/io_k8s_api_networking_v1_ingress_spec.rb', line 19

def default_backend
  @default_backend
end

#ingress_class_name ⇒ Object

IngressClassName is the name of an IngressClass cluster resource. Ingress controller implementations use this field to know whether they should be serving this Ingress resource, by a transitive connection (controller -> IngressClass -> Ingress resource). Although the ‘kubernetes.io/ingress.class` annotation (simple constant name) was never formally defined, it was widely supported by Ingress controllers to create a direct binding between Ingress controller and Ingress resources. Newly created Ingress resources should prefer using the field. However, even though the annotation is officially deprecated, for backwards compatibility reasons, ingress controllers should still honor that annotation if present.



22
23
24
 
# File 'lib/zilla/models/io_k8s_api_networking_v1_ingress_spec.rb', line 22

def ingress_class_name
  @ingress_class_name
end

#rules ⇒ Object

A list of host rules used to configure the Ingress. If unspecified, or no rule matches, all traffic is sent to the default backend.



25
26
27
 
# File 'lib/zilla/models/io_k8s_api_networking_v1_ingress_spec.rb', line 25

def rules
  @rules
end

#tls ⇒ Object

TLS configuration. Currently the Ingress only supports a single TLS port, 443. If multiple members of this list specify different hosts, they will be multiplexed on the same port according to the hostname specified through the SNI TLS extension, if the ingress controller fulfilling the ingress supports SNI.



28
29
30
 
# File 'lib/zilla/models/io_k8s_api_networking_v1_ingress_spec.rb', line 28

def tls
  @tls
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



41
42
43
 
# File 'lib/zilla/models/io_k8s_api_networking_v1_ingress_spec.rb', line 41

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



31
32
33
34
35
36
37
38
 
# File 'lib/zilla/models/io_k8s_api_networking_v1_ingress_spec.rb', line 31

def self.attribute_map
  {
    default_backend: :defaultBackend,
    ingress_class_name: :ingressClassName,
    rules: :rules,
    tls: :tls
  }
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



131
132
133
 
# File 'lib/zilla/models/io_k8s_api_networking_v1_ingress_spec.rb', line 131

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



56
57
58
 
# File 'lib/zilla/models/io_k8s_api_networking_v1_ingress_spec.rb', line 56

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

.openapi_types ⇒ Object

Attribute type mapping.



46
47
48
49
50
51
52
53
 
# File 'lib/zilla/models/io_k8s_api_networking_v1_ingress_spec.rb', line 46

def self.openapi_types
  {
    default_backend: :IoK8sApiNetworkingV1IngressBackend,
    ingress_class_name: :String,
    rules: :'Array<IoK8sApiNetworkingV1IngressRule>',
    tls: :'Array<IoK8sApiNetworkingV1IngressTLS>'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

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

  self.class == other.class &&
    default_backend == other.default_backend &&
    ingress_class_name == other.ingress_class_name &&
    rules == other.rules &&
    tls == other.tls
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



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/zilla/models/io_k8s_api_networking_v1_ingress_spec.rb', line 165

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



236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/zilla/models/io_k8s_api_networking_v1_ingress_spec.rb', line 236

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



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/zilla/models/io_k8s_api_networking_v1_ingress_spec.rb', line 138

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


118
119
120
 
# File 'lib/zilla/models/io_k8s_api_networking_v1_ingress_spec.rb', line 118

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



124
125
126
 
# File 'lib/zilla/models/io_k8s_api_networking_v1_ingress_spec.rb', line 124

def hash
  [default_backend, ingress_class_name, rules, tls].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



94
95
96
 
# File 'lib/zilla/models/io_k8s_api_networking_v1_ingress_spec.rb', line 94

def list_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



212
213
214
 
# File 'lib/zilla/models/io_k8s_api_networking_v1_ingress_spec.rb', line 212

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



218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/zilla/models/io_k8s_api_networking_v1_ingress_spec.rb', line 218

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



206
207
208
 
# File 'lib/zilla/models/io_k8s_api_networking_v1_ingress_spec.rb', line 206

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



100
101
102
 
# File 'lib/zilla/models/io_k8s_api_networking_v1_ingress_spec.rb', line 100

def valid?
  true
end