Package com.twitter.clientlib.api

Class ComplianceApi

java.lang.Object

com.twitter.clientlib.api.ApiCommon

com.twitter.clientlib.api.ComplianceApi

public class ComplianceApi
extends ApiCommon

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	ComplianceApi.APIcreateBatchComplianceJobRequest
class	ComplianceApi.APIgetBatchComplianceJobRequest
class	ComplianceApi.APIlistBatchComplianceJobsRequest

Field Summary

Fields inherited from class com.twitter.clientlib.api.ApiCommon

localVarApiClient

Constructor Summary

Constructors

Constructor	Description
ComplianceApi()

Method Summary

Modifier and Type	Method	Description
ComplianceApi.APIcreateBatchComplianceJobRequest	createBatchComplianceJob(CreateComplianceJobRequest createComplianceJobRequest)	Create compliance job Creates a compliance for the given job type
ComplianceApi.APIgetBatchComplianceJobRequest	getBatchComplianceJob(String id)	Get Compliance Job Returns a single Compliance Job by ID
ComplianceApi.APIlistBatchComplianceJobsRequest	listBatchComplianceJobs(String type)	List Compliance Jobs Returns recent Compliance Jobs for a given job type and optional job status

Methods inherited from class com.twitter.clientlib.api.ApiCommon

handleRateLimit, reduceAuthNames, setClient

Methods inherited from class java.lang.Object

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

Constructor Detail

ComplianceApi

public ComplianceApi()

Method Detail

createBatchComplianceJob

public ComplianceApi.APIcreateBatchComplianceJobRequest createBatchComplianceJob(CreateComplianceJobRequest createComplianceJobRequest)

Create compliance job Creates a compliance for the given job type

Parameters:

createComplianceJobRequest - (required)

Returns:

APIcreateBatchComplianceJobRequest

Http Response Details:

Status Code	Description	Response Headers
200	The request has succeeded.	-
0	The request has failed.	-

getBatchComplianceJob

public ComplianceApi.APIgetBatchComplianceJobRequest getBatchComplianceJob(String id)

Get Compliance Job Returns a single Compliance Job by ID

Parameters:

id - The ID of the Compliance Job to retrieve. (required)

Returns:

APIgetBatchComplianceJobRequest

Http Response Details:

Status Code	Description	Response Headers
200	The request has succeeded.	-
0	The request has failed.	-

listBatchComplianceJobs

public ComplianceApi.APIlistBatchComplianceJobsRequest listBatchComplianceJobs(String type)

List Compliance Jobs Returns recent Compliance Jobs for a given job type and optional job status

Parameters:

type - Type of Compliance Job to list. (required)

Returns:

APIlistBatchComplianceJobsRequest

Http Response Details:

Status Code	Description	Response Headers
200	The request has succeeded.	-
0	The request has failed.	-