Package com.twitter.clientlib.api

Class ComplianceApi.APIlistBatchComplianceJobsRequest

java.lang.Object

com.twitter.clientlib.api.ComplianceApi.APIlistBatchComplianceJobsRequest

Enclosing class:

ComplianceApi

public class ComplianceApi.APIlistBatchComplianceJobsRequest
extends Object

Method Summary

Modifier and Type	Method	Description
okhttp3.Call	buildCall(ApiCallback _callback)	Build call for listBatchComplianceJobs
ComplianceApi.APIlistBatchComplianceJobsRequest	complianceJobFields(Set<String> complianceJobFields)	Set complianceJobFields
Get2ComplianceJobsResponse	execute()	Execute listBatchComplianceJobs request
Get2ComplianceJobsResponse	execute(Integer retries)	Calls the API using a retry mechanism to handle rate limits errors.
okhttp3.Call	executeAsync(ApiCallback<Get2ComplianceJobsResponse> _callback)	Execute listBatchComplianceJobs request (asynchronously)
ApiResponse<Get2ComplianceJobsResponse>	executeWithHttpInfo()	Execute listBatchComplianceJobs request with HTTP info returned
ComplianceApi.APIlistBatchComplianceJobsRequest	status(String status)	Set status

Methods inherited from class java.lang.Object

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

Method Detail

status

public ComplianceApi.APIlistBatchComplianceJobsRequest status(String status)

Set status

Parameters:

status - Status of Compliance Job to list. (optional)

Returns:

APIlistBatchComplianceJobsRequest

complianceJobFields

public ComplianceApi.APIlistBatchComplianceJobsRequest complianceJobFields(Set<String> complianceJobFields)

Set complianceJobFields

Parameters:

complianceJobFields - A comma separated list of ComplianceJob fields to display. (optional)

Returns:

APIlistBatchComplianceJobsRequest

buildCall

public okhttp3.Call buildCall(ApiCallback _callback)
                       throws ApiException

Build call for listBatchComplianceJobs

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

Execute listBatchComplianceJobs request

Returns:

Get2ComplianceJobsResponse

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

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

Throws:

ApiException

executeWithHttpInfo

public ApiResponse<Get2ComplianceJobsResponse> executeWithHttpInfo()
                                                            throws ApiException

Execute listBatchComplianceJobs request with HTTP info returned

Returns:

ApiResponse<Get2ComplianceJobsResponse>

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

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