HS.HC.ClientAPI.InstanceConfig.API
class HS.HC.ClientAPI.InstanceConfig.API extends HS.HC.ClientAPI.AbstractAPI
Client for instance info API.Method Inventory
Parameters
parameter DefaultTimeout = 10;
Default timeout for HTTP requests (in seconds).
Choosen so that not too small to allow for network latency but not too large so that responses are provided fast enough for good UX.
Choosen so that not too small to allow for network latency but not too large so that responses are provided fast enough for good UX.
parameter RESOURCENAME = $$$ResourceNamespaceConfig;
Inherited description: Specifies the name of the resource as it appears in the URL.
@API.Parameter
@API.Parameter
Methods
method GetAllnfo(pIncludeServer As %Boolean = 1, pIncludeInstance As %Boolean = 1, pIncludeNamespaces As %Boolean = 1, Output pIsRunning As %Boolean, pLogical As %Boolean = 0) as HS.HC.ClientAPI.InstanceConfig.Payload
Get all info about the server, instance and namespaces on the instance.
Default is to return all information. Can selectively choose to request partial information.
Throws errors. If the instance is down, pIsRunning is false and no errors are thrown and a null oref is returned.
@API.Method
@Argument pIncludeServer Include server info in response.
@Argument pIncludeInstance Include instance info in response.
@Argument pIncludeNamespaces Include namespaces info in response.
@Argument pIsRunning Whether the instance is running.
@Argument pLogical Whether to return data in logical mode or display mode.
Default is to return all information. Can selectively choose to request partial information.
Throws errors. If the instance is down, pIsRunning is false and no errors are thrown and a null oref is returned.
@API.Method
@Argument pIncludeServer Include server info in response.
@Argument pIncludeInstance Include instance info in response.
@Argument pIncludeNamespaces Include namespaces info in response.
@Argument pIsRunning Whether the instance is running.
@Argument pLogical Whether to return data in logical mode or display mode.
classmethod GetInstance(pServiceName As %String) as HS.HC.ClientAPI.InstanceConfig.API
Get an instance of this API.
@API.Method
@Argument pServiceName The name of corresponding service registry entry.
@API.Method
@Argument pServiceName The name of corresponding service registry entry.
method GetSingleNamespaceInfo(pNamespace As HS.HC.DataType.NamespaceName, pIncludeServer As %Boolean = 1, pIncludeInstance As %Boolean = 1, Output pIsRunning As %Boolean, pLogical As %Boolean = 0) as HS.HC.ClientAPI.InstanceConfig.Payload
Get info about a single namespace.
Default is to return all information. Can selectively choose to request partial information.
Throws errors. If the instance is down, pIsRunning is false and no errors are thrown and a null oref is returned.
@API.Method
@Argument pNamespace Namespace whose info to obtain.
@Argument pIncludeServer Include server info in response.
@Argument pIncludeInstance Include instance info in response.
@Argument pIsRunning Whether the instance is running.
@Argument pLogical Whether to return data in logical mode or display mode.
Default is to return all information. Can selectively choose to request partial information.
Throws errors. If the instance is down, pIsRunning is false and no errors are thrown and a null oref is returned.
@API.Method
@Argument pNamespace Namespace whose info to obtain.
@Argument pIncludeServer Include server info in response.
@Argument pIncludeInstance Include instance info in response.
@Argument pIsRunning Whether the instance is running.
@Argument pLogical Whether to return data in logical mode or display mode.
Inherited Members
Inherited Properties
Inherited Methods
- %AddToSaveSet()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Extends()
- %GetParameter()
- %IsA()
- %IsModified()
- %New()
- %NormalizeObject()
- %ObjectModified()
- %OriginalNamespace()
- %PackageName()
- %RemoveFromSaveSet()
- %SerializeObject()
- %SetModified()
- %ValidateObject()
- GetBestForClient()
- GetBestInstance()