Class: PulpcoreClient::TaskScheduleResponse

Inherits:
Object
  • Object
show all
Defined in:
lib/pulpcore_client/models/task_schedule_response.rb

Overview

Base serializer for use with [pulpcore.app.models.Model][] This ensures that all Serializers provide values for the ‘pulp_href` field. The class provides a default for the “ref_name“ attribute in the ModelSerializers’s “Meta“ class. This ensures that the OpenAPI definitions of plugins are namespaced properly.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TaskScheduleResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash

[View source]

90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/pulpcore_client/models/task_schedule_response.rb', line 90

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `PulpcoreClient::TaskScheduleResponse` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `PulpcoreClient::TaskScheduleResponse`. 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
  }

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

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

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

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

  if attributes.key?(:'name')
    self.name = attributes[:'name']
  else
    self.name = nil
  end

  if attributes.key?(:'task_name')
    self.task_name = attributes[:'task_name']
  else
    self.task_name = nil
  end

  if attributes.key?(:'dispatch_interval')
    self.dispatch_interval = attributes[:'dispatch_interval']
  else
    self.dispatch_interval = nil
  end

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

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

Instance Attribute Details

#dispatch_interval ⇒ Object

Periodicity of the schedule.


37
38
39
 
# File 'lib/pulpcore_client/models/task_schedule_response.rb', line 37

def dispatch_interval
  @dispatch_interval
end

#last_task ⇒ Object

The last task dispatched by this schedule.


43
44
45
 
# File 'lib/pulpcore_client/models/task_schedule_response.rb', line 43

def last_task
  @last_task
end

#name ⇒ Object

The name of the task schedule.


31
32
33
 
# File 'lib/pulpcore_client/models/task_schedule_response.rb', line 31

def name
  @name
end

#next_dispatch ⇒ Object

Timestamp of the next time the task will be dispatched.


40
41
42
 
# File 'lib/pulpcore_client/models/task_schedule_response.rb', line 40

def next_dispatch
  @next_dispatch
end

#prn ⇒ Object

The Pulp Resource Name (PRN).


22
23
24
 
# File 'lib/pulpcore_client/models/task_schedule_response.rb', line 22

def prn
  @prn
end

#pulp_created ⇒ Object

Timestamp of creation.


25
26
27
 
# File 'lib/pulpcore_client/models/task_schedule_response.rb', line 25

def pulp_created
  @pulp_created
end

#pulp_href ⇒ Object

Returns the value of attribute pulp_href.


19
20
21
 
# File 'lib/pulpcore_client/models/task_schedule_response.rb', line 19

def pulp_href
  @pulp_href
end

#pulp_last_updated ⇒ Object

Timestamp of the last time this resource was updated. Note: for immutable resources - like content, repository versions, and publication - pulp_created and pulp_last_updated dates will be the same.


28
29
30
 
# File 'lib/pulpcore_client/models/task_schedule_response.rb', line 28

def pulp_last_updated
  @pulp_last_updated
end

#task_name ⇒ Object

The name of the task to be scheduled.


34
35
36
 
# File 'lib/pulpcore_client/models/task_schedule_response.rb', line 34

def task_name
  @task_name
end

Class Method Details

._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

[View source]

226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/pulpcore_client/models/task_schedule_response.rb', line 226

def self._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 = PulpcoreClient.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about

[View source]

61
62
63
 
# File 'lib/pulpcore_client/models/task_schedule_response.rb', line 61

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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

[View source]

46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/pulpcore_client/models/task_schedule_response.rb', line 46

def self.attribute_map
  {
    :'pulp_href' => :'pulp_href',
    :'prn' => :'prn',
    :'pulp_created' => :'pulp_created',
    :'pulp_last_updated' => :'pulp_last_updated',
    :'name' => :'name',
    :'task_name' => :'task_name',
    :'dispatch_interval' => :'dispatch_interval',
    :'next_dispatch' => :'next_dispatch',
    :'last_task' => :'last_task'
  }
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

[View source]

202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/pulpcore_client/models/task_schedule_response.rb', line 202

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true

[View source]

81
82
83
84
85
86
 
# File 'lib/pulpcore_client/models/task_schedule_response.rb', line 81

def self.openapi_nullable
  Set.new([
    :'dispatch_interval',
    :'next_dispatch',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.

[View source]

66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/pulpcore_client/models/task_schedule_response.rb', line 66

def self.openapi_types
  {
    :'pulp_href' => :'String',
    :'prn' => :'String',
    :'pulp_created' => :'Time',
    :'pulp_last_updated' => :'Time',
    :'name' => :'String',
    :'task_name' => :'String',
    :'dispatch_interval' => :'String',
    :'next_dispatch' => :'Time',
    :'last_task' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared

[View source]

173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/pulpcore_client/models/task_schedule_response.rb', line 173

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      pulp_href == o.pulp_href &&
      prn == o.prn &&
      pulp_created == o.pulp_created &&
      pulp_last_updated == o.pulp_last_updated &&
      name == o.name &&
      task_name == o.task_name &&
      dispatch_interval == o.dispatch_interval &&
      next_dispatch == o.next_dispatch &&
      last_task == o.last_task
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

[View source]

297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/pulpcore_client/models/task_schedule_response.rb', line 297

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method
[View source]

189
190
191
 
# File 'lib/pulpcore_client/models/task_schedule_response.rb', line 189

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code

[View source]

195
196
197
 
# File 'lib/pulpcore_client/models/task_schedule_response.rb', line 195

def hash
  [pulp_href, prn, pulp_created, pulp_last_updated, name, task_name, dispatch_interval, next_dispatch, last_task].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons

[View source]

148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/pulpcore_client/models/task_schedule_response.rb', line 148

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

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

[View source]

273
274
275
 
# File 'lib/pulpcore_client/models/task_schedule_response.rb', line 273

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

[View source]

279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/pulpcore_client/models/task_schedule_response.rb', line 279

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.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_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object

[View source]

267
268
269
 
# File 'lib/pulpcore_client/models/task_schedule_response.rb', line 267

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

[View source]

164
165
166
167
168
169
 
# File 'lib/pulpcore_client/models/task_schedule_response.rb', line 164

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @name.nil?
  return false if @task_name.nil?
  true
end