Struct google_api_proto::google::cloud::datacatalog::v1::ColumnSchema

pub struct ColumnSchema {
    pub column: String,
    pub type: String,
    pub description: String,
    pub mode: String,
    pub default_value: String,
    pub ordinal_position: i32,
    pub highest_indexing_type: i32,
    pub subcolumns: Vec<ColumnSchema>,
    pub range_element_type: Option<FieldElementType>,
    pub gc_rule: String,
    pub system_spec: Option<SystemSpec>,
}

A column within a schema. Columns can be nested inside other columns.

Fields

column: String

Required. Name of the column.

Must be a UTF-8 string without dots (.). The maximum size is 64 bytes.

type: String

Required. Type of the column.

Must be a UTF-8 string with the maximum size of 128 bytes.

description: String

Optional. Description of the column. Default value is an empty string.

The description must be a UTF-8 string with the maximum size of 2000 bytes.

mode: String

Optional. A column’s mode indicates whether values in this column are required, nullable, or repeated.

Only NULLABLE, REQUIRED, and REPEATED values are supported. Default mode is NULLABLE.

default_value: String

Optional. Default value for the column.

ordinal_position: i32

Optional. Ordinal position

highest_indexing_type: i32

Optional. Most important inclusion of this column.

subcolumns: Vec<ColumnSchema>

Optional. Schema of sub-columns. A column can have zero or more sub-columns.

range_element_type: Option<FieldElementType>

Optional. The subtype of the RANGE, if the type of this field is RANGE. If the type is RANGE, this field is required. Possible values for the field element type of a RANGE include:

• DATE
• DATETIME
• TIMESTAMP

gc_rule: String

Optional. Garbage collection policy for the column or column family. Applies to systems like Cloud Bigtable.

system_spec: Option<SystemSpec>

Information only applying for columns in Entries from a specific system.

Implementations

impl ColumnSchema

pub fn highest_indexing_type(&self) -> IndexingType

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

pub fn set_highest_indexing_type(&mut self, value: IndexingType)

Sets highest_indexing_type to the provided enum value.

Trait Implementations

impl Clone for ColumnSchema

fn clone(&self) -> ColumnSchema

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ColumnSchema

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

Formats the value using the given formatter.

impl Default for ColumnSchema

fn default() -> Self

Returns the “default value” for a type.

impl Message for ColumnSchema

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 ColumnSchema

fn eq(&self, other: &ColumnSchema) -> 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 ColumnSchema