ProtocolDescriptionSupport
@Generated(value="com.genesyslab.platform.commons.protocol.generator.Generator", date="2021-06-14T15:45:42.723-07:00") public abstract class RequestGetStatistic extends Message
CurrentTargetState
category.
Name | Description |
---|---|
StatisticMetric |
Contains the StatisticType and TimeProfile to be used in gathering data for the requested statistic object. |
StatisticObject |
The statistic object for which data is requested. |
Name | Description |
---|---|
EventCurrentTargetStateSnapshot |
Contains the CurrentTargetStateSnapshot data structure, which includes information about routing targets such as agent, place, agent group, and place group states. |
EventInfo |
Contains information about a statistics request that does not concern a routing target. |
EventError |
Indicates that the request encountered an error. |
RequestGetStatistic req = RequestGetStatistic.create();
StatisticObject object = StatisticObject.create();
object.setObjectId("An_Agent");
object.setObjectType(StatisticObjectType.Agent);
object.setTenantName("The_Tenant");
object.setTenantPassword("password");
req.setStatisticObject(object);
StatisticMetric statisticMetric = StatisticMetric.create("TotalLoginTime");
req.setStatisticMetric(statisticMetric);
Message response = statProtocol.request(req);
Modifier and Type | Method | Description |
---|---|---|
static RequestGetStatistic |
create() |
Creates instance of RequestGetStatistic with no parameters set.
|
static RequestGetStatistic |
create(StatisticObject statisticObject,
StatisticMetric statisticMetric) |
Creates instance of RequestGetStatistic with required parameters set.
|
static RequestGetStatistic |
create(StatisticObject statisticObject,
StatisticMetric statisticMetric,
KeyValueCollection extensions,
java.lang.Integer tag) |
Creates instance of RequestGetStatistic with all parameters set.
|
abstract KeyValueCollection |
getExtensions() |
|
abstract java.lang.Integer |
getReferenceId() |
A unique integer that is specified for identification of requested statistics.
|
abstract StatisticMetric |
getStatisticMetric() |
|
abstract StatisticObject |
getStatisticObject() |
|
abstract java.lang.Integer |
getTag() |
User reference ID.
|
abstract void |
setExtensions(KeyValueCollection extensions) |
|
abstract void |
setReferenceId(int referenceId) |
A unique integer that is specified for identification of requested statistics.
|
abstract void |
setReferenceId(java.lang.Integer referenceId) |
A unique integer that is specified for identification of requested statistics.
|
abstract void |
setStatisticMetric(StatisticMetric statisticMetric) |
|
abstract void |
setStatisticObject(StatisticObject statisticObject) |
|
abstract void |
setTag(int tag) |
User reference ID.
|
abstract void |
setTag(java.lang.Integer tag) |
User reference ID.
|
equals, hashCode, toString, toString
cloneMessage, getEndpoint, getMessageAttribute, getProtocolDescription, getProtocolId, messageId, messageName, setProtocolDescription
public static final int ID
public static final java.lang.String NAME
public static RequestGetStatistic create()
public static RequestGetStatistic create(StatisticObject statisticObject, StatisticMetric statisticMetric, KeyValueCollection extensions, java.lang.Integer tag)
statisticObject
- StatisticObjectstatisticMetric
- StatisticMetricextensions
- Extensionstag
- Tagpublic static RequestGetStatistic create(StatisticObject statisticObject, StatisticMetric statisticMetric)
statisticObject
- StatisticObjectstatisticMetric
- StatisticMetricpublic abstract java.lang.Integer getReferenceId()
public abstract void setReferenceId(java.lang.Integer referenceId)
public abstract void setReferenceId(int referenceId)
public abstract StatisticObject getStatisticObject()
public abstract void setStatisticObject(StatisticObject statisticObject)
public abstract StatisticMetric getStatisticMetric()
public abstract void setStatisticMetric(StatisticMetric statisticMetric)
public abstract KeyValueCollection getExtensions()
public abstract void setExtensions(KeyValueCollection extensions)
public abstract java.lang.Integer getTag()
public abstract void setTag(java.lang.Integer tag)
public abstract void setTag(int tag)
Send comments on this topicTechpubs.webadmin@genesys.com.
Document version: 9.0.006.00
Copyright © 2006–2019 Genesys Telecommunications Laboratories, Inc. All rights reserved.