Package com.twitter.clientlib.api

Class ComplianceApi.APIgetUsersComplianceStreamRequest

java.lang.Object

com.twitter.clientlib.api.ComplianceApi.APIgetUsersComplianceStreamRequest

Enclosing class:

ComplianceApi

public class ComplianceApi.APIgetUsersComplianceStreamRequest
extends Object

Method Summary

Modifier and Type	Method	Description
ComplianceApi.APIgetUsersComplianceStreamRequest	backfillMinutes(Integer backfillMinutes)	Set backfillMinutes
okhttp3.Call	buildCall(ApiCallback _callback)	Build call for getUsersComplianceStream
ComplianceApi.APIgetUsersComplianceStreamRequest	endTime(OffsetDateTime endTime)	Set endTime
InputStream	execute()	Execute getUsersComplianceStream request
InputStream	execute(Integer retries)	Calls the API using a retry mechanism to handle rate limits errors.
okhttp3.Call	executeAsync(ApiCallback<UserComplianceStreamResponse> _callback)	Execute getUsersComplianceStream request (asynchronously)
InputStream	executeWithHttpInfo()	Execute getUsersComplianceStream request with HTTP info returned
ComplianceApi.APIgetUsersComplianceStreamRequest	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.APIgetUsersComplianceStreamRequest backfillMinutes(Integer backfillMinutes)

Set backfillMinutes

Parameters:

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

Returns:

APIgetUsersComplianceStreamRequest

startTime

public ComplianceApi.APIgetUsersComplianceStreamRequest startTime(OffsetDateTime startTime)

Set startTime

Parameters:

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

Returns:

APIgetUsersComplianceStreamRequest

endTime

public ComplianceApi.APIgetUsersComplianceStreamRequest endTime(OffsetDateTime endTime)

Set endTime

Parameters:

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

Returns:

APIgetUsersComplianceStreamRequest

buildCall

public okhttp3.Call buildCall(ApiCallback _callback)
                       throws ApiException

Build call for getUsersComplianceStream

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

Returns:

UserComplianceStreamResponse

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

Returns:

ApiResponse<UserComplianceStreamResponse>

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

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