Package com.twitter.clientlib.api

Class ComplianceApi.APIgetTweetsComplianceStreamRequest

java.lang.Object

com.twitter.clientlib.api.ComplianceApi.APIgetTweetsComplianceStreamRequest

Enclosing class:

ComplianceApi

public class ComplianceApi.APIgetTweetsComplianceStreamRequest
extends Object

Method Summary

Modifier and Type	Method	Description
ComplianceApi.APIgetTweetsComplianceStreamRequest	backfillMinutes(Integer backfillMinutes)	Set backfillMinutes
okhttp3.Call	buildCall(ApiCallback _callback)	Build call for getTweetsComplianceStream
ComplianceApi.APIgetTweetsComplianceStreamRequest	endTime(OffsetDateTime endTime)	Set endTime
InputStream	execute()	Execute getTweetsComplianceStream request
InputStream	execute(Integer retries)	Calls the API using a retry mechanism to handle rate limits errors.
okhttp3.Call	executeAsync(ApiCallback<TweetComplianceStreamResponse> _callback)	Execute getTweetsComplianceStream request (asynchronously)
InputStream	executeWithHttpInfo()	Execute getTweetsComplianceStream request with HTTP info returned
ComplianceApi.APIgetTweetsComplianceStreamRequest	startTime(OffsetDateTime startTime)	Set startTime

Methods inherited from class java.lang.Object

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

Method Detail

backfillMinutes

public ComplianceApi.APIgetTweetsComplianceStreamRequest backfillMinutes(Integer backfillMinutes)

Set backfillMinutes

Parameters:

backfillMinutes - The number of minutes of backfill requested. (optional)

Returns:

APIgetTweetsComplianceStreamRequest

startTime

public ComplianceApi.APIgetTweetsComplianceStreamRequest startTime(OffsetDateTime startTime)

Set startTime

Parameters:

startTime - YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp from which the Tweet Compliance events will be provided. (optional)

Returns:

APIgetTweetsComplianceStreamRequest

endTime

public ComplianceApi.APIgetTweetsComplianceStreamRequest endTime(OffsetDateTime endTime)

Set endTime

Parameters:

endTime - YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Tweet Compliance events will be provided. (optional)

Returns:

APIgetTweetsComplianceStreamRequest

buildCall

public okhttp3.Call buildCall(ApiCallback _callback)
                       throws ApiException

Build call for getTweetsComplianceStream

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

Execute getTweetsComplianceStream request

Returns:

TweetComplianceStreamResponse

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

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

Throws:

ApiException

executeWithHttpInfo

public InputStream executeWithHttpInfo()
                                throws ApiException

Execute getTweetsComplianceStream request with HTTP info returned

Returns:

ApiResponse<TweetComplianceStreamResponse>

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

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