Package com.twitter.clientlib.api

Class TweetsApi.APIgetTweetsFirehoseStreamRequest

java.lang.Object

com.twitter.clientlib.api.TweetsApi.APIgetTweetsFirehoseStreamRequest

Enclosing class:

TweetsApi

public class TweetsApi.APIgetTweetsFirehoseStreamRequest
extends Object

Method Summary

Modifier and Type	Method	Description
TweetsApi.APIgetTweetsFirehoseStreamRequest	backfillMinutes(Integer backfillMinutes)	Set backfillMinutes
okhttp3.Call	buildCall(ApiCallback _callback)	Build call for getTweetsFirehoseStream
TweetsApi.APIgetTweetsFirehoseStreamRequest	endTime(OffsetDateTime endTime)	Set endTime
TweetsApi.APIgetTweetsFirehoseStreamRequest	excludeInputFields()
InputStream	execute()	Execute getTweetsFirehoseStream request
InputStream	execute(Integer retries)	Calls the API using a retry mechanism to handle rate limits errors.
okhttp3.Call	executeAsync(ApiCallback<StreamingTweetResponse> _callback)	Execute getTweetsFirehoseStream request (asynchronously)
InputStream	executeWithHttpInfo()	Execute getTweetsFirehoseStream request with HTTP info returned
TweetsApi.APIgetTweetsFirehoseStreamRequest	expansions(Set<String> expansions)	Set expansions
TweetsApi.APIgetTweetsFirehoseStreamRequest	mediaFields(Set<String> mediaFields)	Set mediaFields
TweetsApi.APIgetTweetsFirehoseStreamRequest	placeFields(Set<String> placeFields)	Set placeFields
TweetsApi.APIgetTweetsFirehoseStreamRequest	pollFields(Set<String> pollFields)	Set pollFields
TweetsApi.APIgetTweetsFirehoseStreamRequest	startTime(OffsetDateTime startTime)	Set startTime
TweetsApi.APIgetTweetsFirehoseStreamRequest	tweetFields(Set<String> tweetFields)	Set tweetFields
TweetsApi.APIgetTweetsFirehoseStreamRequest	userFields(Set<String> userFields)	Set userFields

Methods inherited from class java.lang.Object

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

Method Detail

excludeInputFields

public TweetsApi.APIgetTweetsFirehoseStreamRequest excludeInputFields()

backfillMinutes

public TweetsApi.APIgetTweetsFirehoseStreamRequest backfillMinutes(Integer backfillMinutes)

Set backfillMinutes

Parameters:

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

Returns:

APIgetTweetsFirehoseStreamRequest

startTime

public TweetsApi.APIgetTweetsFirehoseStreamRequest startTime(OffsetDateTime startTime)

Set startTime

Parameters:

startTime - YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp to which the Tweets will be provided. (optional)

Returns:

APIgetTweetsFirehoseStreamRequest

endTime

public TweetsApi.APIgetTweetsFirehoseStreamRequest endTime(OffsetDateTime endTime)

Set endTime

Parameters:

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

Returns:

APIgetTweetsFirehoseStreamRequest

tweetFields

public TweetsApi.APIgetTweetsFirehoseStreamRequest tweetFields(Set<String> tweetFields)

Set tweetFields

Parameters:

tweetFields - A comma separated list of Tweet fields to display. (optional)

Returns:

APIgetTweetsFirehoseStreamRequest

expansions

public TweetsApi.APIgetTweetsFirehoseStreamRequest expansions(Set<String> expansions)

Set expansions

Parameters:

expansions - A comma separated list of fields to expand. (optional)

Returns:

APIgetTweetsFirehoseStreamRequest

mediaFields

public TweetsApi.APIgetTweetsFirehoseStreamRequest mediaFields(Set<String> mediaFields)

Set mediaFields

Parameters:

mediaFields - A comma separated list of Media fields to display. (optional)

Returns:

APIgetTweetsFirehoseStreamRequest

pollFields

public TweetsApi.APIgetTweetsFirehoseStreamRequest pollFields(Set<String> pollFields)

Set pollFields

Parameters:

pollFields - A comma separated list of Poll fields to display. (optional)

Returns:

APIgetTweetsFirehoseStreamRequest

userFields

public TweetsApi.APIgetTweetsFirehoseStreamRequest userFields(Set<String> userFields)

Set userFields

Parameters:

userFields - A comma separated list of User fields to display. (optional)

Returns:

APIgetTweetsFirehoseStreamRequest

placeFields

public TweetsApi.APIgetTweetsFirehoseStreamRequest placeFields(Set<String> placeFields)

Set placeFields

Parameters:

placeFields - A comma separated list of Place fields to display. (optional)

Returns:

APIgetTweetsFirehoseStreamRequest

buildCall

public okhttp3.Call buildCall(ApiCallback _callback)
                       throws ApiException

Build call for getTweetsFirehoseStream

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 getTweetsFirehoseStream request

Returns:

StreamingTweetResponse

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 getTweetsFirehoseStream request with HTTP info returned

Returns:

ApiResponse<StreamingTweetResponse>

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

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