Struct gcp_client::google::bigtable::admin::table::v1::ColumnFamily

pub struct ColumnFamily {
    pub name: String,
    pub gc_expression: String,
    pub gc_rule: Option<GcRule>,
}

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

Fields

name: String

A unique identifier of the form <table_name>/columnFamilies/[-_.a-zA-Z0-9]+ The last segment is the same as the "name" field in google.bigtable.v1.Family.

gc_expression: String

Garbage collection expression specified by the following grammar: GC = EXPR | "" ; EXPR = EXPR, "||", EXPR (* lowest precedence ) | EXPR, "&&", EXPR | "(", EXPR, ")" ( highest precedence ) | PROP ; PROP = "version() >", NUM32 | "age() >", NUM64, [ UNIT ] ; NUM32 = non-zero-digit { digit } ; ( # NUM32 <= 2^32 - 1 ) NUM64 = non-zero-digit { digit } ; ( # NUM64 <= 2^63 - 1 ) UNIT = "d" | "h" | "m" ( d=days, h=hours, m=minutes, else micros *) GC expressions can be up to 500 characters in length

The different types of PROP are defined as follows: version() - cell index, counting from most recent and starting at 1 age() - age of the cell (current time minus cell timestamp)

Example: "version() > 3 || (age() > 3d && version() > 1)" drop cells beyond the most recent three, and drop cells older than three days unless they're the most recent cell in the row/column

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: Option<GcRule>

Garbage collection rule specified as a protobuf. Supersedes gc_expression. 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.

Trait Implementations

impl Clone for ColumnFamily

fn clone(&self) -> ColumnFamily

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ColumnFamily

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Default for ColumnFamily

fn default() -> ColumnFamily

Returns the "default value" for a type.

impl Message for ColumnFamily

fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message to a buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message with a length-delimiter to a buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    B: Buf,
    Self: Default, 

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    B: Buf,
    Self: Default, 

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq<ColumnFamily> for ColumnFamily

fn eq(&self, other: &ColumnFamily) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &ColumnFamily) -> bool

This method tests for !=.

impl StructuralPartialEq for ColumnFamily