Struct ConnectorEntityField

#[non_exhaustive]
pub struct ConnectorEntityField {
    pub identifier: String,
    pub parent_identifier: Option<String>,
    pub label: Option<String>,
    pub is_primary_key: bool,
    pub default_value: Option<String>,
    pub is_deprecated: bool,
    pub supported_field_type_details: Option<SupportedFieldTypeDetails>,
    pub description: Option<String>,
    pub source_properties: Option<SourceFieldProperties>,
    pub destination_properties: Option<DestinationFieldProperties>,
    pub custom_properties: Option<HashMap<String, String>>,
}

Describes the data model of a connector field. For example, for an account entity, the fields would be account name, account ID, and so on.

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.

identifier: String

The unique identifier of the connector field.

parent_identifier: Option<String>

The parent identifier of the connector field.

label: Option<String>

The label applied to a connector entity field.

is_primary_key: bool

Booelan value that indicates whether this field can be used as a primary key.

default_value: Option<String>

Default value that can be assigned to this field.

is_deprecated: bool

Booelan value that indicates whether this field is deprecated or not.

supported_field_type_details: Option<SupportedFieldTypeDetails>

Contains details regarding the supported FieldType, including the corresponding filterOperators and supportedValues.

description: Option<String>

A description of the connector entity field.

source_properties: Option<SourceFieldProperties>

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

destination_properties: Option<DestinationFieldProperties>

The properties applied to a field when the connector is being used as a destination.

custom_properties: Option<HashMap<String, String>>

A map that has specific properties related to the ConnectorEntityField.

Implementations

impl ConnectorEntityField

pub fn identifier(&self) -> &str

The unique identifier of the connector field.

pub fn parent_identifier(&self) -> Option<&str>

The parent identifier of the connector field.

pub fn label(&self) -> Option<&str>

The label applied to a connector entity field.

pub fn is_primary_key(&self) -> bool

Booelan value that indicates whether this field can be used as a primary key.

pub fn default_value(&self) -> Option<&str>

Default value that can be assigned to this field.

pub fn is_deprecated(&self) -> bool

Booelan value that indicates whether this field is deprecated or not.

pub fn supported_field_type_details(&self) -> Option<&SupportedFieldTypeDetails>

Contains details regarding the supported FieldType, including the corresponding filterOperators and supportedValues.

pub fn description(&self) -> Option<&str>

A description of the connector entity field.

pub fn source_properties(&self) -> Option<&SourceFieldProperties>

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

pub fn destination_properties(&self) -> Option<&DestinationFieldProperties>

The properties applied to a field when the connector is being used as a destination.

pub fn custom_properties(&self) -> Option<&HashMap<String, String>>

A map that has specific properties related to the ConnectorEntityField.

impl ConnectorEntityField

pub fn builder() -> ConnectorEntityFieldBuilder

Creates a new builder-style object to manufacture ConnectorEntityField.

Trait Implementations

impl Clone for ConnectorEntityField

fn clone(&self) -> ConnectorEntityField

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConnectorEntityField

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

Formats the value using the given formatter.

impl PartialEq for ConnectorEntityField

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