Class DataMemoryLimitsConfigBuilder

java.lang.Object
oracle.pgx.config.DataMemoryLimitsConfigBuilder
@Generated({"common/config/src/templates/ConfigBuilder.stg","common/config/config.gradle"}) public final class DataMemoryLimitsConfigBuilder extends Object
Builder for DataMemoryLimitsConfig.

  • Constructor Details

    • DataMemoryLimitsConfigBuilder

      public DataMemoryLimitsConfigBuilder()
      Constructs an empty DataMemoryLimitsConfigBuilder

    • DataMemoryLimitsConfigBuilder

      public DataMemoryLimitsConfigBuilder(Map<DataMemoryLimitsConfig.Field, 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 Details

    • buildDataMemoryLimitsConfig

      public static DataMemoryLimitsConfig buildDataMemoryLimitsConfig(Consumer<DataMemoryLimitsConfigBuilder> builderSetup)
      Builds a DataMemoryLimitsConfig in-place
      Parameters:
      builderSetup - a consumer to setup a newly created DataMemoryLimitsConfig

    • putAll

      public DataMemoryLimitsConfigBuilder putAll(Map<DataMemoryLimitsConfig.Field, Object> values)
      Puts all values from the given map into this builder.
      Parameters:
      values - the values to put in the builder

    • putAll

      public DataMemoryLimitsConfigBuilder putAll(DataMemoryLimitsConfig config)
      Puts all values from the given config into this builder
      Parameters:
      config - the config to take the values from

    • clear

      public DataMemoryLimitsConfigBuilder clear()
      Clears all values from the builder

    • build

      public DataMemoryLimitsConfig build(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:

    • toInputStream

      public InputStream toInputStream()
      Returns:
      an InputStream representing the config

    • getValues

      public Map<DataMemoryLimitsConfig.Field, Object> getValues()
      Returns:
      the raw config values

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • setMaxTotalDataMemorySize

      public DataMemoryLimitsConfigBuilder setMaxTotalDataMemorySize(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(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(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(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(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