Package oracle.nosql.driver.ops

Class WriteRequest

java.lang.Object

oracle.nosql.driver.ops.Request

oracle.nosql.driver.ops.DurableRequest

oracle.nosql.driver.ops.WriteRequest

Direct Known Subclasses:

DeleteRequest, PutRequest

public abstract class WriteRequest
extends DurableRequest

Represents a base class for the single row modifying operations NoSQLHandle.put(oracle.nosql.driver.ops.PutRequest) and NoSQLHandle.delete(oracle.nosql.driver.ops.DeleteRequest).

Method Summary

Modifier and Type	Method	Description
String	getRowMetadata()	This method is **EXPERIMENTAL** and its behavior, signature, or even its existence may change without prior notice in future versions.
WriteRequest	setRowMetadata(String rowMetadata)	This method is **EXPERIMENTAL** and its behavior, signature, or even its existence may change without prior notice in future versions.

Methods inherited from class oracle.nosql.driver.ops.DurableRequest

getDurability

Methods inherited from class oracle.nosql.driver.ops.Request

getCompartment, getNamespace, getRateLimitDelayedMs, getReadRateLimiter, getRetryStats, getTableName, getTypeName, getWriteRateLimiter, setReadRateLimiter, setWriteRateLimiter

Methods inherited from class java.lang.Object

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

Method Details

getRowMetadata

public String getRowMetadata()

This method is **EXPERIMENTAL** and its behavior, signature, or even its existence may change without prior notice in future versions. Use with caution.

Returns the row metadata to be used for this request.

Returns:

the row metadata, or null if not set

Since:

5.4.18

setRowMetadata

public WriteRequest setRowMetadata(String rowMetadata)

This method is **EXPERIMENTAL** and its behavior, signature, or even its existence may change without prior notice in future versions. Use with caution.

Sets the row metadata to use for this request. This is an optional parameter.

Row metadata is associated to a certain version of a row. Any subsequent write operation will use its own row metadata value. If not specified null will be used by default. NOTE that if you have previously written a record with metadata and a subsequent write does not supply metadata, the metadata associated with the row will be null. Therefore, if you wish to have metadata associated with every write operation, you must supply a valid JSON construct to this method.

Parameters:

rowMetadata - the row metadata, must be null or a valid JSON construct: object, array, string, number, true, false or null, otherwise an IllegalArgumentException is thrown.

Returns:

this

Throws:

IllegalArgumentException - if rowMetadata not null and invalid JSON construct

Since:

5.4.18