aws_sdk_deadline/client/
batch_get_job_entity.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`BatchGetJobEntity`](crate::operation::batch_get_job_entity::builders::BatchGetJobEntityFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`farm_id(impl Into<String>)`](crate::operation::batch_get_job_entity::builders::BatchGetJobEntityFluentBuilder::farm_id) / [`set_farm_id(Option<String>)`](crate::operation::batch_get_job_entity::builders::BatchGetJobEntityFluentBuilder::set_farm_id):<br>required: **true**<br><p>The farm ID of the worker that's fetching job details. The worker must have an assignment on a job to fetch job details.</p><br>
    ///   - [`fleet_id(impl Into<String>)`](crate::operation::batch_get_job_entity::builders::BatchGetJobEntityFluentBuilder::fleet_id) / [`set_fleet_id(Option<String>)`](crate::operation::batch_get_job_entity::builders::BatchGetJobEntityFluentBuilder::set_fleet_id):<br>required: **true**<br><p>The fleet ID of the worker that's fetching job details. The worker must have an assignment on a job to fetch job details.</p><br>
    ///   - [`worker_id(impl Into<String>)`](crate::operation::batch_get_job_entity::builders::BatchGetJobEntityFluentBuilder::worker_id) / [`set_worker_id(Option<String>)`](crate::operation::batch_get_job_entity::builders::BatchGetJobEntityFluentBuilder::set_worker_id):<br>required: **true**<br><p>The worker ID of the worker containing the job details to get.</p><br>
    ///   - [`identifiers(JobEntityIdentifiersUnion)`](crate::operation::batch_get_job_entity::builders::BatchGetJobEntityFluentBuilder::identifiers) / [`set_identifiers(Option<Vec::<JobEntityIdentifiersUnion>>)`](crate::operation::batch_get_job_entity::builders::BatchGetJobEntityFluentBuilder::set_identifiers):<br>required: **true**<br><p>The job identifiers to include within the job entity batch details.</p><br>
    /// - On success, responds with [`BatchGetJobEntityOutput`](crate::operation::batch_get_job_entity::BatchGetJobEntityOutput) with field(s):
    ///   - [`entities(Vec::<JobEntity>)`](crate::operation::batch_get_job_entity::BatchGetJobEntityOutput::entities): <p>A list of the job entities, or details, in the batch.</p>
    ///   - [`errors(Vec::<GetJobEntityError>)`](crate::operation::batch_get_job_entity::BatchGetJobEntityOutput::errors): <p>A list of errors from the job error logs for the batch.</p>
    /// - On failure, responds with [`SdkError<BatchGetJobEntityError>`](crate::operation::batch_get_job_entity::BatchGetJobEntityError)
    pub fn batch_get_job_entity(&self) -> crate::operation::batch_get_job_entity::builders::BatchGetJobEntityFluentBuilder {
        crate::operation::batch_get_job_entity::builders::BatchGetJobEntityFluentBuilder::new(self.handle.clone())
    }
}