Package org.netxms.client.datacollection
Class NetconfQueryDefinition
java.lang.Object
org.netxms.client.datacollection.NetconfQueryDefinition
NETCONF query definition
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final int -
Constructor Summary
ConstructorsConstructorDescriptionNetconfQueryDefinition(String name) Create new definition.Create definition from NXCP message -
Method Summary
Modifier and TypeMethodDescriptionvoidfillMessage(NXCPMessage msg) Fill NXCP message with object dataintGet cache retention time in seconds.intGet datastore to be queried (one ofDATASTORE_constants).intGet filter type (one ofFILTER_constants).intgetFlags()Get flags.getGuid()intgetId()Get NETCONF query definition ID.getName()intGet request timeout in milliseconds.voidsetCacheRetentionTime(int cacheRetentionTime) Set cache retention time in seconds.voidsetDatastore(int datastore) Set datastore to be queried (one ofDATASTORE_constants).voidsetDescription(String description) voidvoidsetFilterType(int filterType) Set filter type (one ofFILTER_constants).voidsetFlags(int flags) Set flags.voidvoidsetId(int id) Set NETCONF query definition ID.voidvoidsetRequestTimeout(int requestTimeout) Set request timeout in milliseconds.
-
Field Details
-
DATASTORE_OPERATIONAL
public static final int DATASTORE_OPERATIONAL- See Also:
-
DATASTORE_RUNNING
public static final int DATASTORE_RUNNING- See Also:
-
DATASTORE_CANDIDATE
public static final int DATASTORE_CANDIDATE- See Also:
-
DATASTORE_STARTUP
public static final int DATASTORE_STARTUP- See Also:
-
FILTER_NONE
public static final int FILTER_NONE- See Also:
-
FILTER_SUBTREE
public static final int FILTER_SUBTREE- See Also:
-
FILTER_XPATH
public static final int FILTER_XPATH- See Also:
-
-
Constructor Details
-
NetconfQueryDefinition
Create new definition. Definition object will be created with random GUID and ID 0.- Parameters:
name- name for new definition
-
NetconfQueryDefinition
Create definition from NXCP message- Parameters:
msg- NXCP message
-
-
Method Details
-
fillMessage
Fill NXCP message with object data- Parameters:
msg- NXCP message
-
getId
public int getId()Get NETCONF query definition ID.- Returns:
- NETCONF query definition ID
-
setId
public void setId(int id) Set NETCONF query definition ID.- Parameters:
id- new NETCONF query definition ID
-
getGuid
- Returns:
- the guid
-
setGuid
- Parameters:
guid- the guid to set
-
getName
- Returns:
- the name
-
setName
- Parameters:
name- the name to set
-
getDescription
- Returns:
- the description
-
setDescription
- Parameters:
description- the description to set
-
getDatastore
public int getDatastore()Get datastore to be queried (one ofDATASTORE_constants).- Returns:
- datastore to be queried
-
setDatastore
public void setDatastore(int datastore) Set datastore to be queried (one ofDATASTORE_constants).- Parameters:
datastore- datastore to be queried
-
getFilterType
public int getFilterType()Get filter type (one ofFILTER_constants).- Returns:
- filter type
-
setFilterType
public void setFilterType(int filterType) Set filter type (one ofFILTER_constants).- Parameters:
filterType- new filter type
-
getFilter
- Returns:
- the filter
-
setFilter
- Parameters:
filter- the filter to set
-
getCacheRetentionTime
public int getCacheRetentionTime()Get cache retention time in seconds.- Returns:
- the cacheRetentionTime
-
setCacheRetentionTime
public void setCacheRetentionTime(int cacheRetentionTime) Set cache retention time in seconds.- Parameters:
cacheRetentionTime- the cacheRetentionTime to set
-
getRequestTimeout
public int getRequestTimeout()Get request timeout in milliseconds.- Returns:
- the requestTimeout
-
setRequestTimeout
public void setRequestTimeout(int requestTimeout) Set request timeout in milliseconds.- Parameters:
requestTimeout- the requestTimeout to set
-
getFlags
public int getFlags()Get flags.- Returns:
- flags
-
setFlags
public void setFlags(int flags) Set flags.- Parameters:
flags- new flags
-