influxdb-client-apis 2.9.0.pre.6293 → 2.9.0.pre.6399

data/lib/influxdb2/apis/generated/models/task_update_request.rb

@@ -0,0 +1,270 @@
+=begin
+#InfluxDB OSS API Service
+
+#The InfluxDB v2 API provides a programmatic interface for all interactions with InfluxDB. Access the InfluxDB API using the `/api/v2/` endpoint. 
+
+The version of the OpenAPI document: 2.0.0
+
+Generated by: https://openapi-generator.tech
+
+=end
+
+require 'date'
+require 'set'
+require 'time'
+
+module InfluxDB2::API
+  class TaskUpdateRequest
+    attr_accessor :status
+
+    # Flux with [task configuration options](https://docs.influxdata.com/influxdb/latest/process-data/task-options/) and the script for the task to run.  #### Related guides  - [Task configuration options](https://docs.influxdata.com/influxdb/latest/process-data/task-options/) 
+    attr_accessor :flux
+
+    # The name of the task.
+    attr_accessor :name
+
+    # The interval ([duration literal](https://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.
+    attr_accessor :every
+
+    # A [Cron expression](https://en.wikipedia.org/wiki/Cron#Overview) that defines the schedule on which the task runs. InfluxDB uses the system time when evaluating Cron expressions.
+    attr_accessor :cron
+
+    # A [duration](https://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.
+    attr_accessor :offset
+
+    # A description of the task.
+    attr_accessor :description
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'status' => :'status',
+        :'flux' => :'flux',
+        :'name' => :'name',
+        :'every' => :'every',
+        :'cron' => :'cron',
+        :'offset' => :'offset',
+        :'description' => :'description',
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'status' => :'TaskStatusType',
+        :'flux' => :'String',
+        :'name' => :'String',
+        :'every' => :'String',
+        :'cron' => :'String',
+        :'offset' => :'String',
+        :'description' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    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
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    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
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [status, flux, name, every, cron, offset, description].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    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
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    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
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    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
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    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
+
+  end
+end

data/lib/influxdb2/apis/generated/models/tasks.rb

@@ -0,0 +1,221 @@
+=begin
+#InfluxDB OSS API Service
+
+#The InfluxDB v2 API provides a programmatic interface for all interactions with InfluxDB. Access the InfluxDB API using the `/api/v2/` endpoint. 
+
+The version of the OpenAPI document: 2.0.0
+
+Generated by: https://openapi-generator.tech
+
+=end
+
+require 'date'
+require 'set'
+require 'time'
+
+module InfluxDB2::API
+  class Tasks
+    attr_accessor :links
+
+    attr_accessor :tasks
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'links' => :'links',
+        :'tasks' => :'tasks',
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'links' => :'Links',
+        :'tasks' => :'Array<Task>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `InfluxDB2::Tasks` 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::Tasks`. 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?(:'links')
+        self.links = attributes[:'links']
+      end
+
+      if attributes.key?(:'tasks')
+        if (value = attributes[:'tasks']).is_a?(Array)
+          self.tasks = value
+        end
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          links == o.links &&
+          tasks == o.tasks
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [links, tasks].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    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
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    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
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    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
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    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
+
+  end
+end

data/test/influxdb2/tasks_api_test.rb

@@ -0,0 +1,104 @@
+# The MIT License
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+require 'base_api_test'
+require 'test_helper'
+
+class TasksApiTest < BaseApiTests
+  def setup
+    super
+    @client.create_tasks_api.get_tasks.tasks.each do |task|
+      next unless task.name.end_with?('_TEST')
+
+      @client.create_tasks_api.delete_tasks_id(task.id)
+    end
+  end
+
+  def test_create_task
+    name = generate_name('task')
+    flux = "option task = {name: \"#{name}\", every: 1h}
+
+from(bucket: \"telegraf\")
+ |> range(start: -1h)
+ |> filter(fn: (r) => r._measurement == \"cpu\")
+ |> filter(fn: (r) => r._field == \"usage_system\")"
+
+    request = InfluxDB2::API::TaskCreateRequest.new(org_id: @my_org.id,
+                                                    description: 'This task testing API',
+                                                    flux: flux,
+                                                    status: InfluxDB2::API::TaskStatusType::ACTIVE)
+
+    task = @client.create_tasks_api.post_tasks(request)
+
+    refute_nil task.id
+    assert_equal name, task.name
+    assert_equal @my_org.name, task.org
+    assert_equal @my_org.id, task.org_id
+    assert_equal 'This task testing API', task.description
+    assert_equal InfluxDB2::API::TaskStatusType::ACTIVE, task.status
+    assert_equal flux, task.flux
+  end
+
+  def test_update_task
+    task = _create_task
+
+    request = InfluxDB2::API::TaskUpdateRequest.new(flux: task.flux,
+                                                    description: 'Updated description for testing Task')
+    task = @client.create_tasks_api.patch_tasks_id(task.id, request)
+
+    assert_equal 'Updated description for testing Task', task.description
+  end
+
+  def test_list_task
+    task = _create_task
+
+    tasks = @client.create_tasks_api.get_tasks.tasks
+    assert_equal 1, tasks.length
+    assert_equal task.name, tasks[0].name
+  end
+
+  def test_delete_task
+    task = _create_task
+
+    tasks = @client.create_tasks_api.get_tasks.tasks
+    assert_equal 1, tasks.length
+
+    @client.create_tasks_api.delete_tasks_id(task.id)
+
+    tasks = @client.create_tasks_api.get_tasks.tasks
+    assert_equal 0, tasks.length
+  end
+
+  private
+
+  def _create_task
+    flux = "option task = {name: \"#{generate_name('task')}\", every: 1h}
+
+from(bucket: \"telegraf\")
+ |> range(start: -1h)
+ |> filter(fn: (r) => r._measurement == \"cpu\")
+ |> filter(fn: (r) => r._field == \"usage_system\")"
+
+    request = InfluxDB2::API::TaskCreateRequest.new(org_id: @my_org.id,
+                                                    flux: flux,
+                                                    status: InfluxDB2::API::TaskStatusType::ACTIVE)
+
+    @client.create_tasks_api.post_tasks(request)
+  end
+end

data/test/test_helper.rb

@@ -34,6 +34,6 @@ require 'influxdb-client'
 
 require 'minitest/autorun'
 require 'minitest/reporters'
-Minitest::Reporters.use!
+Minitest::Reporters.use! unless ENV['RM_INFO']
 
 require 'webmock/minitest'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: influxdb-client-apis
 version: !ruby/object:Gem::Version
-  version: 2.9.0.pre.6293
+  version: 2.9.0.pre.6399
 platform: ruby
 authors:
 - Jakub Bednar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-02 00:00:00.000000000 Z
+date: 2022-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: influxdb-client
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.9.0.pre.6293
+        version: 2.9.0.pre.6399
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.9.0.pre.6293
+        version: 2.9.0.pre.6399
 - !ruby/object:Gem::Dependency
   name: typhoeus
   requirement: !ruby/object:Gem::Requirement
@@ -158,6 +158,7 @@ files:
 - lib/influxdb2/apis/generated/api/buckets_api.rb
 - lib/influxdb2/apis/generated/api/labels_api.rb
 - lib/influxdb2/apis/generated/api/organizations_api.rb
+- lib/influxdb2/apis/generated/api/tasks_api.rb
 - lib/influxdb2/apis/generated/api/users_api.rb
 - lib/influxdb2/apis/generated/api_client.rb
 - lib/influxdb2/apis/generated/api_error.rb
@@ -179,6 +180,8 @@ files:
 - lib/influxdb2/apis/generated/models/label_update.rb
 - lib/influxdb2/apis/generated/models/labels_response.rb
 - lib/influxdb2/apis/generated/models/links.rb
+- lib/influxdb2/apis/generated/models/log_event.rb
+- lib/influxdb2/apis/generated/models/logs.rb
 - lib/influxdb2/apis/generated/models/organization.rb
 - lib/influxdb2/apis/generated/models/organization_links.rb
 - lib/influxdb2/apis/generated/models/organizations.rb
@@ -197,6 +200,15 @@ files:
 - lib/influxdb2/apis/generated/models/resource_owner_all_of.rb
 - lib/influxdb2/apis/generated/models/resource_owners.rb
 - lib/influxdb2/apis/generated/models/retention_rule.rb
+- lib/influxdb2/apis/generated/models/run.rb
+- lib/influxdb2/apis/generated/models/run_links.rb
+- lib/influxdb2/apis/generated/models/runs.rb
+- lib/influxdb2/apis/generated/models/task.rb
+- lib/influxdb2/apis/generated/models/task_create_request.rb
+- lib/influxdb2/apis/generated/models/task_links.rb
+- lib/influxdb2/apis/generated/models/task_status_type.rb
+- lib/influxdb2/apis/generated/models/task_update_request.rb
+- lib/influxdb2/apis/generated/models/tasks.rb
 - lib/influxdb2/apis/generated/models/user.rb
 - lib/influxdb2/apis/generated/models/user_response.rb
 - lib/influxdb2/apis/generated/models/user_response_links.rb
@@ -208,6 +220,7 @@ files:
 - test/influxdb2/buckets_api_test.rb
 - test/influxdb2/labels_api_test.rb
 - test/influxdb2/organizations_api_test.rb
+- test/influxdb2/tasks_api_test.rb
 - test/influxdb2/users_api_test.rb
 - test/test_helper.rb
 homepage: https://github.com/influxdata/influxdb-client-ruby
@@ -243,5 +256,6 @@ test_files:
 - test/influxdb2/buckets_api_test.rb
 - test/influxdb2/labels_api_test.rb
 - test/influxdb2/organizations_api_test.rb
+- test/influxdb2/tasks_api_test.rb
 - test/influxdb2/users_api_test.rb
 - test/test_helper.rb