org.apache.streams.twitter.api

Class UsersSearchRequest

java.lang.Object

org.apache.streams.twitter.api.UsersSearchRequest

All Implemented Interfaces:

Serializable

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

https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-users-search

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
UsersSearchRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other)
Map<String,Object>	getAdditionalProperties()
Long	getCount() The number of potential user results to retrieve per page.
Long	getIncludeEntities() The entities node will not be included in embedded Tweet objects when set to false.
Long	getPage() Specifies the page of results to retrieve.
String	getQ() The search query to run against people search.
int	hashCode()
void	setAdditionalProperty(String name, Object value)
void	setCount(Long count) The number of potential user results to retrieve per page.
void	setIncludeEntities(Long includeEntities) The entities node will not be included in embedded Tweet objects when set to false.
void	setPage(Long page) Specifies the page of results to retrieve.
void	setQ(String q) The search query to run against people search.
String	toString()
UsersSearchRequest	withAdditionalProperty(String name, Object value)
UsersSearchRequest	withCount(Long count)
UsersSearchRequest	withIncludeEntities(Long includeEntities)
UsersSearchRequest	withPage(Long page)
UsersSearchRequest	withQ(String q)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UsersSearchRequest

public UsersSearchRequest()

Method Detail

getQ

@BeanProperty(value="q")
public String getQ()

The search query to run against people search. (Required)

Returns:

The q

setQ

@BeanProperty(value="q")
public void setQ(String q)

The search query to run against people search. (Required)

Parameters:

q - The q

withQ

public UsersSearchRequest withQ(String q)

getPage

@BeanProperty(value="page")
public Long getPage()

Specifies the page of results to retrieve.

Returns:

The page

setPage

@BeanProperty(value="page")
public void setPage(Long page)

Specifies the page of results to retrieve.

Parameters:

page - The page

withPage

public UsersSearchRequest withPage(Long page)

getCount

@BeanProperty(value="count")
public Long getCount()

The number of potential user results to retrieve per page. This value has a maximum of 20.

Returns:

The count

setCount

@BeanProperty(value="count")
public void setCount(Long count)

The number of potential user results to retrieve per page. This value has a maximum of 20.

Parameters:

count - The count

withCount

public UsersSearchRequest withCount(Long count)

getIncludeEntities

@BeanProperty(value="include_entities")
public Long getIncludeEntities()

The entities node will not be included in embedded Tweet objects when set to false.

Returns:

The includeEntities

setIncludeEntities

@BeanProperty(value="include_entities")
public void setIncludeEntities(Long includeEntities)

The entities node will not be included in embedded Tweet objects when set to false.

Parameters:

includeEntities - The include_entities

withIncludeEntities

public UsersSearchRequest withIncludeEntities(Long includeEntities)

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 UsersSearchRequest 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