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:

GraphCatalogConfig, GraphProjectFromGraphConfig, GraphSampleProcConfig, RandomGraphGeneratorConfig

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

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
java.util.Map<java.lang.String,java.lang.Object>	asProcedureResultConfigurationField()
default java.util.Map<java.lang.String,java.lang.Object>	cleansed(java.util.Map<java.lang.String,java.lang.Object> map, java.util.Collection<java.lang.String> keysToIgnore)
default java.time.ZonedDateTime	creationTime()
static GraphProjectConfig	emptyWithName(java.lang.String userName, java.lang.String graphName)
java.lang.String	graphName()
default 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

asProcedureResultConfigurationField

@Ignore
java.util.Map<java.lang.String,java.lang.Object> asProcedureResultConfigurationField()

cleansed

@Ignore
default java.util.Map<java.lang.String,java.lang.Object> cleansed(java.util.Map<java.lang.String,java.lang.Object> map,
                                                                        java.util.Collection<java.lang.String> keysToIgnore)

emptyWithName

static GraphProjectConfig emptyWithName(java.lang.String userName,
                                        java.lang.String graphName)

username

@Parameter
default java.lang.String username()

graphName

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

readConcurrency

@Key("readConcurrency")
default int readConcurrency()

nodeCount

@Key("nodeCount")
default long nodeCount()

relationshipCount

@Key("relationshipCount")
default long relationshipCount()

isFictitiousLoading

@Ignore
default boolean isFictitiousLoading()

creationTime

default java.time.ZonedDateTime creationTime()

validateRelationships

@Key("validateRelationships")
default boolean validateRelationships()

graphStoreFactory

@Ignore
default GraphStoreFactory.Supplier graphStoreFactory()

validateReadConcurrency

@Check
default void validateReadConcurrency()

validateName

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