Package com.eventstore.dbclient
Class DeleteStreamOptions
- java.lang.Object
-
- com.eventstore.dbclient.DeleteStreamOptions
-
public class DeleteStreamOptions extends java.lang.Object
Options of the delete or tombstone stream request.
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description T
authenticated(UserCredentials credentials)
Sets user credentials for the requestT
authenticated(java.lang.String login, java.lang.String password)
Sets user credentials for the requestT
deadline(long durationInMs)
A length of time (in milliseconds) to use for gRPC deadlines.T
expectedRevision(long revision)
Asks the server to check that the stream receiving is at the given expected version.T
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.T
notRequireLeader()
Do not require the request to be performed by the leader of the cluster.T
requiresLeader()
Requires the request to be performed by the leader of the cluster.T
requiresLeader(boolean value)
If true, requires the request to be performed by the leader of the cluster.
-
-
-
Method Detail
-
get
public static DeleteStreamOptions get()
Returns options with default values.
-
expectedRevision
public T 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 T 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 T authenticated(UserCredentials credentials)
Sets user credentials for the request- Parameters:
credentials
-- Returns:
- updated options
- See Also:
UserCredentials
-
authenticated
public T authenticated(java.lang.String login, java.lang.String password)
Sets user credentials for the request- Parameters:
login
-password
-- Returns:
- updated options
-
requiresLeader
public T requiresLeader()
Requires the request to be performed by the leader of the cluster.- Returns:
- updated options
-
notRequireLeader
public T notRequireLeader()
Do not require the request to be performed by the leader of the cluster.- Returns:
- updated options
-
requiresLeader
public T requiresLeader(boolean value)
If true, requires the request to be performed by the leader of the cluster.- Parameters:
value
-- Returns:
- updated options
-
deadline
public T deadline(long durationInMs)
A length of time (in milliseconds) to use for gRPC deadlines.- Parameters:
durationInMs
-- Returns:
-
-