org.apache.hadoop.hbase.client

Class CheckAndMutate.Builder

java.lang.Object

org.apache.hadoop.hbase.client.CheckAndMutate.Builder

Enclosing class:

CheckAndMutate

@InterfaceAudience.Public
 @InterfaceStability.Evolving
public static final class CheckAndMutate.Builder
extends Object

A builder class for building a CheckAndMutate object.

Method Summary

Modifier and Type	Method and Description
CheckAndMutate	build(Append append) Build the CheckAndMutate object with an Append to commit if the check succeeds.
CheckAndMutate	build(Delete delete) Build the CheckAndMutate object
CheckAndMutate	build(Increment increment) Build the CheckAndMutate object with an Increment to commit if the check succeeds.
CheckAndMutate	build(Put put) Build the CheckAndMutate object
CheckAndMutate	build(RowMutations mutations) Build the CheckAndMutate object with a RowMutations to commit if the check succeeds.
CheckAndMutate.Builder	ifEquals(byte[] family, byte[] qualifier, byte[] value) Check for equality
CheckAndMutate.Builder	ifMatches(byte[] family, byte[] qualifier, CompareOperator compareOp, byte[] value) Check for match
CheckAndMutate.Builder	ifMatches(Filter filter) Check for match
CheckAndMutate.Builder	ifNotExists(byte[] family, byte[] qualifier) Check for lack of column
CheckAndMutate.Builder	queryMetricsEnabled(boolean queryMetricsEnabled) Enables the return of QueryMetrics alongside the corresponding result for this query
CheckAndMutate.Builder	timeRange(TimeRange timeRange) Specify a timerange

Methods inherited from class java.lang.Object

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

Method Detail

ifNotExists

public CheckAndMutate.Builder ifNotExists(byte[] family,
                                          byte[] qualifier)

Check for lack of column

Parameters:

family - family to check

qualifier - qualifier to check

Returns:

the CheckAndMutate object

ifEquals

public CheckAndMutate.Builder ifEquals(byte[] family,
                                       byte[] qualifier,
                                       byte[] value)

Check for equality

Parameters:

family - family to check

qualifier - qualifier to check

value - the expected value

Returns:

the CheckAndMutate object

ifMatches

public CheckAndMutate.Builder ifMatches(byte[] family,
                                        byte[] qualifier,
                                        CompareOperator compareOp,
                                        byte[] value)

Check for match

Parameters:

family - family to check

qualifier - qualifier to check

compareOp - comparison operator to use

value - the expected value

Returns:

the CheckAndMutate object

ifMatches

public CheckAndMutate.Builder ifMatches(Filter filter)

Check for match

Parameters:

filter - filter to check

Returns:

the CheckAndMutate object

timeRange

public CheckAndMutate.Builder timeRange(TimeRange timeRange)

Specify a timerange

Parameters:

timeRange - time range to check

Returns:

the CheckAndMutate object

queryMetricsEnabled

public CheckAndMutate.Builder queryMetricsEnabled(boolean queryMetricsEnabled)

Enables the return of QueryMetrics alongside the corresponding result for this query

This is intended for advanced users who need result-granular, server-side metrics

Does not work

Parameters:

queryMetricsEnabled - true to enable collection of per-result query metrics false to disable metrics collection (resulting in null metrics)

build

public CheckAndMutate build(Put put)

Build the CheckAndMutate object

Parameters:

put - data to put if check succeeds

Returns:

a CheckAndMutate object

build

public CheckAndMutate build(Delete delete)

Build the CheckAndMutate object

Parameters:

delete - data to delete if check succeeds

Returns:

a CheckAndMutate object

build

public CheckAndMutate build(Increment increment)

Build the CheckAndMutate object with an Increment to commit if the check succeeds.

Parameters:

increment - data to increment if check succeeds

Returns:

a CheckAndMutate object

build

public CheckAndMutate build(Append append)

Build the CheckAndMutate object with an Append to commit if the check succeeds.

Parameters:

append - data to append if check succeeds

Returns:

a CheckAndMutate object

build

public CheckAndMutate build(RowMutations mutations)

Build the CheckAndMutate object with a RowMutations to commit if the check succeeds.

Parameters:

mutations - mutations to perform if check succeeds

Returns:

a CheckAndMutate object