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

Class RowMutation

java.lang.Object

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

All Implemented Interfaces:

MutationApi<RowMutation>, Serializable

public final class RowMutation
extends Object
implements MutationApi<RowMutation>, Serializable

Represents a list of mutations targeted at a single row. It's meant to be used as an parameter for BigtableDataClient.mutateRowAsync(RowMutation).

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
RowMutation	addToCell(String familyName, Value qualifier, Value timestamp, Value input) Adds a Value to an aggregate cell.
static RowMutation	create(String tableId, com.google.protobuf.ByteString key) Deprecated. Please use create(TargetId, ByteString) instead.
static RowMutation	create(String tableId, com.google.protobuf.ByteString key, Mutation mutation) Deprecated. Please use create(TargetId, ByteString, Mutation) instead.
static RowMutation	create(String tableId, String key) Deprecated. Please use create(TargetId, String) instead.
static RowMutation	create(String tableId, String key, Mutation mutation) Deprecated. Please use create(TargetId, String, Mutation) instead.
static RowMutation	create(TargetId targetId, com.google.protobuf.ByteString key) Creates a new instance of the mutation builder for the given target with targetId.
static RowMutation	create(TargetId targetId, com.google.protobuf.ByteString key, Mutation mutation) Creates new instance of mutation builder for the given target with targetId by wrapping existing set of row mutations.
static RowMutation	create(TargetId targetId, String key) Creates a new instance of the mutation builder for the given target with targetId.
static RowMutation	create(TargetId targetId, String key, Mutation mutation) Creates new instance of mutation builder for the given target with targetId by wrapping existing set of row mutations.
RowMutation	deleteCells(String familyName, com.google.protobuf.ByteString qualifier) Adds a mutation which deletes cells from the specified column.
RowMutation	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.
RowMutation	deleteCells(String familyName, String qualifier) Adds a mutation which deletes cells from the specified column.
RowMutation	deleteFamily(String familyName) Adds a mutation which deletes all cells from the specified column family.
RowMutation	deleteRow() Adds a mutation which deletes all cells from the containing row.
static RowMutation	fromProto(MutateRowRequest request) Wraps the protobuf MutateRowRequest.
TargetId	getTargetId()
RowMutation	mergeToCell(String familyName, Value qualifier, Value timestamp, Value input) Merges a Value accumulator to an aggregate cell.
RowMutation	setCell(String familyName, com.google.protobuf.ByteString qualifier, com.google.protobuf.ByteString value) Adds a mutation which sets the value of the specified cell.
RowMutation	setCell(String familyName, com.google.protobuf.ByteString qualifier, long value) Adds a mutation which sets the value of the specified cell.
RowMutation	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.
RowMutation	setCell(String familyName, com.google.protobuf.ByteString qualifier, long timestamp, long value) Adds a mutation which sets the value of the specified cell.
RowMutation	setCell(String familyName, String qualifier, long value) Adds a mutation which sets the value of the specified cell.
RowMutation	setCell(String familyName, String qualifier, long timestamp, long value) Adds a mutation which sets the value of the specified cell.
RowMutation	setCell(String familyName, String qualifier, long timestamp, String value) Adds a mutation which sets the value of the specified cell.
RowMutation	setCell(String familyName, String qualifier, String value) Adds a mutation which sets the value of the specified cell.
MutateRowsRequest	toBulkProto(com.google.cloud.bigtable.data.v2.internal.RequestContext requestContext) Creates a single entry bulk MutateRowsRequest, which will be merged by the batching logic in the callable chain.
MutateRowRequest	toProto(com.google.cloud.bigtable.data.v2.internal.RequestContext requestContext)
SessionMutateRowRequest	toSessionProto()

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

@Deprecated
public static RowMutation create(String tableId,
                                             String key)

Deprecated. Please use create(TargetId, String) instead.

create

public static RowMutation create(TargetId targetId,
                                 String key)

Creates a new instance of the mutation builder for the given target with targetId.

See Also:

AuthorizedViewId, TableId

create

@Deprecated
public static RowMutation create(String tableId,
                                             com.google.protobuf.ByteString key)

Deprecated. Please use create(TargetId, ByteString) instead.

create

public static RowMutation create(TargetId targetId,
                                 com.google.protobuf.ByteString key)

Creates a new instance of the mutation builder for the given target with targetId.

See Also:

AuthorizedViewId, TableId

create

@Deprecated
public static RowMutation create(String tableId,
                                             String key,
                                             Mutation mutation)

Deprecated. Please use create(TargetId, String, Mutation) instead.

create

public static RowMutation create(TargetId targetId,
                                 String key,
                                 Mutation mutation)

Creates new instance of mutation builder for the given target with targetId by wrapping existing set of row mutations. The builder will be owned by this RowMutation and should not be used by the caller after this call. This functionality is intended for advanced usage.

Sample code:

 Mutation mutation = Mutation.create()
     .setCell("[FAMILY_NAME]", "[QUALIFIER]", [TIMESTAMP], "[VALUE]");
 RowMutation rowMutation = RowMutation.create(TableId.of("[TABLE]"), "[ROW_KEY]", mutation);
 

See Also:

AuthorizedViewId, TableId

create

@Deprecated
public static RowMutation create(String tableId,
                                             com.google.protobuf.ByteString key,
                                             Mutation mutation)

Deprecated. Please use create(TargetId, ByteString, Mutation) instead.

create

public static RowMutation create(TargetId targetId,
                                 com.google.protobuf.ByteString key,
                                 Mutation mutation)

Creates new instance of mutation builder for the given target with targetId by wrapping existing set of row mutations. The builder will be owned by this RowMutation and should not be used by the caller after this call. This functionality is intended for advanced usage.

Sample code:

 Mutation mutation = Mutation.create()
     .setCell("[FAMILY_NAME]", "[QUALIFIER]", [TIMESTAMP], "[VALUE]");
 RowMutation rowMutation = RowMutation.create(TableId.of("[TABLE]"), [BYTE_STRING_ROW_KEY], mutation);
 

See Also:

AuthorizedViewId, TableId

setCell

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

Specified by:

setCell in interface MutationApi<RowMutation>

setCell

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

setCell

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

setCell

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

setCell

public RowMutation 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<RowMutation>

setCell

public RowMutation 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<RowMutation>

setCell

public RowMutation 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<RowMutation>

setCell

public RowMutation 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<RowMutation>

deleteCells

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

Description copied from interface: MutationApi

Adds a mutation which deletes cells from the specified column.

Specified by:

deleteCells in interface MutationApi<RowMutation>

deleteCells

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

Description copied from interface: MutationApi

Adds a mutation which deletes cells from the specified column.

Specified by:

deleteCells in interface MutationApi<RowMutation>

deleteCells

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

Description copied from interface: MutationApi

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

Specified by:

deleteCells in interface MutationApi<RowMutation>

Parameters:

familyName - The family name.

qualifier - The qualifier.

timestampRange - The timestamp range in microseconds.

deleteFamily

public RowMutation deleteFamily(@Nonnull
                                String familyName)

Description copied from interface: MutationApi

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

Specified by:

deleteFamily in interface MutationApi<RowMutation>

deleteRow

public RowMutation deleteRow()

Description copied from interface: MutationApi

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

Specified by:

deleteRow in interface MutationApi<RowMutation>

addToCell

public RowMutation 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<RowMutation>

mergeToCell

public RowMutation 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<RowMutation>

getTargetId

@InternalApi
public TargetId getTargetId()

toSessionProto

@InternalApi
public SessionMutateRowRequest toSessionProto()

toProto

@InternalApi
public MutateRowRequest toProto(com.google.cloud.bigtable.data.v2.internal.RequestContext requestContext)

toBulkProto

@InternalApi
public MutateRowsRequest toBulkProto(com.google.cloud.bigtable.data.v2.internal.RequestContext requestContext)

Creates a single entry bulk MutateRowsRequest, which will be merged by the batching logic in the callable chain.

fromProto

@BetaApi
public static RowMutation fromProto(@Nonnull
                                             MutateRowRequest request)

Wraps the protobuf MutateRowRequest.

This is meant for advanced usage only. Please ensure that the MutateRowRequest does not use server side timestamps. The BigtableDataClient assumes that RowMutations are idempotent and is configured to enable retries by default. If serverside timestamps are enabled, this can lead to duplicate mutations.

WARNING: when applied, the resulting mutation object will ignore the project id and instance id in the table_name and instead apply the configuration in the client.