Class: InfluxDB2::API::TaskUpdateRequest

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TaskUpdateRequest

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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'apis/lib/influxdb2/apis/generated/models/task_update_request.rb', line 72

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

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

  if attributes.key?(:'name')
    self.name = attributes[:'name']
  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?(:'description')
    self.description = attributes[:'description']
  end
end

Instance Attribute Details

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



30
31
32
 
# File 'apis/lib/influxdb2/apis/generated/models/task_update_request.rb', line 30

def cron
  @cron
end

#description ⇒ Object

A description of the task.



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

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.



27
28
29
 
# File 'apis/lib/influxdb2/apis/generated/models/task_update_request.rb', line 27

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/)



21
22
23
 
# File 'apis/lib/influxdb2/apis/generated/models/task_update_request.rb', line 21

def flux
  @flux
end

#name ⇒ Object

The name of the task.



24
25
26
 
# File 'apis/lib/influxdb2/apis/generated/models/task_update_request.rb', line 24

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.



33
34
35
 
# File 'apis/lib/influxdb2/apis/generated/models/task_update_request.rb', line 33

def offset
  @offset
end

#status ⇒ Object

Returns the value of attribute status.



18
19
20
 
# File 'apis/lib/influxdb2/apis/generated/models/task_update_request.rb', line 18

def status
  @status
end

Class Method Details

.attribute_map ⇒ Object

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



39
40
41
42
43
44
45
46
47
48
49
 
# File 'apis/lib/influxdb2/apis/generated/models/task_update_request.rb', line 39

def self.attribute_map
  {
    :'status' => :'status',
    :'flux' => :'flux',
    :'name' => :'name',
    :'every' => :'every',
    :'cron' => :'cron',
    :'offset' => :'offset',
    :'description' => :'description',
  }
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



156
157
158
 
# File 'apis/lib/influxdb2/apis/generated/models/task_update_request.rb', line 156

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

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

.openapi_types ⇒ Object

Attribute type mapping.



52
53
54
55
56
57
58
59
60
61
62
 
# File 'apis/lib/influxdb2/apis/generated/models/task_update_request.rb', line 52

def self.openapi_types
  {
    :'status' => :'TaskStatusType',
    :'flux' => :'String',
    :'name' => :'String',
    :'every' => :'String',
    :'cron' => :'String',
    :'offset' => :'String',
    :'description' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



129
130
131
132
133
134
135
136
137
138
139
 
# File 'apis/lib/influxdb2/apis/generated/models/task_update_request.rb', line 129

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      status == o.status &&
      flux == o.flux &&
      name == o.name &&
      every == o.every &&
      cron == o.cron &&
      offset == o.offset &&
      description == o.description
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



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
 
# File 'apis/lib/influxdb2/apis/generated/models/task_update_request.rb', line 186

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



255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'apis/lib/influxdb2/apis/generated/models/task_update_request.rb', line 255

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



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'apis/lib/influxdb2/apis/generated/models/task_update_request.rb', line 163

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


143
144
145
 
# File 'apis/lib/influxdb2/apis/generated/models/task_update_request.rb', line 143

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



149
150
151
 
# File 'apis/lib/influxdb2/apis/generated/models/task_update_request.rb', line 149

def hash
  [status, flux, name, every, cron, offset, description].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



116
117
118
119
 
# File 'apis/lib/influxdb2/apis/generated/models/task_update_request.rb', line 116

def list_invalid_properties
  invalid_properties = Array.new
  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



231
232
233
 
# File 'apis/lib/influxdb2/apis/generated/models/task_update_request.rb', line 231

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



237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'apis/lib/influxdb2/apis/generated/models/task_update_request.rb', line 237

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



225
226
227
 
# File 'apis/lib/influxdb2/apis/generated/models/task_update_request.rb', line 225

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



123
124
125
 
# File 'apis/lib/influxdb2/apis/generated/models/task_update_request.rb', line 123

def valid?
  true
end