Struct MessageBatch

pub struct MessageBatch {
    pub id: String,
    pub object_type: String,
    pub processing_status: BatchStatus,
    pub request_counts: BatchRequestCounts,
    pub created_at: DateTime<Utc>,
    pub expires_at: DateTime<Utc>,
    pub ended_at: Option<DateTime<Utc>>,
    pub input_file_id: String,
    pub output_file_id: Option<String>,
    pub error_file_id: Option<String>,
    pub metadata: HashMap<String, String>,
}

A batch request for processing multiple messages efficiently

Fields

id: String

Unique identifier for the batch

object_type: String

The type of object (always “message_batch”)

processing_status: BatchStatus

Current processing status of the batch

request_counts: BatchRequestCounts

Total number of requests in the batch

created_at: DateTime<Utc>

When the batch was created

expires_at: DateTime<Utc>

When the batch processing will expire

ended_at: Option<DateTime<Utc>>

When the batch processing was completed (if applicable)

input_file_id: String

File ID containing the batch requests

output_file_id: Option<String>

File ID containing the batch results (if completed)

error_file_id: Option<String>

File ID containing any errors (if applicable)

metadata: HashMap<String, String>

Custom metadata for the batch

Implementations

impl MessageBatch

pub fn is_complete(&self) -> bool

Check if the batch is complete

pub fn has_failed(&self) -> bool

Check if the batch has failed

pub fn can_cancel(&self) -> bool

Check if the batch can be cancelled

pub fn completion_percentage(&self) -> f64

Get completion percentage

pub fn pending_requests(&self) -> u32

Get the number of pending requests

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 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.