iron_titan 0.3.10 → 0.4.0

data/lib/iron_titan/models/job.rb

@@ -3,18 +3,30 @@ Titan API
 
 The ultimate, language agnostic, container based job processing framework.
 
-OpenAPI spec version: 0.3.10
+OpenAPI spec version: 0.4.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
 
 =end
 
 require 'date'
 
 module IronTitan
+
   class Job
-    # Name of image to use.
+    # Name of Docker image to use. This is optional and can be used to override the image defined at the group level.
     attr_accessor :image
 
     # Payload for the job. This is what you pass into each job to make it do something.
@@ -23,13 +35,13 @@ module IronTitan
     # Number of seconds to wait before queueing the job for consumption for the first time. Must be a positive integer. Jobs with a delay start in state \"delayed\" and transition to \"running\" after delay seconds.
     attr_accessor :delay
 
-    # Maximum runtime in seconds. If a consumer retrieves the\njob, but does not change it's status within timeout seconds, the job\nis considered failed, with reason timeout (Titan may allow a small\ngrace period). The consumer should also kill the job after timeout\nseconds. If a consumer tries to change status after Titan has already\ntimed out the job, the consumer will be ignored.\n
+    # Maximum runtime in seconds. If a consumer retrieves the job, but does not change it's status within timeout seconds, the job is considered failed, with reason timeout (Titan may allow a small grace period). The consumer should also kill the job after timeout seconds. If a consumer tries to change status after Titan has already timed out the job, the consumer will be ignored. 
     attr_accessor :timeout
 
     # Priority of the job. Higher has more priority. 3 levels from 0-2. Jobs at same priority are processed in FIFO order.
     attr_accessor :priority
 
-    # \"Number of automatic retries this job is allowed. A retry will be attempted if a task fails. Max 25. Automatic retries are performed by titan when a task reaches a failed state and has `max_retries` > 0. A retry is performed by queueing a new job with the same image id and payload. The new job's max_retries is one less than the original. The new job's `retry_of` field is set to the original Job ID.  Titan will delay the new job for retries_delay seconds before queueing it. Cancelled or successful tasks are never automatically retried.\"\n
+    # \"Number of automatic retries this job is allowed. A retry will be attempted if a task fails. Max 25. Automatic retries are performed by titan when a task reaches a failed state and has `max_retries` > 0. A retry is performed by queueing a new job with the same image id and payload. The new job's max_retries is one less than the original. The new job's `retry_of` field is set to the original Job ID.  Titan will delay the new job for retries_delay seconds before queueing it. Cancelled or successful tasks are never automatically retried.\" 
     attr_accessor :max_retries
 
     # Time in seconds to wait before retrying the job. Must be a non-negative integer.
@@ -38,16 +50,16 @@ module IronTitan
     # Unique identifier representing a specific job.
     attr_accessor :id
 
-    # States and valid transitions.\n\n                 +---------+\n       +---------> delayed <----------------+\n                 +----+----+                |\n                      |                     |\n                      |                     |\n                 +----v----+                |\n       +---------> queued  <----------------+\n                 +----+----+                *\n                      |                     *\n                      |               retry * creates new job\n                 +----v----+                *\n                 | running |                *\n                 +--+-+-+--+                |\n          +---------|-|-|-----+-------------+\n      +---|---------+ | +-----|---------+   |\n      |   |           |       |         |   |\n+-----v---^-+      +--v-------^+     +--v---^-+\n| success   |      | cancelled |     |  error |\n+-----------+      +-----------+     +--------+\n\n* delayed - has a delay.\n* queued - Ready to be consumed when it's turn comes.\n* running - Currently consumed by a runner which will attempt to process it.\n* success - (or complete? success/error is common javascript terminology)\n* error - Something went wrong. In this case more information can be obtained\n  by inspecting the \"reason\" field.\n  - timeout\n  - killed - forcibly killed by worker due to resource restrictions or access\n    violations.\n  - bad_exit - exited with non-zero status due to program termination/crash.\n* cancelled - cancelled via API. More information in the reason field.\n  - client_request - Request was cancelled by a client.\n
+    # States and valid transitions.                   +---------+        +---------> delayed <----------------+                  +----+----+                |                       |                     |                       |                     |                  +----v----+                |        +---------> queued  <----------------+                  +----+----+                *                       |                     *                       |               retry * creates new job                  +----v----+                *                  | running |                *                  +--+-+-+--+                |           +---------|-|-|-----+-------------+       +---|---------+ | +-----|---------+   |       |   |           |       |         |   | +-----v---^-+      +--v-------^+     +--v---^-+ | success   |      | cancelled |     |  error | +-----------+      +-----------+     +--------+  * delayed - has a delay. * queued - Ready to be consumed when it's turn comes. * running - Currently consumed by a runner which will attempt to process it. * success - (or complete? success/error is common javascript terminology) * error - Something went wrong. In this case more information can be obtained   by inspecting the \"reason\" field.   - timeout   - killed - forcibly killed by worker due to resource restrictions or access     violations.   - bad_exit - exited with non-zero status due to program termination/crash. * cancelled - cancelled via API. More information in the reason field.   - client_request - Request was cancelled by a client. 
     attr_accessor :status
 
-    # Group this job belongs to. 
-    attr_accessor :name
+    # Group this job belongs to.
+    attr_accessor :group_name
 
     # The error message, if status is 'error'. This is errors due to things outside the job itself. Errors from user code will be found in the log.
     attr_accessor :error
 
-    # Machine usable reason for job being in this state.\nValid values for error status are `timeout | killed | bad_exit`.\nValid values for cancelled status are `client_request`.\nFor everything else, this is undefined.\n
+    # Machine usable reason for job being in this state. Valid values for error status are `timeout | killed | bad_exit`. Valid values for cancelled status are `client_request`. For everything else, this is undefined. 
     attr_accessor :reason
 
     # Time when job was submitted. Always in UTC.
@@ -65,44 +77,52 @@ module IronTitan
     # If this field is set, then this job was retried by the job referenced in this field.
     attr_accessor :retry_at
 
+    # Env vars for the task. Comes from the ones set on the Group.
+    attr_accessor :env_vars
+
+    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
       {
-        
         :'image' => :'image',
-        
         :'payload' => :'payload',
-        
         :'delay' => :'delay',
-        
         :'timeout' => :'timeout',
-        
         :'priority' => :'priority',
-        
         :'max_retries' => :'max_retries',
-        
         :'retries_delay' => :'retries_delay',
-        
         :'id' => :'id',
-        
         :'status' => :'status',
-        
-        :'name' => :'name',
-        
+        :'group_name' => :'group_name',
         :'error' => :'error',
-        
         :'reason' => :'reason',
-        
         :'created_at' => :'created_at',
-        
         :'started_at' => :'started_at',
-        
         :'completed_at' => :'completed_at',
-        
         :'retry_of' => :'retry_of',
-        
-        :'retry_at' => :'retry_at'
-        
+        :'retry_at' => :'retry_at',
+        :'env_vars' => :'env_vars'
       }
     end
 
@@ -118,122 +138,166 @@ module IronTitan
         :'retries_delay' => :'Integer',
         :'id' => :'String',
         :'status' => :'String',
-        :'name' => :'String',
+        :'group_name' => :'String',
         :'error' => :'String',
         :'reason' => :'String',
         :'created_at' => :'DateTime',
         :'started_at' => :'DateTime',
         :'completed_at' => :'DateTime',
         :'retry_of' => :'String',
-        :'retry_at' => :'String'
-        
+        :'retry_at' => :'String',
+        :'env_vars' => :'Hash<String, String>'
       }
     end
 
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 
       # convert string to symbol for hash key
-      attributes = attributes.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
+      attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
 
-      
-      if attributes[:'image']
+      if attributes.has_key?(:'image')
         self.image = attributes[:'image']
       end
-      
-      if attributes[:'payload']
+
+      if attributes.has_key?(:'payload')
         self.payload = attributes[:'payload']
       end
-      
-      if attributes[:'delay']
+
+      if attributes.has_key?(:'delay')
         self.delay = attributes[:'delay']
       else
         self.delay = 0
       end
-      
-      if attributes[:'timeout']
+
+      if attributes.has_key?(:'timeout')
         self.timeout = attributes[:'timeout']
       else
         self.timeout = 60
       end
-      
-      if attributes[:'priority']
+
+      if attributes.has_key?(:'priority')
         self.priority = attributes[:'priority']
       end
-      
-      if attributes[:'max_retries']
+
+      if attributes.has_key?(:'max_retries')
         self.max_retries = attributes[:'max_retries']
       else
         self.max_retries = 0
       end
-      
-      if attributes[:'retries_delay']
+
+      if attributes.has_key?(:'retries_delay')
         self.retries_delay = attributes[:'retries_delay']
       else
         self.retries_delay = 60
       end
-      
-      if attributes[:'id']
+
+      if attributes.has_key?(:'id')
         self.id = attributes[:'id']
       end
-      
-      if attributes[:'status']
+
+      if attributes.has_key?(:'status')
         self.status = attributes[:'status']
       end
-      
-      if attributes[:'name']
-        self.name = attributes[:'name']
+
+      if attributes.has_key?(:'group_name')
+        self.group_name = attributes[:'group_name']
       end
-      
-      if attributes[:'error']
+
+      if attributes.has_key?(:'error')
         self.error = attributes[:'error']
       end
-      
-      if attributes[:'reason']
+
+      if attributes.has_key?(:'reason')
         self.reason = attributes[:'reason']
       end
-      
-      if attributes[:'created_at']
+
+      if attributes.has_key?(:'created_at')
         self.created_at = attributes[:'created_at']
       end
-      
-      if attributes[:'started_at']
+
+      if attributes.has_key?(:'started_at')
         self.started_at = attributes[:'started_at']
       end
-      
-      if attributes[:'completed_at']
+
+      if attributes.has_key?(:'completed_at')
         self.completed_at = attributes[:'completed_at']
       end
-      
-      if attributes[:'retry_of']
+
+      if attributes.has_key?(:'retry_of')
         self.retry_of = attributes[:'retry_of']
       end
-      
-      if attributes[:'retry_at']
+
+      if attributes.has_key?(:'retry_at')
         self.retry_at = attributes[:'retry_at']
       end
-      
+
+      if attributes.has_key?(:'env_vars')
+        if (value = attributes[:'env_vars']).is_a?(Array)
+          self.env_vars = value
+        end
+      end
+
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properies with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      return 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?
+      return false if @image.nil?
+      return false if @payload.to_s.length < 
+      return false if @priority.nil?
+      status_validator = EnumAttributeValidator.new('String', ["delayed", "queued", "running", "success", "error", "cancelled"])
+      return false unless status_validator.valid?(@status)
+      reason_validator = EnumAttributeValidator.new('String', ["timeout", "killed", "bad_exit", "client_request"])
+      return false unless reason_validator.valid?(@reason)
+      return true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] payload Value to be assigned
+    def payload=(payload)
+      if payload.nil?
+        fail ArgumentError, "payload cannot be nil"
+      end
+
+      if payload.to_s.length < 
+        fail ArgumentError, "invalid value for 'payload', the character length must be great than or equal to ."
+      end
+
+      @payload = payload
     end
 
     # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] status Object to be assigned
     def status=(status)
-      allowed_values = ["delayed", "queued", "running", "success", "error", "cancelled"]
-      if status && !allowed_values.include?(status)
-        fail "invalid value for 'status', must be one of #{allowed_values}"
+      validator = EnumAttributeValidator.new('String', ["delayed", "queued", "running", "success", "error", "cancelled"])
+      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] reason Object to be assigned
     def reason=(reason)
-      allowed_values = ["timeout", "killed", "bad_exit", "client_request"]
-      if reason && !allowed_values.include?(reason)
-        fail "invalid value for 'reason', must be one of #{allowed_values}"
+      validator = EnumAttributeValidator.new('String', ["timeout", "killed", "bad_exit", "client_request"])
+      unless validator.valid?(reason)
+        fail ArgumentError, "invalid value for 'reason', must be one of #{validator.allowable_values}."
       end
       @reason = reason
     end
 
-    # Check equality by comparing each attribute.
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
@@ -246,46 +310,53 @@ module IronTitan
           retries_delay == o.retries_delay &&
           id == o.id &&
           status == o.status &&
-          name == o.name &&
+          group_name == o.group_name &&
           error == o.error &&
           reason == o.reason &&
           created_at == o.created_at &&
           started_at == o.started_at &&
           completed_at == o.completed_at &&
           retry_of == o.retry_of &&
-          retry_at == o.retry_at
+          retry_at == o.retry_at &&
+          env_vars == o.env_vars
     end
 
     # @see the `==` method
+    # @param [Object] Object to be compared
     def eql?(o)
       self == o
     end
 
-    # Calculate hash code according to all attributes.
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
     def hash
-      [image, payload, delay, timeout, priority, max_retries, retries_delay, id, status, name, error, reason, created_at, started_at, completed_at, retry_of, retry_at].hash
+      [image, payload, delay, timeout, priority, max_retries, retries_delay, id, status, group_name, error, reason, created_at, started_at, completed_at, retry_of, retry_at, env_vars].hash
     end
 
-    # build the object from hash
+    # 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.swagger_types.each_pair do |key, type|
         if type =~ /^Array<(.*)>/i
+          # check to ensure the input is an array given that the 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) } )
-          else
-            #TODO show warning in debug mode
           end
         elsif !attributes[self.class.attribute_map[key]].nil?
           self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
-        else
-          # data not found in attributes(hash), not an issue as the data can be optional
-        end
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
       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 :DateTime
@@ -319,21 +390,25 @@ module IronTitan
           end
         end
       else # model
-        _model = IronTitan.const_get(type).new
-        _model.build_from_hash(value)
+        temp_model = IronTitan.const_get(type).new
+        temp_model.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_body (backward compatibility))
+    # 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
 
-    # return the object in the form of hash
+    # 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|
@@ -344,8 +419,10 @@ module IronTitan
       hash
     end
 
-    # Method to output non-array value in the form of hash
+    # 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) }
@@ -361,4 +438,5 @@ module IronTitan
     end
 
   end
+
 end

data/lib/iron_titan/models/job_wrapper.rb

@@ -3,25 +3,36 @@ Titan API
 
 The ultimate, language agnostic, container based job processing framework.
 
-OpenAPI spec version: 0.3.10
+OpenAPI spec version: 0.4.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
 
 =end
 
 require 'date'
 
 module IronTitan
+
   class JobWrapper
     attr_accessor :job
 
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        
         :'job' => :'job'
-        
       }
     end
 
@@ -29,24 +40,39 @@ module IronTitan
     def self.swagger_types
       {
         :'job' => :'Job'
-        
       }
     end
 
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 
       # convert string to symbol for hash key
-      attributes = attributes.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
+      attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
 
-      
-      if attributes[:'job']
+      if attributes.has_key?(:'job')
         self.job = attributes[:'job']
       end
-      
+
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properies with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      return 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?
+      return false if @job.nil?
+      return true
     end
 
-    # Check equality by comparing each attribute.
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
@@ -54,35 +80,41 @@ module IronTitan
     end
 
     # @see the `==` method
+    # @param [Object] Object to be compared
     def eql?(o)
       self == o
     end
 
-    # Calculate hash code according to all attributes.
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
     def hash
       [job].hash
     end
 
-    # build the object from hash
+    # 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.swagger_types.each_pair do |key, type|
         if type =~ /^Array<(.*)>/i
+          # check to ensure the input is an array given that the 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) } )
-          else
-            #TODO show warning in debug mode
           end
         elsif !attributes[self.class.attribute_map[key]].nil?
           self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
-        else
-          # data not found in attributes(hash), not an issue as the data can be optional
-        end
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
       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 :DateTime
@@ -116,21 +148,25 @@ module IronTitan
           end
         end
       else # model
-        _model = IronTitan.const_get(type).new
-        _model.build_from_hash(value)
+        temp_model = IronTitan.const_get(type).new
+        temp_model.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_body (backward compatibility))
+    # 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
 
-    # return the object in the form of hash
+    # 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|
@@ -141,8 +177,10 @@ module IronTitan
       hash
     end
 
-    # Method to output non-array value in the form of hash
+    # 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) }
@@ -158,4 +196,5 @@ module IronTitan
     end
 
   end
+
 end