com.twilio.rest.api.v2010.account.usage

Class TriggerCreator

java.lang.Object

com.twilio.base.Creator<Trigger>

com.twilio.rest.api.v2010.account.usage.TriggerCreator

public class TriggerCreator
extends Creator<Trigger>

Constructor Summary

Constructors

Constructor and Description
TriggerCreator(String pathAccountSid, URI callbackUrl, String triggerValue, Trigger.UsageCategory usageCategory) Construct a new TriggerCreator.
TriggerCreator(URI callbackUrl, String triggerValue, Trigger.UsageCategory usageCategory) Construct a new TriggerCreator.

Method Summary

Modifier and Type	Method and Description
Trigger	create(TwilioRestClient client) Make the request to the Twilio API to perform the create.
TriggerCreator	setCallbackMethod(HttpMethod callbackMethod) The HTTP method we should use to call `callback_url`.
TriggerCreator	setFriendlyName(String friendlyName) A descriptive string that you create to describe the resource.
TriggerCreator	setRecurring(Trigger.Recurring recurring) The frequency of a recurring UsageTrigger.
TriggerCreator	setTriggerBy(Trigger.TriggerField triggerBy) The field in the UsageRecord resource that should fire the trigger.

Methods inherited from class com.twilio.base.Creator

create, createAsync, createAsync

Methods inherited from class java.lang.Object

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

Constructor Detail

TriggerCreator

public TriggerCreator(URI callbackUrl,
                      String triggerValue,
                      Trigger.UsageCategory usageCategory)

Construct a new TriggerCreator.

Parameters:

callbackUrl - The URL we call when the trigger fires

triggerValue - The usage value at which the trigger should fire

usageCategory - The usage category the trigger watches

TriggerCreator

public TriggerCreator(String pathAccountSid,
                      URI callbackUrl,
                      String triggerValue,
                      Trigger.UsageCategory usageCategory)

Construct a new TriggerCreator.

Parameters:

pathAccountSid - The SID of the Account that will create the resource

callbackUrl - The URL we call when the trigger fires

triggerValue - The usage value at which the trigger should fire

usageCategory - The usage category the trigger watches

Method Detail

setCallbackMethod

public TriggerCreator setCallbackMethod(HttpMethod callbackMethod)

The HTTP method we should use to call `callback_url`. Can be: `GET` or `POST` and the default is `POST`..

Parameters:

callbackMethod - The HTTP method to use to call callback_url

Returns:

this

setFriendlyName

public TriggerCreator setFriendlyName(String friendlyName)

A descriptive string that you create to describe the resource. It can be up to 64 characters long..

Parameters:

friendlyName - A string to describe the resource

Returns:

this

setRecurring

public TriggerCreator setRecurring(Trigger.Recurring recurring)

The frequency of a recurring UsageTrigger. Can be: `daily`, `monthly`, or `yearly` for recurring triggers or empty for non-recurring triggers. A trigger will only fire once during each period. Recurring times are in GMT..

Parameters:

recurring - The frequency of a recurring UsageTrigger

Returns:

this

setTriggerBy

public TriggerCreator setTriggerBy(Trigger.TriggerField triggerBy)

The field in the UsageRecord resource that should fire the trigger. Can be: `count`, `usage`, or `price` as described in the UsageRecords documentation. The default is `usage`..

Parameters:

triggerBy - The field in the UsageRecord resource that fires the trigger

Returns:

this

create

public Trigger create(TwilioRestClient client)

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

Specified by:

create in class Creator<Trigger>

Parameters:

client - TwilioRestClient with which to make the request

Returns:

Created Trigger