Class: Kubernetes::V1APIServiceSpec

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

Overview

APIServiceSpec contains information for locating and communicating with a server. Only https is supported, though you are able to disable certificate verification.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ V1APIServiceSpec

Initializes the object

Parameters:

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

    Model attributes in the form of hash



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/kubernetes/models/v1_api_service_spec.rb', line 67

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

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

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

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

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

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

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

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

  return unless attributes.key?(:versionPriority)
    self.version_priority = attributes[:versionPriority]
  
end

Instance Attribute Details

#ca_bundle ⇒ Object

CABundle is a PEM encoded CA bundle which will be used to validate an API server’s serving certificate. If unspecified, system trust roots on the apiserver are used.



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

def ca_bundle
  @ca_bundle
end

#group ⇒ Object

Group is the API group name this server hosts



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

def group
  @group
end

#group_priority_minimum ⇒ Object

GroupPriorityMininum is the priority this group should have at least. Higher priority means that the group is preferred by clients over lower priority ones. Note that other versions of this group might specify even higher GroupPriorityMininum values such that the whole group gets a higher priority. The primary sort is based on GroupPriorityMinimum, ordered highest number to lowest (20 before 10). The secondary sort is based on the alphabetical comparison of the name of the object. (v1.bar before v1.foo) We’d recommend something like: *.k8s.io (except extensions) at 18000 and PaaSes (OpenShift, Deis) are recommended to be in the 2000s



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

def group_priority_minimum
  @group_priority_minimum
end

#insecure_skip_tls_verify ⇒ Object

InsecureSkipTLSVerify disables TLS certificate verification when communicating with this server. This is strongly discouraged. You should use the CABundle instead.



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

def insecure_skip_tls_verify
  @insecure_skip_tls_verify
end

#service ⇒ Object

Service is a reference to the service for this API server. It must communicate on port 443 If the Service is nil, that means the handling for the API groupversion is handled locally on this server. The call will simply delegate to the normal handler chain to be fulfilled.



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

def service
  @service
end

#version ⇒ Object

Version is the API version this server hosts. For example, "v1"



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

def version
  @version
end

#version_priority ⇒ Object

VersionPriority controls the ordering of this API version inside of its group. Must be greater than zero. The primary sort is based on VersionPriority, ordered highest to lowest (20 before 10). Since it’s inside of a group, the number can be small, probably in the 10s. In case of equal version priorities, the version string will be used to compute the order inside a group. 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.



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

def version_priority
  @version_priority
end

Class Method Details

.attribute_map ⇒ Object

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



40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/kubernetes/models/v1_api_service_spec.rb', line 40

def self.attribute_map
  {
    ca_bundle: :caBundle,
    group: :group,
    group_priority_minimum: :groupPriorityMinimum,
    insecure_skip_tls_verify: :insecureSkipTLSVerify,
    service: :service,
    version: :version,
    version_priority: :versionPriority
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/kubernetes/models/v1_api_service_spec.rb', line 53

def self.swagger_types
  {
    ca_bundle: :String,
    group: :String,
    group_priority_minimum: :Integer,
    insecure_skip_tls_verify: :BOOLEAN,
    service: :V1ServiceReference,
    version: :String,
    version_priority: :Integer
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/kubernetes/models/v1_api_service_spec.rb', line 141

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

  self.class == other.class &&
    ca_bundle == other.ca_bundle &&
    group == other.group &&
    group_priority_minimum == other.group_priority_minimum &&
    insecure_skip_tls_verify == other.insecure_skip_tls_verify &&
    service == other.service &&
    version == other.version &&
    version_priority == other.version_priority
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



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
224
225
226
227
228
229
 
# File 'lib/kubernetes/models/v1_api_service_spec.rb', line 193

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



260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/kubernetes/models/v1_api_service_spec.rb', line 260

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



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/kubernetes/models/v1_api_service_spec.rb', line 170

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 { |v|
 _deserialize(Regexp.last_match(1), v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


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

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



162
163
164
165
 
# File 'lib/kubernetes/models/v1_api_service_spec.rb', line 162

def hash
  [ca_bundle, group, group_priority_minimum, insecure_skip_tls_verify, service, version, 
version_priority].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



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/kubernetes/models/v1_api_service_spec.rb', line 96

def list_invalid_properties
  invalid_properties = []
  if !@ca_bundle.nil? && @ca_bundle !~ /^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/
    invalid_properties.push("invalid value for 'ca_bundle', must conform to the pattern /^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$/.")
  end

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

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

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

  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



239
240
241
 
# File 'lib/kubernetes/models/v1_api_service_spec.rb', line 239

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



245
246
247
248
249
250
251
252
253
254
 
# File 'lib/kubernetes/models/v1_api_service_spec.rb', line 245

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



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

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



119
120
121
122
123
124
125
126
 
# File 'lib/kubernetes/models/v1_api_service_spec.rb', line 119

def valid?
  return false if !@ca_bundle.nil? && @ca_bundle !~ /^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/
  return false if @group_priority_minimum.nil?
  return false if @service.nil?
  return false if @version_priority.nil?

  true
end