Struct ColumnFamilyMapping 

#[non_exhaustive]
pub struct ColumnFamilyMapping {
    pub key_definition: Option<KeyDefinition>,
    /* private fields */
}

Configuration for writing a Pub/Sub message to a Bigtable row with a user-defined key and writing to column families.

If this field is set:

• The subscription messages must be formatted as JSON.
• The row key mapping is configured in the key_definition section.
• The top-level fields will be written either:
  • By default, they will be written to the data column family with the field name as the column qualifier.
  • But if the field name matches an existing column family (except for the default data column), then that field will be written to that column family, either as a scalar or its next level nested fields if it’s a JSON object.
• The cell timestamp will be the message publish timestamp.

If the field is not set, the default behavior is to write:

• row key: subscription name, message ID hash, and message ID delimited by #.
• columns: message bytes written to a single column family data with an empty-string column qualifier.
• cell timestamp: the message publish timestamp.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

key_definition: Option<KeyDefinition>

How to construct the row key from the Pub/Sub message. If not specified, the default behavior is to construct the row key from the subscription name, message ID hash, and message ID delimited by #.

Implementations

impl ColumnFamilyMapping

pub fn new() -> Self

Creates a new default instance.

pub fn set_key_definition<T: Into<Option<KeyDefinition>>>(self, v: T) -> Self

Sets the value of key_definition.

Note that all the setters affecting key_definition are mutually exclusive.

Example

use google_cloud_pubsub::model::bigtable_config::column_family_mapping::RowKeySchema;
let x = ColumnFamilyMapping::new().set_key_definition(Some(
    google_cloud_pubsub::model::bigtable_config::column_family_mapping::KeyDefinition::RowKeySchema(RowKeySchema::default().into())));

pub fn row_key_schema(&self) -> Option<&Box<RowKeySchema>>

The value of key_definition if it holds a RowKeySchema, None if the field is not set or holds a different branch.

pub fn set_row_key_schema<T: Into<Box<RowKeySchema>>>(self, v: T) -> Self

Sets the value of key_definition to hold a RowKeySchema.

Note that all the setters affecting key_definition are mutually exclusive.

Example

use google_cloud_pubsub::model::bigtable_config::column_family_mapping::RowKeySchema;
let x = ColumnFamilyMapping::new().set_row_key_schema(RowKeySchema::default()/* use setters */);
assert!(x.row_key_schema().is_some());
assert!(x.delimited_key().is_none());

pub fn delimited_key(&self) -> Option<&Box<DelimitedKey>>

The value of key_definition if it holds a DelimitedKey, None if the field is not set or holds a different branch.

pub fn set_delimited_key<T: Into<Box<DelimitedKey>>>(self, v: T) -> Self

Sets the value of key_definition to hold a DelimitedKey.

Note that all the setters affecting key_definition are mutually exclusive.

Example

use google_cloud_pubsub::model::bigtable_config::column_family_mapping::DelimitedKey;
let x = ColumnFamilyMapping::new().set_delimited_key(DelimitedKey::default()/* use setters */);
assert!(x.delimited_key().is_some());
assert!(x.row_key_schema().is_none());

Trait Implementations

impl Clone for ColumnFamilyMapping

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ColumnFamilyMapping

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

Formats the value using the given formatter.

impl Default for ColumnFamilyMapping

fn default() -> Self

Returns the “default value” for a type.

impl Message for ColumnFamilyMapping

fn typename() -> &'static str

The typename of this message.

impl PartialEq for ColumnFamilyMapping

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ColumnFamilyMapping