Struct ConnectorProperty 

#[non_exhaustive]
pub struct ConnectorProperty {
    pub name: String,
    pub key_override: Option<String>,
    pub required: bool,
    pub default_value: Option<String>,
    pub allowed_values: Option<Vec<String>>,
    pub property_location: Option<PropertyLocation>,
    pub property_type: PropertyType,
}

Defines a property configuration for connection types, default values, and where the property should be used in requests.

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.

name: String

The name of the property.

key_override: Option<String>

A key name to use when sending this property in API requests, if different from the display name.

required: bool

Indicates whether the property is required.

default_value: Option<String>

The default value for the property.

allowed_values: Option<Vec<String>>

A list of AllowedValue objects representing the values allowed for the property.

property_location: Option<PropertyLocation>

Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.

property_type: PropertyType

The data type of this property

Implementations

impl ConnectorProperty

pub fn name(&self) -> &str

The name of the property.

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

A key name to use when sending this property in API requests, if different from the display name.

pub fn required(&self) -> bool

Indicates whether the property is required.

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

The default value for the property.

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

A list of AllowedValue objects representing the values allowed for the property.

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

pub fn property_location(&self) -> Option<&PropertyLocation>

Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.

pub fn property_type(&self) -> &PropertyType

The data type of this property

impl ConnectorProperty

pub fn builder() -> ConnectorPropertyBuilder

Creates a new builder-style object to manufacture ConnectorProperty.

Trait Implementations

impl Clone for ConnectorProperty

fn clone(&self) -> ConnectorProperty

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConnectorProperty

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

Formats the value using the given formatter.

impl PartialEq for ConnectorProperty

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