com.arangodb.model

Class LogOptions

java.lang.Object

com.arangodb.model.LogOptions

public class LogOptions
extends Object

Author:

Mark Vollmary

See Also:

API Documentation

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LogOptions.SortOrder

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROPERTY_LEVEL
static String	PROPERTY_OFFSET
static String	PROPERTY_SEARCH
static String	PROPERTY_SIZE
static String	PROPERTY_SORT
static String	PROPERTY_START
static String	PROPERTY_UPTO

Constructor Summary

Constructors

Constructor and Description
LogOptions()

Method Summary

Modifier and Type	Method and Description
LogLevel	getLevel()
Integer	getOffset()
String	getSearch()
Integer	getSize()
LogOptions.SortOrder	getSort()
Long	getStart()
LogLevel	getUpto()
LogOptions	level(LogLevel level)
LogOptions	offset(Integer offset)
LogOptions	search(String search)
LogOptions	size(Integer size)
LogOptions	sort(LogOptions.SortOrder sort)
LogOptions	start(Long start)
LogOptions	upto(LogLevel upto)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PROPERTY_UPTO

public static final String PROPERTY_UPTO

See Also:

Constant Field Values

PROPERTY_LEVEL

public static final String PROPERTY_LEVEL

See Also:

Constant Field Values

PROPERTY_START

public static final String PROPERTY_START

See Also:

Constant Field Values

PROPERTY_SIZE

public static final String PROPERTY_SIZE

See Also:

Constant Field Values

PROPERTY_OFFSET

public static final String PROPERTY_OFFSET

See Also:

Constant Field Values

PROPERTY_SEARCH

public static final String PROPERTY_SEARCH

See Also:

Constant Field Values

PROPERTY_SORT

public static final String PROPERTY_SORT

See Also:

Constant Field Values

Constructor Detail

LogOptions

public LogOptions()

Method Detail

getUpto

public LogLevel getUpto()

upto

public LogOptions upto(LogLevel upto)

Parameters:

upto - Returns all log entries up to log level upto

Returns:

options

getLevel

public LogLevel getLevel()

level

public LogOptions level(LogLevel level)

Parameters:

level - Returns all log entries of log level level. Note that the query parameters upto and level are mutually exclusive

Returns:

options

getStart

public Long getStart()

start

public LogOptions start(Long start)

Parameters:

start - Returns all log entries such that their log entry identifier (lid value) is greater or equal to start

Returns:

options

getSize

public Integer getSize()

size

public LogOptions size(Integer size)

Parameters:

size - Restricts the result to at most size log entries

Returns:

options

getOffset

public Integer getOffset()

offset

public LogOptions offset(Integer offset)

Parameters:

offset - Starts to return log entries skipping the first offset log entries. offset and size can be used for pagination

Returns:

options

getSearch

public String getSearch()

search

public LogOptions search(String search)

Parameters:

search - Only return the log entries containing the text specified in search

Returns:

options

getSort

public LogOptions.SortOrder getSort()

sort

public LogOptions sort(LogOptions.SortOrder sort)

Parameters:

sort - Sort the log entries either ascending (if sort is asc) or descending (if sort is desc) according to their lid values. Note that the lid imposes a chronological order. The default value is asc

Returns:

options