Struct Entity 

#[non_exhaustive]
pub struct Entity {
    pub entity_name: Option<String>,
    pub label: Option<String>,
    pub is_parent_entity: Option<bool>,
    pub description: Option<String>,
    pub category: Option<String>,
    pub custom_properties: Option<HashMap<String, String>>,
}

An entity supported by a given ConnectionType.

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.

entity_name: Option<String>

The name of the entity.

label: Option<String>

Label used for the entity.

is_parent_entity: Option<bool>

A Boolean value which helps to determine whether there are sub objects that can be listed.

description: Option<String>

A description of the entity.

category: Option<String>

The type of entities that are present in the response. This value depends on the source connection. For example this is SObjects for Salesforce and databases or schemas or tables for sources like Amazon Redshift.

custom_properties: Option<HashMap<String, String>>

An optional map of keys which may be returned for an entity by a connector.

Implementations

impl Entity

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

The name of the entity.

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

Label used for the entity.

pub fn is_parent_entity(&self) -> Option<bool>

A Boolean value which helps to determine whether there are sub objects that can be listed.

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

A description of the entity.

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

The type of entities that are present in the response. This value depends on the source connection. For example this is SObjects for Salesforce and databases or schemas or tables for sources like Amazon Redshift.

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

An optional map of keys which may be returned for an entity by a connector.

impl Entity

pub fn builder() -> EntityBuilder

Creates a new builder-style object to manufacture Entity.

Trait Implementations

impl Clone for Entity

fn clone(&self) -> Entity

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Entity

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

Formats the value using the given formatter.

impl PartialEq for Entity

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