Skip to main content

HSMOD.REST.Async.JobRecord

persistent class HSMOD.REST.Async.JobRecord extends %Library.Persistent, %JSON.Adaptor

SQL Table Name: HSMOD_REST_Async.JobRecord

Keeps track of jobs used in the background in async calls.

Property Inventory

Method Inventory

Parameters

parameter DEFAULTGLOBAL = ^CacheTemp.HSMOD.REST.AsyncJob;
Overridden from %Library.Persistent.

Properties

property ArgumentList as %Library.List;
List of arguments passed in method call run for this job.
Property methods: ArgumentListGet(), ArgumentListGetStored(), ArgumentListIsValid(), ArgumentListLogicalToOdbc(), ArgumentListLogicalToXSD(), ArgumentListOdbcToLogical(), ArgumentListSet(), ArgumentListXSDToLogical()
property Classname as %Dictionary.Classname [ Required ];
Name of class from which method is run for this job.
Property methods: ClassnameGet(), ClassnameGetStored(), ClassnameIsValid(), ClassnameSet()
property Counter as %Integer [ InitialExpression = $Increment(@..#CounterGlobal@($Job)) , Required , ReadOnly ];
Per job id counter.
Property methods: CounterDisplayToLogical(), CounterGet(), CounterGetStored(), CounterIsValid(), CounterLogicalToDisplay(), CounterNormalize(), CounterXSDToLogical()
property EndTime as Ens.DataType.UTC;
End time of job
Property methods: EndTimeDisplayToLogical(), EndTimeGet(), EndTimeGetStored(), EndTimeIsValid(), EndTimeLogicalToDisplay(), EndTimeLogicalToOdbc(), EndTimeNormalize(), EndTimeOdbcToLogical(), EndTimeSet(), EndTimeStorageToLogical(), EndTimetimeCmp(), EndTimetimeDiff(), EndTimetimeLocal(), EndTimetimeLocaltoUTC(), EndTimetimeUTC(), EndTimetimeUTCH(), EndTimetimeUTCHtoUTC(), EndTimetimeUTCtoLocal(), EndTimetimeUTCtoUTCH()
property JobId as %Integer [ InitialExpression = $Job , Required , ReadOnly ];
Id of the job.
Property methods: JobIdDisplayToLogical(), JobIdGet(), JobIdGetStored(), JobIdIdxCheck(), JobIdIdxDelete(), JobIdIdxExists(), JobIdIdxOpen(), JobIdIdxSQLCheckUnique(), JobIdIdxSQLExists(), JobIdIdxSQLFindPKeyByConstraint(), JobIdIdxSQLFindRowIDByConstraint(), JobIdIsValid(), JobIdLogicalToDisplay(), JobIdNormalize(), JobIdXSDToLogical()
property JobKey as %String) [ Calculated ];
Unique identifier for a job.
Property methods: JobKeyDisplayToLogical(), JobKeyGet(), JobKeyIsValid(), JobKeyLogicalToDisplay(), JobKeyLogicalToOdbc(), JobKeyNormalize()
property MethodName as %Dictionary.Identifier [ Required ];
Name of method run for this job.
Property methods: MethodNameGet(), MethodNameGetStored(), MethodNameIsValid(), MethodNameSet()
property Namespace as %String [ InitialExpression = $Namespace , Required , ReadOnly ];
Namespace the job is executing in.
Property methods: NamespaceDisplayToLogical(), NamespaceGet(), NamespaceGetStored(), NamespaceIsValid(), NamespaceLogicalToDisplay(), NamespaceLogicalToOdbc(), NamespaceNormalize()
property Result as %Stream.GlobalCharacter;
Output of the job.
MUST be a %Library.DynamicAbstractObject that has been stored in the stream or will be empty if the job has no result.
Property methods: ResultDelete(), ResultGet(), ResultGetObject(), ResultGetObjectId(), ResultGetStored(), ResultGetSwizzled(), ResultIsValid(), ResultNewObject(), ResultOid(), ResultOpen(), ResultSet(), ResultSetObject(), ResultSetObjectId(), ResultUnSwizzle()
property StartTime as Ens.DataType.UTC [ InitialExpression = $$$CurrentTime , Required , ReadOnly ];
Start time of job (i.e. when job is requested)
Property methods: StartTimeDisplayToLogical(), StartTimeGet(), StartTimeGetStored(), StartTimeIsValid(), StartTimeLogicalToDisplay(), StartTimeLogicalToOdbc(), StartTimeNormalize(), StartTimeOdbcToLogical(), StartTimeStorageToLogical(), StartTimetimeCmp(), StartTimetimeDiff(), StartTimetimeLocal(), StartTimetimeLocaltoUTC(), StartTimetimeUTC(), StartTimetimeUTCH(), StartTimetimeUTCHtoUTC(), StartTimetimeUTCtoLocal(), StartTimetimeUTCtoUTCH()
property Status as %String (VALUELIST = ",pending,running,complete,error,internal_error") [ InitialExpression = "pending" , Required ];
Status of the job.
Property methods: StatusDisplayToLogical(), StatusGet(), StatusGetStored(), StatusIsValid(), StatusLogicalToDisplay(), StatusLogicalToOdbc(), StatusNormalize(), StatusSet()
property WrittenOutput as %Stream.GlobalCharacter;
Stores output of any write commands during the execution of the background job.
Property methods: WrittenOutputDelete(), WrittenOutputGet(), WrittenOutputGetObject(), WrittenOutputGetObjectId(), WrittenOutputGetStored(), WrittenOutputGetSwizzled(), WrittenOutputIsValid(), WrittenOutputNewObject(), WrittenOutputOid(), WrittenOutputOpen(), WrittenOutputSet(), WrittenOutputSetObject(), WrittenOutputSetObjectId(), WrittenOutputUnSwizzle()

Methods

method JobKeyGet() as %String

Indexes

index (JobIdIdx on JobId,Counter) [IdKey, Type = key];
Index methods: JobIdIdxCheck(), JobIdIdxDelete(), JobIdIdxExists(), JobIdIdxOpen(), JobIdIdxSQLCheckUnique(), JobIdIdxSQLExists(), JobIdIdxSQLFindPKeyByConstraint(), JobIdIdxSQLFindRowIDByConstraint()
index (MethodCallIdx on Classname,MethodName);
Index methods: MethodCallIdxExists()

Inherited Members

Inherited Methods

Storage

Storage Model: Storage (HSMOD.REST.Async.JobRecord)

^CacheTemp.HSMOD.REST.AsyncJobD(ID)
=
%%CLASSNAME
Status
Classname
MethodName
ArgumentList
Result
WrittenOutput
StartTime
EndTime
Namespace
FeedbackOpens in a new tab