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

java.lang.Object
- org.apache.streams.twitter.api.GeoSearchRequest

All Implemented Interfaces:

Serializable
```
@Generated(value="org.jsonschema2pojo")
public class GeoSearchRequest
extends Object
implements Serializable
```
https://developer.twitter.com/en/docs/geo/places-near-location/api-reference/get-geo-search

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

GeoSearchRequest()

Constructors
Constructor and Description
`GeoSearchRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object other)`
`Boolean`	`getAccuracy()` A hint on the region in which to search.
`Map<String,Object>`	`getAdditionalProperties()`
`String`	`getContainedWithin()` This is the place_id which you would like to restrict the search results to.
`String`	`getGranularity()` This is the minimal granularity of place types to return and must be one of: poi , neighborhood , city , admin or country .
`String`	`getIp()` An IP address.
`Double`	`getLat()` The latitude to search around.
`Double`	`getLong()` The longitude to search around.
`Long`	`getMaxResults()` A hint as to the number of results to return.
`String`	`getQuery()` Free-form text to match against while executing a geo-based query, best suited for finding nearby locations by name.
`int`	`hashCode()`
`void`	`setAccuracy(Boolean accuracy)` A hint on the region in which to search.
`void`	`setAdditionalProperty(String name, Object value)`
`void`	`setContainedWithin(String containedWithin)` This is the place_id which you would like to restrict the search results to.
`void`	`setGranularity(String granularity)` This is the minimal granularity of place types to return and must be one of: poi , neighborhood , city , admin or country .
`void`	`setIp(String ip)` An IP address.
`void`	`setLat(Double lat)` The latitude to search around.
`void`	`setLong(Double _long)` The longitude to search around.
`void`	`setMaxResults(Long maxResults)` A hint as to the number of results to return.
`void`	`setQuery(String query)` Free-form text to match against while executing a geo-based query, best suited for finding nearby locations by name.
`String`	`toString()`
`GeoSearchRequest`	`withAccuracy(Boolean accuracy)`
`GeoSearchRequest`	`withAdditionalProperty(String name, Object value)`
`GeoSearchRequest`	`withContainedWithin(String containedWithin)`
`GeoSearchRequest`	`withGranularity(String granularity)`
`GeoSearchRequest`	`withIp(String ip)`
`GeoSearchRequest`	`withLat(Double lat)`
`GeoSearchRequest`	`withLong(Double _long)`
`GeoSearchRequest`	`withMaxResults(Long maxResults)`
`GeoSearchRequest`	`withQuery(String query)`

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

- Constructor Detail
  - GeoSearchRequest
```
public GeoSearchRequest()
```
- Method Detail
  - getLat
```
@BeanProperty(value="lat")
public Double getLat()
```
    The latitude to search around. This parameter will be ignored unless it is inside the range -90.0 to +90.0 (North is positive) inclusive. It will also be ignored if there isn’t a corresponding long parameter.
    
    Returns:
    
    The lat
  - setLat
```
@BeanProperty(value="lat")
public void setLat(Double lat)
```
    The latitude to search around. This parameter will be ignored unless it is inside the range -90.0 to +90.0 (North is positive) inclusive. It will also be ignored if there isn’t a corresponding long parameter.
    
    Parameters:
    
    lat - The lat
  - withLat
```
public GeoSearchRequest withLat(Double lat)
```
  - getLong
```
@BeanProperty(value="long")
public Double getLong()
```
    The longitude to search around. The valid ranges for longitude is -180.0 to +180.0 (East is positive) inclusive. This parameter will be ignored if outside that range, if it is not a number, if geo_enabled is disabled, or if there not a corresponding lat parameter.
    
    Returns:
    
    The _long
  - setLong
```
@BeanProperty(value="long")
public void setLong(Double _long)
```
    The longitude to search around. The valid ranges for longitude is -180.0 to +180.0 (East is positive) inclusive. This parameter will be ignored if outside that range, if it is not a number, if geo_enabled is disabled, or if there not a corresponding lat parameter.
    
    Parameters:
    
    _long - The long
  - withLong
```
public GeoSearchRequest withLong(Double _long)
```
  - getQuery
```
@BeanProperty(value="query")
public String getQuery()
```
    Free-form text to match against while executing a geo-based query, best suited for finding nearby locations by name. Remember to URL encode the query.
    
    Returns:
    
    The query
  - setQuery
```
@BeanProperty(value="query")
public void setQuery(String query)
```
    Free-form text to match against while executing a geo-based query, best suited for finding nearby locations by name. Remember to URL encode the query.
    
    Parameters:
    
    query - The query
  - withQuery
```
public GeoSearchRequest withQuery(String query)
```
  - getIp
```
@BeanProperty(value="ip")
public String getIp()
```
    An IP address. Used when attempting to fix geolocation based off of the user’s IP address.
    
    Returns:
    
    The ip
  - setIp
```
@BeanProperty(value="ip")
public void setIp(String ip)
```
    An IP address. Used when attempting to fix geolocation based off of the user’s IP address.
    
    Parameters:
    
    ip - The ip
  - withIp
```
public GeoSearchRequest withIp(String ip)
```
  - getGranularity
```
@BeanProperty(value="granularity")
public String getGranularity()
```
    This is the minimal granularity of place types to return and must be one of: poi , neighborhood , city , admin or country . If no granularity is provided for the request neighborhood is assumed. Setting this to city , for example, will find places which have a type of city , admin or country .
    
    Returns:
    
    The granularity
  - setGranularity
```
@BeanProperty(value="granularity")
public void setGranularity(String granularity)
```
    This is the minimal granularity of place types to return and must be one of: poi , neighborhood , city , admin or country . If no granularity is provided for the request neighborhood is assumed. Setting this to city , for example, will find places which have a type of city , admin or country .
    
    Parameters:
    
    granularity - The granularity
  - withGranularity
```
public GeoSearchRequest withGranularity(String granularity)
```
  - getAccuracy
```
@BeanProperty(value="accuracy")
public Boolean getAccuracy()
```
    A hint on the region in which to search. If a number, then this is a radius in meters, but it can also take a string that is suffixed with ft to specify feet. If this is not passed in, then it is assumed to be 0m . If coming from a device, in practice, this value is whatever accuracy the device has measuring its location (whether it be coming from a GPS, WiFi triangulation, etc.).
    
    Returns:
    
    The accuracy
  - setAccuracy
```
@BeanProperty(value="accuracy")
public void setAccuracy(Boolean accuracy)
```
    A hint on the region in which to search. If a number, then this is a radius in meters, but it can also take a string that is suffixed with ft to specify feet. If this is not passed in, then it is assumed to be 0m . If coming from a device, in practice, this value is whatever accuracy the device has measuring its location (whether it be coming from a GPS, WiFi triangulation, etc.).
    
    Parameters:
    
    accuracy - The accuracy
  - withAccuracy
```
public GeoSearchRequest withAccuracy(Boolean accuracy)
```
  - getMaxResults
```
@BeanProperty(value="max_results")
public Long getMaxResults()
```
    A hint as to the number of results to return. This does not guarantee that the number of results returned will equal max_results, but instead informs how many nearby results to return. Ideally, only pass in the number of places you intend to display to the user here.
    
    Returns:
    
    The maxResults
  - setMaxResults
```
@BeanProperty(value="max_results")
public void setMaxResults(Long maxResults)
```
    A hint as to the number of results to return. This does not guarantee that the number of results returned will equal max_results, but instead informs how many nearby results to return. Ideally, only pass in the number of places you intend to display to the user here.
    
    Parameters:
    
    maxResults - The max_results
  - withMaxResults
```
public GeoSearchRequest withMaxResults(Long maxResults)
```
  - getContainedWithin
```
@BeanProperty(value="contained_within")
public String getContainedWithin()
```
    This is the place_id which you would like to restrict the search results to. Setting this value means only places within the given place_id will be found. Specify a place_id.
    
    Returns:
    
    The containedWithin
  - setContainedWithin
```
@BeanProperty(value="contained_within")
public void setContainedWithin(String containedWithin)
```
    This is the place_id which you would like to restrict the search results to. Setting this value means only places within the given place_id will be found. Specify a place_id.
    
    Parameters:
    
    containedWithin - The contained_within
  - withContainedWithin
```
public GeoSearchRequest withContainedWithin(String containedWithin)
```
  - 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 GeoSearchRequest 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 GeoSearchRequest

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GeoSearchRequest

Method Detail

getLat

setLat

withLat

getLong

setLong

withLong

getQuery

setQuery

withQuery

getIp

setIp

withIp

getGranularity

setGranularity

withGranularity

getAccuracy

setAccuracy

withAccuracy

getMaxResults

setMaxResults

withMaxResults

getContainedWithin

setContainedWithin

withContainedWithin

toString

getAdditionalProperties

setAdditionalProperty

withAdditionalProperty

hashCode

equals