SearchOperators (streams-provider-twitter 0.5.2-SNAPSHOT API)

java.lang.Object
- org.apache.streams.twitter.search.SearchOperators

All Implemented Interfaces:: Serializable

@Generated(value="org.jsonschema2pojo")
public class SearchOperators
extends Object
implements Serializable

See Also:: Serialized Form

Constructor Summary

Constructors
Constructor and Description

SearchOperators()

Constructors
Constructor and Description
`SearchOperators()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object other)`
`Map<String,Object>`	`getAdditionalProperties()`
`String`	`getBio()` Matches a keyword or phrase within the user bio of a Tweet.
`String`	`getBioLocation()` Matches Tweets where the user’s bio-level location contains the specified keyword or phrase.
`String`	`getBioName()` Matches a keyword within the user bio name of a Tweet.
`String`	`getBoundingBox()` Matches against the Exact Location (x,y) of the Tweet when present, and in Twitter, against a “Place” geo polygon.
`String`	`getEmoji()` Matches an emoji within the body of a Tweet.
`String`	`getExactPhrase()` Matches an exact phrase within the body of a Tweet.
`String`	`getFrom()` Matches any Tweet from a specific user (name or ID).
`String`	`getHashtag()` Matches any Tweet with the given hashtag.
`Boolean`	`getHasImages()` A boolean search operator that returns all Tweets that contain a native images (e.g.
`Boolean`	`getHasLinks()` This operator matches Tweets which contain links in the message body.
`Boolean`	`getHasMedia()` Matches Tweets that contain a media url classified by Twitter, e.g.
`Boolean`	`getHasMentions()` Matches Tweets that mention another Twitter user.
`Boolean`	`getHasVideos()` A boolean search operator that returns all Tweets that contain native videos (does not include vine, periscope).
`String`	`getKeyword()` Matches a keyword within the body of a Tweet.
`String`	`getLang()` Matches Tweets that have been classified by Twitter as being of a particular language.
`String`	`getMention()` Matches any Tweet that mentions the given user (name or ID).
`String`	`getPlace()` Matches Tweets tagged with a specified location or 'Twitter place.
`String`	`getPlaceCountry()` Matches Tweets tagged with the specified location or Twitter place ID (see examples).
`String`	`getPointRadius()` Matches against the Exact Location (x,y) of the Tweet when present, and in Twitter, against a “Place” geo polygon, where the Place is fully contained within the defined region.
`String`	`getRetweetsOf()` Matches Retweets that are Tweets of a specified user (name or ID).
`String`	`getTimeZone()` Matches Tweets where the user-selected time zone specified in a user’s profile settings matches a given string.
`String`	`getTo()` Matches any Tweet that is in reply to a particular user.
`String`	`getUrl()` Performs a tokenized (keyword/phrase) match on the expanded URLs of a Tweet.
`int`	`hashCode()`
`void`	`setAdditionalProperty(String name, Object value)`
`void`	`setBio(String bio)` Matches a keyword or phrase within the user bio of a Tweet.
`void`	`setBioLocation(String bioLocation)` Matches Tweets where the user’s bio-level location contains the specified keyword or phrase.
`void`	`setBioName(String bioName)` Matches a keyword within the user bio name of a Tweet.
`void`	`setBoundingBox(String boundingBox)` Matches against the Exact Location (x,y) of the Tweet when present, and in Twitter, against a “Place” geo polygon.
`void`	`setEmoji(String emoji)` Matches an emoji within the body of a Tweet.
`void`	`setExactPhrase(String exactPhrase)` Matches an exact phrase within the body of a Tweet.
`void`	`setFrom(String from)` Matches any Tweet from a specific user (name or ID).
`void`	`setHashtag(String hashtag)` Matches any Tweet with the given hashtag.
`void`	`setHasImages(Boolean hasImages)` A boolean search operator that returns all Tweets that contain a native images (e.g.
`void`	`setHasLinks(Boolean hasLinks)` This operator matches Tweets which contain links in the message body.
`void`	`setHasMedia(Boolean hasMedia)` Matches Tweets that contain a media url classified by Twitter, e.g.
`void`	`setHasMentions(Boolean hasMentions)` Matches Tweets that mention another Twitter user.
`void`	`setHasVideos(Boolean hasVideos)` A boolean search operator that returns all Tweets that contain native videos (does not include vine, periscope).
`void`	`setKeyword(String keyword)` Matches a keyword within the body of a Tweet.
`void`	`setLang(String lang)` Matches Tweets that have been classified by Twitter as being of a particular language.
`void`	`setMention(String mention)` Matches any Tweet that mentions the given user (name or ID).
`void`	`setPlace(String place)` Matches Tweets tagged with a specified location or 'Twitter place.
`void`	`setPlaceCountry(String placeCountry)` Matches Tweets tagged with the specified location or Twitter place ID (see examples).
`void`	`setPointRadius(String pointRadius)` Matches against the Exact Location (x,y) of the Tweet when present, and in Twitter, against a “Place” geo polygon, where the Place is fully contained within the defined region.
`void`	`setRetweetsOf(String retweetsOf)` Matches Retweets that are Tweets of a specified user (name or ID).
`void`	`setTimeZone(String timeZone)` Matches Tweets where the user-selected time zone specified in a user’s profile settings matches a given string.
`void`	`setTo(String to)` Matches any Tweet that is in reply to a particular user.
`void`	`setUrl(String url)` Performs a tokenized (keyword/phrase) match on the expanded URLs of a Tweet.
`String`	`toString()`
`SearchOperators`	`withAdditionalProperty(String name, Object value)`
`SearchOperators`	`withBio(String bio)`
`SearchOperators`	`withBioLocation(String bioLocation)`
`SearchOperators`	`withBioName(String bioName)`
`SearchOperators`	`withBoundingBox(String boundingBox)`
`SearchOperators`	`withEmoji(String emoji)`
`SearchOperators`	`withExactPhrase(String exactPhrase)`
`SearchOperators`	`withFrom(String from)`
`SearchOperators`	`withHashtag(String hashtag)`
`SearchOperators`	`withHasImages(Boolean hasImages)`
`SearchOperators`	`withHasLinks(Boolean hasLinks)`
`SearchOperators`	`withHasMedia(Boolean hasMedia)`
`SearchOperators`	`withHasMentions(Boolean hasMentions)`
`SearchOperators`	`withHasVideos(Boolean hasVideos)`
`SearchOperators`	`withKeyword(String keyword)`
`SearchOperators`	`withLang(String lang)`
`SearchOperators`	`withMention(String mention)`
`SearchOperators`	`withPlace(String place)`
`SearchOperators`	`withPlaceCountry(String placeCountry)`
`SearchOperators`	`withPointRadius(String pointRadius)`
`SearchOperators`	`withRetweetsOf(String retweetsOf)`
`SearchOperators`	`withTimeZone(String timeZone)`
`SearchOperators`	`withTo(String to)`
`SearchOperators`	`withUrl(String url)`

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

- Constructor Detail
  - SearchOperators
```
public SearchOperators()
```
- Method Detail
  - getKeyword
```
@BeanProperty(value="keyword")
public String getKeyword()
```
    Matches a keyword within the body of a Tweet.
    
    Returns:
    
    The keyword
  - setKeyword
```
@BeanProperty(value="keyword")
public void setKeyword(String keyword)
```
    Matches a keyword within the body of a Tweet.
    
    Parameters:
    
    keyword - The keyword
  - withKeyword
```
public SearchOperators withKeyword(String keyword)
```
  - getEmoji
```
@BeanProperty(value="emoji")
public String getEmoji()
```
    Matches an emoji within the body of a Tweet.
    
    Returns:
    
    The emoji
  - setEmoji
```
@BeanProperty(value="emoji")
public void setEmoji(String emoji)
```
    Matches an emoji within the body of a Tweet.
    
    Parameters:
    
    emoji - The emoji
  - withEmoji
```
public SearchOperators withEmoji(String emoji)
```
  - getExactPhrase
```
@BeanProperty(value="exact_phrase")
public String getExactPhrase()
```
    Matches an exact phrase within the body of a Tweet.
    
    Returns:
    
    The exactPhrase
  - setExactPhrase
```
@BeanProperty(value="exact_phrase")
public void setExactPhrase(String exactPhrase)
```
    Matches an exact phrase within the body of a Tweet.
    
    Parameters:
    
    exactPhrase - The exact_phrase
  - withExactPhrase
```
public SearchOperators withExactPhrase(String exactPhrase)
```
  - getFrom
```
@BeanProperty(value="from")
public String getFrom()
```
    Matches any Tweet from a specific user (name or ID).
    
    Returns:
    
    The from
  - setFrom
```
@BeanProperty(value="from")
public void setFrom(String from)
```
    Matches any Tweet from a specific user (name or ID).
    
    Parameters:
    
    from - The from
  - withFrom
```
public SearchOperators withFrom(String from)
```
  - getTo
```
@BeanProperty(value="to")
public String getTo()
```
    Matches any Tweet that is in reply to a particular user.
    
    Returns:
    
    The to
  - setTo
```
@BeanProperty(value="to")
public void setTo(String to)
```
    Matches any Tweet that is in reply to a particular user.
    
    Parameters:
    
    to - The to
  - withTo
```
public SearchOperators withTo(String to)
```
  - getMention
```
@BeanProperty(value="mention")
public String getMention()
```
    Matches any Tweet that mentions the given user (name or ID).
    
    Returns:
    
    The mention
  - setMention
```
@BeanProperty(value="mention")
public void setMention(String mention)
```
    Matches any Tweet that mentions the given user (name or ID).
    
    Parameters:
    
    mention - The mention
  - withMention
```
public SearchOperators withMention(String mention)
```
  - getRetweetsOf
```
@BeanProperty(value="retweets_of")
public String getRetweetsOf()
```
    Matches Retweets that are Tweets of a specified user (name or ID).
    
    Returns:
    
    The retweetsOf
  - setRetweetsOf
```
@BeanProperty(value="retweets_of")
public void setRetweetsOf(String retweetsOf)
```
    Matches Retweets that are Tweets of a specified user (name or ID).
    
    Parameters:
    
    retweetsOf - The retweets_of
  - withRetweetsOf
```
public SearchOperators withRetweetsOf(String retweetsOf)
```
  - getHashtag
```
@BeanProperty(value="hashtag")
public String getHashtag()
```
    Matches any Tweet with the given hashtag.
    
    Returns:
    
    The hashtag
  - setHashtag
```
@BeanProperty(value="hashtag")
public void setHashtag(String hashtag)
```
    Matches any Tweet with the given hashtag.
    
    Parameters:
    
    hashtag - The hashtag
  - withHashtag
```
public SearchOperators withHashtag(String hashtag)
```
  - getUrl
```
@BeanProperty(value="url")
public String getUrl()
```
    Performs a tokenized (keyword/phrase) match on the expanded URLs of a Tweet.
    
    Returns:
    
    The url
  - setUrl
```
@BeanProperty(value="url")
public void setUrl(String url)
```
    Performs a tokenized (keyword/phrase) match on the expanded URLs of a Tweet.
    
    Parameters:
    
    url - The url
  - withUrl
```
public SearchOperators withUrl(String url)
```
  - getBio
```
@BeanProperty(value="bio")
public String getBio()
```
    Matches a keyword or phrase within the user bio of a Tweet.
    
    Returns:
    
    The bio
  - setBio
```
@BeanProperty(value="bio")
public void setBio(String bio)
```
    Matches a keyword or phrase within the user bio of a Tweet.
    
    Parameters:
    
    bio - The bio
  - withBio
```
public SearchOperators withBio(String bio)
```
  - getBioName
```
@BeanProperty(value="bio_name")
public String getBioName()
```
    Matches a keyword within the user bio name of a Tweet.
    
    Returns:
    
    The bioName
  - setBioName
```
@BeanProperty(value="bio_name")
public void setBioName(String bioName)
```
    Matches a keyword within the user bio name of a Tweet.
    
    Parameters:
    
    bioName - The bio_name
  - withBioName
```
public SearchOperators withBioName(String bioName)
```
  - getBioLocation
```
@BeanProperty(value="bio_location")
public String getBioLocation()
```
    Matches Tweets where the user’s bio-level location contains the specified keyword or phrase.
    
    Returns:
    
    The bioLocation
  - setBioLocation
```
@BeanProperty(value="bio_location")
public void setBioLocation(String bioLocation)
```
    Matches Tweets where the user’s bio-level location contains the specified keyword or phrase.
    
    Parameters:
    
    bioLocation - The bio_location
  - withBioLocation
```
public SearchOperators withBioLocation(String bioLocation)
```
  - getPlace
```
@BeanProperty(value="place")
public String getPlace()
```
    Matches Tweets tagged with a specified location or 'Twitter place.
    
    Returns:
    
    The place
  - setPlace
```
@BeanProperty(value="place")
public void setPlace(String place)
```
    Matches Tweets tagged with a specified location or 'Twitter place.
    
    Parameters:
    
    place - The place
  - withPlace
```
public SearchOperators withPlace(String place)
```
  - getPlaceCountry
```
@BeanProperty(value="place_country")
public String getPlaceCountry()
```
    Matches Tweets tagged with the specified location or Twitter place ID (see examples). Multi-word place names (“New York City”, “Palo Alto”) should be enclosed in quotes.
    
    Returns:
    
    The placeCountry
  - setPlaceCountry
```
@BeanProperty(value="place_country")
public void setPlaceCountry(String placeCountry)
```
    Matches Tweets tagged with the specified location or Twitter place ID (see examples). Multi-word place names (“New York City”, “Palo Alto”) should be enclosed in quotes.
    
    Parameters:
    
    placeCountry - The place_country
  - withPlaceCountry
```
public SearchOperators withPlaceCountry(String placeCountry)
```
  - getPointRadius
```
@BeanProperty(value="point_radius")
public String getPointRadius()
```
    Matches against the Exact Location (x,y) of the Tweet when present, and in Twitter, against a “Place” geo polygon, where the Place is fully contained within the defined region.
    
    Returns:
    
    The pointRadius
  - setPointRadius
```
@BeanProperty(value="point_radius")
public void setPointRadius(String pointRadius)
```
    Matches against the Exact Location (x,y) of the Tweet when present, and in Twitter, against a “Place” geo polygon, where the Place is fully contained within the defined region.
    
    Parameters:
    
    pointRadius - The point_radius
  - withPointRadius
```
public SearchOperators withPointRadius(String pointRadius)
```
  - getBoundingBox
```
@BeanProperty(value="bounding_box")
public String getBoundingBox()
```
    Matches against the Exact Location (x,y) of the Tweet when present, and in Twitter, against a “Place” geo polygon.
    
    Returns:
    
    The boundingBox
  - setBoundingBox
```
@BeanProperty(value="bounding_box")
public void setBoundingBox(String boundingBox)
```
    Matches against the Exact Location (x,y) of the Tweet when present, and in Twitter, against a “Place” geo polygon.
    
    Parameters:
    
    boundingBox - The bounding_box
  - withBoundingBox
```
public SearchOperators withBoundingBox(String boundingBox)
```
  - getTimeZone
```
@BeanProperty(value="time_zone")
public String getTimeZone()
```
    Matches Tweets where the user-selected time zone specified in a user’s profile settings matches a given string.
    
    Returns:
    
    The timeZone
  - setTimeZone
```
@BeanProperty(value="time_zone")
public void setTimeZone(String timeZone)
```
    Matches Tweets where the user-selected time zone specified in a user’s profile settings matches a given string.
    
    Parameters:
    
    timeZone - The time_zone
  - withTimeZone
```
public SearchOperators withTimeZone(String timeZone)
```
  - getHasLinks
```
@BeanProperty(value="has_links")
public Boolean getHasLinks()
```
    This operator matches Tweets which contain links in the message body.
    
    Returns:
    
    The hasLinks
  - setHasLinks
```
@BeanProperty(value="has_links")
public void setHasLinks(Boolean hasLinks)
```
    This operator matches Tweets which contain links in the message body.
    
    Parameters:
    
    hasLinks - The has_links
  - withHasLinks
```
public SearchOperators withHasLinks(Boolean hasLinks)
```
  - getLang
```
@BeanProperty(value="lang")
public String getLang()
```
    Matches Tweets that have been classified by Twitter as being of a particular language. Assigned to one of over 50 languages or marked as 'undefined.'
    
    Returns:
    
    The lang
  - setLang
```
@BeanProperty(value="lang")
public void setLang(String lang)
```
    Matches Tweets that have been classified by Twitter as being of a particular language. Assigned to one of over 50 languages or marked as 'undefined.'
    
    Parameters:
    
    lang - The lang
  - withLang
```
public SearchOperators withLang(String lang)
```
  - getHasMentions
```
@BeanProperty(value="has_mentions")
public Boolean getHasMentions()
```
    Matches Tweets that mention another Twitter user.
    
    Returns:
    
    The hasMentions
  - setHasMentions
```
@BeanProperty(value="has_mentions")
public void setHasMentions(Boolean hasMentions)
```
    Matches Tweets that mention another Twitter user.
    
    Parameters:
    
    hasMentions - The has_mentions
  - withHasMentions
```
public SearchOperators withHasMentions(Boolean hasMentions)
```
  - getHasImages
```
@BeanProperty(value="has_images")
public Boolean getHasImages()
```
    A boolean search operator that returns all Tweets that contain a native images (e.g. pic.twitter.com).
    
    Returns:
    
    The hasImages
  - setHasImages
```
@BeanProperty(value="has_images")
public void setHasImages(Boolean hasImages)
```
    A boolean search operator that returns all Tweets that contain a native images (e.g. pic.twitter.com).
    
    Parameters:
    
    hasImages - The has_images
  - withHasImages
```
public SearchOperators withHasImages(Boolean hasImages)
```
  - getHasVideos
```
@BeanProperty(value="has_videos")
public Boolean getHasVideos()
```
    A boolean search operator that returns all Tweets that contain native videos (does not include vine, periscope).
    
    Returns:
    
    The hasVideos
  - setHasVideos
```
@BeanProperty(value="has_videos")
public void setHasVideos(Boolean hasVideos)
```
    A boolean search operator that returns all Tweets that contain native videos (does not include vine, periscope).
    
    Parameters:
    
    hasVideos - The has_videos
  - withHasVideos
```
public SearchOperators withHasVideos(Boolean hasVideos)
```
  - getHasMedia
```
@BeanProperty(value="has_media")
public Boolean getHasMedia()
```
    Matches Tweets that contain a media url classified by Twitter, e.g. pic.twitter.com.
    
    Returns:
    
    The hasMedia
  - setHasMedia
```
@BeanProperty(value="has_media")
public void setHasMedia(Boolean hasMedia)
```
    Matches Tweets that contain a media url classified by Twitter, e.g. pic.twitter.com.
    
    Parameters:
    
    hasMedia - The has_media
  - withHasMedia
```
public SearchOperators withHasMedia(Boolean hasMedia)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getAdditionalProperties
```
@BeanProperty(name="*")
public Map<String,Object> getAdditionalProperties()
```
  - setAdditionalProperty
```
@BeanProperty(name="*")
public void setAdditionalProperty(String name,
                                                          Object value)
```
  - withAdditionalProperty
```
public SearchOperators withAdditionalProperty(String name,
                                              Object value)
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object other)
```
    Overrides:
    
    equals in class Object

Class SearchOperators

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SearchOperators

Method Detail

getKeyword

setKeyword

withKeyword

getEmoji

setEmoji

withEmoji

getExactPhrase

setExactPhrase

withExactPhrase

getFrom

setFrom

withFrom

getTo

setTo

withTo

getMention

setMention

withMention

getRetweetsOf

setRetweetsOf

withRetweetsOf

getHashtag

setHashtag

withHashtag

getUrl

setUrl

withUrl

getBio

setBio

withBio

getBioName

setBioName

withBioName

getBioLocation

setBioLocation

withBioLocation

getPlace

setPlace

withPlace

getPlaceCountry

setPlaceCountry

withPlaceCountry

getPointRadius

setPointRadius

withPointRadius

getBoundingBox

setBoundingBox

withBoundingBox

getTimeZone

setTimeZone

withTimeZone

getHasLinks

setHasLinks

withHasLinks

getLang

setLang

withLang

getHasMentions

setHasMentions

withHasMentions

getHasImages

setHasImages

withHasImages

getHasVideos

setHasVideos

withHasVideos

getHasMedia

setHasMedia

withHasMedia

toString

getAdditionalProperties

setAdditionalProperty

withAdditionalProperty