relentless_identity 1.0.0

data/lib/relentless_identity/models/client_background_job_response.rb

@@ -0,0 +1,745 @@
+=begin
+#Relentless Identity API
+
+#Public client API for Finder and Probe workflows. This spec is generated from the FastAPI app, then narrowed to the supported bearer-authenticated routes used by SDKs and the API reference.
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.21.0
+
+=end
+
+require 'date'
+require 'time'
+
+module RelentlessIdentity
+  # Background job status envelope returned by the public jobs API.
+  class ClientBackgroundJobResponse < ApiModelBase
+    attr_accessor :id
+
+    attr_accessor :job_type
+
+    # Current high-level job lifecycle state.
+    attr_accessor :status
+
+    attr_accessor :deadline_at
+
+    attr_accessor :estimated_runtime_seconds
+
+    attr_accessor :scheduled_start_at
+
+    attr_accessor :callback_url
+
+    attr_accessor :callback_status
+
+    attr_accessor :callback_attempts
+
+    attr_accessor :callback_last_error
+
+    # Total number of submitted items for the job.
+    attr_accessor :requested_count
+
+    attr_accessor :completed_count
+
+    attr_accessor :success_count
+
+    attr_accessor :not_found_count
+
+    attr_accessor :error_count
+
+    attr_accessor :reserved_amount_micros
+
+    attr_accessor :actual_amount_micros
+
+    # Approximate percent complete based on completed item count.
+    attr_accessor :progress_percent
+
+    # Aggregated counts and provider stats for the job.
+    attr_accessor :summary
+
+    attr_accessor :metadata
+
+    attr_accessor :started_at
+
+    attr_accessor :completed_at
+
+    attr_accessor :history_expires_at
+
+    attr_accessor :results_pruned_at
+
+    attr_accessor :artifact_available
+
+    attr_accessor :artifact_json_url
+
+    attr_accessor :artifact_size_bytes
+
+    attr_accessor :artifact_uploaded_at
+
+    attr_accessor :created_at
+
+    attr_accessor :updated_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
+      {
+        :'id' => :'id',
+        :'job_type' => :'job_type',
+        :'status' => :'status',
+        :'deadline_at' => :'deadline_at',
+        :'estimated_runtime_seconds' => :'estimated_runtime_seconds',
+        :'scheduled_start_at' => :'scheduled_start_at',
+        :'callback_url' => :'callback_url',
+        :'callback_status' => :'callback_status',
+        :'callback_attempts' => :'callback_attempts',
+        :'callback_last_error' => :'callback_last_error',
+        :'requested_count' => :'requested_count',
+        :'completed_count' => :'completed_count',
+        :'success_count' => :'success_count',
+        :'not_found_count' => :'not_found_count',
+        :'error_count' => :'error_count',
+        :'reserved_amount_micros' => :'reserved_amount_micros',
+        :'actual_amount_micros' => :'actual_amount_micros',
+        :'progress_percent' => :'progress_percent',
+        :'summary' => :'summary',
+        :'metadata' => :'metadata',
+        :'started_at' => :'started_at',
+        :'completed_at' => :'completed_at',
+        :'history_expires_at' => :'history_expires_at',
+        :'results_pruned_at' => :'results_pruned_at',
+        :'artifact_available' => :'artifact_available',
+        :'artifact_json_url' => :'artifact_json_url',
+        :'artifact_size_bytes' => :'artifact_size_bytes',
+        :'artifact_uploaded_at' => :'artifact_uploaded_at',
+        :'created_at' => :'created_at',
+        :'updated_at' => :'updated_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
+      {
+        :'id' => :'String',
+        :'job_type' => :'String',
+        :'status' => :'String',
+        :'deadline_at' => :'Time',
+        :'estimated_runtime_seconds' => :'Integer',
+        :'scheduled_start_at' => :'Time',
+        :'callback_url' => :'String',
+        :'callback_status' => :'String',
+        :'callback_attempts' => :'Integer',
+        :'callback_last_error' => :'String',
+        :'requested_count' => :'Integer',
+        :'completed_count' => :'Integer',
+        :'success_count' => :'Integer',
+        :'not_found_count' => :'Integer',
+        :'error_count' => :'Integer',
+        :'reserved_amount_micros' => :'Integer',
+        :'actual_amount_micros' => :'Integer',
+        :'progress_percent' => :'Float',
+        :'summary' => :'Hash<String, Object>',
+        :'metadata' => :'Hash<String, Object>',
+        :'started_at' => :'Time',
+        :'completed_at' => :'Time',
+        :'history_expires_at' => :'Time',
+        :'results_pruned_at' => :'Time',
+        :'artifact_available' => :'Boolean',
+        :'artifact_json_url' => :'String',
+        :'artifact_size_bytes' => :'Integer',
+        :'artifact_uploaded_at' => :'Time',
+        :'created_at' => :'Time',
+        :'updated_at' => :'Time'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'callback_url',
+        :'callback_last_error',
+        :'started_at',
+        :'completed_at',
+        :'history_expires_at',
+        :'results_pruned_at',
+        :'artifact_json_url',
+        :'artifact_size_bytes',
+        :'artifact_uploaded_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 `RelentlessIdentity::ClientBackgroundJobResponse` 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 `RelentlessIdentity::ClientBackgroundJobResponse`. 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?(:'id')
+        self.id = attributes[:'id']
+      else
+        self.id = nil
+      end
+
+      if attributes.key?(:'job_type')
+        self.job_type = attributes[:'job_type']
+      else
+        self.job_type = nil
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      else
+        self.status = nil
+      end
+
+      if attributes.key?(:'deadline_at')
+        self.deadline_at = attributes[:'deadline_at']
+      else
+        self.deadline_at = nil
+      end
+
+      if attributes.key?(:'estimated_runtime_seconds')
+        self.estimated_runtime_seconds = attributes[:'estimated_runtime_seconds']
+      else
+        self.estimated_runtime_seconds = nil
+      end
+
+      if attributes.key?(:'scheduled_start_at')
+        self.scheduled_start_at = attributes[:'scheduled_start_at']
+      else
+        self.scheduled_start_at = nil
+      end
+
+      if attributes.key?(:'callback_url')
+        self.callback_url = attributes[:'callback_url']
+      end
+
+      if attributes.key?(:'callback_status')
+        self.callback_status = attributes[:'callback_status']
+      else
+        self.callback_status = nil
+      end
+
+      if attributes.key?(:'callback_attempts')
+        self.callback_attempts = attributes[:'callback_attempts']
+      else
+        self.callback_attempts = nil
+      end
+
+      if attributes.key?(:'callback_last_error')
+        self.callback_last_error = attributes[:'callback_last_error']
+      end
+
+      if attributes.key?(:'requested_count')
+        self.requested_count = attributes[:'requested_count']
+      else
+        self.requested_count = nil
+      end
+
+      if attributes.key?(:'completed_count')
+        self.completed_count = attributes[:'completed_count']
+      else
+        self.completed_count = nil
+      end
+
+      if attributes.key?(:'success_count')
+        self.success_count = attributes[:'success_count']
+      else
+        self.success_count = nil
+      end
+
+      if attributes.key?(:'not_found_count')
+        self.not_found_count = attributes[:'not_found_count']
+      else
+        self.not_found_count = nil
+      end
+
+      if attributes.key?(:'error_count')
+        self.error_count = attributes[:'error_count']
+      else
+        self.error_count = nil
+      end
+
+      if attributes.key?(:'reserved_amount_micros')
+        self.reserved_amount_micros = attributes[:'reserved_amount_micros']
+      else
+        self.reserved_amount_micros = nil
+      end
+
+      if attributes.key?(:'actual_amount_micros')
+        self.actual_amount_micros = attributes[:'actual_amount_micros']
+      else
+        self.actual_amount_micros = nil
+      end
+
+      if attributes.key?(:'progress_percent')
+        self.progress_percent = attributes[:'progress_percent']
+      end
+
+      if attributes.key?(:'summary')
+        if (value = attributes[:'summary']).is_a?(Hash)
+          self.summary = value
+        end
+      end
+
+      if attributes.key?(:'metadata')
+        if (value = attributes[:'metadata']).is_a?(Hash)
+          self.metadata = value
+        end
+      end
+
+      if attributes.key?(:'started_at')
+        self.started_at = attributes[:'started_at']
+      end
+
+      if attributes.key?(:'completed_at')
+        self.completed_at = attributes[:'completed_at']
+      end
+
+      if attributes.key?(:'history_expires_at')
+        self.history_expires_at = attributes[:'history_expires_at']
+      end
+
+      if attributes.key?(:'results_pruned_at')
+        self.results_pruned_at = attributes[:'results_pruned_at']
+      end
+
+      if attributes.key?(:'artifact_available')
+        self.artifact_available = attributes[:'artifact_available']
+      else
+        self.artifact_available = false
+      end
+
+      if attributes.key?(:'artifact_json_url')
+        self.artifact_json_url = attributes[:'artifact_json_url']
+      end
+
+      if attributes.key?(:'artifact_size_bytes')
+        self.artifact_size_bytes = attributes[:'artifact_size_bytes']
+      end
+
+      if attributes.key?(:'artifact_uploaded_at')
+        self.artifact_uploaded_at = attributes[:'artifact_uploaded_at']
+      end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      else
+        self.created_at = nil
+      end
+
+      if attributes.key?(:'updated_at')
+        self.updated_at = attributes[:'updated_at']
+      else
+        self.updated_at = nil
+      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 @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @job_type.nil?
+        invalid_properties.push('invalid value for "job_type", job_type cannot be nil.')
+      end
+
+      if @status.nil?
+        invalid_properties.push('invalid value for "status", status cannot be nil.')
+      end
+
+      if @deadline_at.nil?
+        invalid_properties.push('invalid value for "deadline_at", deadline_at cannot be nil.')
+      end
+
+      if @estimated_runtime_seconds.nil?
+        invalid_properties.push('invalid value for "estimated_runtime_seconds", estimated_runtime_seconds cannot be nil.')
+      end
+
+      if @scheduled_start_at.nil?
+        invalid_properties.push('invalid value for "scheduled_start_at", scheduled_start_at cannot be nil.')
+      end
+
+      if @callback_status.nil?
+        invalid_properties.push('invalid value for "callback_status", callback_status cannot be nil.')
+      end
+
+      if @callback_attempts.nil?
+        invalid_properties.push('invalid value for "callback_attempts", callback_attempts cannot be nil.')
+      end
+
+      if @requested_count.nil?
+        invalid_properties.push('invalid value for "requested_count", requested_count cannot be nil.')
+      end
+
+      if @completed_count.nil?
+        invalid_properties.push('invalid value for "completed_count", completed_count cannot be nil.')
+      end
+
+      if @success_count.nil?
+        invalid_properties.push('invalid value for "success_count", success_count cannot be nil.')
+      end
+
+      if @not_found_count.nil?
+        invalid_properties.push('invalid value for "not_found_count", not_found_count cannot be nil.')
+      end
+
+      if @error_count.nil?
+        invalid_properties.push('invalid value for "error_count", error_count cannot be nil.')
+      end
+
+      if @reserved_amount_micros.nil?
+        invalid_properties.push('invalid value for "reserved_amount_micros", reserved_amount_micros cannot be nil.')
+      end
+
+      if @actual_amount_micros.nil?
+        invalid_properties.push('invalid value for "actual_amount_micros", actual_amount_micros cannot be nil.')
+      end
+
+      if @created_at.nil?
+        invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
+      end
+
+      if @updated_at.nil?
+        invalid_properties.push('invalid value for "updated_at", updated_at 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 @id.nil?
+      return false if @job_type.nil?
+      job_type_validator = EnumAttributeValidator.new('String', ["finder_batch", "probe_batch"])
+      return false unless job_type_validator.valid?(@job_type)
+      return false if @status.nil?
+      status_validator = EnumAttributeValidator.new('String', ["queued", "processing", "completed", "failed", "canceled"])
+      return false unless status_validator.valid?(@status)
+      return false if @deadline_at.nil?
+      return false if @estimated_runtime_seconds.nil?
+      return false if @scheduled_start_at.nil?
+      return false if @callback_status.nil?
+      callback_status_validator = EnumAttributeValidator.new('String', ["none", "pending", "delivered", "failed"])
+      return false unless callback_status_validator.valid?(@callback_status)
+      return false if @callback_attempts.nil?
+      return false if @requested_count.nil?
+      return false if @completed_count.nil?
+      return false if @success_count.nil?
+      return false if @not_found_count.nil?
+      return false if @error_count.nil?
+      return false if @reserved_amount_micros.nil?
+      return false if @actual_amount_micros.nil?
+      return false if @created_at.nil?
+      return false if @updated_at.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] id Value to be assigned
+    def id=(id)
+      if id.nil?
+        fail ArgumentError, 'id cannot be nil'
+      end
+
+      @id = id
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] job_type Object to be assigned
+    def job_type=(job_type)
+      validator = EnumAttributeValidator.new('String', ["finder_batch", "probe_batch"])
+      unless validator.valid?(job_type)
+        fail ArgumentError, "invalid value for \"job_type\", must be one of #{validator.allowable_values}."
+      end
+      @job_type = job_type
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] status Object to be assigned
+    def status=(status)
+      validator = EnumAttributeValidator.new('String', ["queued", "processing", "completed", "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 with validation
+    # @param [Object] deadline_at Value to be assigned
+    def deadline_at=(deadline_at)
+      if deadline_at.nil?
+        fail ArgumentError, 'deadline_at cannot be nil'
+      end
+
+      @deadline_at = deadline_at
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] estimated_runtime_seconds Value to be assigned
+    def estimated_runtime_seconds=(estimated_runtime_seconds)
+      if estimated_runtime_seconds.nil?
+        fail ArgumentError, 'estimated_runtime_seconds cannot be nil'
+      end
+
+      @estimated_runtime_seconds = estimated_runtime_seconds
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] scheduled_start_at Value to be assigned
+    def scheduled_start_at=(scheduled_start_at)
+      if scheduled_start_at.nil?
+        fail ArgumentError, 'scheduled_start_at cannot be nil'
+      end
+
+      @scheduled_start_at = scheduled_start_at
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] callback_status Object to be assigned
+    def callback_status=(callback_status)
+      validator = EnumAttributeValidator.new('String', ["none", "pending", "delivered", "failed"])
+      unless validator.valid?(callback_status)
+        fail ArgumentError, "invalid value for \"callback_status\", must be one of #{validator.allowable_values}."
+      end
+      @callback_status = callback_status
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] callback_attempts Value to be assigned
+    def callback_attempts=(callback_attempts)
+      if callback_attempts.nil?
+        fail ArgumentError, 'callback_attempts cannot be nil'
+      end
+
+      @callback_attempts = callback_attempts
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] requested_count Value to be assigned
+    def requested_count=(requested_count)
+      if requested_count.nil?
+        fail ArgumentError, 'requested_count cannot be nil'
+      end
+
+      @requested_count = requested_count
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] completed_count Value to be assigned
+    def completed_count=(completed_count)
+      if completed_count.nil?
+        fail ArgumentError, 'completed_count cannot be nil'
+      end
+
+      @completed_count = completed_count
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] success_count Value to be assigned
+    def success_count=(success_count)
+      if success_count.nil?
+        fail ArgumentError, 'success_count cannot be nil'
+      end
+
+      @success_count = success_count
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] not_found_count Value to be assigned
+    def not_found_count=(not_found_count)
+      if not_found_count.nil?
+        fail ArgumentError, 'not_found_count cannot be nil'
+      end
+
+      @not_found_count = not_found_count
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] error_count Value to be assigned
+    def error_count=(error_count)
+      if error_count.nil?
+        fail ArgumentError, 'error_count cannot be nil'
+      end
+
+      @error_count = error_count
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] reserved_amount_micros Value to be assigned
+    def reserved_amount_micros=(reserved_amount_micros)
+      if reserved_amount_micros.nil?
+        fail ArgumentError, 'reserved_amount_micros cannot be nil'
+      end
+
+      @reserved_amount_micros = reserved_amount_micros
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] actual_amount_micros Value to be assigned
+    def actual_amount_micros=(actual_amount_micros)
+      if actual_amount_micros.nil?
+        fail ArgumentError, 'actual_amount_micros cannot be nil'
+      end
+
+      @actual_amount_micros = actual_amount_micros
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] created_at Value to be assigned
+    def created_at=(created_at)
+      if created_at.nil?
+        fail ArgumentError, 'created_at cannot be nil'
+      end
+
+      @created_at = created_at
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] updated_at Value to be assigned
+    def updated_at=(updated_at)
+      if updated_at.nil?
+        fail ArgumentError, 'updated_at cannot be nil'
+      end
+
+      @updated_at = updated_at
+    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 &&
+          id == o.id &&
+          job_type == o.job_type &&
+          status == o.status &&
+          deadline_at == o.deadline_at &&
+          estimated_runtime_seconds == o.estimated_runtime_seconds &&
+          scheduled_start_at == o.scheduled_start_at &&
+          callback_url == o.callback_url &&
+          callback_status == o.callback_status &&
+          callback_attempts == o.callback_attempts &&
+          callback_last_error == o.callback_last_error &&
+          requested_count == o.requested_count &&
+          completed_count == o.completed_count &&
+          success_count == o.success_count &&
+          not_found_count == o.not_found_count &&
+          error_count == o.error_count &&
+          reserved_amount_micros == o.reserved_amount_micros &&
+          actual_amount_micros == o.actual_amount_micros &&
+          progress_percent == o.progress_percent &&
+          summary == o.summary &&
+          metadata == o.metadata &&
+          started_at == o.started_at &&
+          completed_at == o.completed_at &&
+          history_expires_at == o.history_expires_at &&
+          results_pruned_at == o.results_pruned_at &&
+          artifact_available == o.artifact_available &&
+          artifact_json_url == o.artifact_json_url &&
+          artifact_size_bytes == o.artifact_size_bytes &&
+          artifact_uploaded_at == o.artifact_uploaded_at &&
+          created_at == o.created_at &&
+          updated_at == o.updated_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
+      [id, job_type, status, deadline_at, estimated_runtime_seconds, scheduled_start_at, callback_url, callback_status, callback_attempts, callback_last_error, requested_count, completed_count, success_count, not_found_count, error_count, reserved_amount_micros, actual_amount_micros, progress_percent, summary, metadata, started_at, completed_at, history_expires_at, results_pruned_at, artifact_available, artifact_json_url, artifact_size_bytes, artifact_uploaded_at, created_at, updated_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