com.mesosphere.sdk.http

Class PlansResource

java.lang.Object

com.mesosphere.sdk.http.types.PrettyJsonResource

com.mesosphere.sdk.http.PlansResource

public class PlansResource
extends PrettyJsonResource

API for management of Plan(s).

Constructor Summary

Constructors

Constructor and Description
PlansResource()

Method Summary

Modifier and Type	Method and Description
Response	continueCommand() Deprecated.
Response	continueCommand(java.lang.String planName, java.lang.String phase)
Response	forceCompleteCommand(java.lang.String phaseId, java.lang.String stepId) Deprecated.
Response	forceCompleteCommand(java.lang.String planName, java.lang.String phase, java.lang.String step)
Response	getFullInfo() Deprecated.
Response	getPlanInfo(java.lang.String planName) Returns a full list of the Plan's contents (incl all Phases/Steps).
Response	interruptCommand() Deprecated.
Response	interruptCommand(java.lang.String planName, java.lang.String phase) Interrupts (Pauses) a plan or if specified a phase within a plan.
Response	listPlans() Returns list of all configured plans.
Response	restartCommand(java.lang.String phaseId, java.lang.String stepId) Deprecated.
Response	restartCommand(java.lang.String planName, java.lang.String phase, java.lang.String step)
PlansResource	setPlanManagers(java.util.Collection<PlanManager> planManagers) Assigns the list of plans to be managed via this endpoint.
Response	startPlan(java.lang.String planName, java.util.Map<java.lang.String,java.lang.String> parameters) Idempotently starts a plan.
Response	stopPlan(java.lang.String planName) Idempotently stops a plan.

Methods inherited from class com.mesosphere.sdk.http.types.PrettyJsonResource

getContext

Methods inherited from class java.lang.Object

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

Constructor Detail

PlansResource

public PlansResource()

Method Detail

setPlanManagers

public PlansResource setPlanManagers(java.util.Collection<PlanManager> planManagers)

Assigns the list of plans to be managed via this endpoint.

Returns:

this

listPlans

public Response listPlans()

Returns list of all configured plans.

getPlanInfo

public Response getPlanInfo(java.lang.String planName)

Returns a full list of the Plan's contents (incl all Phases/Steps).

startPlan

public Response startPlan(java.lang.String planName,
                          java.util.Map<java.lang.String,java.lang.String> parameters)

Idempotently starts a plan. If a plan is complete, it restarts the plan. If it is interrupted, in makes the plan proceed. If a plan is already in progress, it has no effect.

stopPlan

public Response stopPlan(java.lang.String planName)

Idempotently stops a plan. If a plan is in progress, it is interrupted and the plan is reset such that all elements are pending. If a plan is already stopped, it has no effect.

See Also:

for the distinctions between Stop and Interrupt actions.

continueCommand

public Response continueCommand(java.lang.String planName,
                                java.lang.String phase)

interruptCommand

public Response interruptCommand(java.lang.String planName,
                                 java.lang.String phase)

Interrupts (Pauses) a plan or if specified a phase within a plan. If a plan/phase is in progress, it is interrupted and the plan/phase is reset such that it is pending. If the plan/phase is already in a non-interruptable state (interrupted or complete), the response will indicate as such. An interrupted Phase is not immediately halted, but sets the interrupted bit to ensure that subsequent requests to process will not proceed. @see Interruptible . Interrupt differs from stop in the following ways: A) Interrupt can be issued for a specific phase or for all phases within a plan. Stop can only be issued for a plan. B) Interrupt updates the underlying Phase/Step state. Stop not only updates the underlying state, but also restarts the Plan.

forceCompleteCommand

public Response forceCompleteCommand(java.lang.String planName,
                                     java.lang.String phase,
                                     java.lang.String step)

restartCommand

public Response restartCommand(java.lang.String planName,
                               java.lang.String phase,
                               java.lang.String step)

getFullInfo

@Deprecated
public Response getFullInfo()

Deprecated.

continueCommand

@Deprecated
public Response continueCommand()

Deprecated.

interruptCommand

@Deprecated
public Response interruptCommand()

Deprecated.

forceCompleteCommand

@Deprecated
public Response forceCompleteCommand(java.lang.String phaseId,
                                                 java.lang.String stepId)

Deprecated.

restartCommand

@Deprecated
public Response restartCommand(java.lang.String phaseId,
                                           java.lang.String stepId)

Deprecated.