Class ProcessInitOrStepOrStatusResponseV1

java.lang.Object

com.kingsrook.qqq.middleware.javalin.specs.v1.responses.ProcessInitOrStepOrStatusResponseV1

All Implemented Interfaces:

AbstractMiddlewareOutputInterface, ProcessInitOrStepOrStatusOutputInterface, ToSchema

public class ProcessInitOrStepOrStatusResponseV1
extends Object
implements ProcessInitOrStepOrStatusOutputInterface, ToSchema

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ProcessInitOrStepOrStatusResponseV1.ProcessStepComplete
static final class	ProcessInitOrStepOrStatusResponseV1.ProcessStepError
static final class	ProcessInitOrStepOrStatusResponseV1.ProcessStepJobStarted
static final class	ProcessInitOrStepOrStatusResponseV1.ProcessStepRunning
static class	ProcessInitOrStepOrStatusResponseV1.TypedResponse

Nested classes/interfaces inherited from interface com.kingsrook.qqq.middleware.javalin.executors.io.ProcessInitOrStepOrStatusOutputInterface

ProcessInitOrStepOrStatusOutputInterface.Type

Constructor Summary

Constructors

Constructor	Description
ProcessInitOrStepOrStatusResponseV1()

Method Summary

Modifier and Type	Method	Description
ProcessInitOrStepOrStatusResponseV1.TypedResponse	getTypedResponse()	Getter for typedResponse
void	setBackStep(String backStep)	Setter for backStep - the step a frontend may go back to (restart at).
void	setCurrent(Integer current)	Setter for current
void	setError(String errorString)	Setter for error
void	setJobUUID(String jobUUID)	Setter for jobUUID
void	setLogTail(List<JobLogLineV1> logTail)	Publish optional logTail.
void	setMessage(String message)	Setter for message
void	setNextStep(String nextStep)	Setter for nextStep
void	setOneTimeSecrets(List<OneTimeSecret> oneTimeSecrets)	Map the transient core secrets into the shared HTTP secret schema.
void	setProcessMetaDataAdjustment(ProcessMetaDataAdjustment processMetaDataAdjustment)	Setter for processMetaDataAdjustment
void	setProcessUUID(String processUUID)	Setter for processUUID
void	setProgress(JobProgressV1 progress)	Publish optional progress.
void	setTotal(Integer total)	Setter for total
void	setType(ProcessInitOrStepOrStatusOutputInterface.Type type)	Setter for type
void	setUserFacingError(String userFacingError)	Setter for userFacingError
void	setValues(Map<String,Serializable> values)	Setter for values
Schema	toSchema()

Methods inherited from class java.lang.Object

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

Constructor Details

ProcessInitOrStepOrStatusResponseV1

public ProcessInitOrStepOrStatusResponseV1()

Method Details

setType

public void setType(ProcessInitOrStepOrStatusOutputInterface.Type type)

Description copied from interface: ProcessInitOrStepOrStatusOutputInterface

Setter for type

Specified by:

setType in interface ProcessInitOrStepOrStatusOutputInterface

setProcessUUID

public void setProcessUUID(String processUUID)

Description copied from interface: ProcessInitOrStepOrStatusOutputInterface

Setter for processUUID

Specified by:

setProcessUUID in interface ProcessInitOrStepOrStatusOutputInterface

setNextStep

public void setNextStep(String nextStep)

Description copied from interface: ProcessInitOrStepOrStatusOutputInterface

Setter for nextStep

Specified by:

setNextStep in interface ProcessInitOrStepOrStatusOutputInterface

setBackStep

public void setBackStep(String backStep)

Description copied from interface: ProcessInitOrStepOrStatusOutputInterface

Setter for backStep - the step a frontend may go back to (restart at).

Specified by:

setBackStep in interface ProcessInitOrStepOrStatusOutputInterface

setValues

public void setValues(Map<String,Serializable> values)

Description copied from interface: ProcessInitOrStepOrStatusOutputInterface

Setter for values

Specified by:

setValues in interface ProcessInitOrStepOrStatusOutputInterface

setProcessMetaDataAdjustment

public void setProcessMetaDataAdjustment(ProcessMetaDataAdjustment processMetaDataAdjustment)

Description copied from interface: ProcessInitOrStepOrStatusOutputInterface

Setter for processMetaDataAdjustment

Specified by:

setProcessMetaDataAdjustment in interface ProcessInitOrStepOrStatusOutputInterface

setJobUUID

public void setJobUUID(String jobUUID)

Description copied from interface: ProcessInitOrStepOrStatusOutputInterface

Setter for jobUUID

Specified by:

setJobUUID in interface ProcessInitOrStepOrStatusOutputInterface

setMessage

public void setMessage(String message)

Description copied from interface: ProcessInitOrStepOrStatusOutputInterface

Setter for message

Specified by:

setMessage in interface ProcessInitOrStepOrStatusOutputInterface

setCurrent

public void setCurrent(Integer current)

Description copied from interface: ProcessInitOrStepOrStatusOutputInterface

Setter for current

Specified by:

setCurrent in interface ProcessInitOrStepOrStatusOutputInterface

setTotal

public void setTotal(Integer total)

Description copied from interface: ProcessInitOrStepOrStatusOutputInterface

Setter for total

Specified by:

setTotal in interface ProcessInitOrStepOrStatusOutputInterface

setError

public void setError(String errorString)

Description copied from interface: ProcessInitOrStepOrStatusOutputInterface

Setter for error

Specified by:

setError in interface ProcessInitOrStepOrStatusOutputInterface

setUserFacingError

public void setUserFacingError(String userFacingError)

Description copied from interface: ProcessInitOrStepOrStatusOutputInterface

Setter for userFacingError

Specified by:

setUserFacingError in interface ProcessInitOrStepOrStatusOutputInterface

toSchema

public Schema toSchema()

Specified by:

toSchema in interface ToSchema

getTypedResponse

public ProcessInitOrStepOrStatusResponseV1.TypedResponse getTypedResponse()

Getter for typedResponse

setOneTimeSecrets

public void setOneTimeSecrets(List<OneTimeSecret> oneTimeSecrets)

Map the transient core secrets into the shared HTTP secret schema.

Specified by:

setOneTimeSecrets in interface ProcessInitOrStepOrStatusOutputInterface

setProgress

public void setProgress(JobProgressV1 progress)

Publish optional progress.

Specified by:

setProgress in interface ProcessInitOrStepOrStatusOutputInterface

setLogTail

public void setLogTail(List<JobLogLineV1> logTail)

Publish optional logTail.

Specified by:

setLogTail in interface ProcessInitOrStepOrStatusOutputInterface