public class AgentList extends XMLRequest implements Iterable<AgentListItem>
Modifier and Type | Class and Description |
---|---|
static class |
AgentList.Filter
Filter in the Agent list.
|
Constructor and Description |
---|
AgentList()
Creates a new AgentList request which reads the full agent list (all columns and all agents).
|
AgentList(AgentList.Filter filter,
String... selectedColumns)
Requests the Agent list with a filter.
|
Modifier and Type | Method and Description |
---|---|
AgentListItem |
getAgentByName(UC4HostName name)
Returns the AgentListItem for the specified name or
null if not found. |
boolean |
isListTruncated()
If max rows are set by the filter and the actual amount of rows exceeds this number than this will return true.
|
Iterator<AgentListItem> |
iterator()
Returns an Iterator which can be used to step through the
AgentListItem . |
void |
setSimpleList(boolean simpleList)
Deprecated.
Do not call this method if you need a filtered output, use AgentList(AgentFilter filter, String... selectedColumns) instead
|
int |
size()
Returns the total number of items in the Agent list (active and inactive).
|
void |
withGenericAgents(boolean with)
If this is set to true then all generic Agents from client 0 are included in the result.
|
getAllMessageBoxes, getMessageBox, getRequestID, handleResponse, send, showQuarantineNotification
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
forEach, spliterator
public AgentList(AgentList.Filter filter, String... selectedColumns)
filter
- Filter to restrict the resultselectedColumns
- Name of optional columns, possible values are:
public AgentList()
public AgentListItem getAgentByName(UC4HostName name)
null
if not found.name
- Name of the Agentpublic Iterator<AgentListItem> iterator()
AgentListItem
.iterator
in interface Iterable<AgentListItem>
AgentListItem
public int size()
AgentListItem
public boolean isListTruncated()
public void withGenericAgents(boolean with)
with
- generic agents@Deprecated public void setSimpleList(boolean simpleList)
simpleList
- true to enable simple-list mode, false to fetch all agent attributes (default)Copyright © 2021. All rights reserved.