com.twilio.rest.sync.v1.service.SyncMapUpdater 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.sync.v1.service;
import com.twilio.base.Updater;
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;
/**
* PLEASE NOTE that this class contains beta products that are subject to
* change. Use them with caution.
*/
public class SyncMapUpdater extends Updater {
private final String pathServiceSid;
private final String pathSid;
private Integer ttl;
private Integer collectionTtl;
/**
* Construct a new SyncMapUpdater.
*
* @param pathServiceSid The SID of the Sync Service with the Sync Map resource
* to update
* @param pathSid The SID of the Sync Map resource to update
*/
public SyncMapUpdater(final String pathServiceSid,
final String pathSid) {
this.pathServiceSid = pathServiceSid;
this.pathSid = pathSid;
}
/**
* An alias for `collection_ttl`. If both parameters are provided, this value is
* ignored..
*
* @param ttl An alias for collection_ttl
* @return this
*/
public SyncMapUpdater setTtl(final Integer ttl) {
this.ttl = ttl;
return this;
}
/**
* How long, in seconds, before the Sync Map expires (time-to-live) and is
* deleted. Can be an integer from 0 to 31,536,000 (1 year). The default value
* is `0`, which means the Sync Map does not expire. The Sync Map will be
* deleted automatically after it expires, but there can be a delay between the
* expiration time and the resources's deletion..
*
* @param collectionTtl How long, in seconds, before the Sync Map expires and
* is deleted
* @return this
*/
public SyncMapUpdater setCollectionTtl(final Integer collectionTtl) {
this.collectionTtl = collectionTtl;
return this;
}
/**
* Make the request to the Twilio API to perform the update.
*
* @param client TwilioRestClient with which to make the request
* @return Updated SyncMap
*/
@Override
@SuppressWarnings("checkstyle:linelength")
public SyncMap update(final TwilioRestClient client) {
Request request = new Request(
HttpMethod.POST,
Domains.SYNC.toString(),
"/v1/Services/" + this.pathServiceSid + "/Maps/" + this.pathSid + ""
);
addPostParams(request);
Response response = client.request(request);
if (response == null) {
throw new ApiConnectionException("SyncMap update failed: Unable to connect to server");
} else if (!TwilioRestClient.SUCCESS.test(response.getStatusCode())) {
RestException restException = RestException.fromJson(response.getStream(), client.getObjectMapper());
if (restException == null) {
throw new ApiException("Server Error, no content");
}
throw new ApiException(restException);
}
return SyncMap.fromJson(response.getStream(), client.getObjectMapper());
}
/**
* Add the requested post parameters to the Request.
*
* @param request Request to add post params to
*/
private void addPostParams(final Request request) {
if (ttl != null) {
request.addPostParam("Ttl", ttl.toString());
}
if (collectionTtl != null) {
request.addPostParam("CollectionTtl", collectionTtl.toString());
}
}
}