Class InfluxdbSystemHistorianConfig

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      java.lang.String getDatabase()
      The InfluxDB database to write to.
      java.lang.String getHost()
      InfluxDB server host name/IP address.
      java.lang.Integer getMaxBatchSize()
      The maximum number of datapoints to send in a single call to InfluxDB.
      int getPort()
      InfluxDB server port.
      com.elastisys.scale.commons.json.types.TimeInterval getReportingInterval()
      The time interval between two successive reporting attempts to InfluxDB.
      java.util.Optional<InfluxdbSecurityConfig> getSecurity()
      Security settings for connecting with the server.
      int hashCode()  
      java.lang.String toString()  
      void validate()  
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • InfluxdbSystemHistorianConfig

        public InfluxdbSystemHistorianConfig​(java.lang.String host,
                                             int port,
                                             java.lang.String database,
                                             InfluxdbSecurityConfig security,
                                             com.elastisys.scale.commons.json.types.TimeInterval reportingInterval,
                                             java.lang.Integer maxBatchSize)
        Parameters:
        host - InfluxDB server host name/IP address. Required.
        port - InfluxDB server port. Required.
        database - The InfluxDB database to write to. An InfluxDB database acts as a container for time series data. For example, mydb. Required.
        security - Security settings for connecting with the server. Optional. If left out, the InfluxDB server is assumed to run over HTTP and no client authentication will be used.
        reportingInterval - The time interval between two successive reporting attempts to InfluxDB. Defaults to: DEFAULT_REPORTING_INTERVAL.
        maxBatchSize - The maximum number of datapoints to send in a single call to InfluxDB. As noted in the InfluxDB docs it may be necessary to split datapoints into smaller batches once they exceed a few thousand points to avoid request time outs. Defaults to: DEFAULT_MAX_BATCH_SIZE.
    • Method Detail

      • getHost

        public java.lang.String getHost()
        InfluxDB server host name/IP address.
        Returns:
      • getPort

        public int getPort()
        InfluxDB server port.
        Returns:
      • getDatabase

        public java.lang.String getDatabase()
        The InfluxDB database to write to. An InfluxDB database acts as a container for time series data. For example, mydb. Required.
        Returns:
      • getSecurity

        public java.util.Optional<InfluxdbSecurityConfig> getSecurity()
        Security settings for connecting with the server. Optional. If left out, the InfluxDB server is assumed to run over HTTP and no client authentication will be used.
        Returns:
      • getReportingInterval

        public com.elastisys.scale.commons.json.types.TimeInterval getReportingInterval()
        The time interval between two successive reporting attempts to InfluxDB.
        Returns:
      • getMaxBatchSize

        public java.lang.Integer getMaxBatchSize()
        The maximum number of datapoints to send in a single call to InfluxDB. As noted in the InfluxDB docs it may be necessary to split datapoints into smaller batches once they exceed a few thousand points to avoid request time outs.
        Returns:
      • validate

        public void validate()
                      throws java.lang.IllegalArgumentException
        Throws:
        java.lang.IllegalArgumentException
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object