Class: Zilla::IoK8sApiNetworkingV1HTTPIngressPath

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

Overview

HTTPIngressPath associates a path with a backend. Incoming urls matching the path are forwarded to the backend.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ IoK8sApiNetworkingV1HTTPIngressPath

Initializes the object

Parameters:

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

    Model attributes in the form of hash



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
# File 'lib/zilla/models/io_k8s_api_networking_v1_http_ingress_path.rb', line 57

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

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

  return unless attributes.key?(:path_type)

  self.path_type = attributes[:path_type]
end

Instance Attribute Details

#backendObject

Returns the value of attribute backend.



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

def backend
  @backend
end

#pathObject

Path is matched against the path of an incoming request. Currently it can contain characters disallowed from the conventional "path" part of a URL as defined by RFC 3986. Paths must begin with a ‘/’ and must be present when using PathType with value "Exact" or "Prefix".



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

def path
  @path
end

#path_typeObject

PathType determines the interpretation of the Path matching. PathType can be one of the following values: * Exact: Matches the URL path exactly. * Prefix: Matches based on a URL path prefix split by ‘/’. Matching is done on a path element by element basis. A path element refers is the list of labels in the path split by the ‘/’ separator. A request is a match for path p if every p is an element-wise prefix of p of the request path. Note that if the last element of the path is a substring of the last element in request path, it is not a match (e.g. /foo/bar matches /foo/bar/baz, but does not match /foo/barbaz). * ImplementationSpecific: Interpretation of the Path matching is up to the IngressClass. Implementations can treat this as a separate PathType or treat it identically to Prefix or Exact path types. Implementations are required to support all path types.



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

def path_type
  @path_type
end

Class Method Details

.acceptable_attributesObject

Returns all the JSON keys this model knows about



37
38
39
# File 'lib/zilla/models/io_k8s_api_networking_v1_http_ingress_path.rb', line 37

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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



28
29
30
31
32
33
34
# File 'lib/zilla/models/io_k8s_api_networking_v1_http_ingress_path.rb', line 28

def self.attribute_map
  {
    backend: :backend,
    path: :path,
    path_type: :pathType
  }
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



128
129
130
# File 'lib/zilla/models/io_k8s_api_networking_v1_http_ingress_path.rb', line 128

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

.openapi_nullableObject

List of attributes with nullable: true



51
52
53
# File 'lib/zilla/models/io_k8s_api_networking_v1_http_ingress_path.rb', line 51

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

.openapi_typesObject

Attribute type mapping.



42
43
44
45
46
47
48
# File 'lib/zilla/models/io_k8s_api_networking_v1_http_ingress_path.rb', line 42

def self.openapi_types
  {
    backend: :IoK8sApiNetworkingV1IngressBackend,
    path: :String,
    path_type: :String
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



104
105
106
107
108
109
110
111
# File 'lib/zilla/models/io_k8s_api_networking_v1_http_ingress_path.rb', line 104

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

  self.class == other.class &&
    backend == other.backend &&
    path == other.path &&
    path_type == other.path_type
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



162
163
164
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
# File 'lib/zilla/models/io_k8s_api_networking_v1_http_ingress_path.rb', line 162

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



233
234
235
236
237
238
239
240
241
242
243
244
245
# File 'lib/zilla/models/io_k8s_api_networking_v1_http_ingress_path.rb', line 233

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



135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
# File 'lib/zilla/models/io_k8s_api_networking_v1_http_ingress_path.rb', line 135

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


115
116
117
# File 'lib/zilla/models/io_k8s_api_networking_v1_http_ingress_path.rb', line 115

def eql?(other)
  self == other
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



121
122
123
# File 'lib/zilla/models/io_k8s_api_networking_v1_http_ingress_path.rb', line 121

def hash
  [backend, path, path_type].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



84
85
86
87
88
89
90
91
# File 'lib/zilla/models/io_k8s_api_networking_v1_http_ingress_path.rb', line 84

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

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

  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



209
210
211
# File 'lib/zilla/models/io_k8s_api_networking_v1_http_ingress_path.rb', line 209

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



215
216
217
218
219
220
221
222
223
224
225
226
227
# File 'lib/zilla/models/io_k8s_api_networking_v1_http_ingress_path.rb', line 215

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



203
204
205
# File 'lib/zilla/models/io_k8s_api_networking_v1_http_ingress_path.rb', line 203

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



95
96
97
98
99
100
# File 'lib/zilla/models/io_k8s_api_networking_v1_http_ingress_path.rb', line 95

def valid?
  return false if @backend.nil?
  return false if @path_type.nil?

  true
end