Class: PinterestSdkClient::VideoMetadataWithItemType

Inherits:
ApiModelBase
  • Object
show all
Defined in:
lib/pinterest_sdk/models/video_metadata_with_item_type.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ VideoMetadataWithItemType

Initializes the object

Parameters:

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

    Model attributes in the form of hash



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/pinterest_sdk/models/video_metadata_with_item_type.rb', line 80

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `PinterestSdkClient::VideoMetadataWithItemType` 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 `PinterestSdkClient::VideoMetadataWithItemType`. 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?(:'cover_image_url')
    self.cover_image_url = attributes[:'cover_image_url']
  end

  if attributes.key?(:'duration')
    self.duration = attributes[:'duration']
  end

  if attributes.key?(:'height')
    self.height = attributes[:'height']
  end

  if attributes.key?(:'item_type')
    self.item_type = attributes[:'item_type']
  end

  if attributes.key?(:'video_url')
    self.video_url = attributes[:'video_url']
  end

  if attributes.key?(:'width')
    self.width = attributes[:'width']
  end
end

Instance Attribute Details

#cover_image_url ⇒ Object

Returns the value of attribute cover_image_url.



18
19
20
 
# File 'lib/pinterest_sdk/models/video_metadata_with_item_type.rb', line 18

def cover_image_url
  @cover_image_url
end

#duration ⇒ Object

Duration (in miliseconds). Field maybe null after creation due to video processing time.



21
22
23
 
# File 'lib/pinterest_sdk/models/video_metadata_with_item_type.rb', line 21

def duration
  @duration
end

#height ⇒ Object

Height (in pixels). Field maybe null after creation due to video processing time.



24
25
26
 
# File 'lib/pinterest_sdk/models/video_metadata_with_item_type.rb', line 24

def height
  @height
end

#item_type ⇒ Object

Returns the value of attribute item_type.



26
27
28
 
# File 'lib/pinterest_sdk/models/video_metadata_with_item_type.rb', line 26

def item_type
  @item_type
end

#video_url ⇒ Object

Video url (720p). Note: This field is limited and not available to all apps.



29
30
31
 
# File 'lib/pinterest_sdk/models/video_metadata_with_item_type.rb', line 29

def video_url
  @video_url
end

#width ⇒ Object

Width (in pixels). Field maybe null after creation due to video processing time.



32
33
34
 
# File 'lib/pinterest_sdk/models/video_metadata_with_item_type.rb', line 32

def width
  @width
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



47
48
49
 
# File 'lib/pinterest_sdk/models/video_metadata_with_item_type.rb', line 47

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



52
53
54
 
# File 'lib/pinterest_sdk/models/video_metadata_with_item_type.rb', line 52

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



35
36
37
38
39
40
41
42
43
44
 
# File 'lib/pinterest_sdk/models/video_metadata_with_item_type.rb', line 35

def self.attribute_map
  {
    :'cover_image_url' => :'cover_image_url',
    :'duration' => :'duration',
    :'height' => :'height',
    :'item_type' => :'item_type',
    :'video_url' => :'video_url',
    :'width' => :'width'
  }
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



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/pinterest_sdk/models/video_metadata_with_item_type.rb', line 162

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



69
70
71
72
73
74
75
76
 
# File 'lib/pinterest_sdk/models/video_metadata_with_item_type.rb', line 69

def self.openapi_nullable
  Set.new([
    :'duration',
    :'height',
    :'video_url',
    :'width'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



57
58
59
60
61
62
63
64
65
66
 
# File 'lib/pinterest_sdk/models/video_metadata_with_item_type.rb', line 57

def self.openapi_types
  {
    :'cover_image_url' => :'String',
    :'duration' => :'Float',
    :'height' => :'Integer',
    :'item_type' => :'String',
    :'video_url' => :'String',
    :'width' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



136
137
138
139
140
141
142
143
144
145
 
# File 'lib/pinterest_sdk/models/video_metadata_with_item_type.rb', line 136

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      cover_image_url == o.cover_image_url &&
      duration == o.duration &&
      height == o.height &&
      item_type == o.item_type &&
      video_url == o.video_url &&
      width == o.width
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


149
150
151
 
# File 'lib/pinterest_sdk/models/video_metadata_with_item_type.rb', line 149

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



155
156
157
 
# File 'lib/pinterest_sdk/models/video_metadata_with_item_type.rb', line 155

def hash
  [cover_image_url, duration, height, item_type, video_url, width].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



121
122
123
124
125
 
# File 'lib/pinterest_sdk/models/video_metadata_with_item_type.rb', line 121

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/pinterest_sdk/models/video_metadata_with_item_type.rb', line 184

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

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



129
130
131
132
 
# File 'lib/pinterest_sdk/models/video_metadata_with_item_type.rb', line 129

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end