Interface MutationApi<T> (2.46.0)

Version latest

• 2.46.0 (latest)
• 2.45.1
• 2.44.1
• 2.43.0
• 2.42.0
• 2.40.0
• 2.39.5
• 2.37.0
• 2.35.1
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.1
• 2.28.0

public interface MutationApi<T>

The API for creating mutations for a single row.

Type Parameter
Name	Description
T

Methods

addToCell(String familyName, Value qualifier, Value timestamp, Value input)

public abstract T addToCell(String familyName, Value qualifier, Value timestamp, Value input)

Adds a Value to an aggregate cell. The column family must be an aggregate family and have an input type matching the type of Value or this mutation will be rejected.

Note: The timestamp values are in microseconds but must match the granularity of the table(defaults to MILLIS). Therefore, the given value must be a multiple of 1000 (millisecond granularity). For example: 1571902339435000.

Parameters
Name	Description
familyName	String
qualifier	Value
timestamp	Value
input	Value

Returns
Type	Description
T

addToCell(String familyName, ByteString qualifier, long timestamp, long input)

public default T addToCell(String familyName, ByteString qualifier, long timestamp, long input)

Adds an int64 value to an aggregate cell. The column family must be an aggregate family and have an "int64" input type or this mutation will be rejected.

Note: The timestamp values are in microseconds but must match the granularity of the table(defaults to MILLIS). Therefore, the given value must be a multiple of 1000 (millisecond granularity). For example: 1571902339435000.

Parameters
Name	Description
familyName	String
qualifier	ByteString
timestamp	long
input	long

Returns
Type	Description
T

addToCell(String familyName, String qualifier, long timestamp, long value)

public default T addToCell(String familyName, String qualifier, long timestamp, long value)

Adds an int64 value to an aggregate cell. The column family must be an aggregate family and have an "int64" input type or this mutation will be rejected.

This is a convenience override that converts Strings to ByteStrings.

Note: The timestamp values are in microseconds but must match the granularity of the table(defaults to MILLIS). Therefore, the given value must be a multiple of 1000 (millisecond granularity). For example: 1571902339435000.

Parameters
Name	Description
familyName	String
qualifier	String
timestamp	long
value	long

Returns
Type	Description
T

deleteCells(String familyName, ByteString qualifier)

public abstract T deleteCells(String familyName, ByteString qualifier)

Adds a mutation which deletes cells from the specified column.

Parameters
Name	Description
familyName	String
qualifier	ByteString

Returns
Type	Description
T

deleteCells(String familyName, ByteString qualifier, Range.TimestampRange timestampRange)

public abstract T deleteCells(String familyName, ByteString qualifier, Range.TimestampRange timestampRange)

Adds a mutation which deletes cells from the specified column, restricted to a given timestamp range.

Parameters
Name	Description
familyName	String The family name.
qualifier	ByteString The qualifier.
timestampRange	Range.TimestampRange The timestamp range in microseconds.

Returns
Type	Description
T

deleteCells(String familyName, String qualifier)

public abstract T deleteCells(String familyName, String qualifier)

Adds a mutation which deletes cells from the specified column.

Parameters
Name	Description
familyName	String
qualifier	String

Returns
Type	Description
T

deleteFamily(String familyName)

public abstract T deleteFamily(String familyName)

Adds a mutation which deletes all cells from the specified column family.

Parameter
Name	Description
familyName	String

Returns
Type	Description
T

deleteRow()

public abstract T deleteRow()

Adds a mutation which deletes all cells from the containing row.

Returns
Type	Description
T

mergeToCell(String familyName, Value qualifier, Value timestamp, Value input)

public abstract T mergeToCell(String familyName, Value qualifier, Value timestamp, Value input)

Merges a Value accumulator to an aggregate cell. The column family must be an aggregate family or this mutation will be rejected.

Note: The timestamp values are in microseconds but must match the granularity of the table(defaults to MILLIS). Therefore, the given value must be a multiple of 1000 (millisecond granularity). For example: 1571902339435000.

Parameters
Name	Description
familyName	String
qualifier	Value
timestamp	Value
input	Value

Returns
Type	Description
T

mergeToCell(String familyName, ByteString qualifier, long timestamp, ByteString input)

public default T mergeToCell(String familyName, ByteString qualifier, long timestamp, ByteString input)

Merges a ByteString accumulator value to a cell in an aggregate column family.

Note: The timestamp values are in microseconds but must match the granularity of the table(defaults to MILLIS). Therefore, the given value must be a multiple of 1000 (millisecond granularity). For example: 1571902339435000.

Parameters
Name	Description
familyName	String
qualifier	ByteString
timestamp	long
input	ByteString

Returns
Type	Description
T

mergeToCell(String familyName, String qualifier, long timestamp, ByteString value)

public default T mergeToCell(String familyName, String qualifier, long timestamp, ByteString value)

Merges a ByteString accumulator value to a cell in an aggregate column family.

This is a convenience override that converts Strings to ByteStrings.

Note: The timestamp values are in microseconds but must match the granularity of the table(defaults to MILLIS). Therefore, the given value must be a multiple of 1000 (millisecond granularity). For example: 1571902339435000.

Parameters
Name	Description
familyName	String
qualifier	String
timestamp	long
value	ByteString

Returns
Type	Description
T

setCell(String familyName, ByteString qualifier, ByteString value)

public abstract T setCell(String familyName, ByteString qualifier, ByteString value)

Adds a mutation which sets the value of the specified cell.

Uses microseconds since epoch as the timestamp.

Parameters
Name	Description
familyName	String
qualifier	ByteString
value	ByteString

Returns
Type	Description
T

setCell(String familyName, ByteString qualifier, long value)

public abstract T setCell(String familyName, ByteString qualifier, long value)

Adds a mutation which sets the value of the specified cell.

Uses microseconds since epoch as the timestamp.

Parameters
Name	Description
familyName	String
qualifier	ByteString
value	long

Returns
Type	Description
T

setCell(String familyName, ByteString qualifier, long timestamp, ByteString value)

public abstract T setCell(String familyName, ByteString qualifier, long timestamp, ByteString value)

Adds a mutation which sets the value of the specified cell.

Note: The timestamp values are in microseconds but must match the granularity of the table(defaults to MILLIS). Therefore, the given value must be a multiple of 1000 (millisecond granularity). For example: 1571902339435000.

Parameters
Name	Description
familyName	String
qualifier	ByteString
timestamp	long
value	ByteString

Returns
Type	Description
T

setCell(String familyName, ByteString qualifier, long timestamp, long value)

public abstract T setCell(String familyName, ByteString qualifier, long timestamp, long value)

Adds a mutation which sets the value of the specified cell.

Note: The timestamp values are in microseconds but must match the granularity of the table(defaults to MILLIS). Therefore, the given value must be a multiple of 1000 (millisecond granularity). For example: 1571902339435000.

Parameters
Name	Description
familyName	String
qualifier	ByteString
timestamp	long
value	long

Returns
Type	Description
T

setCell(String familyName, String qualifier, String value)

public abstract T setCell(String familyName, String qualifier, String value)

Adds a mutation which sets the value of the specified cell.

This a convenience method that converts Strings to ByteStrings and uses microseconds since epoch as the timestamp.

Parameters
Name	Description
familyName	String
qualifier	String
value	String

Returns
Type	Description
T

setCell(String familyName, String qualifier, long value)

public abstract T setCell(String familyName, String qualifier, long value)

Adds a mutation which sets the value of the specified cell.

This a convenience method that converts Strings to ByteStrings and uses microseconds since epoch as the timestamp. Also it accepts long value.

Parameters
Name	Description
familyName	String
qualifier	String
value	long

Returns
Type	Description
T

setCell(String familyName, String qualifier, long timestamp, String value)

public abstract T setCell(String familyName, String qualifier, long timestamp, String value)

Adds a mutation which sets the value of the specified cell.

This is a convenience override that converts Strings to ByteStrings.

Note: The timestamp values are in microseconds but must match the granularity of the table(defaults to MILLIS). Therefore, the given value must be a multiple of 1000 (millisecond granularity). For example: 1571902339435000.

Parameters
Name	Description
familyName	String
qualifier	String
timestamp	long
value	String

Returns
Type	Description
T

setCell(String familyName, String qualifier, long timestamp, long value)

public abstract T setCell(String familyName, String qualifier, long timestamp, long value)

Adds a mutation which sets the value of the specified cell.

This is a convenience override that converts Strings to ByteStrings.

Note: The timestamp values are in microseconds but must match the granularity of the table(defaults to MILLIS). Therefore, the given value must be a multiple of 1000 (millisecond granularity). For example: 1571902339435000.

Parameters
Name	Description
familyName	String
qualifier	String
timestamp	long
value	long

Returns
Type	Description
T