Class: InfluxDB2::API::Task

Inherits:
Object
  • Object
show all
Defined in:
apis/lib/influxdb2/apis/generated/models/task.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Task

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'apis/lib/influxdb2/apis/generated/models/task.rb', line 148

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `InfluxDB2::Task` 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 `InfluxDB2::Task`. 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?(:'id')
    self.id = attributes[:'id']
  end

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

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

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

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

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

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

  if attributes.key?(:'labels')
    if (value = attributes[:'labels']).is_a?(Array)
      self.labels = value
    end
  end

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#authorization_id ⇒ Object

An authorization ID. Identifies the authorization used when the task communicates with the query engine. To find an authorization ID, use the [`GET /api/v2/authorizations` endpoint](#operation/GetAuthorizations) to list authorizations.



41
42
43
 
# File 'apis/lib/influxdb2/apis/generated/models/task.rb', line 41

def authorization_id
  @authorization_id
end

#created_at ⇒ Object

Returns the value of attribute created_at.



62
63
64
 
# File 'apis/lib/influxdb2/apis/generated/models/task.rb', line 62

def created_at
  @created_at
end

#cron ⇒ Object

A [Cron expression](en.wikipedia.org/wiki/Cron#Overview) that defines the schedule on which the task runs. InfluxDB uses the system time when evaluating Cron expressions.



50
51
52
 
# File 'apis/lib/influxdb2/apis/generated/models/task.rb', line 50

def cron
  @cron
end

#description ⇒ Object

A description of the task.



31
32
33
 
# File 'apis/lib/influxdb2/apis/generated/models/task.rb', line 31

def description
  @description
end

#every ⇒ Object

The interval ([duration literal](docs.influxdata.com/influxdb/latest/reference/glossary/#rfc3339-timestamp)) at which the task runs. `every` also determines when the task first runs, depending on the specified time.



47
48
49
 
# File 'apis/lib/influxdb2/apis/generated/models/task.rb', line 47

def every
  @every
end

#flux ⇒ Object

Flux with [task configuration options](docs.influxdata.com/influxdb/latest/process-data/task-options/) and the script for the task to run. #### Related guides - [Task configuration options](docs.influxdata.com/influxdb/latest/process-data/task-options/)



44
45
46
 
# File 'apis/lib/influxdb2/apis/generated/models/task.rb', line 44

def flux
  @flux
end

#id ⇒ Object

The resource ID that InfluxDB uses to uniquely identify the task.



19
20
21
 
# File 'apis/lib/influxdb2/apis/generated/models/task.rb', line 19

def id
  @id
end

#labels ⇒ Object

Returns the value of attribute labels.



38
39
40
 
# File 'apis/lib/influxdb2/apis/generated/models/task.rb', line 38

def labels
  @labels
end

#last_run_error ⇒ Object

Returns the value of attribute last_run_error.



60
61
62
 
# File 'apis/lib/influxdb2/apis/generated/models/task.rb', line 60

def last_run_error
  @last_run_error
end

#last_run_status ⇒ Object

Returns the value of attribute last_run_status.



58
59
60
 
# File 'apis/lib/influxdb2/apis/generated/models/task.rb', line 58

def last_run_status
  @last_run_status
end

#latest_completed ⇒ Object

A timestamp ([RFC3339 date/time format](docs.influxdata.com/influxdb/latest/reference/glossary/#rfc3339-timestamp)) of the latest scheduled and completed run.



56
57
58
 
# File 'apis/lib/influxdb2/apis/generated/models/task.rb', line 56

def latest_completed
  @latest_completed
end

#links ⇒ Object

Returns the value of attribute links.



66
67
68
 
# File 'apis/lib/influxdb2/apis/generated/models/task.rb', line 66

def links
  @links
end

#name ⇒ Object

The name of the task.



28
29
30
 
# File 'apis/lib/influxdb2/apis/generated/models/task.rb', line 28

def name
  @name
end

#offset ⇒ Object

A [duration](docs.influxdata.com/flux/v0.x/spec/lexical-elements/#duration-literals) to delay execution of the task after the scheduled time has elapsed. `0` removes the offset.



53
54
55
 
# File 'apis/lib/influxdb2/apis/generated/models/task.rb', line 53

def offset
  @offset
end

#org ⇒ Object

An organization name. Identifies the [organization](docs.influxdata.com/influxdb/latest/reference/glossary/#organization) that owns the task.



25
26
27
 
# File 'apis/lib/influxdb2/apis/generated/models/task.rb', line 25

def org
  @org
end

#org_id ⇒ Object

An organization ID. Identifies the [organization](docs.influxdata.com/influxdb/latest/reference/glossary/#organization) that owns the task.



22
23
24
 
# File 'apis/lib/influxdb2/apis/generated/models/task.rb', line 22

def org_id
  @org_id
end

#owner_id ⇒ Object

A user ID. Identifies the [user](docs.influxdata.com/influxdb/latest/reference/glossary/#user) that owns the task. To find a user ID, use the [`GET /api/v2/users` endpoint](#operation/GetUsers) to list users.



34
35
36
 
# File 'apis/lib/influxdb2/apis/generated/models/task.rb', line 34

def owner_id
  @owner_id
end

#status ⇒ Object

Returns the value of attribute status.



36
37
38
 
# File 'apis/lib/influxdb2/apis/generated/models/task.rb', line 36

def status
  @status
end

#updated_at ⇒ Object

Returns the value of attribute updated_at.



64
65
66
 
# File 'apis/lib/influxdb2/apis/generated/models/task.rb', line 64

def updated_at
  @updated_at
end

Class Method Details

.attribute_map ⇒ Object

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



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'apis/lib/influxdb2/apis/generated/models/task.rb', line 91

def self.attribute_map
  {
    :'id' => :'id',
    :'org_id' => :'orgID',
    :'org' => :'org',
    :'name' => :'name',
    :'description' => :'description',
    :'owner_id' => :'ownerID',
    :'status' => :'status',
    :'labels' => :'labels',
    :'authorization_id' => :'authorizationID',
    :'flux' => :'flux',
    :'every' => :'every',
    :'cron' => :'cron',
    :'offset' => :'offset',
    :'latest_completed' => :'latestCompleted',
    :'last_run_status' => :'lastRunStatus',
    :'last_run_error' => :'lastRunError',
    :'created_at' => :'createdAt',
    :'updated_at' => :'updatedAt',
    :'links' => :'links',
  }
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



326
327
328
 
# File 'apis/lib/influxdb2/apis/generated/models/task.rb', line 326

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



141
142
143
144
 
# File 'apis/lib/influxdb2/apis/generated/models/task.rb', line 141

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'apis/lib/influxdb2/apis/generated/models/task.rb', line 116

def self.openapi_types
  {
    :'id' => :'String',
    :'org_id' => :'String',
    :'org' => :'String',
    :'name' => :'String',
    :'description' => :'String',
    :'owner_id' => :'String',
    :'status' => :'TaskStatusType',
    :'labels' => :'Array<Label>',
    :'authorization_id' => :'String',
    :'flux' => :'String',
    :'every' => :'String',
    :'cron' => :'String',
    :'offset' => :'String',
    :'latest_completed' => :'Time',
    :'last_run_status' => :'String',
    :'last_run_error' => :'String',
    :'created_at' => :'Time',
    :'updated_at' => :'Time',
    :'links' => :'TaskLinks'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'apis/lib/influxdb2/apis/generated/models/task.rb', line 287

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      org_id == o.org_id &&
      org == o.org &&
      name == o.name &&
      description == o.description &&
      owner_id == o.owner_id &&
      status == o.status &&
      labels == o.labels &&
      authorization_id == o.authorization_id &&
      flux == o.flux &&
      every == o.every &&
      cron == o.cron &&
      offset == o.offset &&
      latest_completed == o.latest_completed &&
      last_run_status == o.last_run_status &&
      last_run_error == o.last_run_error &&
      created_at == o.created_at &&
      updated_at == o.updated_at &&
      links == o.links
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



356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
 
# File 'apis/lib/influxdb2/apis/generated/models/task.rb', line 356

def _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
    InfluxDB2::API.const_get(type).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



425
426
427
428
429
430
431
432
433
434
435
436
437
 
# File 'apis/lib/influxdb2/apis/generated/models/task.rb', line 425

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



333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'apis/lib/influxdb2/apis/generated/models/task.rb', line 333

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


313
314
315
 
# File 'apis/lib/influxdb2/apis/generated/models/task.rb', line 313

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



319
320
321
 
# File 'apis/lib/influxdb2/apis/generated/models/task.rb', line 319

def hash
  [id, org_id, org, name, description, owner_id, status, labels, authorization_id, flux, every, cron, offset, latest_completed, last_run_status, last_run_error, created_at, updated_at, links].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



242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'apis/lib/influxdb2/apis/generated/models/task.rb', line 242

def list_invalid_properties
  invalid_properties = Array.new
  if @id.nil?
    invalid_properties.push('invalid value for "id", id cannot be nil.')
  end

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

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

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



401
402
403
 
# File 'apis/lib/influxdb2/apis/generated/models/task.rb', line 401

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



407
408
409
410
411
412
413
414
415
416
417
418
419
 
# File 'apis/lib/influxdb2/apis/generated/models/task.rb', line 407

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



395
396
397
 
# File 'apis/lib/influxdb2/apis/generated/models/task.rb', line 395

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



265
266
267
268
269
270
271
272
273
 
# File 'apis/lib/influxdb2/apis/generated/models/task.rb', line 265

def valid?
  return false if @id.nil?
  return false if @org_id.nil?
  return false if @name.nil?
  return false if @flux.nil?
  last_run_status_validator = EnumAttributeValidator.new('String', ["failed", "success", "canceled"])
  return false unless last_run_status_validator.valid?(@last_run_status)
  true
end