Package com.courier.api.resources.bulk

Class BulkClient

java.lang.Object

com.courier.api.resources.bulk.BulkClient

public class BulkClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
BulkClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
BulkCreateJobResponse	createJob(BulkCreateJobParams request)
BulkCreateJobResponse	createJob(BulkCreateJobParams request, IdempotentRequestOptions requestOptions)
BulkGetJobResponse	getJob(java.lang.String jobId)	Get a bulk job
BulkGetJobResponse	getJob(java.lang.String jobId, RequestOptions requestOptions)	Get a bulk job
BulkGetJobUsersResponse	getUsers(java.lang.String jobId)	Get Bulk Job Users
BulkGetJobUsersResponse	getUsers(java.lang.String jobId, RequestOptions requestOptions)	Get Bulk Job Users
void	ingestUsers(java.lang.String jobId, BulkIngestUsersParams request)	Ingest user data into a Bulk Job
void	ingestUsers(java.lang.String jobId, BulkIngestUsersParams request, IdempotentRequestOptions requestOptions)	Ingest user data into a Bulk Job
void	runJob(java.lang.String jobId)	Run a bulk job
void	runJob(java.lang.String jobId, IdempotentRequestOptions requestOptions)	Run a bulk job

Methods inherited from class java.lang.Object

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

Field Detail

clientOptions

protected final ClientOptions clientOptions

Constructor Detail

BulkClient

public BulkClient(ClientOptions clientOptions)

Method Detail

createJob

public BulkCreateJobResponse createJob(BulkCreateJobParams request)

createJob

public BulkCreateJobResponse createJob(BulkCreateJobParams request,
                                       IdempotentRequestOptions requestOptions)

ingestUsers

public void ingestUsers(java.lang.String jobId,
                        BulkIngestUsersParams request)

Ingest user data into a Bulk Job

ingestUsers

public void ingestUsers(java.lang.String jobId,
                        BulkIngestUsersParams request,
                        IdempotentRequestOptions requestOptions)

Ingest user data into a Bulk Job

runJob

public void runJob(java.lang.String jobId)

Run a bulk job

runJob

public void runJob(java.lang.String jobId,
                   IdempotentRequestOptions requestOptions)

Run a bulk job

getJob

public BulkGetJobResponse getJob(java.lang.String jobId)

Get a bulk job

getJob

public BulkGetJobResponse getJob(java.lang.String jobId,
                                 RequestOptions requestOptions)

Get a bulk job

getUsers

public BulkGetJobUsersResponse getUsers(java.lang.String jobId)

Get Bulk Job Users

getUsers

public BulkGetJobUsersResponse getUsers(java.lang.String jobId,
                                        RequestOptions requestOptions)

Get Bulk Job Users