com.couchbase.client.core.message.kv.subdoc.multi

Class MutationCommand

java.lang.Object

com.couchbase.client.core.message.kv.subdoc.multi.MutationCommand

@InterfaceStability.Experimental
 @InterfaceAudience.Public
public class MutationCommand
extends Object

A single mutation description inside a BinarySubdocMultiMutationRequest.

Since:

1.2

Author:

Simon Baslé

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MutationCommand(MutationCommandBuilder builder) Create a multi-mutation command.
	MutationCommand(Mutation mutation, String path) Deprecated.
	MutationCommand(Mutation mutation, String path, ByteBuf fragment) Deprecated.
	MutationCommand(Mutation mutation, String path, ByteBuf fragment, boolean createIntermediaryPath) Deprecated.

Method Summary

Modifier and Type	Method and Description
boolean	createIntermediaryPath()
Mutation	mutation()
byte	opCode()
String	path()
boolean	xattr()

Methods inherited from class java.lang.Object

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

Constructor Detail

MutationCommand

@Deprecated
public MutationCommand(Mutation mutation,
                                   String path,
                                   ByteBuf fragment,
                                   boolean createIntermediaryPath)

Deprecated.

Create a multi-mutation command.

Parameters:

mutation - the mutation type.

path - the path to mutate inside the document.

fragment - the target value for the mutation. This will be released when the request is sent.

createIntermediaryPath - true if missing parts of the path should be created if possible, false otherwise.

MutationCommand

@Deprecated
public MutationCommand(Mutation mutation,
                                   String path,
                                   ByteBuf fragment)

Deprecated.

Create a multi-mutation command.

Parameters:

mutation - the mutation type.

path - the path to mutate inside the document.

fragment - the target value for the mutation. This will be released when the request is sent.

MutationCommand

@Deprecated
public MutationCommand(Mutation mutation,
                                   String path)

Deprecated.

Create a multi-mutation without a fragment (should be restricted to DELETE, not to be confused with an empty string fragment where ByteBuf contains “”“”, or the null fragment where ByteBuf contains “NULL”).

Parameters:

path - the path to delete inside the document.

MutationCommand

protected MutationCommand(MutationCommandBuilder builder)

Create a multi-mutation command.

Parameters:

builder - MutationCommandBuilder

Method Detail

mutation

public Mutation mutation()

path

public String path()

opCode

public byte opCode()

createIntermediaryPath

public boolean createIntermediaryPath()

xattr

public boolean xattr()