Struct JobRequestItemBuilder 

pub struct JobRequestItemBuilder<S> { /* private fields */ }

Typestate builder for JobSubmitRequestItem.

Start with JobRequestItemBuilder::new, set fields, then call .pod_spec(spec) or .pod_specs(specs) to transition to the HasPodSpec state, which unlocks .build(). Attempting to call .build() before providing a pod spec is a compile-time error.

Example

let item = JobRequestItemBuilder::new()
    .namespace("default")
    .priority(1.0)
    .label("app", "my-app")
    .pod_spec(pod_spec)
    .build();

Implementations

impl JobRequestItemBuilder<NoPodSpec>

pub fn new() -> Self

Create a new builder with all fields set to their zero/empty defaults.

Call setters to configure the job, then supply a pod spec with .pod_spec() or .pod_specs() to unlock .build().

impl<S> JobRequestItemBuilder<S>

pub fn priority(self, p: f64) -> Self

Job priority relative to others in the queue. Higher values are scheduled first. Must be non-negative; the server will reject negative values. Defaults to 0.0.

pub fn namespace(self, ns: impl Into<String>) -> Self

Set the Kubernetes namespace in which the job’s pod will run.

Typically "default" unless your cluster uses a dedicated namespace for batch workloads.

pub fn client_id(self, id: impl Into<String>) -> Self

Set an opaque client-supplied identifier for idempotency tracking.

If the same client_id is submitted twice, Armada will deduplicate the request and return the existing job rather than creating a new one. Leave empty (the default) to disable deduplication.

pub fn labels(self, l: HashMap<String, String>) -> Self

Replace the entire labels map.

pub fn label(self, k: impl Into<String>, v: impl Into<String>) -> Self

Insert a single label. Can be chained multiple times.

pub fn annotations(self, a: HashMap<String, String>) -> Self

Replace the entire annotations map.

pub fn annotation(self, k: impl Into<String>, v: impl Into<String>) -> Self

Insert a single annotation. Can be chained multiple times.

pub fn scheduler(self, s: impl Into<String>) -> Self

Override the scheduler for this job. Leave empty to use the cluster default.

pub fn ingress(self, i: Vec<IngressConfig>) -> Self

Replace the entire ingress config list.

pub fn add_ingress(self, i: IngressConfig) -> Self

Append a single ingress config. Can be chained multiple times.

pub fn services(self, s: Vec<ServiceConfig>) -> Self

Replace the entire service config list.

pub fn add_service(self, s: ServiceConfig) -> Self

Append a single service config. Can be chained multiple times.

pub fn pod_spec(self, spec: PodSpec) -> JobRequestItemBuilder<HasPodSpec>

Set a single pod spec and transition the builder to [HasPodSpec] state, which unlocks .build().

Shorthand for .pod_specs(vec![spec]). If called again on a JobRequestItemBuilder<HasPodSpec>, the previous spec is replaced.

pub fn pod_specs(self, specs: Vec<PodSpec>) -> JobRequestItemBuilder<HasPodSpec>

Set multiple pod specs and transition the builder to [HasPodSpec] state, which unlocks .build().

If called again on a JobRequestItemBuilder<HasPodSpec>, the previous specs are replaced entirely.

impl JobRequestItemBuilder<HasPodSpec>

pub fn build(self) -> JobSubmitRequestItem

Consume the builder and return a JobSubmitRequestItem ready to be included in a crate::JobSubmitRequest.

This method is only available after calling .pod_spec() or .pod_specs(). Calling .build() on a JobRequestItemBuilder<NoPodSpec> is a compile-time error.