Package com.contentful.java.cma

Class ModuleScheduledActions

java.lang.Object

com.contentful.java.cma.ModuleScheduledActions

public class ModuleScheduledActions
extends java.lang.Object

Scheduled Actions Module.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	ModuleScheduledActions.Async	Async module.

Constructor Summary

Constructors

Constructor	Description
ModuleScheduledActions(retrofit2.Retrofit retrofit, java.util.concurrent.Executor callbackExecutor, java.lang.String spaceId, java.lang.String environmentId, boolean environmentIdConfigured)	Create scheduled actions module.

Method Summary

Modifier and Type	Method	Description
ModuleScheduledActions.Async	async()
CMAScheduledAction	cancel(java.lang.String scheduledActionId)	Cancel a scheduled action.
CMAScheduledAction	create(CMAScheduledAction scheduledAction)	Create a new scheduled action.
protected com.contentful.java.cma.ServiceScheduledActions	createService(retrofit2.Retrofit retrofit)
CMAArray<CMAScheduledAction>	fetchAll()	Fetch all scheduled actions.
CMAArray<CMAScheduledAction>	fetchAll(java.lang.String spaceId, java.lang.String environmentId)	Fetch all scheduled actions in the given space and environment.
CMAScheduledAction	fetchOne(java.lang.String scheduledActionId, java.lang.String entityId)	Fetch a scheduled action by ID.
CMAScheduledAction	fetchOne(java.lang.String spaceId, java.lang.String environmentId, java.lang.String scheduledActionId, java.lang.String entityId)	Fetch a scheduled action by ID from a specific space and environment.
CMAScheduledAction	update(java.lang.String scheduledActionId, CMAScheduledAction scheduledAction)	Update an existing scheduled action.

Methods inherited from class java.lang.Object

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

Constructor Detail

ModuleScheduledActions

public ModuleScheduledActions(retrofit2.Retrofit retrofit,
                              java.util.concurrent.Executor callbackExecutor,
                              java.lang.String spaceId,
                              java.lang.String environmentId,
                              boolean environmentIdConfigured)

Create scheduled actions module.

Parameters:

retrofit - the retrofit instance to be used to create the service.

callbackExecutor - to tell on which thread it should run.

spaceId - the space to be used when not given.

environmentId - the environment to be used when not given.

environmentIdConfigured - internal helper to see if environment was set.

Method Detail

createService

protected com.contentful.java.cma.ServiceScheduledActions createService(retrofit2.Retrofit retrofit)

fetchAll

public CMAArray<CMAScheduledAction> fetchAll()

Fetch all scheduled actions.

Returns:

CMAArray result instance

Throws:

java.lang.IllegalArgumentException - if spaceId or environmentId is null.

fetchAll

public CMAArray<CMAScheduledAction> fetchAll(java.lang.String spaceId,
                                             java.lang.String environmentId)

Fetch all scheduled actions in the given space and environment.

Parameters:

spaceId - Space ID

environmentId - Environment ID

Returns:

CMAArray of scheduled actions matching the query.

Throws:

java.lang.IllegalArgumentException - if spaceId, entityId, or environmentId is null.

fetchOne

public CMAScheduledAction fetchOne(java.lang.String scheduledActionId,
                                   java.lang.String entityId)

Fetch a scheduled action by ID.

Parameters:

scheduledActionId - Scheduled action ID

entityId - Entity ID

Returns:

CMAScheduledAction result instance

Throws:

java.lang.IllegalArgumentException - if spaceId, environmentId, or actionId is null.

fetchOne

public CMAScheduledAction fetchOne(java.lang.String spaceId,
                                   java.lang.String environmentId,
                                   java.lang.String scheduledActionId,
                                   java.lang.String entityId)

Fetch a scheduled action by ID from a specific space and environment.

Parameters:

spaceId - Space ID

environmentId - Environment ID

scheduledActionId - Scheduled action ID

entityId - Entity ID

Returns:

CMAScheduledAction result instance

Throws:

java.lang.IllegalArgumentException - if spaceId, environmentId, actionId, or entityId is null.

create

public CMAScheduledAction create(CMAScheduledAction scheduledAction)

Create a new scheduled action.

Returns:

CMAScheduledAction result instance

update

public CMAScheduledAction update(java.lang.String scheduledActionId,
                                 CMAScheduledAction scheduledAction)

Update an existing scheduled action.

Parameters:

scheduledActionId - Scheduled action ID

Returns:

CMAScheduledAction result instance

cancel

public CMAScheduledAction cancel(java.lang.String scheduledActionId)

Cancel a scheduled action.

Parameters:

scheduledActionId - Scheduled action ID

Returns:

CMAScheduledAction result instance

async

public ModuleScheduledActions.Async async()

Returns:

a module with a set of asynchronous methods.