class AmzSpApi::ReportsApiModel::CreateReportScheduleSpecification
Attributes
A list of marketplace identifiers for the report schedule.
The date and time when the schedule will create its next report, in ISO 8601 date time format.
One of a set of predefined ISO 8601 periods that specifies how often a report should be created.
The report type.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/reports-api-model/models/create_report_schedule_specification.rb, line 53 def self.attribute_map { :'report_type' => :'reportType', :'marketplace_ids' => :'marketplaceIds', :'report_options' => :'reportOptions', :'period' => :'period', :'next_report_creation_time' => :'nextReportCreationTime' } end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/reports-api-model/models/create_report_schedule_specification.rb, line 185 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/reports-api-model/models/create_report_schedule_specification.rb, line 82 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `AmzSpApi::ReportsApiModel::CreateReportScheduleSpecification` 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 `AmzSpApi::ReportsApiModel::CreateReportScheduleSpecification`. 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?(:'report_type') self.report_type = attributes[:'report_type'] end if attributes.key?(:'marketplace_ids') if (value = attributes[:'marketplace_ids']).is_a?(Array) self.marketplace_ids = value end end if attributes.key?(:'report_options') self.report_options = attributes[:'report_options'] end if attributes.key?(:'period') self.period = attributes[:'period'] end if attributes.key?(:'next_report_creation_time') self.next_report_creation_time = attributes[:'next_report_creation_time'] end end
List of attributes with nullable: true
# File lib/reports-api-model/models/create_report_schedule_specification.rb, line 75 def self.openapi_nullable Set.new([ ]) end
Attribute type mapping.
# File lib/reports-api-model/models/create_report_schedule_specification.rb, line 64 def self.openapi_types { :'report_type' => :'Object', :'marketplace_ids' => :'Object', :'report_options' => :'Object', :'period' => :'Object', :'next_report_creation_time' => :'Object' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/reports-api-model/models/create_report_schedule_specification.rb, line 160 def ==(o) return true if self.equal?(o) self.class == o.class && report_type == o.report_type && marketplace_ids == o.marketplace_ids && report_options == o.report_options && period == o.period && next_report_creation_time == o.next_report_creation_time 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/reports-api-model/models/create_report_schedule_specification.rb, line 215 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 AmzSpApi::ReportsApiModel.const_get(type).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/reports-api-model/models/create_report_schedule_specification.rb, line 284 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/reports-api-model/models/create_report_schedule_specification.rb, line 192 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 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]])) elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key) self.send("#{key}=", nil) end end self end
@see the `==` method @param [Object] Object to be compared
# File lib/reports-api-model/models/create_report_schedule_specification.rb, line 172 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/reports-api-model/models/create_report_schedule_specification.rb, line 178 def hash [report_type, marketplace_ids, report_options, period, next_report_creation_time].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/reports-api-model/models/create_report_schedule_specification.rb, line 120 def list_invalid_properties invalid_properties = Array.new if @report_type.nil? invalid_properties.push('invalid value for "report_type", report_type cannot be nil.') end if @marketplace_ids.nil? invalid_properties.push('invalid value for "marketplace_ids", marketplace_ids cannot be nil.') end if @period.nil? invalid_properties.push('invalid value for "period", period cannot be nil.') end invalid_properties end
Custom attribute writer method checking allowed values (enum). @param [Object] period Object to be assigned
# File lib/reports-api-model/models/create_report_schedule_specification.rb, line 150 def period=(period) validator = EnumAttributeValidator.new('Object', ['PT5M', 'PT15M', 'PT30M', 'PT1H', 'PT2H', 'PT4H', 'PT8H', 'PT12H', 'P1D', 'P2D', 'P3D', 'PT84H', 'P7D', 'P14D', 'P15D', 'P18D', 'P30D', 'P1M']) unless validator.valid?(period) fail ArgumentError, "invalid value for \"period\", must be one of #{validator.allowable_values}." end @period = period end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/reports-api-model/models/create_report_schedule_specification.rb, line 266 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/reports-api-model/models/create_report_schedule_specification.rb, line 254 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/reports-api-model/models/create_report_schedule_specification.rb, line 139 def valid? return false if @report_type.nil? return false if @marketplace_ids.nil? return false if @period.nil? period_validator = EnumAttributeValidator.new('Object', ['PT5M', 'PT15M', 'PT30M', 'PT1H', 'PT2H', 'PT4H', 'PT8H', 'PT12H', 'P1D', 'P2D', 'P3D', 'PT84H', 'P7D', 'P14D', 'P15D', 'P18D', 'P30D', 'P1M']) return false unless period_validator.valid?(@period) true end