com.twilio.rest.taskrouter.v1.workspace

Class EventReader

java.lang.Object

com.twilio.base.Reader<Event>

com.twilio.rest.taskrouter.v1.workspace.EventReader

public class EventReader
extends Reader<Event>

Constructor Summary

Constructors

Constructor and Description
EventReader(String pathWorkspaceSid) Construct a new EventReader.

Method Summary

Modifier and Type	Method and Description
Page<Event>	firstPage(TwilioRestClient client) Make the request to the Twilio API to perform the read.
Page<Event>	getPage(String targetUrl, TwilioRestClient client) Retrieve the target page from the Twilio API.
Page<Event>	nextPage(Page<Event> page, TwilioRestClient client) Retrieve the next page from the Twilio API.
Page<Event>	previousPage(Page<Event> page, TwilioRestClient client) Retrieve the previous page from the Twilio API.
ResourceSet<Event>	read(TwilioRestClient client) Make the request to the Twilio API to perform the read.
EventReader	setEndDate(ZonedDateTime endDate) Only include Events that occurred on or before this date, specified in GMT as an ISO 8601 date-time..
EventReader	setEventType(String eventType) The type of Events to read.
EventReader	setMinutes(Integer minutes) The period of events to read in minutes.
EventReader	setReservationSid(String reservationSid) The SID of the Reservation with the Events to read.
EventReader	setSid(String sid) The SID of the Event resource to read..
EventReader	setStartDate(ZonedDateTime startDate) Only include Events from on or after this date and time, specified in ISO 8601 format.
EventReader	setTaskChannel(String taskChannel) The TaskChannel with the Events to read.
EventReader	setTaskQueueSid(String taskQueueSid) The SID of the TaskQueue with the Events to read.
EventReader	setTaskSid(String taskSid) The SID of the Task with the Events to read.
EventReader	setWorkerSid(String workerSid) The SID of the Worker with the Events to read.
EventReader	setWorkflowSid(String workflowSid) The SID of the Workflow with the Events to read.

Methods inherited from class com.twilio.base.Reader

firstPage, getLimit, getPage, getPageSize, limit, nextPage, pageSize, previousPage, read, readAsync, readAsync

Methods inherited from class java.lang.Object

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

Constructor Detail

EventReader

public EventReader(String pathWorkspaceSid)

Construct a new EventReader.

Parameters:

pathWorkspaceSid - The SID of the Workspace with the Events to read

Method Detail

setEndDate

public EventReader setEndDate(ZonedDateTime endDate)

Only include Events that occurred on or before this date, specified in GMT as an ISO 8601 date-time..

Parameters:

endDate - Only include usage that occurred on or before this date

Returns:

this

setEventType

public EventReader setEventType(String eventType)

The type of Events to read. Returns only Events of the type specified..

Parameters:

eventType - The type of Events to read

Returns:

this

setMinutes

public EventReader setMinutes(Integer minutes)

The period of events to read in minutes. Returns only Events that occurred since this many minutes in the past. The default is `15` minutes. Task Attributes for Events occuring more 43,200 minutes ago will be redacted..

Parameters:

minutes - The period of events to read in minutes

Returns:

this

setReservationSid

public EventReader setReservationSid(String reservationSid)

The SID of the Reservation with the Events to read. Returns only Events that pertain to the specified Reservation..

Parameters:

reservationSid - The SID of the Reservation with the Events to read

Returns:

this

setStartDate

public EventReader setStartDate(ZonedDateTime startDate)

Only include Events from on or after this date and time, specified in ISO 8601 format. Task Attributes for Events older than 30 days will be redacted..

Parameters:

startDate - Only include Events from on or after this date

Returns:

this

setTaskQueueSid

public EventReader setTaskQueueSid(String taskQueueSid)

The SID of the TaskQueue with the Events to read. Returns only the Events that pertain to the specified TaskQueue..

Parameters:

taskQueueSid - The SID of the TaskQueue with the Events to read

Returns:

this

setTaskSid

public EventReader setTaskSid(String taskSid)

The SID of the Task with the Events to read. Returns only the Events that pertain to the specified Task..

Parameters:

taskSid - The SID of the Task with the Events to read

Returns:

this

setWorkerSid

public EventReader setWorkerSid(String workerSid)

The SID of the Worker with the Events to read. Returns only the Events that pertain to the specified Worker..

Parameters:

workerSid - The SID of the Worker with the Events to read

Returns:

this

setWorkflowSid

public EventReader setWorkflowSid(String workflowSid)

The SID of the Workflow with the Events to read. Returns only the Events that pertain to the specified Workflow..

Parameters:

workflowSid - The SID of the Worker with the Events to read

Returns:

this

setTaskChannel

public EventReader setTaskChannel(String taskChannel)

The TaskChannel with the Events to read. Returns only the Events that pertain to the specified TaskChannel..

Parameters:

taskChannel - The TaskChannel with the Events to read

Returns:

this

setSid

public EventReader setSid(String sid)

The SID of the Event resource to read..

Parameters:

sid - The unique string that identifies the resource

Returns:

this

read

public ResourceSet<Event> read(TwilioRestClient client)

Make the request to the Twilio API to perform the read.

Specified by:

read in class Reader<Event>

Parameters:

client - TwilioRestClient with which to make the request

Returns:

Event ResourceSet

firstPage

public Page<Event> firstPage(TwilioRestClient client)

Make the request to the Twilio API to perform the read.

Specified by:

firstPage in class Reader<Event>

Parameters:

client - TwilioRestClient with which to make the request

Returns:

Event ResourceSet

getPage

public Page<Event> getPage(String targetUrl,
                           TwilioRestClient client)

Retrieve the target page from the Twilio API.

Specified by:

getPage in class Reader<Event>

Parameters:

targetUrl - API-generated URL for the requested results page

client - TwilioRestClient with which to make the request

Returns:

Event ResourceSet

nextPage

public Page<Event> nextPage(Page<Event> page,
                            TwilioRestClient client)

Retrieve the next page from the Twilio API.

Specified by:

nextPage in class Reader<Event>

Parameters:

page - current page

client - TwilioRestClient with which to make the request

Returns:

Next Page

previousPage

public Page<Event> previousPage(Page<Event> page,
                                TwilioRestClient client)

Retrieve the previous page from the Twilio API.

Specified by:

previousPage in class Reader<Event>

Parameters:

page - current page

client - TwilioRestClient with which to make the request

Returns:

Previous Page