class Azure::CognitiveServices::ImageSearch::V1_0::Models::MediaObject

Defines a media object.

Attributes

_type[RW]
content_size[RW]

@return [String] Size of the media object content (use format “value unit” e.g “1024 B”).

content_url[RW]

@return [String] Original URL to retrieve the source (file) for the media object (e.g the source URL for the image).

encoding_format[RW]

@return [String] Encoding format (e.g mp3, mp4, jpeg, etc).

height[RW]

@return [Integer] The height of the source media object, in pixels.

host_page_display_url[RW]

@return [String] Display URL of the page that hosts the media object.

host_page_url[RW]

@return [String] URL of the page that hosts the media object.

width[RW]

@return [Integer] The width of the source media object, in pixels.

Private Class Methods

mapper() click to toggle source

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

# 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
new() click to toggle source
# File lib/1.0/generated/azure_cognitiveservices_imagesearch/models/media_object.rb, line 16
def initialize
  @_type = "MediaObject"
end