Package io.vertx.mongo.client.model

Class DeleteOptions

java.lang.Object

io.vertx.mongo.client.model.DeleteOptions

public class DeleteOptions
extends java.lang.Object

The options to apply when deleting documents.

Since:

3.4

MongoDB documentation

Remove documents

Delete Command

Constructor Summary

Constructors

Constructor	Description
DeleteOptions()
DeleteOptions(JsonObject json)

Method Summary

Modifier and Type	Method	Description
Collation	getCollation()	Returns the collation options
JsonObject	getHint()	Gets the hint to apply.
java.lang.String	getHintString()	Gets the hint string to apply.
DeleteOptions	setCollation(Collation collation)	Sets the collation options
DeleteOptions	setHint(JsonObject hint)	Sets the hint to apply.
DeleteOptions	setHintString(java.lang.String hint)	Sets the hint to apply.
JsonObject	toJson()

Methods inherited from class java.lang.Object

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

Constructor Detail

DeleteOptions

public DeleteOptions()

DeleteOptions

public DeleteOptions(JsonObject json)

Method Detail

toJson

public JsonObject toJson()

setCollation

public DeleteOptions setCollation(Collation collation)

Sets the collation options

A null value represents the server default.

Parameters:

collation - the collation options to use

Returns:

this

Since server release

3.4

getCollation

public Collation getCollation()

Returns the collation options

Returns:

the collation options

Since server release

3.4

setHint

public DeleteOptions setHint(JsonObject hint)

Sets the hint to apply.

Parameters:

hint - a document describing the index which should be used for this operation.

Returns:

this

Since:

4.1

Since server release

4.4

getHint

public JsonObject getHint()

Gets the hint to apply.

Returns:

the hint, which should describe an existing index

Since:

4.1

Since server release

4.4

setHintString

public DeleteOptions setHintString(java.lang.String hint)

Sets the hint to apply.

Note: If setHint(JsonObject) is set that will be used instead of any hint string.

Parameters:

hint - the name of the index which should be used for the operation

Returns:

this

Since:

4.1

Since server release

4.4

getHintString

public java.lang.String getHintString()

Gets the hint string to apply.

Returns:

the hint string, which should be the name of an existing index

Since:

4.1

Since server release

4.4