Class: Kubernetes::V1ServicePort

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

Overview

ServicePort contains information on service’s port.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ V1ServicePort

Initializes the object



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/kubernetes/models/v1_service_port.rb', line 57

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

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

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

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

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

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

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

Instance Attribute Details

#name ⇒ Object

The name of this port within the service. This must be a DNS_LABEL. All ports within a ServiceSpec must have unique names. This maps to the ‘Name’ field in EndpointPort objects. Optional if only one ServicePort is defined on this service.



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

def name
  @name
end

#node_port ⇒ Object

The port on each node on which this service is exposed when type=NodePort or LoadBalancer. Usually assigned by the system. If specified, it will be allocated to the service if unused or else creation of the service will fail. Default is to auto-allocate a port if the ServiceType of this Service requires one. More info: kubernetes.io/docs/concepts/services-networking/service/#type-nodeport



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

def node_port
  @node_port
end

#port ⇒ Object

The port that will be exposed by this service.



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

def port
  @port
end

#protocol ⇒ Object

The IP protocol for this port. Supports "TCP", "UDP", and "SCTP". Default is TCP.



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

def protocol
  @protocol
end

#target_port ⇒ Object

Number or name of the port to access on the pods targeted by the service. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. If this is a string, it will be looked up as a named port in the target Pod’s container ports. If this is not specified, the value of the ‘port’ field is used (an identity map). This field is ignored for services with clusterIP=None, and should be omitted or set equal to the ‘port’ field. More info: kubernetes.io/docs/concepts/services-networking/service/#defining-a-service



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

def target_port
  @target_port
end

Class Method Details

.attribute_map ⇒ Object

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



34
35
36
37
38
39
40
41
42
 
# File 'lib/kubernetes/models/v1_service_port.rb', line 34

def self.attribute_map
  {
    name: :name,
    node_port: :nodePort,
    port: :port,
    protocol: :protocol,
    target_port: :targetPort
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



45
46
47
48
49
50
51
52
53
 
# File 'lib/kubernetes/models/v1_service_port.rb', line 45

def self.swagger_types
  {
    name: :String,
    node_port: :Integer,
    port: :Integer,
    protocol: :String,
    target_port: :Object
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.



93
94
95
96
97
98
99
100
101
102
 
# File 'lib/kubernetes/models/v1_service_port.rb', line 93

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

  self.class == other.class &&
    name == other.name &&
    node_port == other.node_port &&
    port == other.port &&
    protocol == other.protocol &&
    target_port == other.target_port
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



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
175
176
177
178
179
 
# File 'lib/kubernetes/models/v1_service_port.rb', line 143

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



210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/kubernetes/models/v1_service_port.rb', line 210

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



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/kubernetes/models/v1_service_port.rb', line 119

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


106
107
108
 
# File 'lib/kubernetes/models/v1_service_port.rb', line 106

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.



112
113
114
 
# File 'lib/kubernetes/models/v1_service_port.rb', line 112

def hash
  [name, node_port, port, protocol, target_port].hash
end

#list_invalid_properties ⇒ Object

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



76
77
78
79
80
81
 
# File 'lib/kubernetes/models/v1_service_port.rb', line 76

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

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



189
190
191
 
# File 'lib/kubernetes/models/v1_service_port.rb', line 189

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



195
196
197
198
199
200
201
202
203
204
 
# File 'lib/kubernetes/models/v1_service_port.rb', line 195

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



183
184
185
 
# File 'lib/kubernetes/models/v1_service_port.rb', line 183

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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



85
86
87
88
89
 
# File 'lib/kubernetes/models/v1_service_port.rb', line 85

def valid?
  return false if @port.nil?

  true
end