class Azure::CognitiveServices::WebSearch::V1_0::Models::Videos

Defines a video answer.

Attributes

_type[RW]
next_offset[RW]

@return [Integer]

query_expansions[RW]

@return [Array<Query>]

value[RW]

@return [Array<VideoObject>] A list of video objects that are relevant to the query.

Private Class Methods

mapper() click to toggle source

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

# File lib/1.0/generated/azure_cognitiveservices_websearch/models/videos.rb, line 40
def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'Videos',
    type: {
      name: 'Composite',
      class_name: 'Videos',
      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'
          }
        },
        web_search_url: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'webSearchUrl',
          type: {
            name: 'String'
          }
        },
        follow_up_queries: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'followUpQueries',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'QueryElementType',
                type: {
                  name: 'Composite',
                  class_name: 'Query'
                }
            }
          }
        },
        query_context: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'queryContext',
          type: {
            name: 'Composite',
            class_name: 'QueryContext'
          }
        },
        total_estimated_matches: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'totalEstimatedMatches',
          type: {
            name: 'Number'
          }
        },
        is_family_friendly: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'isFamilyFriendly',
          type: {
            name: 'Boolean'
          }
        },
        value: {
          client_side_validation: true,
          required: true,
          serialized_name: 'value',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'VideoObjectElementType',
                type: {
                  name: 'Composite',
                  class_name: 'VideoObject'
                }
            }
          }
        },
        next_offset: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'nextOffset',
          type: {
            name: 'Number'
          }
        },
        query_expansions: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'queryExpansions',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'QueryElementType',
                type: {
                  name: 'Composite',
                  class_name: 'Query'
                }
            }
          }
        },
        related_searches: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'relatedSearches',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'QueryElementType',
                type: {
                  name: 'Composite',
                  class_name: 'Query'
                }
            }
          }
        }
      }
    }
  }
end
new() click to toggle source
# File lib/1.0/generated/azure_cognitiveservices_websearch/models/videos.rb, line 16
def initialize
  @_type = "Videos"
end