Package org.springframework.data.cassandra.core.cql

Class WriteOptions

java.lang.Object

org.springframework.data.cassandra.core.cql.QueryOptions

org.springframework.data.cassandra.core.cql.WriteOptions

Direct Known Subclasses:

DeleteOptions, InsertOptions, UpdateOptions

public class WriteOptions
extends QueryOptions

Cassandra Write Options are an extension to QueryOptions for write operations. WriteOptions allow tuning of various query options on a per-request level. Only options that are set are applied to queries.

Author:

David Webb, Mark Paluch, Lukasz Antoniak, Tomasz Lelek, Sam Lightfoot

See Also:

• QueryOptions

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WriteOptions.WriteOptionsBuilder	Builder for WriteOptions.

Nested classes/interfaces inherited from class org.springframework.data.cassandra.core.cql.QueryOptions

QueryOptions.QueryOptionsBuilder

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	WriteOptions(com.datastax.oss.driver.api.core.ConsistencyLevel consistencyLevel, ExecutionProfileResolver executionProfileResolver, Boolean idempotent, com.datastax.oss.driver.api.core.CqlIdentifier keyspace, Integer pageSize, com.datastax.oss.driver.api.core.CqlIdentifier routingKeyspace, ByteBuffer routingKey, com.datastax.oss.driver.api.core.ConsistencyLevel serialConsistencyLevel, Duration timeout, Duration ttl, Long timestamp, Boolean tracing)

Method Summary

Modifier and Type	Method	Description
static WriteOptions.WriteOptionsBuilder	builder()	Create a new WriteOptions.WriteOptionsBuilder.
static WriteOptions	empty()	Create default WriteOptions.
boolean	equals(Object o)
Long	getTimestamp()
Duration	getTtl()
int	hashCode()
WriteOptions.WriteOptionsBuilder	mutate()	Create a new WriteOptions.WriteOptionsBuilder to mutate properties of this WriteOptions.

Methods inherited from class org.springframework.data.cassandra.core.cql.QueryOptions

getConsistencyLevel, getExecutionProfileResolver, getKeyspace, getPageSize, getReadTimeout, getRoutingKey, getRoutingKeyspace, getSerialConsistencyLevel, getTimeout, getTracing, isIdempotent

Methods inherited from class java.lang.Object

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

Constructor Details

WriteOptions

protected WriteOptions(@Nullable
 com.datastax.oss.driver.api.core.ConsistencyLevel consistencyLevel,
 ExecutionProfileResolver executionProfileResolver,
 @Nullable
 Boolean idempotent,
 @Nullable
 com.datastax.oss.driver.api.core.CqlIdentifier keyspace,
 @Nullable
 Integer pageSize,
 @Nullable
 com.datastax.oss.driver.api.core.CqlIdentifier routingKeyspace,
 @Nullable
 ByteBuffer routingKey,
 @Nullable
 com.datastax.oss.driver.api.core.ConsistencyLevel serialConsistencyLevel,
 Duration timeout,
 Duration ttl,
 @Nullable
 Long timestamp,
 @Nullable
 Boolean tracing)

Method Details

empty

public static WriteOptions empty()

Create default WriteOptions.

Returns:

default WriteOptions.

Since:

2.0

builder

public static WriteOptions.WriteOptionsBuilder builder()

Create a new WriteOptions.WriteOptionsBuilder.

Returns:

a new WriteOptions.WriteOptionsBuilder.

Since:

1.5

mutate

public WriteOptions.WriteOptionsBuilder mutate()

Create a new WriteOptions.WriteOptionsBuilder to mutate properties of this WriteOptions.

Overrides:

mutate in class QueryOptions

Returns:

a new WriteOptions.WriteOptionsBuilder initialized with this WriteOptions.

Since:

2.0

getTtl

public Duration getTtl()

Returns:

the time to live, if set.

getTimestamp

@Nullable
public Long getTimestamp()

Returns:

mutation timestamp in microseconds.

Since:

2.1

equals

public boolean equals(Object o)

Overrides:

equals in class QueryOptions

hashCode

public int hashCode()

Overrides:

hashCode in class QueryOptions