Struct CreateConnection

pub struct CreateConnection { /* private fields */ }

Implementations

impl CreateConnection

pub fn builder() -> Builder<NameStage>

Returns a new builder.

impl CreateConnection

pub fn new( name: impl Into<String>, connection_details: ConnectionDetails, should_scrape: bool, ) -> Self

Constructs a new instance of the type.

pub fn name(&self) -> &str

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

pub fn connection_details(&self) -> &ConnectionDetails

pub fn metadata(&self) -> &BTreeMap<String, String>

Metadata information about the connection which is not relevant to the DB connection itself.

pub fn required_tag_names(&self) -> &BTreeSet<TagName>

Additional tag name that are required to construct a fully qualified series.

pub fn available_tag_values( &self, ) -> Option<&BTreeMap<TagName, BTreeSet<TagValue>>>

In most cases, this does not to be set by the user. Throws if populated for Nominal connections, which have their tags automatically indexed in the underlying database. Tags for external connections are periodically scraped. Tags should only be updated manually for Visual crossing connections.

pub fn scraping(&self) -> Option<&ScrapingConfig>

pub fn should_scrape(&self) -> bool

pub fn limits(&self) -> Option<&LimitsConfig>

pub fn workspace(&self) -> Option<&WorkspaceRid>

The workspace in which to create the connection. If not provided, the connection will be created in the default workspace for the user’s organization, if the default workspace for the organization is configured.

pub fn marking_rids(&self) -> &BTreeSet<MarkingRid>

The markings to apply to the created connection. If not provided, the connection will be visible to all users in the same workspace.

Trait Implementations

impl Clone for CreateConnection

fn clone(&self) -> CreateConnection

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CreateConnection

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CreateConnection

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<CreateConnection> for Builder<Complete>

fn from(v: CreateConnection) -> Self

Converts to this type from the input type.

impl Hash for CreateConnection

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for CreateConnection

fn cmp(&self, other: &CreateConnection) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for CreateConnection

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

fn partial_cmp(&self, other: &CreateConnection) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for CreateConnection

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for CreateConnection

impl StructuralPartialEq for CreateConnection