Package com.couchbase.client.java.subdoc
Class SubdocOptionsBuilder
- java.lang.Object
-
- com.couchbase.client.java.subdoc.SubdocOptionsBuilder
-
@Committed @Public public class SubdocOptionsBuilder extends Object
Sub-document options builder. Options supported are createParents xattr- Since:
- 2.4.2
- Author:
- Subhashni Balakrishnan
-
-
Constructor Summary
Constructors Constructor Description SubdocOptionsBuilder()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static SubdocOptionsBuilder
builder()
boolean
createParents()
Deprecated.Please usecreatePath()
instead, this method will be removed in the next major version.SubdocOptionsBuilder
createParents(boolean createParents)
Deprecated.Please usecreatePath(boolean)
instead, this method will be removed in the next major version.boolean
createPath()
Returns true if the intermediate paths should be created.SubdocOptionsBuilder
createPath(boolean createPath)
Set true/false if the intermediate paths should be created.boolean
expandMacros()
Get whether macros will be expanded for this field.SubdocOptionsBuilder
expandMacros(boolean expandMacros)
Controls whether macros such as ${Mutation.CAS} will be expanded by the server for this field.String
toString()
boolean
xattr()
Get xattr value set on builderSubdocOptionsBuilder
xattr(boolean xattr)
Set xattr to true to accessing extended attributes, else false.
-
-
-
Method Detail
-
builder
public static SubdocOptionsBuilder builder()
-
createParents
@Deprecated public SubdocOptionsBuilder createParents(boolean createParents)
Deprecated.Please usecreatePath(boolean)
instead, this method will be removed in the next major version.Set createParents to true to create missing intermediary nodes, else false.
-
createPath
public SubdocOptionsBuilder createPath(boolean createPath)
Set true/false if the intermediate paths should be created.- Parameters:
createPath
- true if they should be created, false otherwise.- Returns:
- this builder for chaining purposes.
-
createParents
@Deprecated public boolean createParents()
Deprecated.Please usecreatePath()
instead, this method will be removed in the next major version.Get createParents value set on builder
-
createPath
public boolean createPath()
Returns true if the intermediate paths should be created.- Returns:
- true if they should be created.
-
xattr
@Committed public SubdocOptionsBuilder xattr(boolean xattr)
Set xattr to true to accessing extended attributes, else false.
-
xattr
public boolean xattr()
Get xattr value set on builder
-
expandMacros
@Private public SubdocOptionsBuilder expandMacros(boolean expandMacros)
Controls whether macros such as ${Mutation.CAS} will be expanded by the server for this field. Default is false.
-
expandMacros
@Private public boolean expandMacros()
Get whether macros will be expanded for this field.
-
-