Package com.chargebee.v4.services

Class TimeMachineService

java.lang.Object

com.chargebee.v4.services.BaseService<TimeMachineService>

com.chargebee.v4.services.TimeMachineService

public final class TimeMachineService
extends BaseService<TimeMachineService>

Field Summary

Fields inherited from class com.chargebee.v4.services.BaseService

client, options

Constructor Summary

Constructors

Constructor	Description
TimeMachineService(ChargebeeClient client)

Method Summary

Modifier and Type	Method	Description
TimeMachineRetrieveResponse	retrieve(String timeMachineName)
CompletableFuture<TimeMachineRetrieveResponse>	retrieveAsync(String timeMachineName)	Async variant of retrieve for timeMachine without params.
TimeMachineStartAfreshResponse	startAfresh(String timeMachineName)
TimeMachineStartAfreshResponse	startAfresh(String timeMachineName, TimeMachineStartAfreshParams params)
CompletableFuture<TimeMachineStartAfreshResponse>	startAfreshAsync(String timeMachineName)	Async variant of startAfresh for timeMachine without params.
CompletableFuture<TimeMachineStartAfreshResponse>	startAfreshAsync(String timeMachineName, TimeMachineStartAfreshParams params)	Async variant of startAfresh for timeMachine with params.
TimeMachineTravelForwardResponse	travelForward(String timeMachineName)
TimeMachineTravelForwardResponse	travelForward(String timeMachineName, TimeMachineTravelForwardParams params)
CompletableFuture<TimeMachineTravelForwardResponse>	travelForwardAsync(String timeMachineName)	Async variant of travelForward for timeMachine without params.
CompletableFuture<TimeMachineTravelForwardResponse>	travelForwardAsync(String timeMachineName, TimeMachineTravelForwardParams params)	Async variant of travelForward for timeMachine with params.
TimeMachine	waitForTimeTravelCompletion(TimeMachine timeMachine)	Waits for time travel operation to complete.
TimeMachine	waitForTimeTravelCompletion(String timeMachineName)	Waits for time travel operation to complete.
TimeMachineService	withOptions(RequestOptions options)	Apply per-request options for this service instance.

Methods inherited from class com.chargebee.v4.services.BaseService

buildPathWithParams, clientForBuilders, clientWithOptions, get, getAsync, getMergedHeaders, getWithSubDomain, getWithSubDomainAsync, header, headers, options, parseResponse, post, postAsync, postJson, postJsonAsync, postJsonWithSubDomain, postJsonWithSubDomainAsync, postWithSubDomain, postWithSubDomainAsync

Methods inherited from class java.lang.Object

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

Constructor Details

TimeMachineService

public TimeMachineService(ChargebeeClient client)

Method Details

withOptions

public TimeMachineService withOptions(RequestOptions options)

Apply per-request options for this service instance. Users can chain .withOptions or .options to set headers and other options.

Overrides:

withOptions in class BaseService<TimeMachineService>

retrieve

public TimeMachineRetrieveResponse retrieve(String timeMachineName)
                                     throws ChargebeeException

Throws:

ChargebeeException

retrieveAsync

public CompletableFuture<TimeMachineRetrieveResponse> retrieveAsync(String timeMachineName)

Async variant of retrieve for timeMachine without params.

travelForward

public TimeMachineTravelForwardResponse travelForward(String timeMachineName,
 TimeMachineTravelForwardParams params)
                                               throws ChargebeeException

Throws:

ChargebeeException

travelForwardAsync

public CompletableFuture<TimeMachineTravelForwardResponse> travelForwardAsync(String timeMachineName,
 TimeMachineTravelForwardParams params)

Async variant of travelForward for timeMachine with params.

travelForward

public TimeMachineTravelForwardResponse travelForward(String timeMachineName)
                                               throws ChargebeeException

Throws:

ChargebeeException

travelForwardAsync

public CompletableFuture<TimeMachineTravelForwardResponse> travelForwardAsync(String timeMachineName)

Async variant of travelForward for timeMachine without params.

startAfresh

public TimeMachineStartAfreshResponse startAfresh(String timeMachineName,
 TimeMachineStartAfreshParams params)
                                           throws ChargebeeException

Throws:

ChargebeeException

startAfreshAsync

public CompletableFuture<TimeMachineStartAfreshResponse> startAfreshAsync(String timeMachineName,
 TimeMachineStartAfreshParams params)

Async variant of startAfresh for timeMachine with params.

startAfresh

public TimeMachineStartAfreshResponse startAfresh(String timeMachineName)
                                           throws ChargebeeException

Throws:

ChargebeeException

startAfreshAsync

public CompletableFuture<TimeMachineStartAfreshResponse> startAfreshAsync(String timeMachineName)

Async variant of startAfresh for timeMachine without params.

waitForTimeTravelCompletion

public TimeMachine waitForTimeTravelCompletion(TimeMachine timeMachine)
                                        throws ChargebeeException,
InterruptedException

Waits for time travel operation to complete. Polls the API until the status changes from IN_PROGRESS.

Parameters:

timeMachine - The TimeMachine instance to wait for

Returns:

The updated TimeMachine with final status

Throws:

ChargebeeException - if the API call fails

InterruptedException - if the thread is interrupted while waiting

RuntimeException - if time travel takes too long or ends in invalid state

OperationFailedException - if time travel fails

waitForTimeTravelCompletion

public TimeMachine waitForTimeTravelCompletion(String timeMachineName)
                                        throws ChargebeeException,
InterruptedException

Waits for time travel operation to complete. Polls the API until the status changes from IN_PROGRESS.

Parameters:

timeMachineName - The name of the TimeMachine to wait for

Returns:

The updated TimeMachine with final status

Throws:

ChargebeeException - if the API call fails

InterruptedException - if the thread is interrupted while waiting

RuntimeException - if time travel takes too long or ends in invalid state

OperationFailedException - if time travel fails