Package org.neo4j.gds.config

Interface GraphProjectConfig

All Superinterfaces:

org.neo4j.gds.config.BaseConfig, org.neo4j.gds.config.JobIdConfig, org.neo4j.gds.config.ToMapConvertible

All Known Subinterfaces:

GraphProjectFromCypherConfig, GraphProjectFromGraphConfig, GraphProjectFromStoreConfig, GraphSampleProcConfig, RandomGraphGeneratorConfig

public interface GraphProjectConfig
extends org.neo4j.gds.config.BaseConfig, org.neo4j.gds.config.JobIdConfig

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	GraphProjectConfig.Cases<R>
static interface	GraphProjectConfig.Visitor

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	IMPLICIT_GRAPH_NAME
static java.lang.String	NODE_COUNT_KEY
static java.lang.String	READ_CONCURRENCY_KEY
static java.lang.String	RELATIONSHIP_COUNT_KEY
static java.lang.String	VALIDATE_RELATIONSHIPS_KEY

Fields inherited from interface org.neo4j.gds.config.BaseConfig

LOG_PROGRESS_KEY, SUDO_KEY

Method Summary

Modifier and Type	Method	Description
<R> R	accept(GraphProjectConfig.Cases<R> visitor)
static GraphProjectConfig	createImplicit(java.lang.String username, org.neo4j.gds.core.CypherMapWrapper config)
default java.time.ZonedDateTime	creationTime()
java.lang.String	graphName()
GraphStoreFactory.Supplier	graphStoreFactory()
default boolean	isFictitiousLoading()
default long	nodeCount()
default int	readConcurrency()
default long	relationshipCount()
default java.lang.String	username()
static @Nullable java.lang.String	validateName(java.lang.String input)
default void	validateReadConcurrency()
default boolean	validateRelationships()

Methods inherited from interface org.neo4j.gds.config.BaseConfig

configKeys, logProgress, sudo, toMap, usernameOverride

Methods inherited from interface org.neo4j.gds.config.JobIdConfig

jobId

Field Detail

IMPLICIT_GRAPH_NAME

static final java.lang.String IMPLICIT_GRAPH_NAME

See Also:

Constant Field Values

NODE_COUNT_KEY

static final java.lang.String NODE_COUNT_KEY

See Also:

Constant Field Values

RELATIONSHIP_COUNT_KEY

static final java.lang.String RELATIONSHIP_COUNT_KEY

See Also:

Constant Field Values

READ_CONCURRENCY_KEY

static final java.lang.String READ_CONCURRENCY_KEY

See Also:

Constant Field Values

VALIDATE_RELATIONSHIPS_KEY

static final java.lang.String VALIDATE_RELATIONSHIPS_KEY

See Also:

Constant Field Values

Method Detail

username

@Parameter
@Default
default java.lang.String username()

graphName

@Parameter
@ConvertWith(method="validateName")
java.lang.String graphName()

readConcurrency

@Default
@Parameter(false)
@Key("readConcurrency")
default int readConcurrency()

nodeCount

@Default
@Parameter(false)
@Key("nodeCount")
default long nodeCount()

relationshipCount

@Default
@Parameter(false)
@Key("relationshipCount")
default long relationshipCount()

isFictitiousLoading

@Parameter(false)
@Ignore
default boolean isFictitiousLoading()

creationTime

@Derived
@Auxiliary
default java.time.ZonedDateTime creationTime()

validateRelationships

@Default
@Parameter(false)
@Key("validateRelationships")
default boolean validateRelationships()

graphStoreFactory

@Ignore
GraphStoreFactory.Supplier graphStoreFactory()

validateReadConcurrency

@Check
default void validateReadConcurrency()

accept

@Ignore
<R> R accept(GraphProjectConfig.Cases<R> visitor)

validateName

@Nullable
static @Nullable java.lang.String validateName(java.lang.String input)

createImplicit

static GraphProjectConfig createImplicit(java.lang.String username,
                                         org.neo4j.gds.core.CypherMapWrapper config)