Class: Azure::CognitiveServices::CustomSearch::V1_0::Models::WebPage

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

Overview

Defines a webpage that is relevant to the query.

Instance Attribute Summary collapse

Attributes inherited from CreativeWork

#provider, #text, #thumbnail_url

Attributes inherited from Thing

#bing_id, #description, #name, #url

Attributes inherited from Response

#web_search_url

Attributes inherited from Identifiable

#id

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ WebPage

Returns a new instance of WebPage.



16
17
18
 
# File 'lib/1.0/generated/azure_cognitiveservices_customsearch/models/web_page.rb', line 16

def initialize
  @_type = "WebPage"
end

Instance Attribute Details

#_type ⇒ Object

Returns the value of attribute _type.



20
21
22
 
# File 'lib/1.0/generated/azure_cognitiveservices_customsearch/models/web_page.rb', line 20

def _type
  @_type
end

#date_last_crawled ⇒ String

is in the form, YYYY-MM-DDTHH:MM:SS. For example, 2015-04-13T05:23:39.

Returns:

  • (String) —

    The last time that Bing crawled the webpage. The date



38
39
40
 
# File 'lib/1.0/generated/azure_cognitiveservices_customsearch/models/web_page.rb', line 38

def date_last_crawled
  @date_last_crawled
end

#deep_links ⇒ Array<WebPage>

found in the website that contains this webpage. The Webpage object in this context includes only the name, url, urlPingSuffix, and snippet fields.

Returns:

  • (Array<WebPage>) —

    A list of links to related content that Bing



34
35
36
 
# File 'lib/1.0/generated/azure_cognitiveservices_customsearch/models/web_page.rb', line 34

def deep_links
  @deep_links
end

#display_url ⇒ String

display purposes only and is not well formed.

Returns:

  • (String) —

    The display URL of the webpage. The URL is meant for



24
25
26
 
# File 'lib/1.0/generated/azure_cognitiveservices_customsearch/models/web_page.rb', line 24

def display_url
  @display_url
end

#search_tags ⇒ Array<WebMetaTag>

owner specified on the webpage. The API returns only indexed search tags. The name field of the MetaTag object contains the indexed search tag. Search tags begin with search.* (for example, search.assetId). The content field contains the tag’s value.

Returns:

  • (Array<WebMetaTag>) —

    A list of search tags that the webpage



45
46
47
 
# File 'lib/1.0/generated/azure_cognitiveservices_customsearch/models/web_page.rb', line 45

def search_tags
  @search_tags
end

#snippet ⇒ String

contents.

Returns:

  • (String) —

    A snippet of text from the webpage that describes its



28
29
30
 
# File 'lib/1.0/generated/azure_cognitiveservices_customsearch/models/web_page.rb', line 28

def snippet
  @snippet
end

Class Method Details

.mapper ⇒ Object

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



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
 
# File 'lib/1.0/generated/azure_cognitiveservices_customsearch/models/web_page.rb', line 52

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'WebPage',
    type: {
      name: 'Composite',
      class_name: 'WebPage',
      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'
          }
        },
        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'
          }
        },
        description: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'description',
          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'
                }
            }
          }
        },
        text: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'text',
          type: {
            name: 'String'
          }
        },
        display_url: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'displayUrl',
          type: {
            name: 'String'
          }
        },
        snippet: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'snippet',
          type: {
            name: 'String'
          }
        },
        deep_links: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'deepLinks',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'WebPageElementType',
                type: {
                  name: 'Composite',
                  class_name: 'WebPage'
                }
            }
          }
        },
        date_last_crawled: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'dateLastCrawled',
          type: {
            name: 'String'
          }
        },
        search_tags: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'searchTags',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'WebMetaTagElementType',
                type: {
                  name: 'Composite',
                  class_name: 'WebMetaTag'
                }
            }
          }
        }
      }
    }
  }
end