Share via

SearchOptionalParameter Class

  • Reference
Package:
com.microsoft.azure.cognitiveservices.search.customsearch.models
  • java.lang.Object
    • com.microsoft.azure.cognitiveservices.search.customsearch.models.SearchOptionalParameter

public class SearchOptionalParameter

The SearchOptionalParameter model.

Method Summary

Modifier and Type Method and Description
String acceptLanguage()

Get the acceptLanguage value.
String clientId()

Get the clientId value.
String clientIp()

Get the clientIp value.
Integer count()

Get the count value.
String countryCode()

Get the countryCode value.
String location()

Get the location value.
String market()

Get the market value.
Integer offset()

Get the offset value.
SafeSearch safeSearch()

Get the safeSearch value.
String setLang()

Get the setLang value.
Boolean textDecorations()

Get the textDecorations value.
TextFormat textFormat()

Get the textFormat value.
String userAgent()

Get the userAgent value.
SearchOptionalParameter withAcceptLanguage(String acceptLanguage)

Set the acceptLanguage value.
SearchOptionalParameter withClientId(String clientId)

Set the clientId value.
SearchOptionalParameter withClientIp(String clientIp)

Set the clientIp value.
SearchOptionalParameter withCount(Integer count)

Set the count value.
SearchOptionalParameter withCountryCode(String countryCode)

Set the countryCode value.
SearchOptionalParameter withLocation(String location)

Set the location value.
SearchOptionalParameter withMarket(String market)

Set the market value.
SearchOptionalParameter withOffset(Integer offset)

Set the offset value.
SearchOptionalParameter withSafeSearch(SafeSearch safeSearch)

Set the safeSearch value.
SearchOptionalParameter withSetLang(String setLang)

Set the setLang value.
SearchOptionalParameter withTextDecorations(Boolean textDecorations)

Set the textDecorations value.
SearchOptionalParameter withTextFormat(TextFormat textFormat)

Set the textFormat value.
SearchOptionalParameter withUserAgent(String userAgent)

Set the userAgent value.

Method Details

acceptLanguage

public String acceptLanguage()

Get the acceptLanguage value.

Returns:

the acceptLanguage value

clientId

public String clientId()

Get the clientId value.

Returns:

the clientId value

clientIp

public String clientIp()

Get the clientIp value.

Returns:

the clientIp value

count

public Integer count()

Get the count value.

Returns:

the count value

countryCode

public String countryCode()

Get the countryCode value.

Returns:

the countryCode value

location

public String location()

Get the location value.

Returns:

the location value

market

public String market()

Get the market value.

Returns:

the market value

offset

public Integer offset()

Get the offset value.

Returns:

the offset value

safeSearch

public SafeSearch safeSearch()

Get the safeSearch value.

Returns:

the safeSearch value

setLang

public String setLang()

Get the setLang value.

Returns:

the setLang value

textDecorations

public Boolean textDecorations()

Get the textDecorations value.

Returns:

the textDecorations value

textFormat

public TextFormat textFormat()

Get the textFormat value.

Returns:

the textFormat value

userAgent

public String userAgent()

Get the userAgent value.

Returns:

the userAgent value

withAcceptLanguage

public SearchOptionalParameter withAcceptLanguage(String acceptLanguage)

Set the acceptLanguage value.

Parameters:

acceptLanguage - the acceptLanguage value to set

Returns:

the SearchOptionalParameter object itself.

withClientId

public SearchOptionalParameter withClientId(String clientId)

Set the clientId value.

Parameters:

clientId - the clientId value to set

Returns:

the SearchOptionalParameter object itself.

withClientIp

public SearchOptionalParameter withClientIp(String clientIp)

Set the clientIp value.

Parameters:

clientIp - the clientIp value to set

Returns:

the SearchOptionalParameter object itself.

withCount

public SearchOptionalParameter withCount(Integer count)

Set the count value.

Parameters:

count - the count value to set

Returns:

the SearchOptionalParameter object itself.

withCountryCode

public SearchOptionalParameter withCountryCode(String countryCode)

Set the countryCode value.

Parameters:

countryCode - the countryCode value to set

Returns:

the SearchOptionalParameter object itself.

withLocation

public SearchOptionalParameter withLocation(String location)

Set the location value.

Parameters:

location - the location value to set

Returns:

the SearchOptionalParameter object itself.

withMarket

public SearchOptionalParameter withMarket(String market)

Set the market value.

Parameters:

market - the market value to set

Returns:

the SearchOptionalParameter object itself.

withOffset

public SearchOptionalParameter withOffset(Integer offset)

Set the offset value.

Parameters:

offset - the offset value to set

Returns:

the SearchOptionalParameter object itself.

withSafeSearch

public SearchOptionalParameter withSafeSearch(SafeSearch safeSearch)

Set the safeSearch value.

Parameters:

safeSearch - the safeSearch value to set

Returns:

the SearchOptionalParameter object itself.

withSetLang

public SearchOptionalParameter withSetLang(String setLang)

Set the setLang value.

Parameters:

setLang - the setLang value to set

Returns:

the SearchOptionalParameter object itself.

withTextDecorations

public SearchOptionalParameter withTextDecorations(Boolean textDecorations)

Set the textDecorations value.

Parameters:

textDecorations - the textDecorations value to set

Returns:

the SearchOptionalParameter object itself.

withTextFormat

public SearchOptionalParameter withTextFormat(TextFormat textFormat)

Set the textFormat value.

Parameters:

textFormat - the textFormat value to set

Returns:

the SearchOptionalParameter object itself.

withUserAgent

public SearchOptionalParameter withUserAgent(String userAgent)

Set the userAgent value.

Parameters:

userAgent - the userAgent value to set

Returns:

the SearchOptionalParameter object itself.

Applies to