com.twilio.rest.sync.v1.service.synclist

Class SyncListItemUpdater

java.lang.Object

com.twilio.base.Updater<SyncListItem>

com.twilio.rest.sync.v1.service.synclist.SyncListItemUpdater

public class SyncListItemUpdater
extends Updater<SyncListItem>

Constructor Summary

Constructors

Constructor and Description
SyncListItemUpdater(String pathServiceSid, String pathListSid, Integer pathIndex) Construct a new SyncListItemUpdater.

Method Summary

Modifier and Type	Method and Description
SyncListItemUpdater	setCollectionTtl(Integer collectionTtl) How long, in seconds, before the List Item's parent Sync List expires (time-to-live) and is deleted.
SyncListItemUpdater	setData(Map<String,Object> data) A JSON string that represents an arbitrary, schema-less object that the List Item stores.
SyncListItemUpdater	setIfMatch(String ifMatch) If provided, applies this mutation if (and only if) the “revision” field of this map item] matches the provided value.
SyncListItemUpdater	setItemTtl(Integer itemTtl) How long, in seconds, before the List Item expires (time-to-live) and is deleted..
SyncListItemUpdater	setTtl(Integer ttl) An alias for `item_ttl`.
SyncListItem	update(TwilioRestClient client) Make the request to the Twilio API to perform the update.

Methods inherited from class com.twilio.base.Updater

update, updateAsync, updateAsync

Methods inherited from class java.lang.Object

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

Constructor Detail

SyncListItemUpdater

public SyncListItemUpdater(String pathServiceSid,
                           String pathListSid,
                           Integer pathIndex)

Construct a new SyncListItemUpdater.

Parameters:

pathServiceSid - The SID of the Sync Service with the Sync List Item resource to update

pathListSid - The SID of the Sync List with the Sync List Item resource to update

pathIndex - The index of the Sync List Item resource to update

Method Detail

setData

public SyncListItemUpdater setData(Map<String,Object> data)

A JSON string that represents an arbitrary, schema-less object that the List Item stores. Can be up to 16 KiB in length..

Parameters:

data - A JSON string that represents an arbitrary, schema-less object that the List Item stores

Returns:

this

setTtl

public SyncListItemUpdater setTtl(Integer ttl)

An alias for `item_ttl`. If both parameters are provided, this value is ignored..

Parameters:

ttl - An alias for item_ttl

Returns:

this

setItemTtl

public SyncListItemUpdater setItemTtl(Integer itemTtl)

How long, in seconds, before the List Item expires (time-to-live) and is deleted..

Parameters:

itemTtl - How long, in seconds, before the List Item expires

Returns:

this

setCollectionTtl

public SyncListItemUpdater setCollectionTtl(Integer collectionTtl)

How long, in seconds, before the List Item's parent Sync List expires (time-to-live) and is deleted. This parameter can only be used when the List Item's `data` or `ttl` is updated in the same request..

Parameters:

collectionTtl - How long, in seconds, before the List Item's parent Sync List expires

Returns:

this

setIfMatch

public SyncListItemUpdater setIfMatch(String ifMatch)

If provided, applies this mutation if (and only if) the “revision” field of this map item] matches the provided value. This matches the semantics of (and is implemented with) the HTTP [If-Match header..

Parameters:

ifMatch - The If-Match HTTP request header

Returns:

this

update

public SyncListItem update(TwilioRestClient client)

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

Specified by:

update in class Updater<SyncListItem>

Parameters:

client - TwilioRestClient with which to make the request

Returns:

Updated SyncListItem