io.redisearch.client

Class AddOptions

java.lang.Object

io.redisearch.client.AddOptions

public class AddOptions
extends Object

Created by mnunberg on 2/15/18. This class represents options which may be passed when adding a document

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AddOptions.ReplacementPolicy

Constructor Summary

Constructors

Constructor and Description
AddOptions() Create a new DocumentOptions object.

Method Summary

Modifier and Type	Method and Description
AddOptions	setLanguage(String language) Set the indexing language
AddOptions	setNosave() Indicate that the document's contents should not be stored in the database.
AddOptions	setNosave(boolean enabled) Whether document's contents should not be stored in the database.
AddOptions	setReplacementPolicy(AddOptions.ReplacementPolicy mode) Indicate the behavior for the existing document.

Methods inherited from class java.lang.Object

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

Constructor Detail

AddOptions

public AddOptions()

Create a new DocumentOptions object. Methods can later be chained via a builder-like pattern

Method Detail

setLanguage

public AddOptions setLanguage(String language)

Set the indexing language

Parameters:

language - The language the document should be stemmed as.

Returns:

the AddOptions object for further options

setNosave

public AddOptions setNosave()

Indicate that the document's contents should not be stored in the database. This saves disk/memory space on the server but prevents retrieving the document itself.

Returns:

the AddOptions object for further options

setNosave

public AddOptions setNosave(boolean enabled)

Whether document's contents should not be stored in the database.

Parameters:

enabled - if enabled, the document is not stored on the server. This saves disk/memory space on the server but prevents retrieving the document itself.

Returns:

the AddOptions object for further options

setReplacementPolicy

public AddOptions setReplacementPolicy(AddOptions.ReplacementPolicy mode)

Indicate the behavior for the existing document.

Parameters:

mode - One of the replacement modes

Returns:

the AddOptions object for further options