smplkit 3.0.82 → 3.0.83

data/lib/smplkit/_generated/jobs/lib/smplkit_jobs_client/models/run.rb

@@ -0,0 +1,405 @@
+=begin
+#smplkit Jobs API
+
+#Scheduled HTTP job execution API for smplkit.
+
+The version of the OpenAPI document: 0.1.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.22.0
+
+=end
+
+require 'date'
+require 'time'
+
+module SmplkitGeneratedClient::Jobs
+  # One occurrence of a job executing.
+  class Run < ApiModelBase
+    # The slug of the job this run belongs to.
+    attr_accessor :job
+
+    # The job's version at the time the run executed.
+    attr_accessor :job_version
+
+    # Why the run exists: `SCHEDULE`, `MANUAL` (Run now), or `RERUN`.
+    attr_accessor :trigger
+
+    # The source run's id; set only when `trigger` is `RERUN`.
+    attr_accessor :rerun_of
+
+    # The intended fire time for a scheduled run; `null` for manual / rerun runs.
+    attr_accessor :scheduled_for
+
+    # Lifecycle state of the run.
+    attr_accessor :status
+
+    # When execution started.
+    attr_accessor :started_at
+
+    # When execution finished.
+    attr_accessor :finished_at
+
+    # Milliseconds the run waited as `PENDING` before starting.
+    attr_accessor :pending_duration_ms
+
+    # Milliseconds the run spent executing.
+    attr_accessor :run_duration_ms
+
+    # Milliseconds from enqueue to finish.
+    attr_accessor :total_duration_ms
+
+    # Why a `FAILED` run failed; `null` otherwise.
+    attr_accessor :failure_reason
+
+    # Free-text failure detail, if any.
+    attr_accessor :error
+
+    # Snapshot of the request that was sent (header values redacted). Forensics only.
+    attr_accessor :request
+
+    # Outcome of the call. For `http`: `status`, `headers`, `body` (capped at 64 KiB), `body_truncated`, and the original `body_bytes`.
+    attr_accessor :result
+
+    # When the run was enqueued (became `PENDING`).
+    attr_accessor :created_at
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'job' => :'job',
+        :'job_version' => :'job_version',
+        :'trigger' => :'trigger',
+        :'rerun_of' => :'rerun_of',
+        :'scheduled_for' => :'scheduled_for',
+        :'status' => :'status',
+        :'started_at' => :'started_at',
+        :'finished_at' => :'finished_at',
+        :'pending_duration_ms' => :'pending_duration_ms',
+        :'run_duration_ms' => :'run_duration_ms',
+        :'total_duration_ms' => :'total_duration_ms',
+        :'failure_reason' => :'failure_reason',
+        :'error' => :'error',
+        :'request' => :'request',
+        :'result' => :'result',
+        :'created_at' => :'created_at'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'job' => :'String',
+        :'job_version' => :'Integer',
+        :'trigger' => :'String',
+        :'rerun_of' => :'String',
+        :'scheduled_for' => :'Time',
+        :'status' => :'String',
+        :'started_at' => :'Time',
+        :'finished_at' => :'Time',
+        :'pending_duration_ms' => :'Integer',
+        :'run_duration_ms' => :'Integer',
+        :'total_duration_ms' => :'Integer',
+        :'failure_reason' => :'String',
+        :'error' => :'String',
+        :'request' => :'Hash<String, Object>',
+        :'result' => :'Hash<String, Object>',
+        :'created_at' => :'Time'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'job_version',
+        :'rerun_of',
+        :'scheduled_for',
+        :'started_at',
+        :'finished_at',
+        :'pending_duration_ms',
+        :'run_duration_ms',
+        :'total_duration_ms',
+        :'failure_reason',
+        :'error',
+        :'request',
+        :'result',
+        :'created_at'
+      ])
+    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 `SmplkitGeneratedClient::Jobs::Run` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `SmplkitGeneratedClient::Jobs::Run`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'job')
+        self.job = attributes[:'job']
+      else
+        self.job = nil
+      end
+
+      if attributes.key?(:'job_version')
+        self.job_version = attributes[:'job_version']
+      end
+
+      if attributes.key?(:'trigger')
+        self.trigger = attributes[:'trigger']
+      else
+        self.trigger = nil
+      end
+
+      if attributes.key?(:'rerun_of')
+        self.rerun_of = attributes[:'rerun_of']
+      end
+
+      if attributes.key?(:'scheduled_for')
+        self.scheduled_for = attributes[:'scheduled_for']
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      else
+        self.status = nil
+      end
+
+      if attributes.key?(:'started_at')
+        self.started_at = attributes[:'started_at']
+      end
+
+      if attributes.key?(:'finished_at')
+        self.finished_at = attributes[:'finished_at']
+      end
+
+      if attributes.key?(:'pending_duration_ms')
+        self.pending_duration_ms = attributes[:'pending_duration_ms']
+      end
+
+      if attributes.key?(:'run_duration_ms')
+        self.run_duration_ms = attributes[:'run_duration_ms']
+      end
+
+      if attributes.key?(:'total_duration_ms')
+        self.total_duration_ms = attributes[:'total_duration_ms']
+      end
+
+      if attributes.key?(:'failure_reason')
+        self.failure_reason = attributes[:'failure_reason']
+      end
+
+      if attributes.key?(:'error')
+        self.error = attributes[:'error']
+      end
+
+      if attributes.key?(:'request')
+        if (value = attributes[:'request']).is_a?(Hash)
+          self.request = value
+        end
+      end
+
+      if attributes.key?(:'result')
+        if (value = attributes[:'result']).is_a?(Hash)
+          self.result = value
+        end
+      end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      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
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @job.nil?
+        invalid_properties.push('invalid value for "job", job cannot be nil.')
+      end
+
+      if @trigger.nil?
+        invalid_properties.push('invalid value for "trigger", trigger cannot be nil.')
+      end
+
+      if @status.nil?
+        invalid_properties.push('invalid value for "status", status cannot be nil.')
+      end
+
+      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?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @job.nil?
+      return false if @trigger.nil?
+      trigger_validator = EnumAttributeValidator.new('String', ["SCHEDULE", "MANUAL", "RERUN"])
+      return false unless trigger_validator.valid?(@trigger)
+      return false if @status.nil?
+      status_validator = EnumAttributeValidator.new('String', ["PENDING", "RUNNING", "SUCCEEDED", "FAILED", "CANCELED"])
+      return false unless status_validator.valid?(@status)
+      failure_reason_validator = EnumAttributeValidator.new('String', ["TIMEOUT", "CONNECTION_ERROR", "NON_SUCCESS_STATUS", "SSRF_BLOCKED", "QUOTA_EXCEEDED", "WORKER_LOST"])
+      return false unless failure_reason_validator.valid?(@failure_reason)
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] job Value to be assigned
+    def job=(job)
+      if job.nil?
+        fail ArgumentError, 'job cannot be nil'
+      end
+
+      @job = job
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] trigger Object to be assigned
+    def trigger=(trigger)
+      validator = EnumAttributeValidator.new('String', ["SCHEDULE", "MANUAL", "RERUN"])
+      unless validator.valid?(trigger)
+        fail ArgumentError, "invalid value for \"trigger\", must be one of #{validator.allowable_values}."
+      end
+      @trigger = trigger
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] status Object to be assigned
+    def status=(status)
+      validator = EnumAttributeValidator.new('String', ["PENDING", "RUNNING", "SUCCEEDED", "FAILED", "CANCELED"])
+      unless validator.valid?(status)
+        fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
+      end
+      @status = status
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] failure_reason Object to be assigned
+    def failure_reason=(failure_reason)
+      validator = EnumAttributeValidator.new('String', ["TIMEOUT", "CONNECTION_ERROR", "NON_SUCCESS_STATUS", "SSRF_BLOCKED", "QUOTA_EXCEEDED", "WORKER_LOST"])
+      unless validator.valid?(failure_reason)
+        fail ArgumentError, "invalid value for \"failure_reason\", must be one of #{validator.allowable_values}."
+      end
+      @failure_reason = failure_reason
+    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 &&
+          job == o.job &&
+          job_version == o.job_version &&
+          trigger == o.trigger &&
+          rerun_of == o.rerun_of &&
+          scheduled_for == o.scheduled_for &&
+          status == o.status &&
+          started_at == o.started_at &&
+          finished_at == o.finished_at &&
+          pending_duration_ms == o.pending_duration_ms &&
+          run_duration_ms == o.run_duration_ms &&
+          total_duration_ms == o.total_duration_ms &&
+          failure_reason == o.failure_reason &&
+          error == o.error &&
+          request == o.request &&
+          result == o.result &&
+          created_at == o.created_at
+    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
+      [job, job_version, trigger, rerun_of, scheduled_for, status, started_at, finished_at, pending_duration_ms, run_duration_ms, total_duration_ms, failure_reason, error, request, result, created_at].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)
+      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
+
+    # 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
+
+  end
+
+end

data/lib/smplkit/_generated/jobs/lib/smplkit_jobs_client/models/run_list_links.rb

@@ -0,0 +1,149 @@
+=begin
+#smplkit Jobs API
+
+#Scheduled HTTP job execution API for smplkit.
+
+The version of the OpenAPI document: 0.1.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.22.0
+
+=end
+
+require 'date'
+require 'time'
+
+module SmplkitGeneratedClient::Jobs
+  class RunListLinks < ApiModelBase
+    # URL of the next page, or `null`.
+    attr_accessor :_next
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'_next' => :'next'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'_next' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'_next'
+      ])
+    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 `SmplkitGeneratedClient::Jobs::RunListLinks` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `SmplkitGeneratedClient::Jobs::RunListLinks`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'_next')
+        self._next = attributes[:'_next']
+      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
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      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?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      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 &&
+          _next == o._next
+    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
+      [_next].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)
+      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
+
+    # 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
+
+  end
+
+end