com.twilio.rest.monitor.v1

Class EventReader

java.lang.Object

com.twilio.base.Reader<Event>

com.twilio.rest.monitor.v1.EventReader

public class EventReader
extends Reader<Event>

Constructor Summary

Constructors

Constructor and Description
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	setActorSid(String actorSid) Only include events initiated by this Actor.
EventReader	setEndDate(ZonedDateTime endDate) Only include events that occurred on or before this date.
EventReader	setEventType(String eventType) Only include events of this Event Type..
EventReader	setResourceSid(String resourceSid) Only include events that refer to this resource.
EventReader	setSourceIpAddress(String sourceIpAddress) Only include events that originated from this IP address.
EventReader	setStartDate(ZonedDateTime startDate) Only include events that occurred on or after this date.

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()

Method Detail

setActorSid

public EventReader setActorSid(String actorSid)

Only include events initiated by this Actor. Useful for auditing actions taken by specific users or API credentials..

Parameters:

actorSid - Only include events initiated by this Actor

Returns:

this

setEventType

public EventReader setEventType(String eventType)

Only include events of this Event Type..

Parameters:

eventType - Only include events of this Event Type

Returns:

this

setResourceSid

public EventReader setResourceSid(String resourceSid)

Only include events that refer to this resource. Useful for discovering the history of a specific resource..

Parameters:

resourceSid - Only include events that refer to this resource

Returns:

this

setSourceIpAddress

public EventReader setSourceIpAddress(String sourceIpAddress)

Only include events that originated from this IP address. Useful for tracking suspicious activity originating from the API or the Twilio Console..

Parameters:

sourceIpAddress - Only include events that originated from this IP address

Returns:

this

setStartDate

public EventReader setStartDate(ZonedDateTime startDate)

Only include events that occurred on or after this date. Specify the date in GMT and ISO 8601 format..

Parameters:

startDate - Only include events that occurred on or after this date

Returns:

this

setEndDate

public EventReader setEndDate(ZonedDateTime endDate)

Only include events that occurred on or before this date. Specify the date in GMT and ISO 8601 format..

Parameters:

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

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