Skip to content
Permalink
Fetching contributors…
Cannot retrieve contributors at this time
1049 lines (968 sloc) 74.9 KB
/**
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for
* license information.
*
* Code generated by Microsoft (R) AutoRest Code Generator.
*/
package com.microsoft.azure.cognitiveservices.search.newssearch;
import com.microsoft.azure.cognitiveservices.search.newssearch.models.SearchOptionalParameter;
import com.microsoft.azure.cognitiveservices.search.newssearch.models.CategoryOptionalParameter;
import com.microsoft.azure.cognitiveservices.search.newssearch.models.TrendingOptionalParameter;
import com.microsoft.azure.cognitiveservices.search.newssearch.models.ErrorResponseException;
import com.microsoft.azure.cognitiveservices.search.newssearch.models.Freshness;
import com.microsoft.azure.cognitiveservices.search.newssearch.models.NewsModel;
import com.microsoft.azure.cognitiveservices.search.newssearch.models.SafeSearch;
import com.microsoft.azure.cognitiveservices.search.newssearch.models.TextFormat;
import com.microsoft.azure.cognitiveservices.search.newssearch.models.TrendingTopics;
import rx.Observable;
/**
* An instance of this class provides access to all the operations defined
* in BingNews.
*/
public interface BingNews {
/**
* The News Search API lets you send a search query to Bing and get back a list of news that are relevant to
* the search query. This section provides technical details about the query parameters and headers that you
* use to request news and the JSON response objects that contain them. For examples that show how to make
* requests, see [Searching the web for
* news](https://docs.microsoft.com/en-us/azure/cognitive-services/bing-news-search/search-the-web).
*
* @param query The user's search query string. The query string cannot be empty. The query string may contain [Bing
* Advanced Operators](http://msdn.microsoft.com/library/ff795620.aspx). For example, to limit news to a
* specific domain, use the [site:](http://msdn.microsoft.com/library/ff795613.aspx) operator. Use this
* parameter only with the News Search API. Do not specify this parameter when calling the Trending Topics API
* or News Category API.
* @param searchOptionalParameter the object representing the optional parameters to be set before calling this API
* @throws IllegalArgumentException thrown if parameters fail the validation
* @throws ErrorResponseException thrown if the request is rejected by server
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent
* @return the NewsModel object if successful.
*/
NewsModel search(String query, SearchOptionalParameter searchOptionalParameter);
/**
* The News Search API lets you send a search query to Bing and get back a list of news that are relevant to
* the search query. This section provides technical details about the query parameters and headers that you
* use to request news and the JSON response objects that contain them. For examples that show how to make
* requests, see [Searching the web for
* news](https://docs.microsoft.com/en-us/azure/cognitive-services/bing-news-search/search-the-web).
*
* @param query The user's search query string. The query string cannot be empty. The query string may contain [Bing
* Advanced Operators](http://msdn.microsoft.com/library/ff795620.aspx). For example, to limit news to a
* specific domain, use the [site:](http://msdn.microsoft.com/library/ff795613.aspx) operator. Use this
* parameter only with the News Search API. Do not specify this parameter when calling the Trending Topics API
* or News Category API.
* @param searchOptionalParameter the object representing the optional parameters to be set before calling this API
* @throws IllegalArgumentException thrown if parameters fail the validation
* @return the observable to the NewsModel object
*/
Observable<NewsModel> searchAsync(String query, SearchOptionalParameter searchOptionalParameter);
/**
* The News Search API lets you send a search query to Bing and get back a list of news that are relevant to
* the search query. This section provides technical details about the query parameters and headers that you
* use to request news and the JSON response objects that contain them. For examples that show how to make
* requests, see [Searching the web for
* news](https://docs.microsoft.com/en-us/azure/cognitive-services/bing-news-search/search-the-web).
*
* @return the first stage of the search call
*/
BingNewsSearchDefinitionStages.WithQuery search();
/**
* Grouping of search definition stages.
*/
interface BingNewsSearchDefinitionStages {
/**
* The stage of the definition to be specify query.
*/
interface WithQuery {
/**
* The user's search query string. The query string cannot be empty. The query string may contain [Bing
* Advanced Operators](http://msdn.microsoft.com/library/ff795620.aspx). For example, to limit news to a
* specific domain, use the [site:](http://msdn.microsoft.com/library/ff795613.aspx) operator. Use this
* parameter only with the News Search API. Do not specify this parameter when calling the Trending Topics API
* or News Category API.
*
* @return next definition stage
*/
BingNewsSearchDefinitionStages.WithExecute withQuery(String query);
}
/**
* The stage of the definition which allows for any other optional settings to be specified.
*/
interface WithAllOptions {
/**
* A comma-delimited list of one or more languages to use for user interface strings. The list is in decreasing
* order of preference. For additional information, including expected format, see
* [RFC2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html). This header and the
* [setLang](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#setlang)
* query parameter are mutually exclusive; do not specify both. If you set this header, you must also specify
* the [cc](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#cc) query
* parameter. To determine the market to return results for, Bing uses the first supported language it finds
* from the list and combines it with the cc parameter value. If the list does not include a supported
* language, Bing finds the closest language and market that supports the request or it uses an aggregated or
* default market for the results. To determine the market that Bing used, see the BingAPIs-Market header. Use
* this header and the cc query parameter only if you specify multiple languages. Otherwise, use the
* [mkt](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#mkt) and
* [setLang](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#setlang)
* query parameters. A user interface string is a string that's used as a label in a user interface. There are
* few user interface strings in the JSON response objects. Any links to Bing.com properties in the response
* objects apply the specified language.
*
* @return next definition stage
*/
BingNewsSearchDefinitionStages.WithExecute withAcceptLanguage(String acceptLanguage);
/**
* The user agent originating the request. Bing uses the user agent to provide mobile users with an optimized
* experience. Although optional, you are encouraged to always specify this header. The user-agent should be
* the same string that any commonly used browser sends. For information about user agents, see [RFC
* 2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html). The following are examples of user-agent
* strings. Windows Phone: Mozilla/5.0 (compatible; MSIE 10.0; Windows Phone 8.0; Trident/6.0; IEMobile/10.0;
* ARM; Touch; NOKIA; Lumia 822). Android: Mozilla / 5.0 (Linux; U; Android 2.3.5; en - us; SCH - I500 Build /
* GINGERBREAD) AppleWebKit / 533.1 (KHTML; like Gecko) Version / 4.0 Mobile Safari / 533.1. iPhone: Mozilla /
* 5.0 (iPhone; CPU iPhone OS 6_1 like Mac OS X) AppleWebKit / 536.26 (KHTML; like Gecko) Mobile / 10B142
* iPhone4; 1 BingWeb / 3.03.1428.20120423. PC: Mozilla / 5.0 (Windows NT 6.3; WOW64; Trident / 7.0; Touch;
* rv:11.0) like Gecko. iPad: Mozilla / 5.0 (iPad; CPU OS 7_0 like Mac OS X) AppleWebKit / 537.51.1 (KHTML,
* like Gecko) Version / 7.0 Mobile / 11A465 Safari / 9537.53.
*
* @return next definition stage
*/
BingNewsSearchDefinitionStages.WithExecute withUserAgent(String userAgent);
/**
* Bing uses this header to provide users with consistent behavior across Bing API calls. Bing often flights
* new features and improvements, and it uses the client ID as a key for assigning traffic on different
* flights. If you do not use the same client ID for a user across multiple requests, then Bing may assign the
* user to multiple conflicting flights. Being assigned to multiple conflicting flights can lead to an
* inconsistent user experience. For example, if the second request has a different flight assignment than the
* first, the experience may be unexpected. Also, Bing can use the client ID to tailor web results to that
* client ID’s search history, providing a richer experience for the user. Bing also uses this header to help
* improve result rankings by analyzing the activity generated by a client ID. The relevance improvements help
* with better quality of results delivered by Bing APIs and in turn enables higher click-through rates for the
* API consumer. IMPORTANT: Although optional, you should consider this header required. Persisting the client
* ID across multiple requests for the same end user and device combination enables 1) the API consumer to
* receive a consistent user experience, and 2) higher click-through rates via better quality of results from
* the Bing APIs. Each user that uses your application on the device must have a unique, Bing generated client
* ID. If you do not include this header in the request, Bing generates an ID and returns it in the
* X-MSEdge-ClientID response header. The only time that you should NOT include this header in a request is the
* first time the user uses your app on that device. Use the client ID for each Bing API request that your app
* makes for this user on the device. Persist the client ID. To persist the ID in a browser app, use a
* persistent HTTP cookie to ensure the ID is used across all sessions. Do not use a session cookie. For other
* apps such as mobile apps, use the device's persistent storage to persist the ID. The next time the user uses
* your app on that device, get the client ID that you persisted. Bing responses may or may not include this
* header. If the response includes this header, capture the client ID and use it for all subsequent Bing
* requests for the user on that device. If you include the X-MSEdge-ClientID, you must not include cookies in
* the request.
*
* @return next definition stage
*/
BingNewsSearchDefinitionStages.WithExecute withClientId(String clientId);
/**
* The IPv4 or IPv6 address of the client device. The IP address is used to discover the user's location. Bing
* uses the location information to determine safe search behavior. Although optional, you are encouraged to
* always specify this header and the X-Search-Location header. Do not obfuscate the address (for example, by
* changing the last octet to 0). Obfuscating the address results in the location not being anywhere near the
* device's actual location, which may result in Bing serving erroneous results.
*
* @return next definition stage
*/
BingNewsSearchDefinitionStages.WithExecute withClientIp(String clientIp);
/**
* A semicolon-delimited list of key/value pairs that describe the client's geographical location. Bing uses
* the location information to determine safe search behavior and to return relevant local content. Specify the
* key/value pair as &lt;key&gt;:&lt;value&gt;. The following
* are the keys that you use to specify the user's location. lat (required): The latitude of the client's
* location, in degrees. The latitude must be greater than or equal to -90.0 and less than or equal to +90.0.
* Negative values indicate southern latitudes and positive values indicate northern latitudes. long
* (required): The longitude of the client's location, in degrees. The longitude must be greater than or equal
* to -180.0 and less than or equal to +180.0. Negative values indicate western longitudes and positive values
* indicate eastern longitudes. re (required): The radius, in meters, which specifies the horizontal accuracy
* of the coordinates. Pass the value returned by the device's location service. Typical values might be 22m
* for GPS/Wi-Fi, 380m for cell tower triangulation, and 18,000m for reverse IP lookup. ts (optional): The UTC
* UNIX timestamp of when the client was at the location. (The UNIX timestamp is the number of seconds since
* January 1, 1970.) head (optional): The client's relative heading or direction of travel. Specify the
* direction of travel as degrees from 0 through 360, counting clockwise relative to true north. Specify this
* key only if the sp key is nonzero. sp (optional): The horizontal velocity (speed), in meters per second,
* that the client device is traveling. alt (optional): The altitude of the client device, in meters. are
* (optional): The radius, in meters, that specifies the vertical accuracy of the coordinates. Specify this key
* only if you specify the alt key. Although many of the keys are optional, the more information that you
* provide, the more accurate the location results are. Although optional, you are encouraged to always specify
* the user's geographical location. Providing the location is especially important if the client's IP address
* does not accurately reflect the user's physical location (for example, if the client uses VPN). For optimal
* results, you should include this header and the X-MSEdge-ClientIP header, but at a minimum, you should
* include this header.
*
* @return next definition stage
*/
BingNewsSearchDefinitionStages.WithExecute withLocation(String location);
/**
* A 2-character country code of the country where the results come from. This API supports only the United
* States market. If you specify this query parameter, it must be set to us. If you set this parameter, you
* must also specify the Accept-Language header. Bing uses the first supported language it finds from the
* languages list, and combine that language with the country code that you specify to determine the market to
* return results for. If the languages list does not include a supported language, Bing finds the closest
* language and market that supports the request, or it may use an aggregated or default market for the results
* instead of a specified one. You should use this query parameter and the Accept-Language query parameter only
* if you specify multiple languages; otherwise, you should use the mkt and setLang query parameters. This
* parameter and the mkt query parameter are mutually exclusive—do not specify both.
*
* @return next definition stage
*/
BingNewsSearchDefinitionStages.WithExecute withCountryCode(String countryCode);
/**
* The number of news articles to return in the response. The actual number delivered may be less than
* requested. The default is 10 and the maximum value is 100. The actual number delivered may be less than
* requested.You may use this parameter along with the offset parameter to page results. For example, if your
* user interface displays 20 articles per page, set count to 20 and offset to 0 to get the first page of
* results. For each subsequent page, increment offset by 20 (for example, 0, 20, 40). It is possible for
* multiple pages to include some overlap in results.
*
* @return next definition stage
*/
BingNewsSearchDefinitionStages.WithExecute withCount(Integer count);
/**
* Filter news by the date and time that Bing discovered the news. The following are the possible filter
* values. Day: Return news discovered within the last 24 hours. Week: Return news discovered within the last 7
* days. Month: Return news discovered within the last 30 days. Use this parameter only with the News Search
* API. Do not specify this parameter when calling the News Category API or the Trending Topics API. Possible
* values include: 'Day', 'Week', 'Month'.
*
* @return next definition stage
*/
BingNewsSearchDefinitionStages.WithExecute withFreshness(Freshness freshness);
/**
* The market where the results come from. Typically, mkt is the country where the user is making the request
* from. However, it could be a different country if the user is not located in a country where Bing delivers
* results. The market must be in the form
* &lt;language code&gt;-&lt;country code&gt;. For example, en-US. The string is
* case insensitive. For a list of possible market values, see [Market
* Codes](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#market-codes).
* NOTE: If known, you are encouraged to always specify the market. Specifying the market helps Bing route the
* request and return an appropriate and optimal response. If you specify a market that is not listed in
* [Market
* Codes](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#market-codes),
* Bing uses a best fit market code based on an internal mapping that is subject to change. This parameter and
* the [cc](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#cc) query
* parameter are mutually exclusive—do not specify both.
*
* @return next definition stage
*/
BingNewsSearchDefinitionStages.WithExecute withMarket(String market);
/**
* The zero-based offset that indicates the number of news to skip before returning news. The default is 0. The
* offset should be less than
([totalEstimatedMatche* s](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#news-totalmatches)
* - count). Use this parameter along with the count parameter to page results. For example, if your user
* interface displays 20 news per page, set count to 20 and offset to 0 to get the first page of results. For
* each subsequent page, increment offset by 20 (for example, 0, 20, 40). It is possible for multiple pages to
* include some overlap in results.
*
* @return next definition stage
*/
BingNewsSearchDefinitionStages.WithExecute withOffset(Integer offset);
/**
* A Boolean value that determines whether the image's contentUrl contains a URL that points to a thumbnail of
* the original article's image or the image itself. If the article includes an image, and this parameter is
* set to true, the image's contentUrl property contains a URL that you may use to download the original image
* from the publisher's website. Otherwise, if this parameter is false, the image's contentUrl and thumbnailUrl
* URLs both point to the same thumbnail image. Use this parameter only with the News Search API. Do not
* specify this parameter when calling the Trending Topics API or News Category API.
*
* @return next definition stage
*/
BingNewsSearchDefinitionStages.WithExecute withOriginalImage(Boolean originalImage);
/**
* Filter news for adult content. The following are the possible filter values. Off: Return news articles with
* adult text, images, or videos. Moderate: Return news articles with adult text but not adult images or
* videos. Strict: Do not return news articles with adult text, images, or videos. If the request comes from a
* market that Bing's adult policy requires that safeSearch is set to Strict, Bing ignores the safeSearch value
* and uses Strict. If you use the site: query operator, there is the chance that the response may contain
* adult content regardless of what the safeSearch query parameter is set to. Use site: only if you are aware
* of the content on the site and your scenario supports the possibility of adult content. Possible values
* include: 'Off', 'Moderate', 'Strict'.
*
* @return next definition stage
*/
BingNewsSearchDefinitionStages.WithExecute withSafeSearch(SafeSearch safeSearch);
/**
* The language to use for user interface strings. Specify the language using the ISO 639-1 2-letter language
* code. For example, the language code for English is EN. The default is EN (English). Although optional, you
* should always specify the language. Typically, you set setLang to the same language specified by mkt unless
* the user wants the user interface strings displayed in a different language. This parameter and the
[Accept-Lang* uage](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#acceptlanguage)
* header are mutually exclusive; do not specify both. A user interface string is a string that's used as a
* label in a user interface. There are few user interface strings in the JSON response objects. Also, any
* links to Bing.com properties in the response objects apply the specified language.
*
* @return next definition stage
*/
BingNewsSearchDefinitionStages.WithExecute withSetLang(String setLang);
/**
* The order to return the news in. The following are the possible case-insensitive values. Date: If the
* request is through the News Search API, the response returns news articles sorted by date from the most
* recent to the oldest. If the request is through the News Trending Topics API, the response returns trending
* topics sorted by date from the most recent to the oldest.
*
* @return next definition stage
*/
BingNewsSearchDefinitionStages.WithExecute withSortBy(String sortBy);
/**
* A Boolean value that determines whether display strings contain decoration markers such as hit highlighting
* characters. If true, the strings may include markers. The default is false. To specify whether to use
* Unicode characters or HTML tags as the markers, see the
[te* xtFormat](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#textformat)
* query parameter. For information about hit highlighting, see [Hit
* Highlighting](https://docs.microsoft.com/azure/cognitive-services/bing-news-search/hit-highlighting).
*
* @return next definition stage
*/
BingNewsSearchDefinitionStages.WithExecute withTextDecorations(Boolean textDecorations);
/**
* The type of markers to use for text decorations (see the textDecorations query parameter). Possible values
* are Raw—Use Unicode characters to mark content that needs special formatting. The Unicode characters are in
* the range E000 through E019. For example, Bing uses E000 and E001 to mark the beginning and end of query
* terms for hit highlighting. HTML—Use HTML tags to mark content that needs special formatting. For example,
* use &lt;b&gt; tags to highlight query terms in display strings. The default is
* Raw. For display strings that contain escapable HTML characters such as
* &lt;, &gt;, and &amp;, if textFormat is set to HTML, Bing escapes the characters
* as appropriate (for example, &lt; is escaped to &amp;lt;). Possible values include: 'Raw', 'Html'.
*
* @return next definition stage
*/
BingNewsSearchDefinitionStages.WithExecute withTextFormat(TextFormat textFormat);
}
/**
* The last stage of the definition which will make the operation call.
*/
interface WithExecute extends BingNewsSearchDefinitionStages.WithAllOptions {
/**
* Execute the request.
*
* @return the NewsModel object if successful.
*/
NewsModel execute();
/**
* Execute the request asynchronously.
*
* @return the observable to the NewsModel object
*/
Observable<NewsModel> executeAsync();
}
}
/**
* The entirety of search definition.
*/
interface BingNewsSearchDefinition extends
BingNewsSearchDefinitionStages.WithQuery,
BingNewsSearchDefinitionStages.WithExecute {
}
/**
* The News Category API lets lets you search on Bing and get back a list of top news articles by category.
* This section provides technical details about the query parameters and headers that you use to request news
* and the JSON response objects that contain them. For examples that show how to make requests, see
* [Searching the web for
* news](https://docs.microsoft.com/en-us/azure/cognitive-services/bing-news-search/search-the-web).
*
* @param categoryOptionalParameter the object representing the optional parameters to be set before calling this API
* @throws IllegalArgumentException thrown if parameters fail the validation
* @throws ErrorResponseException thrown if the request is rejected by server
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent
* @return the NewsModel object if successful.
*/
NewsModel category(CategoryOptionalParameter categoryOptionalParameter);
/**
* The News Category API lets lets you search on Bing and get back a list of top news articles by category.
* This section provides technical details about the query parameters and headers that you use to request news
* and the JSON response objects that contain them. For examples that show how to make requests, see
* [Searching the web for
* news](https://docs.microsoft.com/en-us/azure/cognitive-services/bing-news-search/search-the-web).
*
* @param categoryOptionalParameter the object representing the optional parameters to be set before calling this API
* @throws IllegalArgumentException thrown if parameters fail the validation
* @return the observable to the NewsModel object
*/
Observable<NewsModel> categoryAsync(CategoryOptionalParameter categoryOptionalParameter);
/**
* The News Category API lets lets you search on Bing and get back a list of top news articles by category.
* This section provides technical details about the query parameters and headers that you use to request news
* and the JSON response objects that contain them. For examples that show how to make requests, see
* [Searching the web for
* news](https://docs.microsoft.com/en-us/azure/cognitive-services/bing-news-search/search-the-web).
*
* @return the first stage of the category call
*/
BingNewsCategoryDefinitionStages.WithExecute category();
/**
* Grouping of category definition stages.
*/
interface BingNewsCategoryDefinitionStages {
/**
* The stage of the definition which allows for any other optional settings to be specified.
*/
interface WithAllOptions {
/**
* A comma-delimited list of one or more languages to use for user interface strings. The list is in decreasing
* order of preference. For additional information, including expected format, see
* [RFC2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html). This header and the
* [setLang](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#setlang)
* query parameter are mutually exclusive; do not specify both. If you set this header, you must also specify
* the [cc](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#cc) query
* parameter. To determine the market to return results for, Bing uses the first supported language it finds
* from the list and combines it with the cc parameter value. If the list does not include a supported
* language, Bing finds the closest language and market that supports the request or it uses an aggregated or
* default market for the results. To determine the market that Bing used, see the BingAPIs-Market header. Use
* this header and the cc query parameter only if you specify multiple languages. Otherwise, use the
* [mkt](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#mkt) and
* [setLang](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#setlang)
* query parameters. A user interface string is a string that's used as a label in a user interface. There are
* few user interface strings in the JSON response objects. Any links to Bing.com properties in the response
* objects apply the specified language.
*
* @return next definition stage
*/
BingNewsCategoryDefinitionStages.WithExecute withAcceptLanguage(String acceptLanguage);
/**
* The user agent originating the request. Bing uses the user agent to provide mobile users with an optimized
* experience. Although optional, you are encouraged to always specify this header. The user-agent should be
* the same string that any commonly used browser sends. For information about user agents, see [RFC
* 2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html). The following are examples of user-agent
* strings. Windows Phone: Mozilla/5.0 (compatible; MSIE 10.0; Windows Phone 8.0; Trident/6.0; IEMobile/10.0;
* ARM; Touch; NOKIA; Lumia 822). Android: Mozilla / 5.0 (Linux; U; Android 2.3.5; en - us; SCH - I500 Build /
* GINGERBREAD) AppleWebKit / 533.1 (KHTML; like Gecko) Version / 4.0 Mobile Safari / 533.1. iPhone: Mozilla /
* 5.0 (iPhone; CPU iPhone OS 6_1 like Mac OS X) AppleWebKit / 536.26 (KHTML; like Gecko) Mobile / 10B142
* iPhone4; 1 BingWeb / 3.03.1428.20120423. PC: Mozilla / 5.0 (Windows NT 6.3; WOW64; Trident / 7.0; Touch;
* rv:11.0) like Gecko. iPad: Mozilla / 5.0 (iPad; CPU OS 7_0 like Mac OS X) AppleWebKit / 537.51.1 (KHTML,
* like Gecko) Version / 7.0 Mobile / 11A465 Safari / 9537.53.
*
* @return next definition stage
*/
BingNewsCategoryDefinitionStages.WithExecute withUserAgent(String userAgent);
/**
* Bing uses this header to provide users with consistent behavior across Bing API calls. Bing often flights
* new features and improvements, and it uses the client ID as a key for assigning traffic on different
* flights. If you do not use the same client ID for a user across multiple requests, then Bing may assign the
* user to multiple conflicting flights. Being assigned to multiple conflicting flights can lead to an
* inconsistent user experience. For example, if the second request has a different flight assignment than the
* first, the experience may be unexpected. Also, Bing can use the client ID to tailor web results to that
* client ID’s search history, providing a richer experience for the user. Bing also uses this header to help
* improve result rankings by analyzing the activity generated by a client ID. The relevance improvements help
* with better quality of results delivered by Bing APIs and in turn enables higher click-through rates for the
* API consumer. IMPORTANT: Although optional, you should consider this header required. Persisting the client
* ID across multiple requests for the same end user and device combination enables 1) the API consumer to
* receive a consistent user experience, and 2) higher click-through rates via better quality of results from
* the Bing APIs. Each user that uses your application on the device must have a unique, Bing generated client
* ID. If you do not include this header in the request, Bing generates an ID and returns it in the
* X-MSEdge-ClientID response header. The only time that you should NOT include this header in a request is the
* first time the user uses your app on that device. Use the client ID for each Bing API request that your app
* makes for this user on the device. Persist the client ID. To persist the ID in a browser app, use a
* persistent HTTP cookie to ensure the ID is used across all sessions. Do not use a session cookie. For other
* apps such as mobile apps, use the device's persistent storage to persist the ID. The next time the user uses
* your app on that device, get the client ID that you persisted. Bing responses may or may not include this
* header. If the response includes this header, capture the client ID and use it for all subsequent Bing
* requests for the user on that device. If you include the X-MSEdge-ClientID, you must not include cookies in
* the request.
*
* @return next definition stage
*/
BingNewsCategoryDefinitionStages.WithExecute withClientId(String clientId);
/**
* The IPv4 or IPv6 address of the client device. The IP address is used to discover the user's location. Bing
* uses the location information to determine safe search behavior. Although optional, you are encouraged to
* always specify this header and the X-Search-Location header. Do not obfuscate the address (for example, by
* changing the last octet to 0). Obfuscating the address results in the location not being anywhere near the
* device's actual location, which may result in Bing serving erroneous results.
*
* @return next definition stage
*/
BingNewsCategoryDefinitionStages.WithExecute withClientIp(String clientIp);
/**
* A semicolon-delimited list of key/value pairs that describe the client's geographical location. Bing uses
* the location information to determine safe search behavior and to return relevant local content. Specify the
* key/value pair as &lt;key&gt;:&lt;value&gt;. The following
* are the keys that you use to specify the user's location. lat (required): The latitude of the client's
* location, in degrees. The latitude must be greater than or equal to -90.0 and less than or equal to +90.0.
* Negative values indicate southern latitudes and positive values indicate northern latitudes. long
* (required): The longitude of the client's location, in degrees. The longitude must be greater than or equal
* to -180.0 and less than or equal to +180.0. Negative values indicate western longitudes and positive values
* indicate eastern longitudes. re (required): The radius, in meters, which specifies the horizontal accuracy
* of the coordinates. Pass the value returned by the device's location service. Typical values might be 22m
* for GPS/Wi-Fi, 380m for cell tower triangulation, and 18,000m for reverse IP lookup. ts (optional): The UTC
* UNIX timestamp of when the client was at the location. (The UNIX timestamp is the number of seconds since
* January 1, 1970.) head (optional): The client's relative heading or direction of travel. Specify the
* direction of travel as degrees from 0 through 360, counting clockwise relative to true north. Specify this
* key only if the sp key is nonzero. sp (optional): The horizontal velocity (speed), in meters per second,
* that the client device is traveling. alt (optional): The altitude of the client device, in meters. are
* (optional): The radius, in meters, that specifies the vertical accuracy of the coordinates. Specify this key
* only if you specify the alt key. Although many of the keys are optional, the more information that you
* provide, the more accurate the location results are. Although optional, you are encouraged to always specify
* the user's geographical location. Providing the location is especially important if the client's IP address
* does not accurately reflect the user's physical location (for example, if the client uses VPN). For optimal
* results, you should include this header and the X-MSEdge-ClientIP header, but at a minimum, you should
* include this header.
*
* @return next definition stage
*/
BingNewsCategoryDefinitionStages.WithExecute withLocation(String location);
/**
* A 2-character country code of the country where the results come from. This API supports only the United
* States market. If you specify this query parameter, it must be set to us. If you set this parameter, you
* must also specify the Accept-Language header. Bing uses the first supported language it finds from the
* languages list, and combine that language with the country code that you specify to determine the market to
* return results for. If the languages list does not include a supported language, Bing finds the closest
* language and market that supports the request, or it may use an aggregated or default market for the results
* instead of a specified one. You should use this query parameter and the Accept-Language query parameter only
* if you specify multiple languages; otherwise, you should use the mkt and setLang query parameters. This
* parameter and the mkt query parameter are mutually exclusive—do not specify both.
*
* @return next definition stage
*/
BingNewsCategoryDefinitionStages.WithExecute withCountryCode(String countryCode);
/**
* The category of articles to return. For example, Sports articles or Entertainment articles. For a list of
* possible categories, see [News Categories by
Market](h* ttps://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#categories-by-market).
* Use this parameter only with News Category API. If you do not specify this parameter, the response includes
* both: Headline articles typically published in the last 24 hours from any category and articles from each
* parent category (up to four articles). If the article is a headline, the article's headline field is set to
* true. By default, the response includes up to 12 headline articles. To specify the number of headline
* articles to return, set the
[headline* Count](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#headlineCount)
* query parameter.
*
* @return next definition stage
*/
BingNewsCategoryDefinitionStages.WithExecute withCategory(String category);
/**
* The number of news articles to return in the response. The actual number delivered may be less than
* requested. The default is 10 and the maximum value is 100. The actual number delivered may be less than
* requested.You may use this parameter along with the offset parameter to page results. For example, if your
* user interface displays 20 articles per page, set count to 20 and offset to 0 to get the first page of
* results. For each subsequent page, increment offset by 20 (for example, 0, 20, 40). It is possible for
* multiple pages to include some overlap in results. If you do not specify the
* [category](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#category)
* parameter, Bing ignores this parameter.
*
* @return next definition stage
*/
BingNewsCategoryDefinitionStages.WithExecute withCount(Integer count);
/**
* The number of headline articles to return in the response. The default is 12. Specify this parameter only if
* you do not specify the
* [category](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#category)
* parameter.
*
* @return next definition stage
*/
BingNewsCategoryDefinitionStages.WithExecute withHeadlineCount(Integer headlineCount);
/**
* The market where the results come from. Typically, mkt is the country where the user is making the request
* from. However, it could be a different country if the user is not located in a country where Bing delivers
* results. The market must be in the form
* &lt;language code&gt;-&lt;country code&gt;. For example, en-US. The string is
* case insensitive. For a list of possible market values, see [Market
* Codes](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#market-codes).
* NOTE: If known, you are encouraged to always specify the market. Specifying the market helps Bing route the
* request and return an appropriate and optimal response. If you specify a market that is not listed in
* [Market
* Codes](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#market-codes),
* Bing uses a best fit market code based on an internal mapping that is subject to change. This parameter and
* the [cc](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#cc) query
* parameter are mutually exclusive—do not specify both.
*
* @return next definition stage
*/
BingNewsCategoryDefinitionStages.WithExecute withMarket(String market);
/**
* The zero-based offset that indicates the number of news to skip before returning news. The default is 0. The
* offset should be less than
([totalEstimatedMatche* s](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#news-totalmatches)
* - count). Use this parameter along with the count parameter to page results. For example, if your user
* interface displays 20 news per page, set count to 20 and offset to 0 to get the first page of results. For
* each subsequent page, increment offset by 20 (for example, 0, 20, 40). It is possible for multiple pages to
* include some overlap in results. If you do not specify the
* [category](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#category)
* parameter, Bing ignores this parameter.
*
* @return next definition stage
*/
BingNewsCategoryDefinitionStages.WithExecute withOffset(Integer offset);
/**
* A Boolean value that determines whether the image's contentUrl contains a URL that points to a thumbnail of
* the original article's image or the image itself. If the article includes an image, and this parameter is
* set to true, the image's contentUrl property contains a URL that you may use to download the original image
* from the publisher's website. Otherwise, if this parameter is false, the image's contentUrl and thumbnailUrl
* URLs both point to the same thumbnail image. Use this parameter only with the News Search API or News
* Category API. Trending Topics API ignore this parameter.
*
* @return next definition stage
*/
BingNewsCategoryDefinitionStages.WithExecute withOriginalImage(Boolean originalImage);
/**
* Filter news for adult content. The following are the possible filter values. Off: Return news articles with
* adult text, images, or videos. Moderate: Return news articles with adult text but not adult images or
* videos. Strict: Do not return news articles with adult text, images, or videos. If the request comes from a
* market that Bing's adult policy requires that safeSearch is set to Strict, Bing ignores the safeSearch value
* and uses Strict. If you use the site: query operator, there is the chance that the response may contain
* adult content regardless of what the safeSearch query parameter is set to. Use site: only if you are aware
* of the content on the site and your scenario supports the possibility of adult content. Possible values
* include: 'Off', 'Moderate', 'Strict'.
*
* @return next definition stage
*/
BingNewsCategoryDefinitionStages.WithExecute withSafeSearch(SafeSearch safeSearch);
/**
* The language to use for user interface strings. Specify the language using the ISO 639-1 2-letter language
* code. For example, the language code for English is EN. The default is EN (English). Although optional, you
* should always specify the language. Typically, you set setLang to the same language specified by mkt unless
* the user wants the user interface strings displayed in a different language. This parameter and the
[Accept-Lang* uage](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#acceptlanguage)
* header are mutually exclusive; do not specify both. A user interface string is a string that's used as a
* label in a user interface. There are few user interface strings in the JSON response objects. Also, any
* links to Bing.com properties in the response objects apply the specified language.
*
* @return next definition stage
*/
BingNewsCategoryDefinitionStages.WithExecute withSetLang(String setLang);
/**
* A Boolean value that determines whether display strings contain decoration markers such as hit highlighting
* characters. If true, the strings may include markers. The default is false. To specify whether to use
* Unicode characters or HTML tags as the markers, see the
[te* xtFormat](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#textformat)
* query parameter. For information about hit highlighting, see [Hit
* Highlighting](https://docs.microsoft.com/azure/cognitive-services/bing-news-search/hit-highlighting).
*
* @return next definition stage
*/
BingNewsCategoryDefinitionStages.WithExecute withTextDecorations(Boolean textDecorations);
/**
* The type of markers to use for text decorations (see the textDecorations query parameter). Possible values
* are Raw—Use Unicode characters to mark content that needs special formatting. The Unicode characters are in
* the range E000 through E019. For example, Bing uses E000 and E001 to mark the beginning and end of query
* terms for hit highlighting. HTML—Use HTML tags to mark content that needs special formatting. For example,
* use &lt;b&gt; tags to highlight query terms in display strings. The default is
* Raw. For display strings that contain escapable HTML characters such as
* &lt;, &gt;, and &amp;, if textFormat is set to HTML, Bing escapes the characters
* as appropriate (for example, &lt; is escaped to &amp;lt;). Possible values include: 'Raw', 'Html'.
*
* @return next definition stage
*/
BingNewsCategoryDefinitionStages.WithExecute withTextFormat(TextFormat textFormat);
}
/**
* The last stage of the definition which will make the operation call.
*/
interface WithExecute extends BingNewsCategoryDefinitionStages.WithAllOptions {
/**
* Execute the request.
*
* @return the NewsModel object if successful.
*/
NewsModel execute();
/**
* Execute the request asynchronously.
*
* @return the observable to the NewsModel object
*/
Observable<NewsModel> executeAsync();
}
}
/**
* The entirety of category definition.
*/
interface BingNewsCategoryDefinition extends
BingNewsCategoryDefinitionStages.WithExecute {
}
/**
* The News Trending Topics API lets lets you search on Bing and get back a list of trending news topics that
* are currently trending on Bing. This section provides technical details about the query parameters and
* headers that you use to request news and the JSON response objects that contain them. For examples that
* show how to make requests, see [Searching the web for
* news](https://docs.microsoft.com/en-us/azure/cognitive-services/bing-news-search/search-the-web).
*
* @param trendingOptionalParameter the object representing the optional parameters to be set before calling this API
* @throws IllegalArgumentException thrown if parameters fail the validation
* @throws ErrorResponseException thrown if the request is rejected by server
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent
* @return the TrendingTopics object if successful.
*/
TrendingTopics trending(TrendingOptionalParameter trendingOptionalParameter);
/**
* The News Trending Topics API lets lets you search on Bing and get back a list of trending news topics that
* are currently trending on Bing. This section provides technical details about the query parameters and
* headers that you use to request news and the JSON response objects that contain them. For examples that
* show how to make requests, see [Searching the web for
* news](https://docs.microsoft.com/en-us/azure/cognitive-services/bing-news-search/search-the-web).
*
* @param trendingOptionalParameter the object representing the optional parameters to be set before calling this API
* @throws IllegalArgumentException thrown if parameters fail the validation
* @return the observable to the TrendingTopics object
*/
Observable<TrendingTopics> trendingAsync(TrendingOptionalParameter trendingOptionalParameter);
/**
* The News Trending Topics API lets lets you search on Bing and get back a list of trending news topics that
* are currently trending on Bing. This section provides technical details about the query parameters and
* headers that you use to request news and the JSON response objects that contain them. For examples that
* show how to make requests, see [Searching the web for
* news](https://docs.microsoft.com/en-us/azure/cognitive-services/bing-news-search/search-the-web).
*
* @return the first stage of the trending call
*/
BingNewsTrendingDefinitionStages.WithExecute trending();
/**
* Grouping of trending definition stages.
*/
interface BingNewsTrendingDefinitionStages {
/**
* The stage of the definition which allows for any other optional settings to be specified.
*/
interface WithAllOptions {
/**
* A comma-delimited list of one or more languages to use for user interface strings. The list is in decreasing
* order of preference. For additional information, including expected format, see
* [RFC2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html). This header and the
* [setLang](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#setlang)
* query parameter are mutually exclusive; do not specify both. If you set this header, you must also specify
* the [cc](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#cc) query
* parameter. To determine the market to return results for, Bing uses the first supported language it finds
* from the list and combines it with the cc parameter value. If the list does not include a supported
* language, Bing finds the closest language and market that supports the request or it uses an aggregated or
* default market for the results. To determine the market that Bing used, see the BingAPIs-Market header. Use
* this header and the cc query parameter only if you specify multiple languages. Otherwise, use the
* [mkt](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#mkt) and
* [setLang](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#setlang)
* query parameters. A user interface string is a string that's used as a label in a user interface. There are
* few user interface strings in the JSON response objects. Any links to Bing.com properties in the response
* objects apply the specified language.
*
* @return next definition stage
*/
BingNewsTrendingDefinitionStages.WithExecute withAcceptLanguage(String acceptLanguage);
/**
* The user agent originating the request. Bing uses the user agent to provide mobile users with an optimized
* experience. Although optional, you are encouraged to always specify this header. The user-agent should be
* the same string that any commonly used browser sends. For information about user agents, see [RFC
* 2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html). The following are examples of user-agent
* strings. Windows Phone: Mozilla/5.0 (compatible; MSIE 10.0; Windows Phone 8.0; Trident/6.0; IEMobile/10.0;
* ARM; Touch; NOKIA; Lumia 822). Android: Mozilla / 5.0 (Linux; U; Android 2.3.5; en - us; SCH - I500 Build /
* GINGERBREAD) AppleWebKit / 533.1 (KHTML; like Gecko) Version / 4.0 Mobile Safari / 533.1. iPhone: Mozilla /
* 5.0 (iPhone; CPU iPhone OS 6_1 like Mac OS X) AppleWebKit / 536.26 (KHTML; like Gecko) Mobile / 10B142
* iPhone4; 1 BingWeb / 3.03.1428.20120423. PC: Mozilla / 5.0 (Windows NT 6.3; WOW64; Trident / 7.0; Touch;
* rv:11.0) like Gecko. iPad: Mozilla / 5.0 (iPad; CPU OS 7_0 like Mac OS X) AppleWebKit / 537.51.1 (KHTML,
* like Gecko) Version / 7.0 Mobile / 11A465 Safari / 9537.53.
*
* @return next definition stage
*/
BingNewsTrendingDefinitionStages.WithExecute withUserAgent(String userAgent);
/**
* Bing uses this header to provide users with consistent behavior across Bing API calls. Bing often flights
* new features and improvements, and it uses the client ID as a key for assigning traffic on different
* flights. If you do not use the same client ID for a user across multiple requests, then Bing may assign the
* user to multiple conflicting flights. Being assigned to multiple conflicting flights can lead to an
* inconsistent user experience. For example, if the second request has a different flight assignment than the
* first, the experience may be unexpected. Also, Bing can use the client ID to tailor web results to that
* client ID’s search history, providing a richer experience for the user. Bing also uses this header to help
* improve result rankings by analyzing the activity generated by a client ID. The relevance improvements help
* with better quality of results delivered by Bing APIs and in turn enables higher click-through rates for the
* API consumer. IMPORTANT: Although optional, you should consider this header required. Persisting the client
* ID across multiple requests for the same end user and device combination enables 1) the API consumer to
* receive a consistent user experience, and 2) higher click-through rates via better quality of results from
* the Bing APIs. Each user that uses your application on the device must have a unique, Bing generated client
* ID. If you do not include this header in the request, Bing generates an ID and returns it in the
* X-MSEdge-ClientID response header. The only time that you should NOT include this header in a request is the
* first time the user uses your app on that device. Use the client ID for each Bing API request that your app
* makes for this user on the device. Persist the client ID. To persist the ID in a browser app, use a
* persistent HTTP cookie to ensure the ID is used across all sessions. Do not use a session cookie. For other
* apps such as mobile apps, use the device's persistent storage to persist the ID. The next time the user uses
* your app on that device, get the client ID that you persisted. Bing responses may or may not include this
* header. If the response includes this header, capture the client ID and use it for all subsequent Bing
* requests for the user on that device. If you include the X-MSEdge-ClientID, you must not include cookies in
* the request.
*
* @return next definition stage
*/
BingNewsTrendingDefinitionStages.WithExecute withClientId(String clientId);
/**
* The IPv4 or IPv6 address of the client device. The IP address is used to discover the user's location. Bing
* uses the location information to determine safe search behavior. Although optional, you are encouraged to
* always specify this header and the X-Search-Location header. Do not obfuscate the address (for example, by
* changing the last octet to 0). Obfuscating the address results in the location not being anywhere near the
* device's actual location, which may result in Bing serving erroneous results.
*
* @return next definition stage
*/
BingNewsTrendingDefinitionStages.WithExecute withClientIp(String clientIp);
/**
* A semicolon-delimited list of key/value pairs that describe the client's geographical location. Bing uses
* the location information to determine safe search behavior and to return relevant local content. Specify the
* key/value pair as &lt;key&gt;:&lt;value&gt;. The following
* are the keys that you use to specify the user's location. lat (required): The latitude of the client's
* location, in degrees. The latitude must be greater than or equal to -90.0 and less than or equal to +90.0.
* Negative values indicate southern latitudes and positive values indicate northern latitudes. long
* (required): The longitude of the client's location, in degrees. The longitude must be greater than or equal
* to -180.0 and less than or equal to +180.0. Negative values indicate western longitudes and positive values
* indicate eastern longitudes. re (required): The radius, in meters, which specifies the horizontal accuracy
* of the coordinates. Pass the value returned by the device's location service. Typical values might be 22m
* for GPS/Wi-Fi, 380m for cell tower triangulation, and 18,000m for reverse IP lookup. ts (optional): The UTC
* UNIX timestamp of when the client was at the location. (The UNIX timestamp is the number of seconds since
* January 1, 1970.) head (optional): The client's relative heading or direction of travel. Specify the
* direction of travel as degrees from 0 through 360, counting clockwise relative to true north. Specify this
* key only if the sp key is nonzero. sp (optional): The horizontal velocity (speed), in meters per second,
* that the client device is traveling. alt (optional): The altitude of the client device, in meters. are
* (optional): The radius, in meters, that specifies the vertical accuracy of the coordinates. Specify this key
* only if you specify the alt key. Although many of the keys are optional, the more information that you
* provide, the more accurate the location results are. Although optional, you are encouraged to always specify
* the user's geographical location. Providing the location is especially important if the client's IP address
* does not accurately reflect the user's physical location (for example, if the client uses VPN). For optimal
* results, you should include this header and the X-MSEdge-ClientIP header, but at a minimum, you should
* include this header.
*
* @return next definition stage
*/
BingNewsTrendingDefinitionStages.WithExecute withLocation(String location);
/**
* A 2-character country code of the country where the results come from. This API supports only the United
* States market. If you specify this query parameter, it must be set to us. If you set this parameter, you
* must also specify the Accept-Language header. Bing uses the first supported language it finds from the
* languages list, and combine that language with the country code that you specify to determine the market to
* return results for. If the languages list does not include a supported language, Bing finds the closest
* language and market that supports the request, or it may use an aggregated or default market for the results
* instead of a specified one. You should use this query parameter and the Accept-Language query parameter only
* if you specify multiple languages; otherwise, you should use the mkt and setLang query parameters. This
* parameter and the mkt query parameter are mutually exclusive—do not specify both.
*
* @return next definition stage
*/
BingNewsTrendingDefinitionStages.WithExecute withCountryCode(String countryCode);
/**
* The number of news articles to return in the response. The actual number delivered may be less than
* requested. The default is 10 and the maximum value is 100. The actual number delivered may be less than
* requested.You may use this parameter along with the offset parameter to page results. For example, if your
* user interface displays 20 articles per page, set count to 20 and offset to 0 to get the first page of
* results. For each subsequent page, increment offset by 20 (for example, 0, 20, 40). It is possible for
* multiple pages to include some overlap in results.
*
* @return next definition stage
*/
BingNewsTrendingDefinitionStages.WithExecute withCount(Integer count);
/**
* The market where the results come from. Typically, mkt is the country where the user is making the request
* from. However, it could be a different country if the user is not located in a country where Bing delivers
* results. The market must be in the form
* &lt;language code&gt;-&lt;country code&gt;. For example, en-US. The string is
* case insensitive. For a list of possible market values, see [Market
* Codes](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#market-codes).
* NOTE: If known, you are encouraged to always specify the market. Specifying the market helps Bing route the
* request and return an appropriate and optimal response. If you specify a market that is not listed in
* [Market
* Codes](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#market-codes),
* Bing uses a best fit market code based on an internal mapping that is subject to change. This parameter and
* the [cc](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#cc) query
* parameter are mutually exclusive—do not specify both.
*
* @return next definition stage
*/
BingNewsTrendingDefinitionStages.WithExecute withMarket(String market);
/**
* The zero-based offset that indicates the number of news to skip before returning news. The default is 0. The
* offset should be less than
([totalEstimatedMatche* s](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#news-totalmatches)
* - count). Use this parameter along with the count parameter to page results. For example, if your user
* interface displays 20 news per page, set count to 20 and offset to 0 to get the first page of results. For
* each subsequent page, increment offset by 20 (for example, 0, 20, 40). It is possible for multiple pages to
* include some overlap in results.
*
* @return next definition stage
*/
BingNewsTrendingDefinitionStages.WithExecute withOffset(Integer offset);
/**
* Filter news for adult content. The following are the possible filter values. Off: Return news articles with
* adult text, images, or videos. Moderate: Return news articles with adult text but not adult images or
* videos. Strict: Do not return news articles with adult text, images, or videos. If the request comes from a
* market that Bing's adult policy requires that safeSearch is set to Strict, Bing ignores the safeSearch value
* and uses Strict. If you use the site: query operator, there is the chance that the response may contain
* adult content regardless of what the safeSearch query parameter is set to. Use site: only if you are aware
* of the content on the site and your scenario supports the possibility of adult content. Possible values
* include: 'Off', 'Moderate', 'Strict'.
*
* @return next definition stage
*/
BingNewsTrendingDefinitionStages.WithExecute withSafeSearch(SafeSearch safeSearch);
/**
* The language to use for user interface strings. Specify the language using the ISO 639-1 2-letter language
* code. For example, the language code for English is EN. The default is EN (English). Although optional, you
* should always specify the language. Typically, you set setLang to the same language specified by mkt unless
* the user wants the user interface strings displayed in a different language. This parameter and the
[Accept-Lang* uage](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#acceptlanguage)
* header are mutually exclusive; do not specify both. A user interface string is a string that's used as a
* label in a user interface. There are few user interface strings in the JSON response objects. Also, any
* links to Bing.com properties in the response objects apply the specified language.
*
* @return next definition stage
*/
BingNewsTrendingDefinitionStages.WithExecute withSetLang(String setLang);
/**
* The Unix epoch time (Unix timestamp) that Bing uses to select the trending topics. Bing returns trending
* topics that it discovered on or after the specified date and time, not the date the topic was published. To
* use this parameter, also specify the sortBy parameter. Use this parameter only with the News Trending Topics
* API. Do not specify this parameter when calling the News Search API or News Category API.
*
* @return next definition stage
*/
BingNewsTrendingDefinitionStages.WithExecute withSince(Long since);
/**
* The order to return the news in. The following are the possible case-insensitive values. Date: If the
* request is through the News Search API, the response returns news articles sorted by date from the most
* recent to the oldest. If the request is through the News Trending Topics API, the response returns trending
* topics sorted by date from the most recent to the oldest.
*
* @return next definition stage
*/
BingNewsTrendingDefinitionStages.WithExecute withSortBy(String sortBy);
/**
* A Boolean value that determines whether display strings contain decoration markers such as hit highlighting
* characters. If true, the strings may include markers. The default is false. To specify whether to use
* Unicode characters or HTML tags as the markers, see the
[te* xtFormat](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#textformat)
* query parameter. For information about hit highlighting, see [Hit
* Highlighting](https://docs.microsoft.com/azure/cognitive-services/bing-news-search/hit-highlighting).
*
* @return next definition stage
*/
BingNewsTrendingDefinitionStages.WithExecute withTextDecorations(Boolean textDecorations);
/**
* The type of markers to use for text decorations (see the textDecorations query parameter). Possible values
* are Raw—Use Unicode characters to mark content that needs special formatting. The Unicode characters are in
* the range E000 through E019. For example, Bing uses E000 and E001 to mark the beginning and end of query
* terms for hit highlighting. HTML—Use HTML tags to mark content that needs special formatting. For example,
* use &lt;b&gt; tags to highlight query terms in display strings. The default is
* Raw. For display strings that contain escapable HTML characters such as
* &lt;, &gt;, and &amp;, if textFormat is set to HTML, Bing escapes the characters
* as appropriate (for example, &lt; is escaped to &amp;lt;). Possible values include: 'Raw', 'Html'.
*
* @return next definition stage
*/
BingNewsTrendingDefinitionStages.WithExecute withTextFormat(TextFormat textFormat);
}
/**
* The last stage of the definition which will make the operation call.
*/
interface WithExecute extends BingNewsTrendingDefinitionStages.WithAllOptions {
/**
* Execute the request.
*
* @return the TrendingTopics object if successful.
*/
TrendingTopics execute();
/**
* Execute the request asynchronously.
*
* @return the observable to the TrendingTopics object
*/
Observable<TrendingTopics> executeAsync();
}
}
/**
* The entirety of trending definition.
*/
interface BingNewsTrendingDefinition extends
BingNewsTrendingDefinitionStages.WithExecute {
}
}
You can’t perform that action at this time.