Serialized Form (streams-processor-pipl 0.6.1 API)

Package org.apache.streams.pipl.api
- Class org.apache.streams.pipl.api.BasicSearchRequest extends SearchRequest implements Serializable
  
  serialVersionUID:
  
  8516928647574366944L
  - Serialized Fields
    - email
```
String email
```
      Email address.
    - phone
```
String phone
```
      Home/work/mobile phone number. We’ll try to parse the number using libphonenumber.
    - username
```
String username
```
      Username/screen-name, minimum 3 characters. There’s an advanced option to search by username or user-id at a specific service like superman@facebook.
    - userId
```
String userId
```
      Unique ID in a supported service, must include the service name.
    - url
```
String url
```
      Profile URL in a supported service. This URL will be parsed to a username or user_id object.
    - firstName
```
String firstName
```
      First name, minimum 2 characters.
    - lastName
```
String lastName
```
      Last name, minimum 2 characters.
    - middleName
```
String middleName
```
      Middle name or middle initial.
    - rawName
```
String rawName
```
      Full Name. Use this parameter if the accurate name parts (first/middle/last) are not available, this parameter will only be used in absence of first_name and last_name.
    - country
```
String country
```
      A two-letter, Alpha-2 ISO-3166 country code.
    - state
```
String state
```
      A United States, Canada, Great Britain or Australia state code. If a US state is provided and no country specified, we’ll assume the country to be US.
    - city
```
String city
```
      City.
    - street
```
String street
```
      Street.
    - house
```
String house
```
      House number.
    - zipcode
```
String zipcode
```
      ZIP Code.
    - rawAddress
```
String rawAddress
```
      Full Address. Use this parameter if the accurate address parts (country/state/city…) are not available.
    - age
```
String age
```
      String, an exact (YY) or approximate (YY-YY) age.
    - additionalProperties
```
Map<K,V> additionalProperties
```
- Class org.apache.streams.pipl.api.FullPersonSearchRequest extends SearchRequest implements Serializable
  
  serialVersionUID:
  
  -8113177381800305314L
  - Serialized Fields
    - person
```
Person person
```
    - key
```
String key
```
      Your API key, this is our way to identify you and authorize your call.
    - pretty
```
Boolean pretty
```
      Indicates whether you want the response to be "pretty-printed" (with indentation).
    - minimumProbability
```
Double minimumProbability
```
      0 – 1. The minimum acceptable probability for inferred data.
    - inferPersons
```
Boolean inferPersons
```
      whether the API should return persons made up solely from data inferred by statistical analysis from your search query.
    - minimumMatch
```
Double minimumMatch
```
      0 – 1. The minimum required match score for possible persons to be returned.
    - showSources
```
String showSources
```
      true/false/all/matching. all - all sources are shown. matching or true - only sources from the person. false - don’t show sources.
    - hideSponsored
```
Boolean hideSponsored
```
      Whether to omit results marked "sponsored" (when additional data from this source is available behind a website paywall).
    - liveFeeds
```
Boolean liveFeeds
```
      Whether to use live data sources.
    - matchRequirements
```
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.
    - sourceCategoryRequirements
```
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.
    - callback
```
String callback
```
      For JSONP support in JavaScript applications. Only alphanumeric characters and underscores are allowed
    - topMatch
```
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.
    - additionalProperties
```
Map<K,V> additionalProperties
```
- Class org.apache.streams.pipl.api.SearchPointerRequest extends Object implements Serializable
  
  serialVersionUID:
  
  5625809648911925320L
  - Serialized Fields
    - searchPointer
```
String searchPointer
```
      search pointer.
    - key
```
String key
```
      Your API key, this is our way to identify you and authorize your call.
    - additionalProperties
```
Map<K,V> additionalProperties
```
- Class org.apache.streams.pipl.api.SearchRequest extends Object implements Serializable
  
  serialVersionUID:
  
  -3622322981133290454L
  - Serialized Fields
    - key
```
String key
```
      Your API key, this is our way to identify you and authorize your call.
    - pretty
```
Boolean pretty
```
      Indicates whether you want the response to be "pretty-printed" (with indentation).
    - minimumProbability
```
Double minimumProbability
```
      0 – 1. The minimum acceptable probability for inferred data.
    - inferPersons
```
Boolean inferPersons
```
      whether the API should return persons made up solely from data inferred by statistical analysis from your search query.
    - minimumMatch
```
Double minimumMatch
```
      0 – 1. The minimum required match score for possible persons to be returned.
    - showSources
```
String showSources
```
      true/false/all/matching. all - all sources are shown. matching or true - only sources from the person. false - don’t show sources.
    - hideSponsored
```
Boolean hideSponsored
```
      Whether to omit results marked "sponsored" (when additional data from this source is available behind a website paywall).
    - liveFeeds
```
Boolean liveFeeds
```
      Whether to use live data sources.
    - matchRequirements
```
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.
    - sourceCategoryRequirements
```
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.
    - callback
```
String callback
```
      For JSONP support in JavaScript applications. Only alphanumeric characters and underscores are allowed
    - topMatch
```
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.
    - additionalProperties
```
Map<K,V> additionalProperties
```
- Class org.apache.streams.pipl.api.SearchResponse extends Object implements Serializable
  
  serialVersionUID:
  
  8057150225723237745L
  - Serialized Fields
    - httpStatusCode
```
Long httpStatusCode
```
      The HTTP status code of the response. Successful calls will be 200.
    - visibleSources
```
Long visibleSources
```
      The number of sources returned in the sources array (if show_sources is not false).
    - availableSources
```
Long availableSources
```
      The number of sources we know of that are relevant to the search.
    - personsCount
```
Long personsCount
```
      The number of persons returned in this API response.
    - searchId
```
String searchId
```
      An internal ID which identifies the search on our systems. Useful for debugging.
    - topMatch
```
Boolean topMatch
```
      Whether top match was set in request.
    - query
```
Person query
```
    - matchRequirements
```
String matchRequirements
```
      The canonical way to express the match requirement you’ve sent. Useful to see how we’ve parsed your criteria.
    - availableData
```
AvailableData availableData
```
    - error
```
String error
```
      An error message, explaining an error that prevented your search from being run.
    - warnings
```
List<E> warnings
```
      An array of warning strings.
    - person
```
Person person
```
    - possiblePersons
```
List<E> possiblePersons
```
      An array of person objects containing possible matches.
    - sources
```
List<E> sources
```
      An array of source objects, in case you need to see where the data came from.
    - additionalProperties
```
Map<K,V> additionalProperties
```
Package org.apache.streams.pipl.config
- Class org.apache.streams.pipl.config.PiplConfiguration extends Object implements Serializable
  
  serialVersionUID:
  
  -7053708405254486294L
  - Serialized Fields
    - debug
```
Boolean debug
```
    - key
```
String key
```
    - additionalProperties
```
Map<K,V> additionalProperties
```
Package org.apache.streams.pipl.pojo
- Class org.apache.streams.pipl.pojo.Address extends Object implements Serializable
  
  serialVersionUID:
  
  3089333807473138846L
  - Serialized Fields
    - type
```
String type
```
      Either one of 'home’, 'work’ or 'old’. Default is 'home’
    - validSince
```
String validSince
```
      Valid since (YYYY-mm-DD)
    - country
```
String country
```
      Alpha-2 ISO 3166 country code
    - state
```
String state
```
      2 letters state code, if country is one of US, Canada or Brazil. 3 letters state code if country is Australia or UK.
    - city
```
String city
```
      City name
    - street
```
String street
```
      Street name
    - house
```
String house
```
      House number
    - apartment
```
String apartment
```
      Apartment number
    - zipCode
```
String zipCode
```
      Postal zip code
    - poBox
```
String poBox
```
      Post Office box number
    - raw
```
String raw
```
      An unparsed full address. Request only.
    - display
```
String display
```
      The full address for display purposes. Response only.
    - additionalProperties
```
Map<K,V> additionalProperties
```
- Class org.apache.streams.pipl.pojo.AvailableData extends Object implements Serializable
  
  serialVersionUID:
  
  -8635354470080206847L
  - Serialized Fields
    - premium
```
FieldCount premium
```
    - additionalProperties
```
Map<K,V> additionalProperties
```
- Class org.apache.streams.pipl.pojo.DateOfBirth extends Object implements Serializable
  
  serialVersionUID:
  
  4401657272066660533L
  - Serialized Fields
    - dateRange
```
DateRange dateRange
```
    - display
```
String display
```
      The person’s estimated age represented by this DOB for display purposes. For example, '47 years old’. If age > 80 the format is 'Born 1927’. Response only.
    - additionalProperties
```
Map<K,V> additionalProperties
```
- Class org.apache.streams.pipl.pojo.DateRange extends Object implements Serializable
  
  serialVersionUID:
  
  6897174284232316497L
  - Serialized Fields
    - start
```
String start
```
      Start date of this range in 'YYYY-MM-DD’ format.
    - end
```
String end
```
      End date of this range in 'YYYY-MM-DD’ format.
    - additionalProperties
```
Map<K,V> additionalProperties
```
- Class org.apache.streams.pipl.pojo.Education extends Object implements Serializable
  
  serialVersionUID:
  
  -8535038624019014635L
  - Serialized Fields
    - degree
```
String degree
```
      Degree. B.Sc, PhD, etc…
    - school
```
String school
```
      Name of the educational institute.
    - dateRange
```
DateRange dateRange
```
    - display
```
String display
```
      The full degree headline for display purposes. Response only.
    - additionalProperties
```
Map<K,V> additionalProperties
```
- Class org.apache.streams.pipl.pojo.Email extends Object implements Serializable
  
  serialVersionUID:
  
  -9087291223195722649L
  - Serialized Fields
    - type
```
String type
```
      Either one of 'personal’ or 'work’. Default is 'personal’.
    - validSince
```
String validSince
```
      Valid since (YYYY-mm-DD)
    - address
```
String address
```
      Valid email address in simple form. No brackets of any kind.
    - addressMd5
```
String addressMd5
```
      MD5 hash of the address.
    - disposable
```
Boolean disposable
```
      Whether this is a disposable email (for example guerillamail.com). Response only. Omitted if false.
    - emailProvider
```
Boolean emailProvider
```
      Whether this email came from a public provider (such as gmail.com). Response only.
    - additionalProperties
```
Map<K,V> additionalProperties
```
- Class org.apache.streams.pipl.pojo.Ethnicity extends Object implements Serializable
  
  serialVersionUID:
  
  6157498300503605943L
  - Serialized Fields
    - content
```
String content
```
      One of the following: 'white’, 'black’, 'american_indian’, 'alaska_native’, 'chinese’, 'filipino’, 'other_asian’, 'japanese’, 'korean’, 'vietnamese’, 'native_hawaiian’, 'guamanian’, 'chamorro’, 'samoan’, 'other_pacific_islander’, 'other’.
    - additionalProperties
```
Map<K,V> additionalProperties
```
- Class org.apache.streams.pipl.pojo.FieldCount extends Object implements Serializable
  
  serialVersionUID:
  
  3785942055964042924L
  - Serialized Fields
    - emails
```
Long emails
```
      The sum of emails.
    - relationships
```
Long relationships
```
      The sum of relationships.
    - usernames
```
Long usernames
```
      The sum of usernames.
    - userIds
```
Long userIds
```
      The sum of user ids.
    - jobs
```
Long jobs
```
      The sum of jobs.
    - addresses
```
Long addresses
```
      The sum of addresses.
    - ethnicities
```
Long ethnicities
```
      The sum of ethnicities.
    - phones
```
Long phones
```
      The sum of both mobile and landline phones.
    - mobilePhones
```
Long mobilePhones
```
      The sum of mobile phones.
    - landlinePhones
```
Long landlinePhones
```
      The sum of landline (non-mobile) phones.
    - educations
```
Long educations
```
      The sum of educations.
    - languages
```
Long languages
```
      The sum of languages.
    - socialProfiles
```
Long socialProfiles
```
      The sum of social profile sources.
    - names
```
Long names
```
      The sum of names.
    - dobs
```
Long dobs
```
      The sum of dates of birth.
    - images
```
Long images
```
      The sum of images.
    - genders
```
Long genders
```
      The sum of genders.
    - originCountries
```
Long originCountries
```
      The sum of origin countries.
    - additionalProperties
```
Map<K,V> additionalProperties
```
- Class org.apache.streams.pipl.pojo.Gender extends Object implements Serializable
  
  serialVersionUID:
  
  -1129346668295832423L
  - Serialized Fields
    - content
```
String content
```
      Either one of 'male’ or 'female’. No default value.
    - additionalProperties
```
Map<K,V> additionalProperties
```
- Class org.apache.streams.pipl.pojo.Image extends Object implements Serializable
  
  serialVersionUID:
  
  -3519546654211025780L
  - Serialized Fields
    - url
```
String url
```
      Image URL
    - thumbnailToken
```
String thumbnailToken
```
      A special token that can be used with our thumbnail server.
    - additionalProperties
```
Map<K,V> additionalProperties
```
- Class org.apache.streams.pipl.pojo.Job extends Object implements Serializable
  
  serialVersionUID:
  
  -4716773287398524116L
  - Serialized Fields
    - title
```
String title
```
      Job title
    - organization
```
String organization
```
      The name of the employing organization
    - industry
```
String industry
```
      The employing organization industry
    - dateRange
```
DateRange dateRange
```
    - display
```
String display
```
      The full job headline for display purposes. Response only.
    - additionalProperties
```
Map<K,V> additionalProperties
```
- Class org.apache.streams.pipl.pojo.Language extends Object implements Serializable
  
  serialVersionUID:
  
  -2588546661108899686L
  - Serialized Fields
    - inferred
```
Boolean inferred
```
      Inferred or not.
    - language
```
String language
```
      A 2-letter language code
    - region
```
String region
```
      Country code
    - display
```
String display
```
      The representation of this language (for example “en_US”)
    - additionalProperties
```
Map<K,V> additionalProperties
```
- Class org.apache.streams.pipl.pojo.Name extends Object implements Serializable
  
  serialVersionUID:
  
  -9199706342950241349L
  - Serialized Fields
    - type
```
String type
```
      Either one of ‘present’, 'maiden’, 'former’ or 'alias’. Default is 'present’
    - validSince
```
String validSince
```
      Valid since (YYYY-mm-DD)
    - first
```
String first
```
      First name.
    - middle
```
String middle
```
      Middle name or middle initial.
    - last
```
String last
```
      Last name.
    - prefix
```
String prefix
```
      A person’s title.
    - suffix
```
String suffix
```
      Additional information about a person.
    - raw
```
String raw
```
      An unparsed person’s full name. Request only.
    - display
```
String display
```
      The full name for display purposes. Response only.
    - additionalProperties
```
Map<K,V> additionalProperties
```
- Class org.apache.streams.pipl.pojo.OriginCountry extends Object implements Serializable
  
  serialVersionUID:
  
  2382361089638700341L
  - Serialized Fields
    - content
```
String content
```
      A country code.
    - additionalProperties
```
Map<K,V> additionalProperties
```
- Class org.apache.streams.pipl.pojo.Person extends Object implements Serializable
  
  serialVersionUID:
  
  2147516879123507281L
  - Serialized Fields
    - id
```
String id
```
      An identifier of this person in this response. To be used in conjunction with @person_id in the Source object. Only shown if the response includes a single person object.
    - inferred
```
Boolean inferred
```
      Whether this person is made up solely from data inferred by statistical analysis from your search query. You can control inference using the minimum_probability parameter, and inference of persons using the infer_persons parameter.
    - searchPointer
```
String searchPointer
```
      A special string crafted by the API for follow up searches.
    - match
```
Double match
```
      0-1. The level of confidence we have that this is the person you’re looking for.
    - names
```
List<E> names
```
    - emails
```
List<E> emails
```
    - usernames
```
List<E> usernames
```
    - phones
```
List<E> phones
```
    - gender
```
Gender gender
```
    - dob
```
DateOfBirth dob
```
    - languages
```
List<E> languages
```
    - ethnicities
```
List<E> ethnicities
```
    - originCountries
```
List<E> originCountries
```
    - addresses
```
List<E> addresses
```
    - jobs
```
List<E> jobs
```
    - educations
```
List<E> educations
```
    - relationships
```
List<E> relationships
```
    - userIds
```
List<E> userIds
```
    - images
```
List<E> images
```
    - urls
```
List<E> urls
```
    - additionalProperties
```
Map<K,V> additionalProperties
```
- Class org.apache.streams.pipl.pojo.Phone extends Object implements Serializable
  
  serialVersionUID:
  
  -3108708748691312249L
  - Serialized Fields
    - type
```
String type
```
      One of 'mobile’, 'home_phone’, 'home_fax’, 'work_phone’,'work_fax’ or 'pager’. No default value.
    - doNotCall
```
Boolean doNotCall
```
      When the indicator is marked as true, this indicates that the US phone number is listed in the National Do Not Call Registry and should not to be contacted for telemarketing purposes. This indicator can be used solely for the purpose of complying with the US law for preventing phone calls to numbers listed on the DNC list. We constantly update the DNC registry to be current, this indication should only be used at the same day the API response was received.
    - countryCode
```
Long countryCode
```
      International call country code. See ITU-T Recommendation E.164
    - number
```
Long number
```
      Phone number.
    - extension
```
Long extension
```
      Extension.
    - raw
```
String raw
```
      An unparsed phone. Request only.
    - display
```
String display
```
      The full national phone for display purposes. Response only.
    - displayInternational
```
String displayInternational
```
      The full international phone for display purposes. Response only.
    - additionalProperties
```
Map<K,V> additionalProperties
```
- Class org.apache.streams.pipl.pojo.Relationship extends Person implements Serializable
  
  serialVersionUID:
  
  3422360874094082911L
  - Serialized Fields
    - type
```
String type
```
      Either one of 'work’, 'family’, 'friend’ or 'other’. Default is 'friend’
    - subtype
```
String subtype
```
      A free text providing further info on the association. For example, Father.
    - additionalProperties
```
Map<K,V> additionalProperties
```
- Class org.apache.streams.pipl.pojo.Source extends Person implements Serializable
  
  serialVersionUID:
  
  3840790063948087039L
  - Serialized Fields
    - id
```
String id
```
      Unique identifier of this source in our systems. Useful for debugging
    - name
```
String name
```
      Data Source name.
    - category
```
String category
```
      Data Source category.
    - domain
```
String domain
```
      Data Source domain.
    - personId
```
String personId
```
      The id of the person this source belongs to.
    - sponsored
```
Boolean sponsored
```
      Indicating whether additional data from this source is available behind a website paywall. Omitted if false.
    - originUrl
```
String originUrl
```
      The url of the web page holding this information. Only shown if the data is available online.
    - match
```
Double match
```
      0-1. The match score of the person this source belongs to.
    - premium
```
Boolean premium
```
      Whether this is a premium data source. Omitted if false.
    - display
```
String display
```
      The full address for display purposes. Response only.
    - additionalProperties
```
Map<K,V> additionalProperties
```
- Class org.apache.streams.pipl.pojo.Url extends Object implements Serializable
  
  serialVersionUID:
  
  4479884515856357882L
  - Serialized Fields
    - sourceId
```
String sourceId
```
      The source ID (if this URL is a source of data)
    - domain
```
String domain
```
      The domain
    - name
```
String name
```
      The site name.
    - category
```
String category
```
      One of: 'background_reports’, 'contact_details’, 'email_address’, 'media’, 'personal_profiles’, 'professional_and_business’, 'public_records’, 'publications’, 'school_and_classmates’, 'web_pages’
    - url
```
String url
```
      The actual URL
    - sponsored
```
Boolean sponsored
```
      Indicating whether additional data from this source is available behind a website paywall. Omitted if false.
    - additionalProperties
```
Map<K,V> additionalProperties
```
- Class org.apache.streams.pipl.pojo.UserId extends Object implements Serializable
  
  serialVersionUID:
  
  -8070444543627835115L
  - Serialized Fields
    - content
```
String content
```
      A person’s user id in the format of user_id@service.
    - additionalProperties
```
Map<K,V> additionalProperties
```
- Class org.apache.streams.pipl.pojo.Username extends Object implements Serializable
  
  serialVersionUID:
  
  -1423539758603567871L
  - Serialized Fields
    - content
```
String content
```
      A person’s username at one or more online service.
    - additionalProperties
```
Map<K,V> additionalProperties
```

Serialized Form

Package org.apache.streams.pipl.api

Class org.apache.streams.pipl.api.BasicSearchRequest extends SearchRequest implements Serializable

Serialized Fields

email

phone

username

userId

url

firstName

lastName

middleName

rawName

country

state

city

street

house

zipcode

rawAddress

age

additionalProperties

Class org.apache.streams.pipl.api.FullPersonSearchRequest extends SearchRequest implements Serializable

Serialized Fields

person

key

pretty

minimumProbability

inferPersons

minimumMatch

showSources

hideSponsored

liveFeeds

matchRequirements

sourceCategoryRequirements

callback

topMatch

additionalProperties

Class org.apache.streams.pipl.api.SearchPointerRequest extends Object implements Serializable

Serialized Fields

searchPointer

key

additionalProperties

Class org.apache.streams.pipl.api.SearchRequest extends Object implements Serializable

Serialized Fields

key

pretty

minimumProbability

inferPersons

minimumMatch

showSources

hideSponsored

liveFeeds

matchRequirements

sourceCategoryRequirements

callback

topMatch

additionalProperties

Class org.apache.streams.pipl.api.SearchResponse extends Object implements Serializable

Serialized Fields

httpStatusCode

visibleSources

availableSources

personsCount

searchId

topMatch

query

matchRequirements

availableData

error

warnings

person

possiblePersons

sources

additionalProperties

Package org.apache.streams.pipl.config

Class org.apache.streams.pipl.config.PiplConfiguration extends Object implements Serializable

Serialized Fields

debug

key