Class NSSaintAgent

Administration and maintenance of SAINT counters and statuses.

Syntax

Examples

NSSaintAgent agent;
agent.callMethod(arg1, arg2);

Constructors

NSSaintAgent()

Administration and maintenance of SAINT counters and statuses.

Introduced or updated in version: 7

Declaration

NSSaintAgent

Examples

NSSaintAgent agent;
agent.callMethod(arg1, arg2);

Methods

CreateDefaultSaintConfiguration()

Sets default values into a new NSSaintConfiguration.

Introduced or updated in version: 8.5R08

Declaration

NSSaintConfiguration CreateDefaultSaintConfiguration()

Returns

Type	Description
NSSaintConfiguration

Remarks

NetServer calculates default values (for example, Country) on the entity, which is required when creating/storing a new instance

Examples

NSSaintAgent agent;
NSSaintConfiguration thing = agent.CreateDefaultSaintConfiguration();
thing = agent.SaveSaintConfiguration(thing);

CreateDefaultStatusMonitor()

Sets default values into a new NSStatusMonitor.

Introduced or updated in version: 7

Declaration

NSStatusMonitor CreateDefaultStatusMonitor()

Returns

Type	Description
NSStatusMonitor

Remarks

NetServer calculates default values (for example, Country) on the entity, which is required when creating/storing a new instance

Examples

NSSaintAgent agent;
NSStatusMonitor thing = agent.CreateDefaultStatusMonitor();
thing = agent.SaveStatusMonitor(thing);

CreateDefaultStatusMonitorPeriods()

Sets default values into a new NSStatusMonitorPeriods.

Introduced or updated in version: 7.5

Declaration

NSStatusMonitorPeriods CreateDefaultStatusMonitorPeriods()

Returns

Type	Description
NSStatusMonitorPeriods

Remarks

NetServer calculates default values (for example, Country) on the entity, which is required when creating/storing a new instance

Examples

NSSaintAgent agent;
NSStatusMonitorPeriods thing = agent.CreateDefaultStatusMonitorPeriods();
thing = agent.SaveStatusMonitorPeriods(thing);

GetSaintConfigurations()

Returns the NSStatusMonitorPeriods entity.

Introduced or updated in version: 8.5R08

Declaration

NSSaintConfiguration[] GetSaintConfigurations()

Returns

Type	Description
NSSaintConfiguration[]

Examples

NSSaintAgent agent;
NSSaintConfiguration[] res = agent.GetSaintConfigurations();

GetStatusMonitor(Integer)

Gets a single status monitor based on its identity

Introduced or updated in version: 7

Declaration

NSStatusMonitor GetStatusMonitor(Integer id)

Parameters

Type	Name	Description
Integer	id

Returns

Type	Description
NSStatusMonitor

Examples

NSSaintAgent agent;
Integer id;
NSStatusMonitor res = agent.GetStatusMonitor(id);

GetStatusMonitorPeriods()

Returns the NSStatusMonitorPeriods entity.

Introduced or updated in version: 7.5

Declaration

NSStatusMonitorPeriods GetStatusMonitorPeriods()

Returns

Type	Description
NSStatusMonitorPeriods

Examples

NSSaintAgent agent;
NSStatusMonitorPeriods res = agent.GetStatusMonitorPeriods();

GetStatusMonitors(Integer,String)

Gets all active status monitors for a specified target

Introduced or updated in version: 7

Declaration

NSStatusMonitor[] GetStatusMonitors(Integer id, String type)

Parameters

Type	Name	Description
Integer	id
String	type

Returns

Type	Description
NSStatusMonitor[]

Examples

NSSaintAgent agent;
Integer id;
String type;
NSStatusMonitor[] res = agent.GetStatusMonitors(id, type);

RegenerateCounters(Bool)

Regenerates the Saint counters* this can take several minutes

Introduced or updated in version: 7.5

Declaration

NSBatchTaskInfo RegenerateCounters(Bool runAsBatch)

Parameters

Type	Name	Description
Bool	runAsBatch

Returns

Type	Description
NSBatchTaskInfo

Examples

NSSaintAgent agent;
Bool runAsBatch;
NSBatchTaskInfo res = agent.RegenerateCounters(runAsBatch);

RegenerateStatusMonitor(Integer)

Regenerates the given status monitor

Introduced or updated in version: 7.5

Declaration

Void RegenerateStatusMonitor(Integer statusMonitorId)

Parameters

Type	Name	Description
Integer	statusMonitorId

Returns

Type	Description
Void

Examples

NSSaintAgent agent;
Integer statusMonitorId;
agent.RegenerateStatusMonitor(statusMonitorId);

RegenerateStatusMonitors(Bool)

Regenerates status monitors

Introduced or updated in version: 7.5

Declaration

NSBatchTaskInfo RegenerateStatusMonitors(Bool runAsBatch)

Parameters

Type	Name	Description
Bool	runAsBatch

Returns

Type	Description
NSBatchTaskInfo

Examples

NSSaintAgent agent;
Bool runAsBatch;
NSBatchTaskInfo res = agent.RegenerateStatusMonitors(runAsBatch);

SaveSaintConfiguration(NSSaintConfiguration)

Updates the existing NSSaintConfiguration or creates a new NSSaintConfiguration if the id parameter is 0.

Introduced or updated in version: 8.5R08

Declaration

NSSaintConfiguration SaveSaintConfiguration(NSSaintConfiguration saintConfiguration)

Parameters

Type	Name	Description
NSSaintConfiguration	saintConfiguration	The NSSaintConfiguration to save.

Returns

Type	Description
NSSaintConfiguration

Examples

NSSaint  agent;
NSSaintConfiguration thing = agent.CreateDefaultSaintConfiguration();
thing = agent.SaveSaintConfiguration(thing);

SaveStatusMonitor(NSStatusMonitor)

Updates the existing NSStatusMonitor or creates a new NSStatusMonitor if the id parameter is 0

Introduced or updated in version: 7.5

Declaration

NSStatusMonitor SaveStatusMonitor(NSStatusMonitor statusMonitor)

Parameters

Type	Name	Description
NSStatusMonitor	statusMonitor	The NSStatusMonitor to save.

Returns

Type	Description
NSStatusMonitor

Examples

NSSaint  agent;
NSStatusMonitor thing = agent.CreateDefaultStatusMonitor();
thing = agent.SaveStatusMonitor(thing);

SaveStatusMonitorPeriods(NSStatusMonitorPeriods)

Updates the existing NSStatusMonitorPeriods or creates a new NSStatusMonitorPeriods if the id parameter is 0

Introduced or updated in version: 7.5

Declaration

NSStatusMonitorPeriods SaveStatusMonitorPeriods(NSStatusMonitorPeriods statusMonitorPeriods)

Parameters

Type	Name	Description
NSStatusMonitorPeriods	statusMonitorPeriods	The NSStatusMonitorPeriods to save.

Returns

Type	Description
NSStatusMonitorPeriods

Examples

NSSaint  agent;
NSStatusMonitorPeriods thing = agent.CreateDefaultStatusMonitorPeriods();
thing = agent.SaveStatusMonitorPeriods(thing);

SetRankOnStatusMonitors(String,Integer[])

Sets rank order on status monitors

Introduced or updated in version: 7.5

Declaration

Void SetRankOnStatusMonitors(String type, Integer[] itemsIds)

Parameters

Type	Name	Description
String	type
Integer[]	itemsIds

Returns

Type	Description
Void

Examples

NSSaintAgent agent;
String type;
Integer[] itemsIds;
agent.SetRankOnStatusMonitors(type, itemsIds);