Struct AuthParameter

#[non_exhaustive]
pub struct AuthParameter {
    pub key: Option<String>,
    pub is_required: bool,
    pub label: Option<String>,
    pub description: Option<String>,
    pub is_sensitive_field: bool,
    pub connector_supplied_values: Option<Vec<String>>,
}

Information about required authentication parameters.

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.

key: Option<String>

The authentication key required to authenticate with the connector.

is_required: bool

Indicates whether this authentication parameter is required.

label: Option<String>

Label used for authentication parameter.

description: Option<String>

A description about the authentication parameter.

is_sensitive_field: bool

Indicates whether this authentication parameter is a sensitive field.

connector_supplied_values: Option<Vec<String>>

Contains default values for this authentication parameter that are supplied by the connector.

Implementations

impl AuthParameter

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

The authentication key required to authenticate with the connector.

pub fn is_required(&self) -> bool

Indicates whether this authentication parameter is required.

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

Label used for authentication parameter.

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

A description about the authentication parameter.

pub fn is_sensitive_field(&self) -> bool

Indicates whether this authentication parameter is a sensitive field.

pub fn connector_supplied_values(&self) -> &[String]

Contains default values for this authentication parameter that are supplied by the connector.

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

impl AuthParameter

pub fn builder() -> AuthParameterBuilder

Creates a new builder-style object to manufacture AuthParameter.

Trait Implementations

impl Clone for AuthParameter

fn clone(&self) -> AuthParameter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AuthParameter

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

Formats the value using the given formatter.

impl PartialEq for AuthParameter

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