FullPersonSearchRequest (streams-processor-pipl 0.6.1 API)

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

All Implemented Interfaces:: Serializable

public class FullPersonSearchRequest
extends SearchRequest
implements Serializable

See Also:: Serialized Form

Constructor Summary

Constructors
Constructor and Description

FullPersonSearchRequest()

Constructors
Constructor and Description
`FullPersonSearchRequest()`

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.
`Person`	`getPerson()`
`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`	`setPerson(Person person)`
`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()`
`FullPersonSearchRequest`	`withAdditionalProperty(String name, Object value)`
`FullPersonSearchRequest`	`withCallback(String callback)`
`FullPersonSearchRequest`	`withHideSponsored(Boolean hideSponsored)`
`FullPersonSearchRequest`	`withInferPersons(Boolean inferPersons)`
`FullPersonSearchRequest`	`withKey(String key)`
`FullPersonSearchRequest`	`withLiveFeeds(Boolean liveFeeds)`
`FullPersonSearchRequest`	`withMatchRequirements(String matchRequirements)`
`FullPersonSearchRequest`	`withMinimumMatch(Double minimumMatch)`
`FullPersonSearchRequest`	`withMinimumProbability(Double minimumProbability)`
`FullPersonSearchRequest`	`withPerson(Person person)`
`FullPersonSearchRequest`	`withPretty(Boolean pretty)`
`FullPersonSearchRequest`	`withShowSources(String showSources)`
`FullPersonSearchRequest`	`withSourceCategoryRequirements(String sourceCategoryRequirements)`
`FullPersonSearchRequest`	`withTopMatch(Boolean topMatch)`

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

- Constructor Detail
  - FullPersonSearchRequest
```
public FullPersonSearchRequest()
```
- Method Detail
  - getPerson
```
public Person getPerson()
```
  - setPerson
```
public void setPerson(Person person)
```
  - withPerson
```
public FullPersonSearchRequest withPerson(Person person)
```
  - getKey
```
public String getKey()
```
    Your API key, this is our way to identify you and authorize your call.
    
    Overrides:
    
    getKey in class SearchRequest
  - setKey
```
public void setKey(String key)
```
    Your API key, this is our way to identify you and authorize your call.
    
    Overrides:
    
    setKey in class SearchRequest
  - withKey
```
public FullPersonSearchRequest withKey(String key)
```
    Overrides:
    
    withKey in class SearchRequest
  - getPretty
```
public Boolean getPretty()
```
    Indicates whether you want the response to be "pretty-printed" (with indentation).
    
    Overrides:
    
    getPretty in class SearchRequest
  - setPretty
```
public void setPretty(Boolean pretty)
```
    Indicates whether you want the response to be "pretty-printed" (with indentation).
    
    Overrides:
    
    setPretty in class SearchRequest
  - withPretty
```
public FullPersonSearchRequest withPretty(Boolean pretty)
```
    Overrides:
    
    withPretty in class SearchRequest
  - getMinimumProbability
```
public Double getMinimumProbability()
```
    0 – 1. The minimum acceptable probability for inferred data.
    
    Overrides:
    
    getMinimumProbability in class SearchRequest
  - setMinimumProbability
```
public void setMinimumProbability(Double minimumProbability)
```
    0 – 1. The minimum acceptable probability for inferred data.
    
    Overrides:
    
    setMinimumProbability in class SearchRequest
  - withMinimumProbability
```
public FullPersonSearchRequest withMinimumProbability(Double minimumProbability)
```
    Overrides:
    
    withMinimumProbability in class SearchRequest
  - getInferPersons
```
public Boolean getInferPersons()
```
    whether the API should return persons made up solely from data inferred by statistical analysis from your search query.
    
    Overrides:
    
    getInferPersons in class SearchRequest
  - 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.
    
    Overrides:
    
    setInferPersons in class SearchRequest
  - withInferPersons
```
public FullPersonSearchRequest withInferPersons(Boolean inferPersons)
```
    Overrides:
    
    withInferPersons in class SearchRequest
  - getMinimumMatch
```
public Double getMinimumMatch()
```
    0 – 1. The minimum required match score for possible persons to be returned.
    
    Overrides:
    
    getMinimumMatch in class SearchRequest
  - setMinimumMatch
```
public void setMinimumMatch(Double minimumMatch)
```
    0 – 1. The minimum required match score for possible persons to be returned.
    
    Overrides:
    
    setMinimumMatch in class SearchRequest
  - withMinimumMatch
```
public FullPersonSearchRequest withMinimumMatch(Double minimumMatch)
```
    Overrides:
    
    withMinimumMatch in class SearchRequest
  - 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.
    
    Overrides:
    
    getShowSources in class SearchRequest
  - 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.
    
    Overrides:
    
    setShowSources in class SearchRequest
  - withShowSources
```
public FullPersonSearchRequest withShowSources(String showSources)
```
    Overrides:
    
    withShowSources in class SearchRequest
  - getHideSponsored
```
public Boolean getHideSponsored()
```
    Whether to omit results marked "sponsored" (when additional data from this source is available behind a website paywall).
    
    Overrides:
    
    getHideSponsored in class SearchRequest
  - setHideSponsored
```
public void setHideSponsored(Boolean hideSponsored)
```
    Whether to omit results marked "sponsored" (when additional data from this source is available behind a website paywall).
    
    Overrides:
    
    setHideSponsored in class SearchRequest
  - withHideSponsored
```
public FullPersonSearchRequest withHideSponsored(Boolean hideSponsored)
```
    Overrides:
    
    withHideSponsored in class SearchRequest
  - getLiveFeeds
```
public Boolean getLiveFeeds()
```
    Whether to use live data sources.
    
    Overrides:
    
    getLiveFeeds in class SearchRequest
  - setLiveFeeds
```
public void setLiveFeeds(Boolean liveFeeds)
```
    Whether to use live data sources.
    
    Overrides:
    
    setLiveFeeds in class SearchRequest
  - withLiveFeeds
```
public FullPersonSearchRequest withLiveFeeds(Boolean liveFeeds)
```
    Overrides:
    
    withLiveFeeds in class SearchRequest
  - 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.
    
    Overrides:
    
    getMatchRequirements in class SearchRequest
  - 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.
    
    Overrides:
    
    setMatchRequirements in class SearchRequest
  - withMatchRequirements
```
public FullPersonSearchRequest withMatchRequirements(String matchRequirements)
```
    Overrides:
    
    withMatchRequirements in class SearchRequest
  - 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.
    
    Overrides:
    
    getSourceCategoryRequirements in class SearchRequest
  - 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.
    
    Overrides:
    
    setSourceCategoryRequirements in class SearchRequest
  - withSourceCategoryRequirements
```
public FullPersonSearchRequest withSourceCategoryRequirements(String sourceCategoryRequirements)
```
    Overrides:
    
    withSourceCategoryRequirements in class SearchRequest
  - getCallback
```
public String getCallback()
```
    For JSONP support in JavaScript applications. Only alphanumeric characters and underscores are allowed
    
    Overrides:
    
    getCallback in class SearchRequest
  - setCallback
```
public void setCallback(String callback)
```
    For JSONP support in JavaScript applications. Only alphanumeric characters and underscores are allowed
    
    Overrides:
    
    setCallback in class SearchRequest
  - withCallback
```
public FullPersonSearchRequest withCallback(String callback)
```
    Overrides:
    
    withCallback in class SearchRequest
  - 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.
    
    Overrides:
    
    getTopMatch in class SearchRequest
  - 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.
    
    Overrides:
    
    setTopMatch in class SearchRequest
  - withTopMatch
```
public FullPersonSearchRequest withTopMatch(Boolean topMatch)
```
    Overrides:
    
    withTopMatch in class SearchRequest
  - getAdditionalProperties
```
public Map<String,Object> getAdditionalProperties()
```
    Overrides:
    
    getAdditionalProperties in class SearchRequest
  - setAdditionalProperty
```
public void setAdditionalProperty(String name,
                                  Object value)
```
    Overrides:
    
    setAdditionalProperty in class SearchRequest
  - withAdditionalProperty
```
public FullPersonSearchRequest withAdditionalProperty(String name,
                                                      Object value)
```
    Overrides:
    
    withAdditionalProperty in class SearchRequest
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class SearchRequest
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class SearchRequest
  - equals
```
public boolean equals(Object other)
```
    Overrides:
    
    equals in class SearchRequest

Class FullPersonSearchRequest

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FullPersonSearchRequest

Method Detail

getPerson

setPerson

withPerson

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