TTLIndexOptions (c84j 1.1.14 API)

java.lang.Object
- com.c8db.model.IndexOptions
- - com.c8db.model.TTLIndexOptions

public class TTLIndexOptions
extends IndexOptions

Index option for Time to live (ttl) index type.

Constructor Summary

Constructors
Constructor Description

TTLIndexOptions()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`TTLIndexOptions`	`expireAfter(Long expireAfter)`
`protected TTLIndexOptions`	`fields(Iterable<String> fields)`
`Long`	`getExpireAfter()`
`protected Iterable<String>`	`getFields()`

Methods inherited from class com.c8db.model.IndexOptions
create, getInBackground, getName, getType, inBackground, name

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

- Constructor Detail
  - TTLIndexOptions
```
public TTLIndexOptions()
```
- Method Detail
  - getFields
```
protected Iterable<String> getFields()
```
  - fields
```
protected TTLIndexOptions fields(Iterable<String> fields)
```
    Parameters:
    
    fields - A list of attribute paths
    
    Returns:
    
    options
  - getExpireAfter
```
public Long getExpireAfter()
```
  - expireAfter
```
public TTLIndexOptions expireAfter(Long expireAfter)
```
    Parameters:
    
    expireAfter - Number of seconds to be added to the timestamp attribute value of each document. If documents have reached their expiration timepoint, they will eventually get deleted by a background process.
    
    Returns:
    
    options