PregelProcedure (pregel 2.0.0-alpha02 API)

@Target(TYPE)
@Retention(CLASS)
public @interface PregelProcedure

Required Element Summary

Required Elements
Modifier and Type Required Element Description

java.lang.String name
The namespace and name for the procedure, as a period-separated string.

Optional Element Summary

Optional Elements
Modifier and Type	Optional Element	Description
`java.lang.String`	`description`	A description of the procedure that can be accessed via Cypher.
`GDSMode[]`	`modes`	The procedure modes to generate.

- Element Detail
  - name
```
java.lang.String name
```
    The namespace and name for the procedure, as a period-separated string. For instance myprocedures.myprocedure.
    
    Returns:
    
    the namespace and procedure name.
- - modes
```
GDSMode[] modes
```
    The procedure modes to generate.
    
    Returns:
    
    procedure modes
    
    Default:
    
    {org.neo4j.gds.beta.pregel.annotation.GDSMode.STREAM, org.neo4j.gds.beta.pregel.annotation.GDSMode.WRITE, org.neo4j.gds.beta.pregel.annotation.GDSMode.MUTATE, org.neo4j.gds.beta.pregel.annotation.GDSMode.STATS}
- - description
```
java.lang.String description
```
    A description of the procedure that can be accessed via Cypher.
    
    Returns:
    
    procedure description
    
    Default:
    
    ""