Struct BigtableColumnFamily 

#[non_exhaustive]
pub struct BigtableColumnFamily {
    pub field_name: String,
    pub encoding: Encoding,
    pub type: Type,
    pub columns: Vec<BigtableColumn>,
    /* private fields */
}

Available on crate feature document-service only.

The column family of the Bigtable.

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.

field_name: String

The field name to use for this column family in the document. The name has to match the pattern [a-zA-Z0-9][a-zA-Z0-9-_]*. If not set, it is parsed from the family name with best effort. However, due to different naming patterns, field name collisions could happen, where parsing behavior is undefined.

encoding: Encoding

The encoding mode of the values when the type is not STRING. Acceptable encoding values are:

• TEXT: indicates values are alphanumeric text strings.
• BINARY: indicates values are encoded using HBase Bytes.toBytes family of functions. This can be overridden for a specific column by listing that column in columns and specifying an encoding for it.

type: Type

The type of values in this column family. The values are expected to be encoded using HBase Bytes.toBytes function when the encoding value is set to BINARY.

columns: Vec<BigtableColumn>

The list of objects that contains column level information for each column. If a column is not present in this list it will be ignored.

Implementations

impl BigtableColumnFamily

pub fn new() -> Self

pub fn set_field_name<T: Into<String>>(self, v: T) -> Self

Sets the value of field_name.

Example

let x = BigtableColumnFamily::new().set_field_name("example");

pub fn set_encoding<T: Into<Encoding>>(self, v: T) -> Self

Sets the value of encoding.

Example

use google_cloud_discoveryengine_v1::model::bigtable_options::Encoding;
let x0 = BigtableColumnFamily::new().set_encoding(Encoding::Text);
let x1 = BigtableColumnFamily::new().set_encoding(Encoding::Binary);

pub fn set_type<T: Into<Type>>(self, v: T) -> Self

Sets the value of r#type.

Example

use google_cloud_discoveryengine_v1::model::bigtable_options::Type;
let x0 = BigtableColumnFamily::new().set_type(Type::String);
let x1 = BigtableColumnFamily::new().set_type(Type::Number);
let x2 = BigtableColumnFamily::new().set_type(Type::Integer);

pub fn set_columns<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<BigtableColumn>,

Sets the value of columns.

Example

use google_cloud_discoveryengine_v1::model::bigtable_options::BigtableColumn;
let x = BigtableColumnFamily::new()
    .set_columns([
        BigtableColumn::default()/* use setters */,
        BigtableColumn::default()/* use (different) setters */,
    ]);

Trait Implementations

impl Clone for BigtableColumnFamily

fn clone(&self) -> BigtableColumnFamily

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BigtableColumnFamily

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

Formats the value using the given formatter.

impl Default for BigtableColumnFamily

fn default() -> BigtableColumnFamily

Returns the “default value” for a type.

impl Message for BigtableColumnFamily

fn typename() -> &'static str

The typename of this message.

impl PartialEq for BigtableColumnFamily

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for BigtableColumnFamily