Struct Reference

#[non_exhaustive]
pub struct Reference {
    pub value: String,
    pub type: ReferenceType,
    pub status: Option<ReferenceStatus>,
    pub arn: Option<String>,
    pub status_reason: Option<String>,
}

Well-formed data on a contact, used by agents to complete a contact request. You can have up to 4,096 UTF-8 bytes across all references for a contact.

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.

value: String

A valid value for the reference. For example, for a URL reference, a formatted URL that is displayed to an agent in the Contact Control Panel (CCP).

type: ReferenceType

The type of the reference. DATE must be of type Epoch timestamp.

status: Option<ReferenceStatus>

Status of the attachment reference type.

arn: Option<String>

The Amazon Resource Name (ARN) of the reference

status_reason: Option<String>

Relevant details why the reference was not successfully created.

Implementations

impl Reference

pub fn value(&self) -> &str

A valid value for the reference. For example, for a URL reference, a formatted URL that is displayed to an agent in the Contact Control Panel (CCP).

pub fn type(&self) -> &ReferenceType

The type of the reference. DATE must be of type Epoch timestamp.

pub fn status(&self) -> Option<&ReferenceStatus>

Status of the attachment reference type.

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

The Amazon Resource Name (ARN) of the reference

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

Relevant details why the reference was not successfully created.

impl Reference

pub fn builder() -> ReferenceBuilder

Creates a new builder-style object to manufacture Reference.

Trait Implementations

impl Clone for Reference

fn clone(&self) -> Reference

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Reference

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

Formats the value using the given formatter.

impl PartialEq for Reference

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