Package com.twitter.clientlib.api

Class TweetsApi.APIaddOrDeleteRulesRequest

java.lang.Object

com.twitter.clientlib.api.TweetsApi.APIaddOrDeleteRulesRequest

Enclosing class:

TweetsApi

public class TweetsApi.APIaddOrDeleteRulesRequest
extends Object

Method Summary

Modifier and Type	Method	Description
okhttp3.Call	buildCall(ApiCallback _callback)	Build call for addOrDeleteRules
TweetsApi.APIaddOrDeleteRulesRequest	dryRun(Boolean dryRun)	Set dryRun
AddOrDeleteRulesResponse	execute()	Execute addOrDeleteRules request
AddOrDeleteRulesResponse	execute(Integer retries)	Calls the API using a retry mechanism to handle rate limits errors.
okhttp3.Call	executeAsync(ApiCallback<AddOrDeleteRulesResponse> _callback)	Execute addOrDeleteRules request (asynchronously)
ApiResponse<AddOrDeleteRulesResponse>	executeWithHttpInfo()	Execute addOrDeleteRules request with HTTP info returned

Methods inherited from class java.lang.Object

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

Method Detail

dryRun

public TweetsApi.APIaddOrDeleteRulesRequest dryRun(Boolean dryRun)

Set dryRun

Parameters:

dryRun - Dry Run can be used with both the add and delete action, with the expected result given, but without actually taking any action in the system (meaning the end state will always be as it was when the request was submitted). This is particularly useful to validate rule changes. (optional)

Returns:

APIaddOrDeleteRulesRequest

buildCall

public okhttp3.Call buildCall(ApiCallback _callback)
                       throws ApiException

Build call for addOrDeleteRules

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 AddOrDeleteRulesResponse execute()
                                 throws ApiException

Execute addOrDeleteRules request

Returns:

AddOrDeleteRulesResponse

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 AddOrDeleteRulesResponse execute(Integer retries)
                                 throws ApiException

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

Throws:

ApiException

executeWithHttpInfo

public ApiResponse<AddOrDeleteRulesResponse> executeWithHttpInfo()
                                                          throws ApiException

Execute addOrDeleteRules request with HTTP info returned

Returns:

ApiResponse<AddOrDeleteRulesResponse>

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<AddOrDeleteRulesResponse> _callback)
                          throws ApiException

Execute addOrDeleteRules 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.	-