Struct GatewayBatch 

pub struct GatewayBatch { /* private fields */ }

A gateway batch job over an input file, with status and per-request counts.

Implementations

impl GatewayBatch

pub fn new( id: impl Into<String>, input_file_id: impl Into<String>, endpoint: impl Into<String>, created_at_ms: u64, request_counts: GatewayBatchCounts, ) -> Self

Creates a new batch in the GatewayBatchStatus::Queued state.

pub fn complete( self, output_file_id: Option<String>, error_file_id: Option<String>, completed_at_ms: u64, request_counts: GatewayBatchCounts, ) -> Self

Returns the batch transitioned to GatewayBatchStatus::Completed with the given output/error files, completion time, and final counts.

pub fn cancel(self, cancelled_at_ms: u64) -> Self

Returns the batch transitioned to GatewayBatchStatus::Cancelled, counting any still-queued requests as cancelled.

pub fn id(&self) -> &str

Returns the batch identifier.

pub fn input_file_id(&self) -> &str

Returns the id of the input file backing this batch.

pub fn endpoint(&self) -> &str

Returns the target API endpoint for the batched requests.

pub fn status(&self) -> &GatewayBatchStatus

Returns the current lifecycle status.

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

Returns the output file id, once the batch has produced one.

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

Returns the error file id, if the batch produced one.

pub fn created_at_ms(&self) -> u64

Returns the creation timestamp in milliseconds since the Unix epoch.

pub fn completed_at_ms(&self) -> Option<u64>

Returns the completion timestamp in milliseconds, if completed.

pub fn cancelled_at_ms(&self) -> Option<u64>

Returns the cancellation timestamp in milliseconds, if cancelled.

pub fn request_counts(&self) -> GatewayBatchCounts

Returns the current per-request counts.

pub fn to_expr(&self) -> Expr

Encodes the batch as a SIM Expr map record.

Trait Implementations

impl Clone for GatewayBatch

fn clone(&self) -> GatewayBatch

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GatewayBatch

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

Formats the value using the given formatter.

impl Eq for GatewayBatch

impl PartialEq for GatewayBatch

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