Skip to content

Commit fe24764

Browse files
author
Mark
committed
added graph create javadoc
1 parent ecd649d commit fe24764

File tree

1 file changed

+21
-2
lines changed

1 file changed

+21
-2
lines changed

src/main/java/com/arangodb/model/GraphCreateOptions.java

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,12 @@ public Boolean getIsSmart() {
8888
return isSmart;
8989
}
9090

91+
/**
92+
*
93+
* @param isSmart
94+
* Define if the created graph should be smart. This only has effect in Enterprise version.
95+
* @return options
96+
*/
9197
public GraphCreateOptions isSmart(final Boolean isSmart) {
9298
this.isSmart = isSmart;
9399
return this;
@@ -97,16 +103,29 @@ public Integer getNumberOfShards() {
97103
return getOptions().getNumberOfShards();
98104
}
99105

100-
public void numberOfShards(final Integer numberOfShards) {
106+
/**
107+
* @param numberOfShards
108+
* The number of shards that is used for every collection within this graph. Cannot be modified later.
109+
* @return options
110+
*/
111+
public GraphCreateOptions numberOfShards(final Integer numberOfShards) {
101112
getOptions().setNumberOfShards(numberOfShards);
113+
return this;
102114
}
103115

104116
public String getSmartGraphAttribute() {
105117
return getOptions().getSmartGraphAttribute();
106118
}
107119

108-
public void smartGraphAttribute(final String smartGraphAttribute) {
120+
/**
121+
* @param smartGraphAttribute
122+
* The attribute name that is used to smartly shard the vertices of a graph. Every vertex in this Graph
123+
* has to have this attribute. Cannot be modified later.
124+
* @return options
125+
*/
126+
public GraphCreateOptions smartGraphAttribute(final String smartGraphAttribute) {
109127
getOptions().setSmartGraphAttribute(smartGraphAttribute);
128+
return this;
110129
}
111130

112131
private SmartOptions getOptions() {

0 commit comments

Comments
 (0)