@Generated(value="config_generator.py") public class GraphLoadingConfig extends AbstractConfig
Modifier and Type | Class and Description |
---|---|
static class |
GraphLoadingConfig.Field
Fields of PGX Engine Graph Loading Config
|
ENV_SEPARATOR, ENV_VARIABLE_PREFIX, SYSTEM_PROPERTY_PREFIX
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj) |
static GraphLoadingConfig.Field[] |
getConfigFields() |
java.lang.Integer |
getFetchIntervalSec()
(only relevant if the format supports delta updates) the interval in which the graph source is queried for changes
|
FilterExpressionConfig |
getFilter()
if not
null , load subgraph specified by this filter |
FilterStrategy |
getFilterStrategy()
the strategy to process the filter
|
java.util.Map<java.lang.String,java.lang.Object> |
getLeftoverValues()
Gets the values that do not belong to any field.
|
java.lang.Integer |
getLoadingProgressReportingFrequency()
indicates at what frequency the loading of vertices and edges should be logged.
|
java.lang.String |
getPropertyValueDelimiter()
if
null read the whole string value as label. |
SnapshotsSource |
getSnapshotsSource()
source of graph snapshots: if
REFRESH , new snapshots can be created only by reading the graph again via this config (e.g., with `readGraphWithProperties`), or equivalently via auto-refresh if enabled; if CHANGE_SET , new snapshots can be added only via changesets by any session. |
java.lang.Integer |
getUpdateIntervalSec()
the interval in which a new snapshot is created, either by reloading the entire graph or if the format supports delta-updates, out of the cached changes.
|
java.lang.Integer |
getUpdateThreshold()
(only relevant if the format supports delta updates) the maximum number of changes that are cached before a new snapshot is created.
|
java.lang.String |
getUseVertexPropertyValueAsLabel()
load the given property as vertex label.
|
java.util.Map<GraphLoadingConfig.Field,java.lang.Object> |
getValues()
Gets the parsed values.
|
java.util.Map<GraphLoadingConfig.Field,java.lang.Object> |
getValuesWithoutDefaults()
Gets the values without defaults.
|
boolean |
hasDefaultValue(GraphLoadingConfig.Field field)
Checks for default value.
|
java.lang.Boolean |
isAutoRefresh()
if
true the graph gets refreshed automatically in periodic intervals. |
java.lang.Boolean |
isCreateEdgeIdIndex()
if
true , an index is prepared during loading which enables retrieval of edge paths |
java.lang.Boolean |
isCreateEdgeIdMapping()
if
true , a mapping is prepared during loading which enables edge key arguments and filters containing edge keys |
java.lang.Boolean |
isCreateLabelHistogram()
whether a label histogram needs to be generated when the graph is loaded
|
java.lang.Boolean |
isCreateVertexIdIndex()
if
true , an index is prepared during loading which enables retrieval of vertex paths |
java.lang.Boolean |
isCreateVertexIdMapping()
if
true , a mapping is prepared during loading which enables vertex arguments and vertex filters |
boolean |
isEmpty()
Checks if it's empty.
|
java.lang.Boolean |
isPartitionDiscardDefaultValues()
[relevant for partition_while_loading]when partition_while_loading is specified, if set to
by_label , the properties that contain only default values are removed from vertex and edge providers. |
java.lang.Boolean |
isStrictMode()
if
true , exceptions are thrown and logged with ERROR level whenever loader encounters problems with input file, such as invalid format, repeated keys, missing fields, mismatches and other potential errors. |
java.lang.Boolean |
isUpdatePropertiesInPlace()
if
true , non-structural updates get applied to the graph in-place, else non-structural updates also cause new snapshots of the graph to be created. |
java.lang.Boolean |
loadEdgeLabel()
whether or not to load the edge label if it is available
|
java.lang.Boolean |
loadVertexLabels()
whether or not to load the vertex label if it is available
|
static GraphLoadingConfig |
parse(java.io.InputStream is, boolean strict, java.lang.String parentPath)
Parses an input stream.
|
static GraphLoadingConfig |
parse(java.util.Map<java.lang.String,java.lang.Object> raw, boolean strict, java.lang.String parentPath)
Parses a raw key/value mapping.
|
static GraphLoadingConfig |
parse(java.util.Properties props, boolean strict)
Parses a properties file.
|
java.lang.Boolean |
skipEdges()
whether or not to load the edges
|
java.lang.Boolean |
skipVertices()
whether or not to load the vertices
|
java.lang.String |
toString() |
java.lang.String |
toString(boolean hideSensitiveData) |
getDefault, getValueFromEnvironment, getValueFromEnvironment, parseString, setSerializable
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public static GraphLoadingConfig.Field[] getConfigFields()
public java.lang.Integer getFetchIntervalSec()
public FilterExpressionConfig getFilter()
null
, load subgraph specified by this filterpublic FilterStrategy getFilterStrategy()
public java.util.Map<java.lang.String,java.lang.Object> getLeftoverValues()
public java.lang.Integer getLoadingProgressReportingFrequency()
public java.lang.String getPropertyValueDelimiter()
null
read the whole string value as label. Otherwise, split the string using the specified delimiter and use all values as vertex labelspublic SnapshotsSource getSnapshotsSource()
REFRESH
, new snapshots can be created only by reading the graph again via this config (e.g., with `readGraphWithProperties`), or equivalently via auto-refresh if enabled; if CHANGE_SET
, new snapshots can be added only via changesets by any session. Note: CHANGE_SET is not compatible with auto-refreshpublic java.lang.Integer getUpdateIntervalSec()
update_interval_sec
and update_threshold
must be setpublic java.lang.Integer getUpdateThreshold()
update_interval_sec
and update_threshold
must be setpublic java.lang.String getUseVertexPropertyValueAsLabel()
public java.util.Map<GraphLoadingConfig.Field,java.lang.Object> getValues()
getValues
in class AbstractConfig
public java.util.Map<GraphLoadingConfig.Field,java.lang.Object> getValuesWithoutDefaults()
public boolean hasDefaultValue(GraphLoadingConfig.Field field)
field
- the fieldpublic java.lang.Boolean isAutoRefresh()
true
the graph gets refreshed automatically in periodic intervals. Note: Depending on the global settings, only fixed (pre-loaded) graphs can be auto-refreshedpublic java.lang.Boolean isCreateEdgeIdIndex()
true
, an index is prepared during loading which enables retrieval of edge pathspublic java.lang.Boolean isCreateEdgeIdMapping()
true
, a mapping is prepared during loading which enables edge key arguments and filters containing edge keyspublic java.lang.Boolean isCreateLabelHistogram()
public java.lang.Boolean isCreateVertexIdIndex()
true
, an index is prepared during loading which enables retrieval of vertex pathspublic java.lang.Boolean isCreateVertexIdMapping()
true
, a mapping is prepared during loading which enables vertex arguments and vertex filterspublic boolean isEmpty()
public java.lang.Boolean isPartitionDiscardDefaultValues()
by_label
, the properties that contain only default values are removed from vertex and edge providers.public java.lang.Boolean isStrictMode()
true
, exceptions are thrown and logged with ERROR
level whenever loader encounters problems with input file, such as invalid format, repeated keys, missing fields, mismatches and other potential errors. If false
, loader may use less memory during loading phase, but behave unexpectedly with erratic input filespublic java.lang.Boolean isUpdatePropertiesInPlace()
true
, non-structural updates get applied to the graph in-place, else non-structural updates also cause new snapshots of the graph to be created.public java.lang.Boolean loadEdgeLabel()
public java.lang.Boolean loadVertexLabels()
public static GraphLoadingConfig parse(java.io.InputStream is, boolean strict, java.lang.String parentPath) throws java.io.IOException
is
- the input streamstrict
- if true, parses in strict modeparentPath
- if not null, resolves relative paths against this parentPathjava.io.IOException
- Signals that an I/O exception has occurred.public static GraphLoadingConfig parse(java.util.Map<java.lang.String,java.lang.Object> raw, boolean strict, java.lang.String parentPath)
raw
- the raw key/value mapping to parsestrict
- if true, parses in strict modeparentPath
- if not null, resolves relative paths against this parentPathpublic static GraphLoadingConfig parse(java.util.Properties props, boolean strict)
props
- the properties to parsestrict
- if true, parses in strict modepublic java.lang.Boolean skipEdges()
public java.lang.Boolean skipVertices()
public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String toString(boolean hideSensitiveData)