class DocSpring::SubmissionBatch
Attributes
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/docspring/models/submission_batch.rb, line 58 def self.attribute_map { :'pending_count' => :'pending_count', :'completion_percentage' => :'completion_percentage', :'metadata' => :'metadata', :'total_count' => :'total_count', :'submissions' => :'submissions', :'processed_at' => :'processed_at', :'id' => :'id', :'state' => :'state', :'error_count' => :'error_count' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/docspring/models/submission_batch.rb, line 89 def initialize(attributes = {}) return unless attributes.is_a?(Hash) # convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v } if attributes.has_key?(:'pending_count') self.pending_count = attributes[:'pending_count'] end if attributes.has_key?(:'completion_percentage') self.completion_percentage = attributes[:'completion_percentage'] end if attributes.has_key?(:'metadata') self.metadata = attributes[:'metadata'] end if attributes.has_key?(:'total_count') self.total_count = attributes[:'total_count'] end if attributes.has_key?(:'submissions') if (value = attributes[:'submissions']).is_a?(Array) self.submissions = value end end if attributes.has_key?(:'processed_at') self.processed_at = attributes[:'processed_at'] end if attributes.has_key?(:'id') self.id = attributes[:'id'] end if attributes.has_key?(:'state') self.state = attributes[:'state'] end if attributes.has_key?(:'error_count') self.error_count = attributes[:'error_count'] end end
Attribute type mapping.
# File lib/docspring/models/submission_batch.rb, line 73 def self.openapi_types { :'pending_count' => :'Integer', :'completion_percentage' => :'Integer', :'metadata' => :'Object', :'total_count' => :'Integer', :'submissions' => :'Array<Submission>', :'processed_at' => :'String', :'id' => :'String', :'state' => :'String', :'error_count' => :'Integer' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/docspring/models/submission_batch.rb, line 161 def ==(o) return true if self.equal?(o) self.class == o.class && pending_count == o.pending_count && completion_percentage == o.completion_percentage && metadata == o.metadata && total_count == o.total_count && submissions == o.submissions && processed_at == o.processed_at && id == o.id && state == o.state && error_count == o.error_count end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/docspring/models/submission_batch.rb, line 211 def _deserialize(type, value) case type.to_sym when :DateTime DateTime.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 temp_model = DocSpring.const_get(type).new temp_model.build_from_hash(value) end 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
# File lib/docspring/models/submission_batch.rb, line 277 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/docspring/models/submission_batch.rb, line 190 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.openapi_types.each_pair do |key, type| if type =~ /\AArray<(.*)>/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) }) end elsif !attributes[self.class.attribute_map[key]].nil? self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) end # or else data not found in attributes(hash), not an issue as the data can be optional end self end
@see the `==` method @param [Object] Object to be compared
# File lib/docspring/models/submission_batch.rb, line 177 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/docspring/models/submission_batch.rb, line 183 def hash [pending_count, completion_percentage, metadata, total_count, submissions, processed_at, id, state, error_count].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/docspring/models/submission_batch.rb, line 136 def list_invalid_properties invalid_properties = Array.new invalid_properties end
Custom attribute writer method checking allowed values (enum). @param [Object] state Object to be assigned
# File lib/docspring/models/submission_batch.rb, line 151 def state=(state) validator = EnumAttributeValidator.new('String', ['pending', 'processed', 'error']) unless validator.valid?(state) fail ArgumentError, 'invalid value for "state", must be one of #{validator.allowable_values}.' end @state = state end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/docspring/models/submission_batch.rb, line 263 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) next if value.nil? hash[param] = _to_hash(value) end hash end
Returns the string representation of the object @return [String] String presentation of the object
# File lib/docspring/models/submission_batch.rb, line 251 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/docspring/models/submission_batch.rb, line 143 def valid? state_validator = EnumAttributeValidator.new('String', ['pending', 'processed', 'error']) return false unless state_validator.valid?(@state) true end