Cloud Bigtable Admin V2 API - Class Google::Cloud::Bigtable::Admin::V2::GcRule (v1.6.0)

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

Rule for determining which cells to delete during garbage collection.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

.intersection

def self.intersection(*rules) -> Google::Cloud::Bigtable::Admin::V2::GcRule

Construct a GcRule that is an intersection of rules

Parameter
Returns

.max_age

def self.max_age(value) -> Google::Cloud::Bigtable::Admin::V2::GcRule

Construct a GcRule for max_age

Parameter
Returns

.max_num_versions

def self.max_num_versions(value) -> Google::Cloud::Bigtable::Admin::V2::GcRule

Construct a GcRule for max_num_versions

Parameter
  • value (Integer) — The max_num_versions
Returns

.union

def self.union(*rules) -> Google::Cloud::Bigtable::Admin::V2::GcRule

Construct a GcRule that is a union of rules

Parameter
Returns

#intersection

def intersection() -> ::Google::Cloud::Bigtable::Admin::V2::GcRule::Intersection
Returns
  • (::Google::Cloud::Bigtable::Admin::V2::GcRule::Intersection) — Delete cells that would be deleted by every nested rule.

    Note: The following fields are mutually exclusive: intersection, max_num_versions, max_age, union. If a field in that set is populated, all other fields in the set will automatically be cleared.

#intersection=

def intersection=(value) -> ::Google::Cloud::Bigtable::Admin::V2::GcRule::Intersection
Parameter
  • value (::Google::Cloud::Bigtable::Admin::V2::GcRule::Intersection) — Delete cells that would be deleted by every nested rule.

    Note: The following fields are mutually exclusive: intersection, max_num_versions, max_age, union. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Bigtable::Admin::V2::GcRule::Intersection) — Delete cells that would be deleted by every nested rule.

    Note: The following fields are mutually exclusive: intersection, max_num_versions, max_age, union. If a field in that set is populated, all other fields in the set will automatically be cleared.

#max_age

def max_age() -> ::Google::Protobuf::Duration
Returns
  • (::Google::Protobuf::Duration) — Delete cells in a column older than the given age. Values must be at least one millisecond, and will be truncated to microsecond granularity.

    Note: The following fields are mutually exclusive: max_age, max_num_versions, intersection, union. If a field in that set is populated, all other fields in the set will automatically be cleared.

#max_age=

def max_age=(value) -> ::Google::Protobuf::Duration
Parameter
  • value (::Google::Protobuf::Duration) — Delete cells in a column older than the given age. Values must be at least one millisecond, and will be truncated to microsecond granularity.

    Note: The following fields are mutually exclusive: max_age, max_num_versions, intersection, union. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Protobuf::Duration) — Delete cells in a column older than the given age. Values must be at least one millisecond, and will be truncated to microsecond granularity.

    Note: The following fields are mutually exclusive: max_age, max_num_versions, intersection, union. If a field in that set is populated, all other fields in the set will automatically be cleared.

#max_num_versions

def max_num_versions() -> ::Integer
Returns
  • (::Integer) — Delete all cells in a column except the most recent N.

    Note: The following fields are mutually exclusive: max_num_versions, max_age, intersection, union. If a field in that set is populated, all other fields in the set will automatically be cleared.

#max_num_versions=

def max_num_versions=(value) -> ::Integer
Parameter
  • value (::Integer) — Delete all cells in a column except the most recent N.

    Note: The following fields are mutually exclusive: max_num_versions, max_age, intersection, union. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Integer) — Delete all cells in a column except the most recent N.

    Note: The following fields are mutually exclusive: max_num_versions, max_age, intersection, union. If a field in that set is populated, all other fields in the set will automatically be cleared.

#union

def union() -> ::Google::Cloud::Bigtable::Admin::V2::GcRule::Union
Returns
  • (::Google::Cloud::Bigtable::Admin::V2::GcRule::Union) — Delete cells that would be deleted by any nested rule.

    Note: The following fields are mutually exclusive: union, max_num_versions, max_age, intersection. If a field in that set is populated, all other fields in the set will automatically be cleared.

#union=

def union=(value) -> ::Google::Cloud::Bigtable::Admin::V2::GcRule::Union
Parameter
  • value (::Google::Cloud::Bigtable::Admin::V2::GcRule::Union) — Delete cells that would be deleted by any nested rule.

    Note: The following fields are mutually exclusive: union, max_num_versions, max_age, intersection. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Bigtable::Admin::V2::GcRule::Union) — Delete cells that would be deleted by any nested rule.

    Note: The following fields are mutually exclusive: union, max_num_versions, max_age, intersection. If a field in that set is populated, all other fields in the set will automatically be cleared.