Package com.twitter.clientlib.api

Class TweetsApi.APIsampleStreamRequest

java.lang.Object

com.twitter.clientlib.api.TweetsApi.APIsampleStreamRequest

Enclosing class:

TweetsApi

public class TweetsApi.APIsampleStreamRequest
extends Object

Method Summary

Modifier and Type	Method	Description
TweetsApi.APIsampleStreamRequest	backfillMinutes(Integer backfillMinutes)	Set backfillMinutes
okhttp3.Call	buildCall(ApiCallback _callback)	Build call for sampleStream
InputStream	execute()	Execute sampleStream request
InputStream	execute(Integer retries)	Calls the API using a retry mechanism to handle rate limits errors.
okhttp3.Call	executeAsync(ApiCallback<StreamingTweetResponse> _callback)	Execute sampleStream request (asynchronously)
InputStream	executeWithHttpInfo()	Execute sampleStream request with HTTP info returned
TweetsApi.APIsampleStreamRequest	expansions(Set<String> expansions)	Set expansions
TweetsApi.APIsampleStreamRequest	mediaFields(Set<String> mediaFields)	Set mediaFields
TweetsApi.APIsampleStreamRequest	placeFields(Set<String> placeFields)	Set placeFields
TweetsApi.APIsampleStreamRequest	pollFields(Set<String> pollFields)	Set pollFields
TweetsApi.APIsampleStreamRequest	tweetFields(Set<String> tweetFields)	Set tweetFields
TweetsApi.APIsampleStreamRequest	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

backfillMinutes

public TweetsApi.APIsampleStreamRequest backfillMinutes(Integer backfillMinutes)

Set backfillMinutes

Parameters:

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

Returns:

APIsampleStreamRequest

tweetFields

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

Set tweetFields

Parameters:

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

Returns:

APIsampleStreamRequest

expansions

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

Set expansions

Parameters:

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

Returns:

APIsampleStreamRequest

mediaFields

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

Set mediaFields

Parameters:

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

Returns:

APIsampleStreamRequest

pollFields

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

Set pollFields

Parameters:

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

Returns:

APIsampleStreamRequest

userFields

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

Set userFields

Parameters:

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

Returns:

APIsampleStreamRequest

placeFields

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

Set placeFields

Parameters:

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

Returns:

APIsampleStreamRequest

buildCall

public okhttp3.Call buildCall(ApiCallback _callback)
                       throws ApiException

Build call for sampleStream

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 sampleStream 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 sampleStream 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 sampleStream 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.	-