SearchRequest (streams-processor-pipl 0.6.1 API)

java.lang.Object
- org.apache.streams.pipl.api.SearchRequest

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

BasicSearchRequest, FullPersonSearchRequest
```
public class SearchRequest
extends Object
implements Serializable
```
See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

SearchRequest()

Constructors
Constructor and Description
`SearchRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object other)`
`Map<String,Object>`	`getAdditionalProperties()`
`String`	`getCallback()` For JSONP support in JavaScript applications.
`Boolean`	`getHideSponsored()` Whether to omit results marked "sponsored" (when additional data from this source is available behind a website paywall).
`Boolean`	`getInferPersons()` whether the API should return persons made up solely from data inferred by statistical analysis from your search query.
`String`	`getKey()` Your API key, this is our way to identify you and authorize your call.
`Boolean`	`getLiveFeeds()` Whether to use live data sources.
`String`	`getMatchRequirements()` A condition to specify what fields you must get back.
`Double`	`getMinimumMatch()` 0 – 1.
`Double`	`getMinimumProbability()` 0 – 1.
`Boolean`	`getPretty()` Indicates whether you want the response to be "pretty-printed" (with indentation).
`String`	`getShowSources()` true/false/all/matching.
`String`	`getSourceCategoryRequirements()` A condition to specify what source categories you must get back.
`Boolean`	`getTopMatch()` "top_match=true" returns the best high-ranking Person match to your search.
`int`	`hashCode()`
`void`	`setAdditionalProperty(String name, Object value)`
`void`	`setCallback(String callback)` For JSONP support in JavaScript applications.
`void`	`setHideSponsored(Boolean hideSponsored)` Whether to omit results marked "sponsored" (when additional data from this source is available behind a website paywall).
`void`	`setInferPersons(Boolean inferPersons)` whether the API should return persons made up solely from data inferred by statistical analysis from your search query.
`void`	`setKey(String key)` Your API key, this is our way to identify you and authorize your call.
`void`	`setLiveFeeds(Boolean liveFeeds)` Whether to use live data sources.
`void`	`setMatchRequirements(String matchRequirements)` A condition to specify what fields you must get back.
`void`	`setMinimumMatch(Double minimumMatch)` 0 – 1.
`void`	`setMinimumProbability(Double minimumProbability)` 0 – 1.
`void`	`setPretty(Boolean pretty)` Indicates whether you want the response to be "pretty-printed" (with indentation).
`void`	`setShowSources(String showSources)` true/false/all/matching.
`void`	`setSourceCategoryRequirements(String sourceCategoryRequirements)` A condition to specify what source categories you must get back.
`void`	`setTopMatch(Boolean topMatch)` "top_match=true" returns the best high-ranking Person match to your search.
`String`	`toString()`
`SearchRequest`	`withAdditionalProperty(String name, Object value)`
`SearchRequest`	`withCallback(String callback)`
`SearchRequest`	`withHideSponsored(Boolean hideSponsored)`
`SearchRequest`	`withInferPersons(Boolean inferPersons)`
`SearchRequest`	`withKey(String key)`
`SearchRequest`	`withLiveFeeds(Boolean liveFeeds)`
`SearchRequest`	`withMatchRequirements(String matchRequirements)`
`SearchRequest`	`withMinimumMatch(Double minimumMatch)`
`SearchRequest`	`withMinimumProbability(Double minimumProbability)`
`SearchRequest`	`withPretty(Boolean pretty)`
`SearchRequest`	`withShowSources(String showSources)`
`SearchRequest`	`withSourceCategoryRequirements(String sourceCategoryRequirements)`
`SearchRequest`	`withTopMatch(Boolean topMatch)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - SearchRequest
```
public SearchRequest()
```
- Method Detail
  - getKey
```
public String getKey()
```
    Your API key, this is our way to identify you and authorize your call.
  - setKey
```
public void setKey(String key)
```
    Your API key, this is our way to identify you and authorize your call.
  - withKey
```
public SearchRequest withKey(String key)
```
  - getPretty
```
public Boolean getPretty()
```
    Indicates whether you want the response to be "pretty-printed" (with indentation).
  - setPretty
```
public void setPretty(Boolean pretty)
```
    Indicates whether you want the response to be "pretty-printed" (with indentation).
  - withPretty
```
public SearchRequest withPretty(Boolean pretty)
```
  - getMinimumProbability
```
public Double getMinimumProbability()
```
    0 – 1. The minimum acceptable probability for inferred data.
  - setMinimumProbability
```
public void setMinimumProbability(Double minimumProbability)
```
    0 – 1. The minimum acceptable probability for inferred data.
  - withMinimumProbability
```
public SearchRequest withMinimumProbability(Double minimumProbability)
```
  - getInferPersons
```
public Boolean getInferPersons()
```
    whether the API should return persons made up solely from data inferred by statistical analysis from your search query.
  - setInferPersons
```
public void setInferPersons(Boolean inferPersons)
```
    whether the API should return persons made up solely from data inferred by statistical analysis from your search query.
  - withInferPersons
```
public SearchRequest withInferPersons(Boolean inferPersons)
```
  - getMinimumMatch
```
public Double getMinimumMatch()
```
    0 – 1. The minimum required match score for possible persons to be returned.
  - setMinimumMatch
```
public void setMinimumMatch(Double minimumMatch)
```
    0 – 1. The minimum required match score for possible persons to be returned.
  - withMinimumMatch
```
public SearchRequest withMinimumMatch(Double minimumMatch)
```
  - getShowSources
```
public String getShowSources()
```
    true/false/all/matching. all - all sources are shown. matching or true - only sources from the person. false - don’t show sources.
  - setShowSources
```
public void setShowSources(String showSources)
```
    true/false/all/matching. all - all sources are shown. matching or true - only sources from the person. false - don’t show sources.
  - withShowSources
```
public SearchRequest withShowSources(String showSources)
```
  - getHideSponsored
```
public Boolean getHideSponsored()
```
    Whether to omit results marked "sponsored" (when additional data from this source is available behind a website paywall).
  - setHideSponsored
```
public void setHideSponsored(Boolean hideSponsored)
```
    Whether to omit results marked "sponsored" (when additional data from this source is available behind a website paywall).
  - withHideSponsored
```
public SearchRequest withHideSponsored(Boolean hideSponsored)
```
  - getLiveFeeds
```
public Boolean getLiveFeeds()
```
    Whether to use live data sources.
  - setLiveFeeds
```
public void setLiveFeeds(Boolean liveFeeds)
```
    Whether to use live data sources.
  - withLiveFeeds
```
public SearchRequest withLiveFeeds(Boolean liveFeeds)
```
  - getMatchRequirements
```
public String getMatchRequirements()
```
    A condition to specify what fields you must get back. Responses not meeting the criteria will return empty and won’t be charged.
  - setMatchRequirements
```
public void setMatchRequirements(String matchRequirements)
```
    A condition to specify what fields you must get back. Responses not meeting the criteria will return empty and won’t be charged.
  - withMatchRequirements
```
public SearchRequest withMatchRequirements(String matchRequirements)
```
  - getSourceCategoryRequirements
```
public String getSourceCategoryRequirements()
```
    A condition to specify what source categories you must get back. Responses with no persons that meet the criteria will return empty and won’t be charged.
  - setSourceCategoryRequirements
```
public void setSourceCategoryRequirements(String sourceCategoryRequirements)
```
    A condition to specify what source categories you must get back. Responses with no persons that meet the criteria will return empty and won’t be charged.
  - withSourceCategoryRequirements
```
public SearchRequest withSourceCategoryRequirements(String sourceCategoryRequirements)
```
  - getCallback
```
public String getCallback()
```
    For JSONP support in JavaScript applications. Only alphanumeric characters and underscores are allowed
  - setCallback
```
public void setCallback(String callback)
```
    For JSONP support in JavaScript applications. Only alphanumeric characters and underscores are allowed
  - withCallback
```
public SearchRequest withCallback(String callback)
```
  - getTopMatch
```
public Boolean getTopMatch()
```
    "top_match=true" returns the best high-ranking Person match to your search. The API will only return a highly probable Person OR a No Match (when no highly probable profile is found). It never returns a Possible Persons’ response.
  - setTopMatch
```
public void setTopMatch(Boolean topMatch)
```
    "top_match=true" returns the best high-ranking Person match to your search. The API will only return a highly probable Person OR a No Match (when no highly probable profile is found). It never returns a Possible Persons’ response.
  - withTopMatch
```
public SearchRequest withTopMatch(Boolean topMatch)
```
  - getAdditionalProperties
```
public Map<String,Object> getAdditionalProperties()
```
  - setAdditionalProperty
```
public void setAdditionalProperty(String name,
                                  Object value)
```
  - withAdditionalProperty
```
public SearchRequest withAdditionalProperty(String name,
                                            Object value)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object other)
```
    Overrides:
    
    equals in class Object

Class SearchRequest

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SearchRequest

Method Detail

getKey

setKey

withKey

getPretty

setPretty

withPretty

getMinimumProbability

setMinimumProbability

withMinimumProbability

getInferPersons

setInferPersons

withInferPersons

getMinimumMatch

setMinimumMatch

withMinimumMatch

getShowSources

setShowSources

withShowSources

getHideSponsored

setHideSponsored

withHideSponsored

getLiveFeeds

setLiveFeeds

withLiveFeeds

getMatchRequirements

setMatchRequirements

withMatchRequirements

getSourceCategoryRequirements

setSourceCategoryRequirements

withSourceCategoryRequirements

getCallback

setCallback

withCallback

getTopMatch

setTopMatch

withTopMatch

getAdditionalProperties

setAdditionalProperty

withAdditionalProperty

toString

hashCode

equals