Struct DestinationFieldProperties

#[non_exhaustive]
pub struct DestinationFieldProperties {
    pub is_creatable: bool,
    pub is_nullable: bool,
    pub is_upsertable: bool,
    pub is_updatable: bool,
    pub is_defaulted_on_create: bool,
    pub supported_write_operations: Option<Vec<WriteOperationType>>,
}

The properties that can be applied to a field when connector is being used as a destination.

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.

is_creatable: bool

Specifies if the destination field can be created by the current user.

is_nullable: bool

Specifies if the destination field can have a null value.

is_upsertable: bool

Specifies if the flow run can either insert new rows in the destination field if they do not already exist, or update them if they do.

is_updatable: bool

Specifies whether the field can be updated during an UPDATE or UPSERT write operation.

is_defaulted_on_create: bool

Specifies whether the field can use the default value during a Create operation.

supported_write_operations: Option<Vec<WriteOperationType>>

A list of supported write operations. For each write operation listed, this field can be used in idFieldNames when that write operation is present as a destination option.

Implementations

impl DestinationFieldProperties

pub fn is_creatable(&self) -> bool

Specifies if the destination field can be created by the current user.

pub fn is_nullable(&self) -> bool

Specifies if the destination field can have a null value.

pub fn is_upsertable(&self) -> bool

Specifies if the flow run can either insert new rows in the destination field if they do not already exist, or update them if they do.

pub fn is_updatable(&self) -> bool

Specifies whether the field can be updated during an UPDATE or UPSERT write operation.

pub fn is_defaulted_on_create(&self) -> bool

Specifies whether the field can use the default value during a Create operation.

pub fn supported_write_operations(&self) -> &[WriteOperationType]

A list of supported write operations. For each write operation listed, this field can be used in idFieldNames when that write operation is present as a destination option.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .supported_write_operations.is_none().

impl DestinationFieldProperties

pub fn builder() -> DestinationFieldPropertiesBuilder

Creates a new builder-style object to manufacture DestinationFieldProperties.

Trait Implementations

impl Clone for DestinationFieldProperties

fn clone(&self) -> DestinationFieldProperties

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DestinationFieldProperties

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

Formats the value using the given formatter.

impl PartialEq for DestinationFieldProperties

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