DataMemoryLimitsConfigBuilder (Oracle Graph Java API Reference Release 20.4 (F15858-05))

java.lang.Object
- oracle.pgx.config.DataMemoryLimitsConfigBuilder

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

Builder for DataMemoryLimitsConfig.

Constructor Summary

Constructors
Constructor and Description
`DataMemoryLimitsConfigBuilder()` Constructs an empty DataMemoryLimitsConfigBuilder
`DataMemoryLimitsConfigBuilder(DataMemoryLimitsConfig config)` Constructs a DataMemoryLimitsConfigBuilder initialized with the values from the given config
`DataMemoryLimitsConfigBuilder(DataMemoryLimitsConfigBuilder builder)` Constructs a DataMemoryLimitsConfigBuilder initialized with the values from the given builder
`DataMemoryLimitsConfigBuilder(java.util.Map<DataMemoryLimitsConfig.Field,java.lang.Object> values)` Constructs a DataMemoryLimitsConfigBuilder initialized with the values from the given map

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DataMemoryLimitsConfig`	`build()` Builds the DataMemoryLimitsConfig with a `parentPath` of `null`.
`DataMemoryLimitsConfig`	`build(java.lang.String parentPath)` Builds the DataMemoryLimitsConfig.
`static DataMemoryLimitsConfig`	`buildDataMemoryLimitsConfig(java.util.function.Consumer<DataMemoryLimitsConfigBuilder> builderSetup)` Builds a `DataMemoryLimitsConfig` in-place
`DataMemoryLimitsConfigBuilder`	`clear()` Clears all values from the builder
`java.util.Map<DataMemoryLimitsConfig.Field,java.lang.Object>`	`getValues()`
`DataMemoryLimitsConfigBuilder`	`putAll(DataMemoryLimitsConfig config)` Puts all values from the given config into this builder
`DataMemoryLimitsConfigBuilder`	`putAll(java.util.Map<DataMemoryLimitsConfig.Field,java.lang.Object> values)` Puts all values from the given map into this builder.
`DataMemoryLimitsConfigBuilder`	`setMaxPerSessionDataMemoryRatio(double maxPerSessionDataMemoryRatio)` memory limit for any one session of the PGX engine relative to the user data memory limit
`DataMemoryLimitsConfigBuilder`	`setMaxPerSessionDataMemorySize(java.lang.String maxPerSessionDataMemorySize)` absolute memory limit for any one session of the PGX engine
`DataMemoryLimitsConfigBuilder`	`setMaxPerUserDataMemoryRatio(double maxPerUserDataMemoryRatio)` memory limit for any one user of the PGX engine relative to the private data memory limit
`DataMemoryLimitsConfigBuilder`	`setMaxPerUserDataMemorySize(java.lang.String maxPerUserDataMemorySize)` absolute memory limit for any one user of the PGX engine
`DataMemoryLimitsConfigBuilder`	`setMaxTotalDataMemoryRatio(double maxTotalDataMemoryRatio)` memory limit across entire PGX engine relative to available system memory
`DataMemoryLimitsConfigBuilder`	`setMaxTotalDataMemorySize(java.lang.String maxTotalDataMemorySize)` absolute memory limit across entire PGX engine
`DataMemoryLimitsConfigBuilder`	`setMaxTotalPrivateDataMemoryRatio(double maxTotalPrivateDataMemoryRatio)` memory limit of private data (includes non-published graphs and PGQL results) relative to total PGX engine memory limit
`DataMemoryLimitsConfigBuilder`	`setMaxTotalPrivateDataMemorySize(java.lang.String maxTotalPrivateDataMemorySize)` absolute memory limit of private data (includes non-published graphs and PGQL results)
`DataMemoryLimitsConfigBuilder`	`setMaxTotalSharedDataMemoryRatio(double maxTotalSharedDataMemoryRatio)` memory limit of shared data (includes published graphs and pinned non-referenced graphs) relative to total PGX engine memory limit
`DataMemoryLimitsConfigBuilder`	`setMaxTotalSharedDataMemorySize(java.lang.String maxTotalSharedDataMemorySize)` absolute memory limit of shared data (includes published graphs and pinned non-referenced graphs)
`java.io.InputStream`	`toInputStream()`
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DataMemoryLimitsConfigBuilder
```
public DataMemoryLimitsConfigBuilder()
```
    Constructs an empty DataMemoryLimitsConfigBuilder
  - 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
  - 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
- Method Detail
  - build
```
public DataMemoryLimitsConfig build()
```
    Builds the DataMemoryLimitsConfig with a parentPath of null.
    
    Returns:
    
    An instance of DataMemoryLimitsConfig
    
    See Also:
    
    build(String)
  - 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
  - buildDataMemoryLimitsConfig
```
public static DataMemoryLimitsConfig buildDataMemoryLimitsConfig(java.util.function.Consumer<DataMemoryLimitsConfigBuilder> builderSetup)
```
    Builds a DataMemoryLimitsConfig in-place
    
    Parameters:
    
    builderSetup - a consumer to setup a newly created DataMemoryLimitsConfig
  - clear
```
public DataMemoryLimitsConfigBuilder clear()
```
    Clears all values from the builder
  - getValues
```
public java.util.Map<DataMemoryLimitsConfig.Field,java.lang.Object> getValues()
```
    Returns:
    
    the raw config values
  - 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
  - putAll
```
public DataMemoryLimitsConfigBuilder putAll(java.util.Map<DataMemoryLimitsConfig.Field,java.lang.Object> values)
```
    Puts all values from the given map into this builder.
    
    Parameters:
    
    values - the values to put in the builder
  - setMaxPerSessionDataMemoryRatio
```
public DataMemoryLimitsConfigBuilder setMaxPerSessionDataMemoryRatio(double maxPerSessionDataMemoryRatio)
```
    memory limit for any one session of the PGX engine relative to the user data memory limit
  - setMaxPerSessionDataMemorySize
```
public DataMemoryLimitsConfigBuilder setMaxPerSessionDataMemorySize(java.lang.String maxPerSessionDataMemorySize)
```
    absolute memory limit for any one session of the PGX engine
  - setMaxPerUserDataMemoryRatio
```
public DataMemoryLimitsConfigBuilder setMaxPerUserDataMemoryRatio(double maxPerUserDataMemoryRatio)
```
    memory limit for any one user of the PGX engine relative to the private data memory limit
  - setMaxPerUserDataMemorySize
```
public DataMemoryLimitsConfigBuilder setMaxPerUserDataMemorySize(java.lang.String maxPerUserDataMemorySize)
```
    absolute memory limit for any one user of the PGX engine
  - setMaxTotalDataMemoryRatio
```
public DataMemoryLimitsConfigBuilder setMaxTotalDataMemoryRatio(double maxTotalDataMemoryRatio)
```
    memory limit across entire PGX engine relative to available system memory
  - setMaxTotalDataMemorySize
```
public DataMemoryLimitsConfigBuilder setMaxTotalDataMemorySize(java.lang.String maxTotalDataMemorySize)
```
    absolute memory limit across entire PGX engine
  - 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
  - setMaxTotalPrivateDataMemorySize
```
public DataMemoryLimitsConfigBuilder setMaxTotalPrivateDataMemorySize(java.lang.String maxTotalPrivateDataMemorySize)
```
    absolute memory limit of private data (includes non-published graphs and PGQL results)
  - 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
  - setMaxTotalSharedDataMemorySize
```
public DataMemoryLimitsConfigBuilder setMaxTotalSharedDataMemorySize(java.lang.String maxTotalSharedDataMemorySize)
```
    absolute memory limit of shared data (includes published graphs and pinned non-referenced graphs)
  - 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

Class DataMemoryLimitsConfigBuilder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DataMemoryLimitsConfigBuilder

DataMemoryLimitsConfigBuilder

DataMemoryLimitsConfigBuilder

DataMemoryLimitsConfigBuilder

Method Detail

build

build

buildDataMemoryLimitsConfig

clear

getValues

putAll

putAll

setMaxPerSessionDataMemoryRatio

setMaxPerSessionDataMemorySize

setMaxPerUserDataMemoryRatio

setMaxPerUserDataMemorySize

setMaxTotalDataMemoryRatio

setMaxTotalDataMemorySize

setMaxTotalPrivateDataMemoryRatio

setMaxTotalPrivateDataMemorySize

setMaxTotalSharedDataMemoryRatio

setMaxTotalSharedDataMemorySize

toInputStream

toString