TraverseSpec (client 3.0.0 API)

java.lang.Object
- com.vesoft.nebula.storage.TraverseSpec

All Implemented Interfaces:: com.facebook.thrift.TBase, Serializable, Cloneable, Comparable<TraverseSpec>

public class TraverseSpec
extends Object
implements com.facebook.thrift.TBase, Serializable, Cloneable, Comparable<TraverseSpec>

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class TraverseSpec.Builder

Nested Classes
Modifier and Type	Class and Description
`static class`	`TraverseSpec.Builder`

Field Summary

Fields
Modifier and Type	Field and Description
`boolean`	`dedup`
`static int`	`DEDUP`
`EdgeDirection`	`edge_direction`
`static int`	`EDGE_DIRECTION`
`List<EdgeProp>`	`edge_props`
`static int`	`EDGE_PROPS`
`List<Integer>`	`edge_types`
`static int`	`EDGE_TYPES`
`List<Expr>`	`expressions`
`static int`	`EXPRESSIONS`
`byte[]`	`filter`
`static int`	`FILTER`
`long`	`limit`
`static int`	`LIMIT`
`static Map<Integer,com.facebook.thrift.meta_data.FieldMetaData>`	`metaDataMap`
`List<OrderBy>`	`order_by`
`static int`	`ORDER_BY`
`boolean`	`random`
`static int`	`RANDOM`
`List<StatProp>`	`stat_props`
`static int`	`STAT_PROPS`
`List<VertexProp>`	`vertex_props`
`static int`	`VERTEX_PROPS`

Constructor Summary

Constructors
Constructor and Description
`TraverseSpec()`
`TraverseSpec(List<Integer> edge_types, EdgeDirection edge_direction, boolean dedup)`
`TraverseSpec(List<Integer> edge_types, EdgeDirection edge_direction, boolean dedup, List<StatProp> stat_props, List<VertexProp> vertex_props, List<EdgeProp> edge_props, List<Expr> expressions, List<OrderBy> order_by, boolean random, long limit, byte[] filter)`
`TraverseSpec(TraverseSpec other)` Performs a deep copy on other.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static TraverseSpec.Builder`	`builder()`
`int`	`compareTo(TraverseSpec other)`
`TraverseSpec`	`deepCopy()` Returns a copy of `this`.
`boolean`	`equals(Object _that)`
`EdgeDirection`	`getEdge_direction()`
`List<EdgeProp>`	`getEdge_props()`
`List<Integer>`	`getEdge_types()`
`List<Expr>`	`getExpressions()`
`Object`	`getFieldValue(int fieldID)`
`byte[]`	`getFilter()`
`long`	`getLimit()`
`List<OrderBy>`	`getOrder_by()`
`List<StatProp>`	`getStat_props()`
`List<VertexProp>`	`getVertex_props()`
`int`	`hashCode()`
`boolean`	`isDedup()`
`boolean`	`isRandom()`
`boolean`	`isSetDedup()`
`boolean`	`isSetEdge_direction()`
`boolean`	`isSetEdge_props()`
`boolean`	`isSetEdge_types()`
`boolean`	`isSetExpressions()`
`boolean`	`isSetFilter()`
`boolean`	`isSetLimit()`
`boolean`	`isSetOrder_by()`
`boolean`	`isSetRandom()`
`boolean`	`isSetStat_props()`
`boolean`	`isSetVertex_props()`
`void`	`read(com.facebook.thrift.protocol.TProtocol iprot)` Reads the TObject from the given input protocol.
`TraverseSpec`	`setDedup(boolean dedup)`
`void`	`setDedupIsSet(boolean __value)`
`TraverseSpec`	`setEdge_direction(EdgeDirection edge_direction)`
`void`	`setEdge_directionIsSet(boolean __value)`
`TraverseSpec`	`setEdge_props(List<EdgeProp> edge_props)`
`void`	`setEdge_propsIsSet(boolean __value)`
`TraverseSpec`	`setEdge_types(List<Integer> edge_types)`
`void`	`setEdge_typesIsSet(boolean __value)`
`TraverseSpec`	`setExpressions(List<Expr> expressions)`
`void`	`setExpressionsIsSet(boolean __value)`
`void`	`setFieldValue(int fieldID, Object __value)`
`TraverseSpec`	`setFilter(byte[] filter)`
`void`	`setFilterIsSet(boolean __value)`
`TraverseSpec`	`setLimit(long limit)`
`void`	`setLimitIsSet(boolean __value)`
`TraverseSpec`	`setOrder_by(List<OrderBy> order_by)`
`void`	`setOrder_byIsSet(boolean __value)`
`TraverseSpec`	`setRandom(boolean random)`
`void`	`setRandomIsSet(boolean __value)`
`TraverseSpec`	`setStat_props(List<StatProp> stat_props)`
`void`	`setStat_propsIsSet(boolean __value)`
`TraverseSpec`	`setVertex_props(List<VertexProp> vertex_props)`
`void`	`setVertex_propsIsSet(boolean __value)`
`String`	`toString()`
`String`	`toString(int indent, boolean prettyPrint)` Creates an indented String representation for pretty printing
`void`	`unsetDedup()`
`void`	`unsetEdge_direction()`
`void`	`unsetEdge_props()`
`void`	`unsetEdge_types()`
`void`	`unsetExpressions()`
`void`	`unsetFilter()`
`void`	`unsetLimit()`
`void`	`unsetOrder_by()`
`void`	`unsetRandom()`
`void`	`unsetStat_props()`
`void`	`unsetVertex_props()`
`void`	`validate()`
`void`	`write(com.facebook.thrift.protocol.TProtocol oprot)` Writes the objects out to the protocol

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

edge_types
```
public List<Integer> edge_types
```

edge_direction
```
public EdgeDirection edge_direction
```
See Also:

EdgeDirection

dedup
```
public boolean dedup
```

stat_props
```
public List<StatProp> stat_props
```

vertex_props
```
public List<VertexProp> vertex_props
```

edge_props
```
public List<EdgeProp> edge_props
```

expressions
```
public List<Expr> expressions
```

order_by
```
public List<OrderBy> order_by
```

random
```
public boolean random
```

limit
```
public long limit
```

filter
```
public byte[] filter
```

EDGE_TYPES
```
public static final int EDGE_TYPES
```
See Also:

Constant Field Values

EDGE_DIRECTION
```
public static final int EDGE_DIRECTION
```
See Also:

Constant Field Values

DEDUP
```
public static final int DEDUP
```
See Also:

Constant Field Values

STAT_PROPS
```
public static final int STAT_PROPS
```
See Also:

Constant Field Values

VERTEX_PROPS
```
public static final int VERTEX_PROPS
```
See Also:

Constant Field Values

EDGE_PROPS
```
public static final int EDGE_PROPS
```
See Also:

Constant Field Values

EXPRESSIONS
```
public static final int EXPRESSIONS
```
See Also:

Constant Field Values

ORDER_BY
```
public static final int ORDER_BY
```
See Also:

Constant Field Values

RANDOM
```
public static final int RANDOM
```
See Also:

Constant Field Values

LIMIT
```
public static final int LIMIT
```
See Also:

Constant Field Values

FILTER
```
public static final int FILTER
```
See Also:

Constant Field Values

metaDataMap

public static final Map<Integer,com.facebook.thrift.meta_data.FieldMetaData> metaDataMap

Constructor Detail

TraverseSpec
```
public TraverseSpec()
```

TraverseSpec

public TraverseSpec(List<Integer> edge_types,
                    EdgeDirection edge_direction,
                    boolean dedup)

TraverseSpec

public TraverseSpec(List<Integer> edge_types,
                    EdgeDirection edge_direction,
                    boolean dedup,
                    List<StatProp> stat_props,
                    List<VertexProp> vertex_props,
                    List<EdgeProp> edge_props,
                    List<Expr> expressions,
                    List<OrderBy> order_by,
                    boolean random,
                    long limit,
                    byte[] filter)

TraverseSpec

public TraverseSpec(TraverseSpec other)

Performs a deep copy on other.

Method Detail

builder

public static TraverseSpec.Builder builder()

deepCopy
```
public TraverseSpec deepCopy()
```
Description copied from interface: com.facebook.thrift.TBase

Returns a copy of `this`. The type of the returned object should be the same as the type of this; that is, x.getClass() == x.deepCopy().getClass() should be true for any TBase.

Specified by:

deepCopy in interface com.facebook.thrift.TBase

getEdge_types
```
public List<Integer> getEdge_types()
```

setEdge_types

public TraverseSpec setEdge_types(List<Integer> edge_types)

unsetEdge_types
```
public void unsetEdge_types()
```

isSetEdge_types
```
public boolean isSetEdge_types()
```

setEdge_typesIsSet

public void setEdge_typesIsSet(boolean __value)

getEdge_direction

public EdgeDirection getEdge_direction()

See Also:: EdgeDirection

setEdge_direction

public TraverseSpec setEdge_direction(EdgeDirection edge_direction)

See Also:: EdgeDirection

unsetEdge_direction
```
public void unsetEdge_direction()
```

isSetEdge_direction
```
public boolean isSetEdge_direction()
```

setEdge_directionIsSet

public void setEdge_directionIsSet(boolean __value)

isDedup
```
public boolean isDedup()
```

setDedup

public TraverseSpec setDedup(boolean dedup)

unsetDedup
```
public void unsetDedup()
```

isSetDedup
```
public boolean isSetDedup()
```

setDedupIsSet

public void setDedupIsSet(boolean __value)

getStat_props
```
public List<StatProp> getStat_props()
```

setStat_props

public TraverseSpec setStat_props(List<StatProp> stat_props)

unsetStat_props
```
public void unsetStat_props()
```

isSetStat_props
```
public boolean isSetStat_props()
```

setStat_propsIsSet

public void setStat_propsIsSet(boolean __value)

getVertex_props

public List<VertexProp> getVertex_props()

setVertex_props

public TraverseSpec setVertex_props(List<VertexProp> vertex_props)

unsetVertex_props
```
public void unsetVertex_props()
```

isSetVertex_props
```
public boolean isSetVertex_props()
```

setVertex_propsIsSet

public void setVertex_propsIsSet(boolean __value)

getEdge_props
```
public List<EdgeProp> getEdge_props()
```

setEdge_props

public TraverseSpec setEdge_props(List<EdgeProp> edge_props)

unsetEdge_props
```
public void unsetEdge_props()
```

isSetEdge_props
```
public boolean isSetEdge_props()
```

setEdge_propsIsSet

public void setEdge_propsIsSet(boolean __value)

getExpressions
```
public List<Expr> getExpressions()
```

setExpressions

public TraverseSpec setExpressions(List<Expr> expressions)

unsetExpressions
```
public void unsetExpressions()
```

isSetExpressions
```
public boolean isSetExpressions()
```

setExpressionsIsSet

public void setExpressionsIsSet(boolean __value)

getOrder_by
```
public List<OrderBy> getOrder_by()
```

setOrder_by

public TraverseSpec setOrder_by(List<OrderBy> order_by)

unsetOrder_by
```
public void unsetOrder_by()
```

isSetOrder_by
```
public boolean isSetOrder_by()
```

setOrder_byIsSet

public void setOrder_byIsSet(boolean __value)

isRandom
```
public boolean isRandom()
```

setRandom

public TraverseSpec setRandom(boolean random)

unsetRandom
```
public void unsetRandom()
```

isSetRandom
```
public boolean isSetRandom()
```

setRandomIsSet

public void setRandomIsSet(boolean __value)

getLimit
```
public long getLimit()
```

setLimit

public TraverseSpec setLimit(long limit)

unsetLimit
```
public void unsetLimit()
```

isSetLimit
```
public boolean isSetLimit()
```

setLimitIsSet

public void setLimitIsSet(boolean __value)

getFilter
```
public byte[] getFilter()
```

setFilter

public TraverseSpec setFilter(byte[] filter)

unsetFilter
```
public void unsetFilter()
```

isSetFilter
```
public boolean isSetFilter()
```

setFilterIsSet

public void setFilterIsSet(boolean __value)

setFieldValue

public void setFieldValue(int fieldID,
                          Object __value)

getFieldValue

public Object getFieldValue(int fieldID)

equals
```
public boolean equals(Object _that)
```
Overrides:

equals in class Object

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

compareTo
```
public int compareTo(TraverseSpec other)
```
Specified by:

compareTo in interface Comparable<TraverseSpec>

read
```
public void read(com.facebook.thrift.protocol.TProtocol iprot)
          throws com.facebook.thrift.TException
```
Description copied from interface: com.facebook.thrift.TBase

Reads the TObject from the given input protocol.

Specified by:

read in interface com.facebook.thrift.TBase

Parameters:

iprot - Input protocol

Throws:

com.facebook.thrift.TException

write
```
public void write(com.facebook.thrift.protocol.TProtocol oprot)
           throws com.facebook.thrift.TException
```
Description copied from interface: com.facebook.thrift.TBase

Writes the objects out to the protocol

Specified by:

write in interface com.facebook.thrift.TBase

Parameters:

oprot - Output protocol

Throws:

com.facebook.thrift.TException

toString
```
public String toString()
```
Overrides:

toString in class Object

toString
```
public String toString(int indent,
                       boolean prettyPrint)
```
Description copied from interface: com.facebook.thrift.TBase

Creates an indented String representation for pretty printing

Specified by:

toString in interface com.facebook.thrift.TBase

Parameters:

indent - The level of indentation desired

prettyPrint - Set pretty printing on/off

validate

public void validate()
              throws com.facebook.thrift.TException

Throws:: com.facebook.thrift.TException

Class TraverseSpec

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

edge_types

edge_direction

dedup

stat_props

vertex_props

edge_props

expressions

order_by

random

limit

filter

EDGE_TYPES

EDGE_DIRECTION

DEDUP

STAT_PROPS

VERTEX_PROPS

EDGE_PROPS

EXPRESSIONS

ORDER_BY

RANDOM

LIMIT

FILTER

metaDataMap

Constructor Detail

TraverseSpec

TraverseSpec

TraverseSpec

TraverseSpec

Method Detail

builder

deepCopy

getEdge_types

setEdge_types

unsetEdge_types

isSetEdge_types

setEdge_typesIsSet

getEdge_direction

setEdge_direction

unsetEdge_direction

isSetEdge_direction

setEdge_directionIsSet

isDedup

setDedup

unsetDedup

isSetDedup

setDedupIsSet

getStat_props

setStat_props

unsetStat_props

isSetStat_props

setStat_propsIsSet

getVertex_props

setVertex_props

unsetVertex_props

isSetVertex_props

setVertex_propsIsSet

getEdge_props

setEdge_props

unsetEdge_props

isSetEdge_props

setEdge_propsIsSet

getExpressions

setExpressions

unsetExpressions

isSetExpressions

setExpressionsIsSet

getOrder_by

setOrder_by

unsetOrder_by

isSetOrder_by

setOrder_byIsSet

isRandom

setRandom