com.twilio.rest.monitor.v1.EventReader Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of twilio Show documentation
Show all versions of twilio Show documentation
Twilio Java Helper Library
/**
* This code was generated by
* \ / _ _ _| _ _
* | (_)\/(_)(_|\/| |(/_ v1.0.0
* / /
*/
package com.twilio.rest.monitor.v1;
import com.twilio.base.Page;
import com.twilio.base.Reader;
import com.twilio.base.ResourceSet;
import com.twilio.converter.DateConverter;
import com.twilio.exception.ApiConnectionException;
import com.twilio.exception.ApiException;
import com.twilio.exception.RestException;
import com.twilio.http.HttpMethod;
import com.twilio.http.Request;
import com.twilio.http.Response;
import com.twilio.http.TwilioRestClient;
import com.twilio.rest.Domains;
import org.joda.time.DateTime;
public class EventReader extends Reader {
private String actorSid;
private String eventType;
private String resourceSid;
private String sourceIpAddress;
private DateTime startDate;
private DateTime endDate;
/**
* Only include Events initiated by this Actor. Useful for auditing actions
* taken by specific users or API credentials..
*
* @param actorSid Only include Events initiated by this Actor
* @return this
*/
public EventReader setActorSid(final String actorSid) {
this.actorSid = actorSid;
return this;
}
/**
* Only include Events of this EventType..
*
* @param eventType Only include Events of this EventType
* @return this
*/
public EventReader setEventType(final String eventType) {
this.eventType = eventType;
return this;
}
/**
* Only include Events referring to this resource. Useful for discovering the
* history of a specific resource..
*
* @param resourceSid Only include Events referring to this resource
* @return this
*/
public EventReader setResourceSid(final String resourceSid) {
this.resourceSid = resourceSid;
return this;
}
/**
* Only include Events that originated from this IP address. Useful for tracking
* suspicious activity originating from the API or the Twilio Console..
*
* @param sourceIpAddress Only include Events that originated from this IP
* address
* @return this
*/
public EventReader setSourceIpAddress(final String sourceIpAddress) {
this.sourceIpAddress = sourceIpAddress;
return this;
}
/**
* Only show events on or after this date. Useful in combination with `EndDate`
* to define a date-range of events. Input is a [UTC ISO 8601
* Timestamp](http://en.wikipedia.org/wiki/ISO_8601#UTC), but time of day is
* ignored by the filter..
*
* @param startDate Only show events on or after this date
* @return this
*/
public EventReader setStartDate(final DateTime startDate) {
this.startDate = startDate;
return this;
}
/**
* Only show events on or before this date. Useful in combination with
* `StartDate` to define a date-range of events. Input is a [UTC ISO 8601
* Timestamp](http://en.wikipedia.org/wiki/ISO_8601#UTC), but time of day is
* ignored by the filter..
*
* @param endDate Only show events on or before this date
* @return this
*/
public EventReader setEndDate(final DateTime endDate) {
this.endDate = endDate;
return this;
}
/**
* Make the request to the Twilio API to perform the read.
*
* @param client TwilioRestClient with which to make the request
* @return Event ResourceSet
*/
@Override
public ResourceSet read(final TwilioRestClient client) {
return new ResourceSet<>(this, client, firstPage(client));
}
/**
* Make the request to the Twilio API to perform the read.
*
* @param client TwilioRestClient with which to make the request
* @return Event ResourceSet
*/
@Override
@SuppressWarnings("checkstyle:linelength")
public Page firstPage(final TwilioRestClient client) {
Request request = new Request(
HttpMethod.GET,
Domains.MONITOR.toString(),
"/v1/Events",
client.getRegion()
);
addQueryParams(request);
return pageForRequest(client, request);
}
/**
* Retrieve the target page from the Twilio API.
*
* @param targetUrl API-generated URL for the requested results page
* @param client TwilioRestClient with which to make the request
* @return Event ResourceSet
*/
@Override
@SuppressWarnings("checkstyle:linelength")
public Page getPage(final String targetUrl, final TwilioRestClient client) {
Request request = new Request(
HttpMethod.GET,
targetUrl
);
return pageForRequest(client, request);
}
/**
* Retrieve the next page from the Twilio API.
*
* @param page current page
* @param client TwilioRestClient with which to make the request
* @return Next Page
*/
@Override
public Page nextPage(final Page page,
final TwilioRestClient client) {
Request request = new Request(
HttpMethod.GET,
page.getNextPageUrl(
Domains.MONITOR.toString(),
client.getRegion()
)
);
return pageForRequest(client, request);
}
/**
* Retrieve the previous page from the Twilio API.
*
* @param page current page
* @param client TwilioRestClient with which to make the request
* @return Previous Page
*/
@Override
public Page previousPage(final Page page,
final TwilioRestClient client) {
Request request = new Request(
HttpMethod.GET,
page.getPreviousPageUrl(
Domains.MONITOR.toString(),
client.getRegion()
)
);
return pageForRequest(client, request);
}
/**
* Generate a Page of Event Resources for a given request.
*
* @param client TwilioRestClient with which to make the request
* @param request Request to generate a page for
* @return Page for the Request
*/
private Page pageForRequest(final TwilioRestClient client, final Request request) {
Response response = client.request(request);
if (response == null) {
throw new ApiConnectionException("Event read failed: Unable to connect to server");
} else if (!TwilioRestClient.SUCCESS.apply(response.getStatusCode())) {
RestException restException = RestException.fromJson(response.getStream(), client.getObjectMapper());
if (restException == null) {
throw new ApiException("Server Error, no content");
}
throw new ApiException(
restException.getMessage(),
restException.getCode(),
restException.getMoreInfo(),
restException.getStatus(),
null
);
}
return Page.fromJson(
"events",
response.getContent(),
Event.class,
client.getObjectMapper()
);
}
/**
* Add the requested query string arguments to the Request.
*
* @param request Request to add query string arguments to
*/
private void addQueryParams(final Request request) {
if (actorSid != null) {
request.addQueryParam("ActorSid", actorSid);
}
if (eventType != null) {
request.addQueryParam("EventType", eventType);
}
if (resourceSid != null) {
request.addQueryParam("ResourceSid", resourceSid);
}
if (sourceIpAddress != null) {
request.addQueryParam("SourceIpAddress", sourceIpAddress);
}
if (startDate != null) {
request.addQueryParam("StartDate", startDate.toString());
}
if (endDate != null) {
request.addQueryParam("EndDate", endDate.toString());
}
if (getPageSize() != null) {
request.addQueryParam("PageSize", Integer.toString(getPageSize()));
}
}
} © 2015 - 2025 Weber Informatics LLC | Privacy Policy