Struct google_api_proto::google::cloud::discoveryengine::v1::bigtable_options::BigtableColumnFamily

pub struct BigtableColumnFamily {
    pub field_name: String,
    pub encoding: i32,
    pub type: i32,
    pub columns: Vec<BigtableColumn>,
}

The column family of the Bigtable.

Fields

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: i32

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: i32

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 encoding(&self) -> Encoding

Returns the enum value of encoding, or the default if the field is set to an invalid enum value.

pub fn set_encoding(&mut self, value: Encoding)

Sets encoding to the provided enum value.

pub fn type(&self) -> Type

Returns the enum value of type, or the default if the field is set to an invalid enum value.

pub fn set_type(&mut self, value: Type)

Sets type to the provided enum value.

Trait Implementations

impl Clone for BigtableColumnFamily

fn clone(&self) -> BigtableColumnFamily

Returns a copy 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() -> Self

Returns the “default value” for a type.

impl Message for BigtableColumnFamily

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(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

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

where Self: Sized,

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

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

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

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

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

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

where Self: Sized,

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

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

where Self: Sized,

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

impl PartialEq for BigtableColumnFamily

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

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

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

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

impl StructuralPartialEq for BigtableColumnFamily