Class DataMemoryLimitsConfigBuilder


  • @Generated({"common/config/src/templates/ConfigBuilder.stg","common/config/config.gradle"})
    public final class DataMemoryLimitsConfigBuilder
    extends java.lang.Object
    • Constructor Detail

      • DataMemoryLimitsConfigBuilder

        public DataMemoryLimitsConfigBuilder()
        Constructs an empty DataMemoryLimitsConfigBuilder
      • DataMemoryLimitsConfigBuilder

        public DataMemoryLimitsConfigBuilder​(java.util.Map<DataMemoryLimitsConfig.Field,​java.lang.Object> values)
        Constructs a DataMemoryLimitsConfigBuilder initialized with the values from the given map
        Parameters:
        values - a map containing configuration values
      • DataMemoryLimitsConfigBuilder

        public DataMemoryLimitsConfigBuilder​(DataMemoryLimitsConfig config)
        Constructs a DataMemoryLimitsConfigBuilder initialized with the values from the given config
        Parameters:
        config - the configuration to take the values from
      • DataMemoryLimitsConfigBuilder

        public DataMemoryLimitsConfigBuilder​(DataMemoryLimitsConfigBuilder builder)
        Constructs a DataMemoryLimitsConfigBuilder initialized with the values from the given builder
        Parameters:
        builder - the builder to take the values from
    • Method Detail

      • build

        public DataMemoryLimitsConfig build​(java.lang.String parentPath)
        Builds the DataMemoryLimitsConfig.
        Parameters:
        parentPath - if not null, resolves relative paths against this parentPath
        Returns:
        an instance of DataMemoryLimitsConfig
      • build

        public DataMemoryLimitsConfig build()
        Builds the DataMemoryLimitsConfig with a parentPath of null.
        Returns:
        An instance of DataMemoryLimitsConfig
        See Also:
        build(String)
      • toInputStream

        public java.io.InputStream toInputStream()
        Returns:
        an InputStream representing the config
      • toString

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

        public DataMemoryLimitsConfigBuilder setMaxTotalDataMemorySize​(java.lang.String maxTotalDataMemorySize)
        absolute memory limit across entire PGX engine, default memory unit is byte, can use (k, m, g, t, p) as suffix for (kilobyte, megabyte, gigabyte, terabyte, petabyte) units
      • setMaxTotalDataMemoryRatio

        public DataMemoryLimitsConfigBuilder setMaxTotalDataMemoryRatio​(double maxTotalDataMemoryRatio)
        memory limit across entire PGX engine relative to available system memory
      • setMaxTotalPrivateDataMemorySize

        public DataMemoryLimitsConfigBuilder setMaxTotalPrivateDataMemorySize​(java.lang.String maxTotalPrivateDataMemorySize)
        absolute memory limit of private data (includes non-published graphs and PGQL results), default memory unit is byte, can use (k, m, g, t, p) as suffix for (kilobyte, megabyte, gigabyte, terabyte, petabyte) units
      • setMaxTotalPrivateDataMemoryRatio

        public DataMemoryLimitsConfigBuilder setMaxTotalPrivateDataMemoryRatio​(double maxTotalPrivateDataMemoryRatio)
        memory limit of private data (includes non-published graphs and PGQL results) relative to total PGX engine memory limit
      • setMaxTotalSharedDataMemorySize

        public DataMemoryLimitsConfigBuilder setMaxTotalSharedDataMemorySize​(java.lang.String maxTotalSharedDataMemorySize)
        absolute memory limit of shared data (includes published graphs and pinned non-referenced graphs), default memory unit is byte, can use (k, m, g, t, p) as suffix for (kilobyte, megabyte, gigabyte, terabyte, petabyte) units
      • setMaxTotalSharedDataMemoryRatio

        public DataMemoryLimitsConfigBuilder setMaxTotalSharedDataMemoryRatio​(double maxTotalSharedDataMemoryRatio)
        memory limit of shared data (includes published graphs and pinned non-referenced graphs) relative to total PGX engine memory limit
      • setMaxPerUserDataMemorySize

        public DataMemoryLimitsConfigBuilder setMaxPerUserDataMemorySize​(java.lang.String maxPerUserDataMemorySize)
        absolute memory limit for any one user of the PGX engine, default memory unit is byte, can use (k, m, g, t, p) as suffix for (kilobyte, megabyte, gigabyte, terabyte, petabyte) units
      • setMaxPerUserDataMemoryRatio

        public DataMemoryLimitsConfigBuilder setMaxPerUserDataMemoryRatio​(double maxPerUserDataMemoryRatio)
        memory limit for any one user of the PGX engine relative to the private data memory limit
      • setMaxPerSessionDataMemorySize

        public DataMemoryLimitsConfigBuilder setMaxPerSessionDataMemorySize​(java.lang.String maxPerSessionDataMemorySize)
        absolute memory limit for any one session of the PGX engine, default memory unit is byte, can use (k, m, g, t, p) as suffix for (kilobyte, megabyte, gigabyte, terabyte, petabyte) units
      • setMaxPerSessionDataMemoryRatio

        public DataMemoryLimitsConfigBuilder setMaxPerSessionDataMemoryRatio​(double maxPerSessionDataMemoryRatio)
        memory limit for any one session of the PGX engine relative to the user data memory limit