HS.HC.SystemConfig.REST.V1.Status
class HS.HC.SystemConfig.REST.V1.Status extends HS.REST.Model.Resource
Method Inventory
Parameters
parameter MEDIATYPE = application/vnd.intersystems.com.hs.sys.status.v1+json;
Inherited description: Content-Type implemented in this class
Subclasses MAY override this
parameter RESOURCENAME = mirror-monitor;
Inherited description: Name of the resource at the REST level
Subclasses MUST override this
Methods
classmethod CheckPermission(pID As %String, pOperation As %String, pUserContext As %RegisteredObject, ByRef URLParams) as %Boolean
Inherited description: Checks the user's permission for a particular operation on a particular record.
pOperation may be one of the macros of the form $$$Operation*
present in %pkg.isc.rest.general.inc.
If this method returns 0, the corresponding dispatch class will return a 403 Unauthorized status when the operation is invoked.
pUserContext is supplied by GetUserContext().
If this method returns 0, the corresponding dispatch class will return a 403 Unauthorized status when the operation is invoked.
pUserContext is supplied by GetUserContext().
classmethod GetConfigStepStatus(pInstanceName As %String, pIsError As %Boolean = "", pIsIgnored As %Boolean = "") as %DynamicArray
classmethod GetSummary() as HS.HC.SystemConfig.REST.V1.SummaryResponse
Returns an object with keys isRunning, isPrimary, memberSummary.
The value of memberSummary is an array of object, one for each member in the mirror set, containing
memberName, instanceName, role, completed steps and last completed step, and status ("Caught up" or "Behind")
classmethod SetIsIgnored(pIdArray As %DynamicArray, pIsIgnored As %Boolean)
classmethod StartAgent() as %DynamicObject
classmethod StopAgent() as %DynamicObject
Inherited Members
Inherited Methods
- %AddToSaveSet()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Extends()
- %GetParameter()
- %IsA()
- %IsModified()
- %JSONExport()
- %JSONExportToStream()
- %JSONExportToString()
- %JSONImport()
- %JSONMappingInfo()
- %JSONNew()
- %New()
- %NormalizeObject()
- %ObjectModified()
- %OriginalNamespace()
- %PackageName()
- %RemoveFromSaveSet()
- %SerializeObject()
- %SetModified()
- %ValidateObject()
- DeleteModelInstance()
- GetCollection()
- GetModelInstance()
- JSONExport()
- JSONExportToStream()
- JSONExportToString()
- JSONImport()
- ModifyOpenAPIInfo()
- SaveModelInstance()
- Supports()
- SupportsDefault()
- Version()