Package com.twitter.clientlib.api

Class TweetsApi.APIgetRulesRequest

java.lang.Object

com.twitter.clientlib.api.TweetsApi.APIgetRulesRequest

Enclosing class:

TweetsApi

public class TweetsApi.APIgetRulesRequest
extends Object

Method Summary

Modifier and Type	Method	Description
okhttp3.Call	buildCall(ApiCallback _callback)	Build call for getRules
RulesLookupResponse	execute()	Execute getRules request
RulesLookupResponse	execute(Integer retries)	Calls the API using a retry mechanism to handle rate limits errors.
okhttp3.Call	executeAsync(ApiCallback<RulesLookupResponse> _callback)	Execute getRules request (asynchronously)
ApiResponse<RulesLookupResponse>	executeWithHttpInfo()	Execute getRules request with HTTP info returned
TweetsApi.APIgetRulesRequest	ids(List<String> ids)	Set ids
TweetsApi.APIgetRulesRequest	maxResults(Integer maxResults)	Set maxResults
TweetsApi.APIgetRulesRequest	paginationToken(String paginationToken)	Set paginationToken

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

ids

public TweetsApi.APIgetRulesRequest ids(List<String> ids)

Set ids

Parameters:

ids - A comma-separated list of Rule IDs. (optional)

Returns:

APIgetRulesRequest

maxResults

public TweetsApi.APIgetRulesRequest maxResults(Integer maxResults)

Set maxResults

Parameters:

maxResults - The maximum number of results. (optional, default to 1000)

Returns:

APIgetRulesRequest

paginationToken

public TweetsApi.APIgetRulesRequest paginationToken(String paginationToken)

Set paginationToken

Parameters:

paginationToken - This value is populated by passing the 'next_token' returned in a request to paginate through results. (optional)

Returns:

APIgetRulesRequest

buildCall

public okhttp3.Call buildCall(ApiCallback _callback)
                       throws ApiException

Build call for getRules

Parameters:

_callback - ApiCallback API callback

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	The request has succeeded.	-
0	The request has failed.	-

execute

public RulesLookupResponse execute()
                            throws ApiException

Execute getRules request

Returns:

RulesLookupResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	The request has succeeded.	-
0	The request has failed.	-

execute

public RulesLookupResponse execute(Integer retries)
                            throws ApiException

Calls the API using a retry mechanism to handle rate limits errors.

Throws:

ApiException

executeWithHttpInfo

public ApiResponse<RulesLookupResponse> executeWithHttpInfo()
                                                     throws ApiException

Execute getRules request with HTTP info returned

Returns:

ApiResponse<RulesLookupResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	The request has succeeded.	-
0	The request has failed.	-

executeAsync

public okhttp3.Call executeAsync(ApiCallback<RulesLookupResponse> _callback)
                          throws ApiException

Execute getRules request (asynchronously)

Parameters:

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	The request has succeeded.	-
0	The request has failed.	-