Cloud Bigtable V2 Client - Class DeleteFromColumn (1.24.1)

Reference documentation and code samples for the Cloud Bigtable V2 Client class DeleteFromColumn.

A Mutation which deletes cells from the specified column, optionally restricting the deletions to a given timestamp range.

Generated from protobuf message google.bigtable.v2.Mutation.DeleteFromColumn

Namespace

Google \ Cloud \ Bigtable \ V2 \ Mutation

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ family_name string

The name of the family from which cells should be deleted. Must match [-_.a-zA-Z0-9]+

↳ column_qualifier string

The qualifier of the column from which cells should be deleted. Can be any byte string, including the empty string.

↳ time_range Google\Cloud\Bigtable\V2\TimestampRange

The range of timestamps within which cells should be deleted.

getFamilyName

The name of the family from which cells should be deleted.

Must match [-_.a-zA-Z0-9]+

Returns
TypeDescription
string

setFamilyName

The name of the family from which cells should be deleted.

Must match [-_.a-zA-Z0-9]+

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getColumnQualifier

The qualifier of the column from which cells should be deleted.

Can be any byte string, including the empty string.

Returns
TypeDescription
string

setColumnQualifier

The qualifier of the column from which cells should be deleted.

Can be any byte string, including the empty string.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getTimeRange

The range of timestamps within which cells should be deleted.

Returns
TypeDescription
Google\Cloud\Bigtable\V2\TimestampRange|null

hasTimeRange

clearTimeRange

setTimeRange

The range of timestamps within which cells should be deleted.

Parameter
NameDescription
var Google\Cloud\Bigtable\V2\TimestampRange
Returns
TypeDescription
$this