Class: AmznSpApi::FeedsApiModel::Feed

Inherits:
Object
  • Object
show all
Defined in:
lib/feeds_api_model/models/feed.rb

Overview

Detailed information about the feed.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Feed

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Raises:

  • (ArgumentError) 


95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/feeds_api_model/models/feed.rb', line 95

def initialize(attributes = {})
  raise ArgumentError, 'The input argument (attributes) must be a hash in `AmznSpApi::FeedsApiModel::Feed` initialize method' unless attributes.is_a?(Hash)

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) do |(k, v), h|
    raise ArgumentError, "`#{k}` is not a valid attribute in `AmznSpApi::FeedsApiModel::Feed`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect unless self.class.attribute_map.key?(k.to_sym)

    h[k.to_sym] = v
  end

  self.feed_id = attributes[:feed_id] if attributes.key?(:feed_id)

  self.feed_type = attributes[:feed_type] if attributes.key?(:feed_type)

  if attributes.key?(:marketplace_ids) && (value = attributes[:marketplace_ids]).is_a?(Array)
    self.marketplace_ids = value
  end

  self.created_time = attributes[:created_time] if attributes.key?(:created_time)

  self.processing_status = attributes[:processing_status] if attributes.key?(:processing_status)

  self.processing_start_time = attributes[:processing_start_time] if attributes.key?(:processing_start_time)

  self.processing_end_time = attributes[:processing_end_time] if attributes.key?(:processing_end_time)

  return unless attributes.key?(:result_feed_document_id)

  self.result_feed_document_id = attributes[:result_feed_document_id]
end

Instance Attribute Details

#created_time ⇒ Object

The date and time when the feed was created, in ISO 8601 date time format.



25
26
27
 
# File 'lib/feeds_api_model/models/feed.rb', line 25

def created_time
  @created_time
end

#feed_id ⇒ Object

The identifier for the feed. This identifier is unique only in combination with a seller ID.



16
17
18
 
# File 'lib/feeds_api_model/models/feed.rb', line 16

def feed_id
  @feed_id
end

#feed_type ⇒ Object

The feed type.



19
20
21
 
# File 'lib/feeds_api_model/models/feed.rb', line 19

def feed_type
  @feed_type
end

#marketplace_ids ⇒ Object

A list of identifiers for the marketplaces that the feed is applied to.



22
23
24
 
# File 'lib/feeds_api_model/models/feed.rb', line 22

def marketplace_ids
  @marketplace_ids
end

#processing_end_time ⇒ Object

The date and time when feed processing completed, in ISO 8601 date time format.



34
35
36
 
# File 'lib/feeds_api_model/models/feed.rb', line 34

def processing_end_time
  @processing_end_time
end

#processing_start_time ⇒ Object

The date and time when feed processing started, in ISO 8601 date time format.



31
32
33
 
# File 'lib/feeds_api_model/models/feed.rb', line 31

def processing_start_time
  @processing_start_time
end

#processing_status ⇒ Object

The processing status of the feed.



28
29
30
 
# File 'lib/feeds_api_model/models/feed.rb', line 28

def processing_status
  @processing_status
end

#result_feed_document_id ⇒ Object

The identifier for the feed document. This identifier is unique only in combination with a seller ID.



37
38
39
 
# File 'lib/feeds_api_model/models/feed.rb', line 37

def result_feed_document_id
  @result_feed_document_id
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/feeds_api_model/models/feed.rb', line 61

def self.attribute_map
  {
    'feed_id': :feedId,
    'feed_type': :feedType,
    'marketplace_ids': :marketplaceIds,
    'created_time': :createdTime,
    'processing_status': :processingStatus,
    'processing_start_time': :processingStartTime,
    'processing_end_time': :processingEndTime,
    'result_feed_document_id': :resultFeedDocumentId
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



195
196
197
 
# File 'lib/feeds_api_model/models/feed.rb', line 195

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



89
90
91
 
# File 'lib/feeds_api_model/models/feed.rb', line 89

def self.openapi_nullable
  Set.new([])
end

.openapi_types ⇒ Object

Attribute type mapping.



75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/feeds_api_model/models/feed.rb', line 75

def self.openapi_types
  {
    'feed_id': :Object,
    'feed_type': :Object,
    'marketplace_ids': :Object,
    'created_time': :Object,
    'processing_status': :Object,
    'processing_start_time': :Object,
    'processing_end_time': :Object,
    'result_feed_document_id': :Object
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/feeds_api_model/models/feed.rb', line 166

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    feed_id == other.feed_id &&
    feed_type == other.feed_type &&
    marketplace_ids == other.marketplace_ids &&
    created_time == other.created_time &&
    processing_status == other.processing_status &&
    processing_start_time == other.processing_start_time &&
    processing_end_time == other.processing_end_time &&
    result_feed_document_id == other.result_feed_document_id
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/feeds_api_model/models/feed.rb', line 224

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
    AmznSpApi::FeedsApiModel.const_get(type).build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/feeds_api_model/models/feed.rb', line 293

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

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/feeds_api_model/models/feed.rb', line 202

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
      send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize(::Regexp.last_match(1), v) }) if attributes[self.class.attribute_map[key]].is_a?(Array)
    elsif !attributes[self.class.attribute_map[key]].nil?
      send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      send("#{key}=", nil)
    end
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


182
183
184
 
# File 'lib/feeds_api_model/models/feed.rb', line 182

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



188
189
190
 
# File 'lib/feeds_api_model/models/feed.rb', line 188

def hash
  [feed_id, feed_type, marketplace_ids, created_time, processing_status, processing_start_time, processing_end_time, result_feed_document_id].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/feeds_api_model/models/feed.rb', line 128

def list_invalid_properties
  invalid_properties = []
  invalid_properties.push('invalid value for "feed_id", feed_id cannot be nil.') if @feed_id.nil?

  invalid_properties.push('invalid value for "feed_type", feed_type cannot be nil.') if @feed_type.nil?

  invalid_properties.push('invalid value for "created_time", created_time cannot be nil.') if @created_time.nil?

  invalid_properties.push('invalid value for "processing_status", processing_status cannot be nil.') if @processing_status.nil?

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



269
270
271
 
# File 'lib/feeds_api_model/models/feed.rb', line 269

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/feeds_api_model/models/feed.rb', line 275

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = 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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



263
264
265
 
# File 'lib/feeds_api_model/models/feed.rb', line 263

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/feeds_api_model/models/feed.rb', line 143

def valid?
  return false if @feed_id.nil?
  return false if @feed_type.nil?
  return false if @created_time.nil?
  return false if @processing_status.nil?

  processing_status_validator = EnumAttributeValidator.new('Object', %w[CANCELLED DONE FATAL IN_PROGRESS IN_QUEUE])
  return false unless processing_status_validator.valid?(@processing_status)

  true
end