
com.twilio.rest.video.v1.CompositionReader Maven / Gradle / Ivy
/**
* This code was generated by
* \ / _ _ _| _ _
* | (_)\/(_)(_|\/| |(/_ v1.0.0
* / /
*/
package com.twilio.rest.video.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;
/**
* PLEASE NOTE that this class contains preview products that are subject to
* change. Use them with caution. If you currently do not have developer preview
* access, please contact [email protected].
*/
public class CompositionReader extends Reader {
private Composition.Status status;
private DateTime dateCreatedAfter;
private DateTime dateCreatedBefore;
private String roomSid;
/**
* Read only Composition resources with this status. Can be: `enqueued`,
* `processing`, `completed`, `deleted`, or `failed`..
*
* @param status Read only Composition resources with this status
* @return this
*/
public CompositionReader setStatus(final Composition.Status status) {
this.status = status;
return this;
}
/**
* Read only Composition resources created on or after this [ISO
* 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time with time zone..
*
* @param dateCreatedAfter Read only Composition resources created on or after
* this [ISO
* 8601](https://en.wikipedia.org/wiki/ISO_8601)
* date-time with time zone
* @return this
*/
public CompositionReader setDateCreatedAfter(final DateTime dateCreatedAfter) {
this.dateCreatedAfter = dateCreatedAfter;
return this;
}
/**
* Read only Composition resources created before this ISO 8601 date-time with
* time zone..
*
* @param dateCreatedBefore Read only Composition resources created before this
* ISO 8601 date-time with time zone
* @return this
*/
public CompositionReader setDateCreatedBefore(final DateTime dateCreatedBefore) {
this.dateCreatedBefore = dateCreatedBefore;
return this;
}
/**
* Read only Composition resources with this Room SID..
*
* @param roomSid Read only Composition resources with this Room SID
* @return this
*/
public CompositionReader setRoomSid(final String roomSid) {
this.roomSid = roomSid;
return this;
}
/**
* Make the request to the Twilio API to perform the read.
*
* @param client TwilioRestClient with which to make the request
* @return Composition 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 Composition ResourceSet
*/
@Override
@SuppressWarnings("checkstyle:linelength")
public Page firstPage(final TwilioRestClient client) {
Request request = new Request(
HttpMethod.GET,
Domains.VIDEO.toString(),
"/v1/Compositions",
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 Composition 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.VIDEO.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.VIDEO.toString(),
client.getRegion()
)
);
return pageForRequest(client, request);
}
/**
* Generate a Page of Composition 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("Composition 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(
"compositions",
response.getContent(),
Composition.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 (status != null) {
request.addQueryParam("Status", status.toString());
}
if (dateCreatedAfter != null) {
request.addQueryParam("DateCreatedAfter", dateCreatedAfter.toString());
}
if (dateCreatedBefore != null) {
request.addQueryParam("DateCreatedBefore", dateCreatedBefore.toString());
}
if (roomSid != null) {
request.addQueryParam("RoomSid", roomSid);
}
if (getPageSize() != null) {
request.addQueryParam("PageSize", Integer.toString(getPageSize()));
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy