Cloud Bigtable Admin V2 API - Class Google::Cloud::Bigtable::Admin::V2::ColumnFamily (v1.5.0)

Reference documentation and code samples for the Cloud Bigtable Admin V2 API class Google::Cloud::Bigtable::Admin::V2::ColumnFamily.

A set of columns within a table which share a common configuration.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#gc_rule

def gc_rule() -> ::Google::Cloud::Bigtable::Admin::V2::GcRule
Returns
  • (::Google::Cloud::Bigtable::Admin::V2::GcRule) — Garbage collection rule specified as a protobuf. Must serialize to at most 500 bytes.

    NOTE: Garbage collection executes opportunistically in the background, and so it's possible for reads to return a cell even if it matches the active GC expression for its family.

#gc_rule=

def gc_rule=(value) -> ::Google::Cloud::Bigtable::Admin::V2::GcRule
Parameter
  • value (::Google::Cloud::Bigtable::Admin::V2::GcRule) — Garbage collection rule specified as a protobuf. Must serialize to at most 500 bytes.

    NOTE: Garbage collection executes opportunistically in the background, and so it's possible for reads to return a cell even if it matches the active GC expression for its family.

Returns
  • (::Google::Cloud::Bigtable::Admin::V2::GcRule) — Garbage collection rule specified as a protobuf. Must serialize to at most 500 bytes.

    NOTE: Garbage collection executes opportunistically in the background, and so it's possible for reads to return a cell even if it matches the active GC expression for its family.

#value_type

def value_type() -> ::Google::Cloud::Bigtable::Admin::V2::Type
Returns
  • (::Google::Cloud::Bigtable::Admin::V2::Type) —

    The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes.

    For now, only the Aggregate type is supported.

    Aggregate can only be set at family creation and is immutable afterwards.

    If value_type is Aggregate, written data must be compatible with:

    • value_type.input_type for AddInput mutations

#value_type=

def value_type=(value) -> ::Google::Cloud::Bigtable::Admin::V2::Type
Parameter
  • value (::Google::Cloud::Bigtable::Admin::V2::Type) —

    The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes.

    For now, only the Aggregate type is supported.

    Aggregate can only be set at family creation and is immutable afterwards.

    If value_type is Aggregate, written data must be compatible with:

    • value_type.input_type for AddInput mutations
Returns
  • (::Google::Cloud::Bigtable::Admin::V2::Type) —

    The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes.

    For now, only the Aggregate type is supported.

    Aggregate can only be set at family creation and is immutable afterwards.

    If value_type is Aggregate, written data must be compatible with:

    • value_type.input_type for AddInput mutations