Class: Kubernetes::V1DeploymentSpec

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

Overview

DeploymentSpec is the specification of the desired behavior of the Deployment.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ V1DeploymentSpec

Initializes the object

Parameters:

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

    Model attributes in the form of hash



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/kubernetes/models/v1_deployment_spec.rb', line 72

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

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

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

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

  if attributes.key?(:progressDeadlineSeconds)
    self.progress_deadline_seconds = attributes[:progressDeadlineSeconds]
  end

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

  if attributes.key?(:revisionHistoryLimit)
    self.revision_history_limit = attributes[:revisionHistoryLimit]
  end

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

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

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

Instance Attribute Details

#min_ready_seconds ⇒ Object

Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready)



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

def min_ready_seconds
  @min_ready_seconds
end

#paused ⇒ Object

Indicates that the deployment is paused.



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

def paused
  @paused
end

#progress_deadline_seconds ⇒ Object

The maximum time in seconds for a deployment to make progress before it is considered to be failed. The deployment controller will continue to process failed deployments and a condition with a ProgressDeadlineExceeded reason will be surfaced in the deployment status. Note that progress will not be estimated during the time a deployment is paused. Defaults to 600s.



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

def progress_deadline_seconds
  @progress_deadline_seconds
end

#replicas ⇒ Object

Number of desired pods. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1.



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

def replicas
  @replicas
end

#revision_history_limit ⇒ Object

The number of old ReplicaSets to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified. Defaults to 10.



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

def revision_history_limit
  @revision_history_limit
end

#selector ⇒ Object

Label selector for pods. Existing ReplicaSets whose pods are selected by this will be the ones affected by this deployment. It must match the pod template’s labels.



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

def selector
  @selector
end

#strategy ⇒ Object

The deployment strategy to use to replace existing pods with new ones.



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

def strategy
  @strategy
end

#template ⇒ Object

Template describes the pods that will be created.



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

def template
  @template
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    min_ready_seconds: :minReadySeconds,
    paused: :paused,
    progress_deadline_seconds: :progressDeadlineSeconds,
    replicas: :replicas,
    revision_history_limit: :revisionHistoryLimit,
    selector: :selector,
    strategy: :strategy,
    template: :template
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/kubernetes/models/v1_deployment_spec.rb', line 57

def self.swagger_types
  {
    min_ready_seconds: :Integer,
    paused: :BOOLEAN,
    progress_deadline_seconds: :Integer,
    replicas: :Integer,
    revision_history_limit: :Integer,
    selector: :V1LabelSelector,
    strategy: :V1DeploymentStrategy,
    template: :V1PodTemplateSpec
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/kubernetes/models/v1_deployment_spec.rb', line 125

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

  self.class == other.class &&
    min_ready_seconds == other.min_ready_seconds &&
    paused == other.paused &&
    progress_deadline_seconds == other.progress_deadline_seconds &&
    replicas == other.replicas &&
    revision_history_limit == other.revision_history_limit &&
    selector == other.selector &&
    strategy == other.strategy &&
    template == other.template
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



179
180
181
182
183
184
185
186
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
 
# File 'lib/kubernetes/models/v1_deployment_spec.rb', line 179

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



246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/kubernetes/models/v1_deployment_spec.rb', line 246

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



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/kubernetes/models/v1_deployment_spec.rb', line 155

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


141
142
143
 
# File 'lib/kubernetes/models/v1_deployment_spec.rb', line 141

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



147
148
149
150
 
# File 'lib/kubernetes/models/v1_deployment_spec.rb', line 147

def hash
  [min_ready_seconds, paused, progress_deadline_seconds, replicas, revision_history_limit,
   selector, strategy, template].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



101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/kubernetes/models/v1_deployment_spec.rb', line 101

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

  if @template.nil?
    invalid_properties.push("invalid value for 'template', template 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



225
226
227
 
# File 'lib/kubernetes/models/v1_deployment_spec.rb', line 225

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



231
232
233
234
235
236
237
238
239
240
 
# File 'lib/kubernetes/models/v1_deployment_spec.rb', line 231

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



219
220
221
 
# File 'lib/kubernetes/models/v1_deployment_spec.rb', line 219

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



116
117
118
119
120
121
 
# File 'lib/kubernetes/models/v1_deployment_spec.rb', line 116

def valid?
  return false if @selector.nil?
  return false if @template.nil?

  true
end