Package org.netxms.client.datacollection

Class DataExportRequest

java.lang.Object
org.netxms.client.datacollection.DataExportRequest
public class DataExportRequest extends Object
Request for export of DCI history. Metrics are selected either by tag patterns under a root object, or by an explicit list of DCI references (which takes precedence when not empty).

  • Field Details

  • Constructor Details

    • DataExportRequest

      public DataExportRequest()

  • Method Details

    • fillMessage

      public void fillMessage(NXCPMessage msg)
      Fill NXCP message with request data
      Parameters:
      msg - NXCP message

    • getRootObjectId

      public long getRootObjectId()
      Returns:
      root object ID

    • setRootObjectId

      public void setRootObjectId(long rootObjectId)
      Parameters:
      rootObjectId - root object ID (subtree searched for tagged DCIs)

    • getTagPatterns

      public List<String> getTagPatterns()
      Returns:
      tag glob patterns

    • setTagPatterns

      public void setTagPatterns(List<String> tagPatterns)
      Parameters:
      tagPatterns - tag glob patterns (e.g. "eed.*")

    • getDciList

      public List<DataExportRequest.DciReference> getDciList()
      Returns:
      explicit DCI list

    • setDciList

      public void setDciList(List<DataExportRequest.DciReference> dciList)
      Parameters:
      dciList - explicit DCI list; when not empty, root object and tag patterns are ignored

    • getTimeFrom

      public Date getTimeFrom()
      Returns:
      start of export period

    • setTimeFrom

      public void setTimeFrom(Date timeFrom)
      Parameters:
      timeFrom - start of export period

    • getTimeTo

      public Date getTimeTo()
      Returns:
      end of export period (inclusive)

    • setTimeTo

      public void setTimeTo(Date timeTo)
      Parameters:
      timeTo - end of export period (inclusive)

    • getTier

      public DciTier getTier()
      Returns:
      history tier to export

    • setTier

      public void setTier(DciTier tier)
      Parameters:
      tier - history tier to export (RAW, HOURLY, or DAILY)

    • isAnonymize

      public boolean isAnonymize()
      Returns:
      true if identities should be replaced with pseudonyms

    • setAnonymize

      public void setAnonymize(boolean anonymize)
      Parameters:
      anonymize - true to replace identities with pseudonyms

    • isKeepMapping

      public boolean isKeepMapping()
      Returns:
      true if pseudonym mapping file should be produced

    • setKeepMapping

      public void setKeepMapping(boolean keepMapping)
      Parameters:
      keepMapping - true to produce pseudonym mapping file (anonymized exports only)