Package com.mongodb.client.model.bulk

Interface ClientDeleteManyOptions

@Sealed
public interface ClientDeleteManyOptions

The options to apply when deleting documents.

Since:

5.3

Method Summary

Modifier and Type	Method	Description
static ClientDeleteManyOptions	clientDeleteManyOptions()	Creates the default options.
ClientDeleteManyOptions	collation(Collation collation)	Sets the collation.
ClientDeleteManyOptions	hint(Bson hint)	Sets the index specification, null-ifies hint string.
ClientDeleteManyOptions	hintString(String hintString)	Sets the index name, null-ifies hint.

Method Details

clientDeleteManyOptions

static ClientDeleteManyOptions clientDeleteManyOptions()

Creates the default options.

Returns:

The default options.

collation

ClientDeleteManyOptions collation(@Nullable
 Collation collation)

Sets the collation.

Parameters:

collation - The collation. null represents the server default.

Returns:

this.

hint

ClientDeleteManyOptions hint(@Nullable
 Bson hint)

Sets the index specification, null-ifies hint string.

Parameters:

hint - The index specification. null represents the server default.

Returns:

this.

hintString

ClientDeleteManyOptions hintString(@Nullable
 String hintString)

Sets the index name, null-ifies hint.

Parameters:

hintString - The index name. null represents the server default.

Returns:

this.