Package com.stripe.model.testhelpers

Class TestClock

java.lang.Object

com.stripe.model.StripeObject

com.stripe.net.ApiResource

com.stripe.model.testhelpers.TestClock

All Implemented Interfaces:

HasId, StripeActiveObject, StripeObjectInterface

public class TestClock
extends ApiResource
implements HasId

A test clock enables deterministic control over objects in testmode. With a test clock, you can create objects at a frozen time in the past or future, and advance to a specific future time to observe webhooks and state changes. After the clock advances, you can either validate the current state of your scenario (and test your assumptions), change the current state of your scenario (and test more complex scenarios), or keep advancing forward in time.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TestClock.StatusDetails

Nested classes/interfaces inherited from class com.stripe.net.ApiResource

ApiResource.RequestMethod

Field Summary

Fields inherited from class com.stripe.net.ApiResource

CHARSET, GSON, INTERNAL_GSON

Fields inherited from class com.stripe.model.StripeObject

PRETTY_PRINT_GSON

Constructor Summary

Constructors

Constructor	Description
TestClock()

Method Summary

Modifier and Type	Method	Description
TestClock	advance(TestClockAdvanceParams params)	Starts advancing a test clock to a specified time in the future.
TestClock	advance(TestClockAdvanceParams params, RequestOptions options)	Starts advancing a test clock to a specified time in the future.
TestClock	advance(Map<String,Object> params)	Starts advancing a test clock to a specified time in the future.
TestClock	advance(Map<String,Object> params, RequestOptions options)	Starts advancing a test clock to a specified time in the future.
protected boolean	canEqual(Object other)
static TestClock	create(TestClockCreateParams params)	Creates a new test clock that can be attached to new customers and quotes.
static TestClock	create(TestClockCreateParams params, RequestOptions options)	Creates a new test clock that can be attached to new customers and quotes.
static TestClock	create(Map<String,Object> params)	Creates a new test clock that can be attached to new customers and quotes.
static TestClock	create(Map<String,Object> params, RequestOptions options)	Creates a new test clock that can be attached to new customers and quotes.
TestClock	delete()	Deletes a test clock.
TestClock	delete(RequestOptions options)	Deletes a test clock.
TestClock	delete(Map<String,Object> params)	Deletes a test clock.
TestClock	delete(Map<String,Object> params, RequestOptions options)	Deletes a test clock.
boolean	equals(Object o)
Long	getCreated()	Time at which the object was created.
Boolean	getDeleted()	Always true for a deleted object.
Long	getDeletesAfter()	Time at which this clock is scheduled to auto delete.
Long	getFrozenTime()	Time at which all objects belonging to this clock are frozen.
String	getId()	Unique identifier for the object.
Boolean	getLivemode()	Has the value true if the object exists in live mode or the value false if the object exists in test mode.
String	getName()	The custom name supplied at creation.
String	getObject()	String representing the object's type.
String	getStatus()	The status of the Test Clock.
TestClock.StatusDetails	getStatusDetails()
int	hashCode()
static TestClockCollection	list(TestClockListParams params)	Returns a list of your test clocks.
static TestClockCollection	list(TestClockListParams params, RequestOptions options)	Returns a list of your test clocks.
static TestClockCollection	list(Map<String,Object> params)	Returns a list of your test clocks.
static TestClockCollection	list(Map<String,Object> params, RequestOptions options)	Returns a list of your test clocks.
static TestClock	retrieve(String testClock)	Retrieves a test clock.
static TestClock	retrieve(String testClock, RequestOptions options)	Retrieves a test clock.
static TestClock	retrieve(String testClock, TestClockRetrieveParams params, RequestOptions options)	Retrieves a test clock.
static TestClock	retrieve(String testClock, Map<String,Object> params, RequestOptions options)	Retrieves a test clock.
void	setCreated(Long created)	Time at which the object was created.
void	setDeleted(Boolean deleted)	Always true for a deleted object.
void	setDeletesAfter(Long deletesAfter)	Time at which this clock is scheduled to auto delete.
void	setFrozenTime(Long frozenTime)	Time at which all objects belonging to this clock are frozen.
void	setId(String id)	Unique identifier for the object.
void	setLivemode(Boolean livemode)	Has the value true if the object exists in live mode or the value false if the object exists in test mode.
void	setName(String name)	The custom name supplied at creation.
void	setObject(String object)	String representing the object's type.
void	setResponseGetter(StripeResponseGetter responseGetter)	The frozen_time that the Test Clock is advancing towards.
void	setStatus(String status)	The status of the Test Clock.
void	setStatusDetails(TestClock.StatusDetails statusDetails)

Methods inherited from class com.stripe.net.ApiResource

checkNullTypedParams, getGlobalResponseGetter, getResponseGetter, setExpandableFieldId, setStripeResponseGetter, urlEncode, urlEncodeId

Methods inherited from class com.stripe.model.StripeObject

deserializeStripeObject, deserializeStripeObject, deserializeStripeObject, equals, getLastResponse, getRawJsonObject, setLastResponse, toJson, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.stripe.model.StripeActiveObject

trySetResponseGetter

Constructor Details

TestClock

public TestClock()

Method Details

advance

public TestClock advance(Map<String,Object> params)
                  throws StripeException

Starts advancing a test clock to a specified time in the future. Advancement is done when status changes to Ready.

Throws:

StripeException

advance

public TestClock advance(Map<String,Object> params,
 RequestOptions options)
                  throws StripeException

Starts advancing a test clock to a specified time in the future. Advancement is done when status changes to Ready.

Throws:

StripeException

advance

public TestClock advance(TestClockAdvanceParams params)
                  throws StripeException

Starts advancing a test clock to a specified time in the future. Advancement is done when status changes to Ready.

Throws:

StripeException

advance

public TestClock advance(TestClockAdvanceParams params,
 RequestOptions options)
                  throws StripeException

Starts advancing a test clock to a specified time in the future. Advancement is done when status changes to Ready.

Throws:

StripeException

create

public static TestClock create(Map<String,Object> params)
                        throws StripeException

Creates a new test clock that can be attached to new customers and quotes.

Throws:

StripeException

create

public static TestClock create(Map<String,Object> params,
 RequestOptions options)
                        throws StripeException

Creates a new test clock that can be attached to new customers and quotes.

Throws:

StripeException

create

public static TestClock create(TestClockCreateParams params)
                        throws StripeException

Creates a new test clock that can be attached to new customers and quotes.

Throws:

StripeException

create

public static TestClock create(TestClockCreateParams params,
 RequestOptions options)
                        throws StripeException

Creates a new test clock that can be attached to new customers and quotes.

Throws:

StripeException

delete

public TestClock delete()
                 throws StripeException

Deletes a test clock.

Throws:

StripeException

delete

public TestClock delete(RequestOptions options)
                 throws StripeException

Deletes a test clock.

Throws:

StripeException

delete

public TestClock delete(Map<String,Object> params)
                 throws StripeException

Deletes a test clock.

Throws:

StripeException

delete

public TestClock delete(Map<String,Object> params,
 RequestOptions options)
                 throws StripeException

Deletes a test clock.

Throws:

StripeException

list

public static TestClockCollection list(Map<String,Object> params)
                                throws StripeException

Returns a list of your test clocks.

Throws:

StripeException

list

public static TestClockCollection list(Map<String,Object> params,
 RequestOptions options)
                                throws StripeException

Returns a list of your test clocks.

Throws:

StripeException

list

public static TestClockCollection list(TestClockListParams params)
                                throws StripeException

Returns a list of your test clocks.

Throws:

StripeException

list

public static TestClockCollection list(TestClockListParams params,
 RequestOptions options)
                                throws StripeException

Returns a list of your test clocks.

Throws:

StripeException

retrieve

public static TestClock retrieve(String testClock)
                          throws StripeException

Retrieves a test clock.

Throws:

StripeException

retrieve

public static TestClock retrieve(String testClock,
 RequestOptions options)
                          throws StripeException

Retrieves a test clock.

Throws:

StripeException

retrieve

public static TestClock retrieve(String testClock,
 Map<String,Object> params,
 RequestOptions options)
                          throws StripeException

Retrieves a test clock.

Throws:

StripeException

retrieve

public static TestClock retrieve(String testClock,
 TestClockRetrieveParams params,
 RequestOptions options)
                          throws StripeException

Retrieves a test clock.

Throws:

StripeException

setResponseGetter

public void setResponseGetter(StripeResponseGetter responseGetter)

The frozen_time that the Test Clock is advancing towards.

Specified by:

setResponseGetter in interface StripeActiveObject

Overrides:

setResponseGetter in class ApiResource

Parameters:

responseGetter - the StripeResponseGetter instance to use for making further requests.

getCreated

public Long getCreated()

Time at which the object was created. Measured in seconds since the Unix epoch.

getDeleted

public Boolean getDeleted()

Always true for a deleted object.

getDeletesAfter

public Long getDeletesAfter()

Time at which this clock is scheduled to auto delete.

getFrozenTime

public Long getFrozenTime()

Time at which all objects belonging to this clock are frozen.

getLivemode

public Boolean getLivemode()

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

getName

public String getName()

The custom name supplied at creation.

getObject

public String getObject()

String representing the object's type. Objects of the same type share the same value.

Equal to test_helpers.test_clock.

getStatus

public String getStatus()

The status of the Test Clock.

One of advancing, internal_failure, or ready.

getStatusDetails

public TestClock.StatusDetails getStatusDetails()

setCreated

public void setCreated(Long created)

Time at which the object was created. Measured in seconds since the Unix epoch.

setDeleted

public void setDeleted(Boolean deleted)

Always true for a deleted object.

setDeletesAfter

public void setDeletesAfter(Long deletesAfter)

Time at which this clock is scheduled to auto delete.

setFrozenTime

public void setFrozenTime(Long frozenTime)

Time at which all objects belonging to this clock are frozen.

setId

public void setId(String id)

Unique identifier for the object.

setLivemode

public void setLivemode(Boolean livemode)

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

setName

public void setName(String name)

The custom name supplied at creation.

setObject

public void setObject(String object)

String representing the object's type. Objects of the same type share the same value.

Equal to test_helpers.test_clock.

setStatus

public void setStatus(String status)

The status of the Test Clock.

One of advancing, internal_failure, or ready.

setStatusDetails

public void setStatusDetails(TestClock.StatusDetails statusDetails)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getId

public String getId()

Unique identifier for the object.

Specified by:

getId in interface HasId