Struct HttpAction

#[non_exhaustive]
pub struct HttpAction {
    pub url: String,
    pub confirmation_url: Option<String>,
    pub headers: Option<Vec<HttpActionHeader>>,
    pub auth: Option<HttpAuthorization>,
}

Send data to an HTTPS endpoint.

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.

url: String

The endpoint URL. If substitution templates are used in the URL, you must also specify a confirmationUrl. If this is a new destination, a new TopicRuleDestination is created if possible.

confirmation_url: Option<String>

The URL to which IoT sends a confirmation message. The value of the confirmation URL must be a prefix of the endpoint URL. If you do not specify a confirmation URL IoT uses the endpoint URL as the confirmation URL. If you use substitution templates in the confirmationUrl, you must create and enable topic rule destinations that match each possible value of the substitution template before traffic is allowed to your endpoint URL.

headers: Option<Vec<HttpActionHeader>>

The HTTP headers to send with the message data.

auth: Option<HttpAuthorization>

The authentication method to use when sending data to an HTTPS endpoint.

Implementations

impl HttpAction

pub fn url(&self) -> &str

The endpoint URL. If substitution templates are used in the URL, you must also specify a confirmationUrl. If this is a new destination, a new TopicRuleDestination is created if possible.

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

The URL to which IoT sends a confirmation message. The value of the confirmation URL must be a prefix of the endpoint URL. If you do not specify a confirmation URL IoT uses the endpoint URL as the confirmation URL. If you use substitution templates in the confirmationUrl, you must create and enable topic rule destinations that match each possible value of the substitution template before traffic is allowed to your endpoint URL.

pub fn headers(&self) -> &[HttpActionHeader]

The HTTP headers to send with the message data.

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

pub fn auth(&self) -> Option<&HttpAuthorization>

The authentication method to use when sending data to an HTTPS endpoint.

impl HttpAction

pub fn builder() -> HttpActionBuilder

Creates a new builder-style object to manufacture HttpAction.

Trait Implementations

impl Clone for HttpAction

fn clone(&self) -> HttpAction

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HttpAction

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

Formats the value using the given formatter.

impl PartialEq for HttpAction

fn eq(&self, other: &HttpAction) -> bool

Tests for self and other values to be equal, and is used by ==.

const 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 HttpAction