Package com.twitter.clientlib.api

Class TweetsApi.APIgetTweetsSample10StreamRequest

java.lang.Object

com.twitter.clientlib.api.TweetsApi.APIgetTweetsSample10StreamRequest

Enclosing class:

TweetsApi

public class TweetsApi.APIgetTweetsSample10StreamRequest
extends Object

Method Summary

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

backfillMinutes

public TweetsApi.APIgetTweetsSample10StreamRequest backfillMinutes(Integer backfillMinutes)

Set backfillMinutes

Parameters:

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

Returns:

APIgetTweetsSample10StreamRequest

startTime

public TweetsApi.APIgetTweetsSample10StreamRequest 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:

APIgetTweetsSample10StreamRequest

endTime

public TweetsApi.APIgetTweetsSample10StreamRequest 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:

APIgetTweetsSample10StreamRequest

tweetFields

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

Set tweetFields

Parameters:

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

Returns:

APIgetTweetsSample10StreamRequest

expansions

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

Set expansions

Parameters:

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

Returns:

APIgetTweetsSample10StreamRequest

mediaFields

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

Set mediaFields

Parameters:

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

Returns:

APIgetTweetsSample10StreamRequest

pollFields

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

Set pollFields

Parameters:

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

Returns:

APIgetTweetsSample10StreamRequest

userFields

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

Set userFields

Parameters:

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

Returns:

APIgetTweetsSample10StreamRequest

placeFields

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

Set placeFields

Parameters:

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

Returns:

APIgetTweetsSample10StreamRequest

buildCall

public okhttp3.Call buildCall(ApiCallback _callback)
                       throws ApiException

Build call for getTweetsSample10Stream

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

Returns:

Get2TweetsSample10StreamResponse

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

Returns:

ApiResponse<Get2TweetsSample10StreamResponse>

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

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