Class: Azure::CognitiveServices::ImageSearch::V1_0::Models::MediaObject

Inherits:
CreativeWork show all
Includes:
MsRestAzure
Defined in:
lib/1.0/generated/azure_cognitiveservices_imagesearch/models/media_object.rb

Overview

Defines a media object.

Direct Known Subclasses

ImageObject

Instance Attribute Summary collapse

Attributes inherited from CreativeWork

#date_published, #provider, #text, #thumbnail_url

Attributes inherited from Thing

#alternate_name, #bing_id, #description, #image, #name, #url

Attributes inherited from Response

#read_link, #web_search_url

Attributes inherited from Identifiable

#id

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ MediaObject

Returns a new instance of MediaObject.



16
17
18
 
# File 'lib/1.0/generated/azure_cognitiveservices_imagesearch/models/media_object.rb', line 16

def initialize
  @_type = "MediaObject"
end

Instance Attribute Details

#_type ⇒ Object

Returns the value of attribute _type.



20
21
22
 
# File 'lib/1.0/generated/azure_cognitiveservices_imagesearch/models/media_object.rb', line 20

def _type
  @_type
end

#content_size ⇒ String

unit“ e.g ”1024 B“).

Returns:

  • (String) —

    Size of the media object content (use format “value



31
32
33
 
# File 'lib/1.0/generated/azure_cognitiveservices_imagesearch/models/media_object.rb', line 31

def content_size
  @content_size
end

#content_url ⇒ String

media object (e.g the source URL for the image).

Returns:

  • (String) —

    Original URL to retrieve the source (file) for the



24
25
26
 
# File 'lib/1.0/generated/azure_cognitiveservices_imagesearch/models/media_object.rb', line 24

def content_url
  @content_url
end

#encoding_format ⇒ String

Returns Encoding format (e.g mp3, mp4, jpeg, etc).

Returns:

  • (String) —

    Encoding format (e.g mp3, mp4, jpeg, etc).



34
35
36
 
# File 'lib/1.0/generated/azure_cognitiveservices_imagesearch/models/media_object.rb', line 34

def encoding_format
  @encoding_format
end

#height ⇒ Integer

Returns The height of the source media object, in pixels.

Returns:

  • (Integer) —

    The height of the source media object, in pixels.



43
44
45
 
# File 'lib/1.0/generated/azure_cognitiveservices_imagesearch/models/media_object.rb', line 43

def height
  @height
end

#host_page_display_url ⇒ String

Returns Display URL of the page that hosts the media object.

Returns:

  • (String) —

    Display URL of the page that hosts the media object.



37
38
39
 
# File 'lib/1.0/generated/azure_cognitiveservices_imagesearch/models/media_object.rb', line 37

def host_page_display_url
  @host_page_display_url
end

#host_page_url ⇒ String

Returns URL of the page that hosts the media object.

Returns:

  • (String) —

    URL of the page that hosts the media object.



27
28
29
 
# File 'lib/1.0/generated/azure_cognitiveservices_imagesearch/models/media_object.rb', line 27

def host_page_url
  @host_page_url
end

#width ⇒ Integer

Returns The width of the source media object, in pixels.

Returns:

  • (Integer) —

    The width of the source media object, in pixels.



40
41
42
 
# File 'lib/1.0/generated/azure_cognitiveservices_imagesearch/models/media_object.rb', line 40

def width
  @width
end

Class Method Details

.mapper ⇒ Object

Mapper for MediaObject class as Ruby Hash. This will be used for serialization/deserialization.



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
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
260
 
# File 'lib/1.0/generated/azure_cognitiveservices_imagesearch/models/media_object.rb', line 50

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'MediaObject',
    type: {
      name: 'Composite',
      class_name: 'MediaObject',
      model_properties: {
        _type: {
          client_side_validation: true,
          required: true,
          serialized_name: '_type',
          type: {
            name: 'String'
          }
        },
        id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'id',
          type: {
            name: 'String'
          }
        },
        read_link: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'readLink',
          type: {
            name: 'String'
          }
        },
        web_search_url: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'webSearchUrl',
          type: {
            name: 'String'
          }
        },
        name: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'name',
          type: {
            name: 'String'
          }
        },
        url: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'url',
          type: {
            name: 'String'
          }
        },
        image: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'image',
          type: {
            name: 'Composite',
            class_name: 'ImageObject'
          }
        },
        description: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'description',
          type: {
            name: 'String'
          }
        },
        alternate_name: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'alternateName',
          type: {
            name: 'String'
          }
        },
        bing_id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'bingId',
          type: {
            name: 'String'
          }
        },
        thumbnail_url: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'thumbnailUrl',
          type: {
            name: 'String'
          }
        },
        provider: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'provider',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'ThingElementType',
                type: {
                  name: 'Composite',
                  class_name: 'Thing'
                }
            }
          }
        },
        date_published: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'datePublished',
          type: {
            name: 'String'
          }
        },
        text: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'text',
          type: {
            name: 'String'
          }
        },
        content_url: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'contentUrl',
          type: {
            name: 'String'
          }
        },
        host_page_url: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'hostPageUrl',
          type: {
            name: 'String'
          }
        },
        content_size: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'contentSize',
          type: {
            name: 'String'
          }
        },
        encoding_format: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'encodingFormat',
          type: {
            name: 'String'
          }
        },
        host_page_display_url: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'hostPageDisplayUrl',
          type: {
            name: 'String'
          }
        },
        width: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'width',
          type: {
            name: 'Number'
          }
        },
        height: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'height',
          type: {
            name: 'Number'
          }
        }
      }
    }
  }
end