Package com.eventstore.dbclient

Class DeleteStreamOptions

java.lang.Object

com.eventstore.dbclient.DeleteStreamOptions

public class DeleteStreamOptions
extends Object

Options of the delete or tombstone stream request.

Method Summary

Modifier and Type	Method	Description
DeleteStreamOptions	authenticated(UserCredentials credentials)	Sets user credentials for the request
DeleteStreamOptions	authenticated(String login, String password)	Sets user credentials for the request
DeleteStreamOptions	deadline(long durationInMs)	A length of time (in milliseconds) to use for gRPC deadlines.
DeleteStreamOptions	expectedRevision(long revision)	Asks the server to check that the stream receiving is at the given expected version.
DeleteStreamOptions	expectedRevision(ExpectedRevision revision)	Asks the server to check that the stream receiving is at the given expected version.
static DeleteStreamOptions	get()	Returns options with default values.
DeleteStreamOptions	header(String key, String value)	Adds a custom HTTP header that will be added to the request.
DeleteStreamOptions	notRequireLeader()	Do not require the request to be performed by the leader of the cluster.
DeleteStreamOptions	requiresLeader()	Requires the request to be performed by the leader of the cluster.
DeleteStreamOptions	requiresLeader(boolean value)	If true, requires the request to be performed by the leader of the cluster.

Methods inherited from class java.lang.Object

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

Method Details

get

public static DeleteStreamOptions get()

Returns options with default values.

expectedRevision

public DeleteStreamOptions expectedRevision(ExpectedRevision revision)

Asks the server to check that the stream receiving is at the given expected version.

Parameters:

revision - - expected revision.

Returns:

updated options.

expectedRevision

public DeleteStreamOptions expectedRevision(long revision)

Asks the server to check that the stream receiving is at the given expected version.

Parameters:

revision - - expected revision.

Returns:

updated options.

authenticated

public DeleteStreamOptions authenticated(UserCredentials credentials)

Sets user credentials for the request

Parameters:

credentials -

Returns:

updated options

See Also:

• UserCredentials

authenticated

public DeleteStreamOptions authenticated(String login,
 String password)

Sets user credentials for the request

Parameters:

login -

password -

Returns:

updated options

requiresLeader

public DeleteStreamOptions requiresLeader()

Requires the request to be performed by the leader of the cluster.

Returns:

updated options

notRequireLeader

public DeleteStreamOptions notRequireLeader()

Do not require the request to be performed by the leader of the cluster.

Returns:

updated options

requiresLeader

public DeleteStreamOptions requiresLeader(boolean value)

If true, requires the request to be performed by the leader of the cluster.

Parameters:

value -

Returns:

updated options

deadline

public DeleteStreamOptions deadline(long durationInMs)

A length of time (in milliseconds) to use for gRPC deadlines.

Parameters:

durationInMs -

Returns:

header

public DeleteStreamOptions header(String key,
 String value)

Adds a custom HTTP header that will be added to the request.