com.google.cloud.bigtable.data.v2.models

Class RowMutationEntry

java.lang.Object

com.google.cloud.bigtable.data.v2.models.RowMutationEntry

All Implemented Interfaces:

MutationApi<RowMutationEntry>, Serializable

public class RowMutationEntry
extends Object
implements MutationApi<RowMutationEntry>, Serializable

Represents a list of mutations targeted at a single row. It is meant to be used as an parameter for BigtableDataClient.newBulkMutationBatcher(String).

Note: The changes in the mutation will be applied atomically but the ordering between different RowMutationEntry instances is not guaranteed.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
RowMutationEntry	addToCell(String familyName, Value qualifier, Value timestamp, Value input) Adds a Value to an aggregate cell.
static RowMutationEntry	create(com.google.protobuf.ByteString key) Creates a new instance of the mutation builder.
static RowMutationEntry	create(String key) Creates a new instance of the mutation builder.
static RowMutationEntry	createFromMutationUnsafe(com.google.protobuf.ByteString key, Mutation mutation) Creates a new instance from existing mutation.
static RowMutationEntry	createUnsafe(com.google.protobuf.ByteString key) Creates new instance of mutation builder which allows server timestamp for setCell operations.
RowMutationEntry	deleteCells(String familyName, com.google.protobuf.ByteString qualifier) Adds a mutation which deletes cells from the specified column.
RowMutationEntry	deleteCells(String familyName, com.google.protobuf.ByteString qualifier, Range.TimestampRange timestampRange) Adds a mutation which deletes cells from the specified column, restricted to a given timestamp range.
RowMutationEntry	deleteCells(String familyName, String qualifier) Adds a mutation which deletes cells from the specified column.
RowMutationEntry	deleteFamily(String familyName) Adds a mutation which deletes all cells from the specified column family.
RowMutationEntry	deleteRow() Adds a mutation which deletes all cells from the containing row.
RowMutationEntry	mergeToCell(String familyName, Value qualifier, Value timestamp, Value input) Merges a Value accumulator to an aggregate cell.
RowMutationEntry	setCell(String familyName, com.google.protobuf.ByteString qualifier, com.google.protobuf.ByteString value) Adds a mutation which sets the value of the specified cell.
RowMutationEntry	setCell(String familyName, com.google.protobuf.ByteString qualifier, long value) Adds a mutation which sets the value of the specified cell.
RowMutationEntry	setCell(String familyName, com.google.protobuf.ByteString qualifier, long timestamp, com.google.protobuf.ByteString value) Adds a mutation which sets the value of the specified cell.
RowMutationEntry	setCell(String familyName, com.google.protobuf.ByteString qualifier, long timestamp, long value) Adds a mutation which sets the value of the specified cell.
RowMutationEntry	setCell(String familyName, String qualifier, long value) Adds a mutation which sets the value of the specified cell.
RowMutationEntry	setCell(String familyName, String qualifier, long timestamp, long value) Adds a mutation which sets the value of the specified cell.
RowMutationEntry	setCell(String familyName, String qualifier, long timestamp, String value) Adds a mutation which sets the value of the specified cell.
RowMutationEntry	setCell(String familyName, String qualifier, String value) Adds a mutation which sets the value of the specified cell.
MutateRowsRequest.Entry	toProto()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.cloud.bigtable.data.v2.models.MutationApi

addToCell, addToCell, mergeToCell, mergeToCell

Method Detail

create

public static RowMutationEntry create(@Nonnull
                                      String key)

Creates a new instance of the mutation builder.

create

public static RowMutationEntry create(@Nonnull
                                      com.google.protobuf.ByteString key)

Creates a new instance of the mutation builder.

createFromMutationUnsafe

@BetaApi
public static RowMutationEntry createFromMutationUnsafe(@Nonnull
                                                                 com.google.protobuf.ByteString key,
                                                                 @Nonnull
                                                                 Mutation mutation)

Creates a new instance from existing mutation.

createUnsafe

@InternalApi(value="For internal usage only")
public static RowMutationEntry createUnsafe(@Nonnull
                                                                                          com.google.protobuf.ByteString key)

Creates new instance of mutation builder which allows server timestamp for setCell operations.

NOTE: This functionality is intended for advanced usage.

See Also:

for more explanation.

setCell

public RowMutationEntry setCell(@Nonnull
                                String familyName,
                                @Nonnull
                                String qualifier,
                                @Nonnull
                                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.

Specified by:

setCell in interface MutationApi<RowMutationEntry>

setCell

public RowMutationEntry setCell(@Nonnull
                                String familyName,
                                @Nonnull
                                String qualifier,
                                long timestamp,
                                @Nonnull
                                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`.

Specified by:

setCell in interface MutationApi<RowMutationEntry>

setCell

public RowMutationEntry setCell(@Nonnull
                                String familyName,
                                @Nonnull
                                com.google.protobuf.ByteString qualifier,
                                @Nonnull
                                com.google.protobuf.ByteString value)

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

Uses microseconds since epoch as the timestamp.

Specified by:

setCell in interface MutationApi<RowMutationEntry>

setCell

public RowMutationEntry setCell(@Nonnull
                                String familyName,
                                @Nonnull
                                com.google.protobuf.ByteString qualifier,
                                long timestamp,
                                @Nonnull
                                com.google.protobuf.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`.

Specified by:

setCell in interface MutationApi<RowMutationEntry>

setCell

public RowMutationEntry setCell(@Nonnull
                                String familyName,
                                @Nonnull
                                String qualifier,
                                long value)

Description copied from interface: MutationApi

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.

Specified by:

setCell in interface MutationApi<RowMutationEntry>

setCell

public RowMutationEntry setCell(@Nonnull
                                String familyName,
                                @Nonnull
                                String qualifier,
                                long timestamp,
                                long value)

Description copied from interface: MutationApi

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`.

Specified by:

setCell in interface MutationApi<RowMutationEntry>

setCell

public RowMutationEntry setCell(@Nonnull
                                String familyName,
                                @Nonnull
                                com.google.protobuf.ByteString qualifier,
                                long value)

Description copied from interface: MutationApi

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

Uses microseconds since epoch as the timestamp.

Specified by:

setCell in interface MutationApi<RowMutationEntry>

setCell

public RowMutationEntry setCell(@Nonnull
                                String familyName,
                                @Nonnull
                                com.google.protobuf.ByteString qualifier,
                                long timestamp,
                                long value)

Description copied from interface: MutationApi

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`.

Specified by:

setCell in interface MutationApi<RowMutationEntry>

deleteCells

public RowMutationEntry deleteCells(@Nonnull
                                    String familyName,
                                    @Nonnull
                                    String qualifier)

Adds a mutation which deletes cells from the specified column.

Specified by:

deleteCells in interface MutationApi<RowMutationEntry>

deleteCells

public RowMutationEntry deleteCells(@Nonnull
                                    String familyName,
                                    @Nonnull
                                    com.google.protobuf.ByteString qualifier)

Adds a mutation which deletes cells from the specified column.

Specified by:

deleteCells in interface MutationApi<RowMutationEntry>

deleteCells

public RowMutationEntry deleteCells(@Nonnull
                                    String familyName,
                                    @Nonnull
                                    com.google.protobuf.ByteString qualifier,
                                    @Nonnull
                                    Range.TimestampRange timestampRange)

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

Specified by:

deleteCells in interface MutationApi<RowMutationEntry>

Parameters:

familyName - The family name.

qualifier - The qualifier.

timestampRange - The timestamp range in microseconds.

deleteFamily

public RowMutationEntry deleteFamily(@Nonnull
                                     String familyName)

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

Specified by:

deleteFamily in interface MutationApi<RowMutationEntry>

deleteRow

public RowMutationEntry deleteRow()

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

Specified by:

deleteRow in interface MutationApi<RowMutationEntry>

addToCell

public RowMutationEntry addToCell(@Nonnull
                                  String familyName,
                                  @Nonnull
                                  Value qualifier,
                                  @Nonnull
                                  Value timestamp,
                                  @Nonnull
                                  Value input)

Description copied from interface: MutationApi

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`.

Specified by:

addToCell in interface MutationApi<RowMutationEntry>

mergeToCell

public RowMutationEntry mergeToCell(@Nonnull
                                    String familyName,
                                    @Nonnull
                                    Value qualifier,
                                    @Nonnull
                                    Value timestamp,
                                    @Nonnull
                                    Value input)

Description copied from interface: MutationApi

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`.

Specified by:

mergeToCell in interface MutationApi<RowMutationEntry>

toProto

@InternalApi
public MutateRowsRequest.Entry toProto()