Class: Kubernetes::V2alpha1CronJobSpec

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

Overview

CronJobSpec describes how the job execution will look like and when it will actually run.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ V2alpha1CronJobSpec

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
93
94
 
# File 'lib/kubernetes/models/v2alpha1_cron_job_spec.rb', line 67

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#concurrency_policy ⇒ Object

Specifies how to treat concurrent executions of a Job. Valid values are: - "Allow" (default): allows CronJobs to run concurrently; - "Forbid": forbids concurrent runs, skipping next run if previous run hasn’t finished yet; - "Replace": cancels currently running job and replaces it with a new one



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

def concurrency_policy
  @concurrency_policy
end

#failed_jobs_history_limit ⇒ Object

The number of failed finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified.



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

def failed_jobs_history_limit
  @failed_jobs_history_limit
end

#job_template ⇒ Object

Specifies the job that will be created when executing a CronJob.



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

def job_template
  @job_template
end

#schedule ⇒ Object

The schedule in Cron format, see en.wikipedia.org/wiki/Cron.



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

def schedule
  @schedule
end

#starting_deadline_seconds ⇒ Object

Optional deadline in seconds for starting the job if it misses scheduled time for any reason. Missed jobs executions will be counted as failed ones.



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

def starting_deadline_seconds
  @starting_deadline_seconds
end

#successful_jobs_history_limit ⇒ Object

The number of successful finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified.



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

def successful_jobs_history_limit
  @successful_jobs_history_limit
end

#suspend ⇒ Object

This flag tells the controller to suspend subsequent executions, it does not apply to already started executions. Defaults to false.



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

def suspend
  @suspend
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/v2alpha1_cron_job_spec.rb', line 40

def self.attribute_map
  {
    concurrency_policy: :concurrencyPolicy,
    failed_jobs_history_limit: :failedJobsHistoryLimit,
    job_template: :jobTemplate,
    schedule: :schedule,
    starting_deadline_seconds: :startingDeadlineSeconds,
    successful_jobs_history_limit: :successfulJobsHistoryLimit,
    suspend: :suspend
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    concurrency_policy: :String,
    failed_jobs_history_limit: :Integer,
    job_template: :V2alpha1JobTemplateSpec,
    schedule: :String,
    starting_deadline_seconds: :Integer,
    successful_jobs_history_limit: :Integer,
    suspend: :BOOLEAN
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/kubernetes/models/v2alpha1_cron_job_spec.rb', line 122

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

  self.class == other.class &&
    concurrency_policy == other.concurrency_policy &&
    failed_jobs_history_limit == other.failed_jobs_history_limit &&
    job_template == other.job_template &&
    schedule == other.schedule &&
    starting_deadline_seconds == other.starting_deadline_seconds &&
    successful_jobs_history_limit == other.successful_jobs_history_limit &&
    suspend == other.suspend
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



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
203
204
205
206
207
208
209
210
211
 
# File 'lib/kubernetes/models/v2alpha1_cron_job_spec.rb', line 175

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



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

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



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/kubernetes/models/v2alpha1_cron_job_spec.rb', line 151

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


137
138
139
 
# File 'lib/kubernetes/models/v2alpha1_cron_job_spec.rb', line 137

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



143
144
145
146
 
# File 'lib/kubernetes/models/v2alpha1_cron_job_spec.rb', line 143

def hash
  [concurrency_policy, failed_jobs_history_limit, job_template, schedule,
   starting_deadline_seconds, successful_jobs_history_limit, suspend].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



98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/kubernetes/models/v2alpha1_cron_job_spec.rb', line 98

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

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



221
222
223
 
# File 'lib/kubernetes/models/v2alpha1_cron_job_spec.rb', line 221

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



227
228
229
230
231
232
233
234
235
236
 
# File 'lib/kubernetes/models/v2alpha1_cron_job_spec.rb', line 227

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



215
216
217
 
# File 'lib/kubernetes/models/v2alpha1_cron_job_spec.rb', line 215

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



113
114
115
116
117
118
 
# File 'lib/kubernetes/models/v2alpha1_cron_job_spec.rb', line 113

def valid?
  return false if @job_template.nil?
  return false if @schedule.nil?

  true
end