Struct MessageBatch 

#[non_exhaustive]
pub struct MessageBatch {
    pub id: String,
    pub kind: String,
    pub processing_status: ProcessingStatus,
    pub request_counts: RequestCounts,
    pub created_at: String,
    pub expires_at: String,
    pub ended_at: Option<String>,
    pub archived_at: Option<String>,
    pub cancel_initiated_at: Option<String>,
    pub results_url: Option<String>,
}

Status snapshot of a batch from GET /v1/messages/batches/{id}.

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.

id: String

Stable batch identifier (e.g. msgbatch_01...).

kind: String

Wire type discriminant; always "message_batch".

processing_status: ProcessingStatus

Current processing status.

request_counts: RequestCounts

Per-status counts of the batch entries.

created_at: String

Creation timestamp (ISO-8601).

expires_at: String

Expiration timestamp (ISO-8601).

ended_at: Option<String>

Set once processing is complete.

archived_at: Option<String>

Set when the batch is archived by the server.

cancel_initiated_at: Option<String>

Set when a cancel was requested.

results_url: Option<String>

URL hosting the JSONL results, available once ended_at is set. The SDK does not require this directly – use super::Batches::results or super::Batches::results_stream to fetch them by batch id.

Trait Implementations

impl Clone for MessageBatch

fn clone(&self) -> MessageBatch

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MessageBatch

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MessageBatch

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for MessageBatch

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

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 MessageBatch

impl StructuralPartialEq for MessageBatch