class Azure::CognitiveServices::NewsSearch::V1_0::Models::Query

Defines a search query.

Attributes

display_text[RW]

@return [String] The display version of the query term. This version of the query term may contain special characters that highlight the search term found in the query string. The string contains the highlighting characters only if the query enabled hit highlighting

text[RW]

@return [String] The query string. Use this string as the query term in a new search request.

thumbnail[RW]

@return [ImageObject] The URL to a thumbnail of a related image.

web_search_url[RW]

@return [String] The URL that takes the user to the Bing search results page for the query.Only related search results include this field.

Private Class Methods

mapper() click to toggle source

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

# File lib/1.0/generated/azure_cognitiveservices_newssearch/models/query.rb, line 44
def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'Query',
    type: {
      name: 'Composite',
      class_name: 'Query',
      model_properties: {
        text: {
          client_side_validation: true,
          required: true,
          serialized_name: 'text',
          type: {
            name: 'String'
          }
        },
        display_text: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'displayText',
          type: {
            name: 'String'
          }
        },
        web_search_url: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'webSearchUrl',
          type: {
            name: 'String'
          }
        },
        search_link: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'searchLink',
          type: {
            name: 'String'
          }
        },
        thumbnail: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'thumbnail',
          type: {
            name: 'Composite',
            class_name: 'ImageObject'
          }
        }
      }
    }
  }
end