Interface JobSummary.Builder

All Superinterfaces:
Buildable, CopyableBuilder<JobSummary.Builder,JobSummary>, SdkBuilder<JobSummary.Builder,JobSummary>, SdkPojo
Enclosing class:
JobSummary
@Mutable @NotThreadSafe public static interface JobSummary.Builder extends SdkPojo, CopyableBuilder<JobSummary.Builder,JobSummary>

  • Method Details

    • jobArn

      JobSummary.Builder jobArn(String jobArn)

      The Amazon Resource Name (ARN) of the job.

      Parameters:
      jobArn - The Amazon Resource Name (ARN) of the job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • jobId

      JobSummary.Builder jobId(String jobId)

      The job ID.

      Parameters:
      jobId - The job ID.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • jobName

      JobSummary.Builder jobName(String jobName)

      The job name.

      Parameters:
      jobName - The job name.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • capacityUsage

      JobSummary.Builder capacityUsage(Collection<JobCapacityUsageSummary> capacityUsage)

      The configured capacity usage information for this job, including the unit of measure and quantity of resources.

      Parameters:
      capacityUsage - The configured capacity usage information for this job, including the unit of measure and quantity of resources.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • capacityUsage

      JobSummary.Builder capacityUsage(JobCapacityUsageSummary... capacityUsage)

      The configured capacity usage information for this job, including the unit of measure and quantity of resources.

      Parameters:
      capacityUsage - The configured capacity usage information for this job, including the unit of measure and quantity of resources.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • capacityUsage

      JobSummary.Builder capacityUsage(Consumer<JobCapacityUsageSummary.Builder>... capacityUsage)

      The configured capacity usage information for this job, including the unit of measure and quantity of resources.

      This is a convenience method that creates an instance of the JobCapacityUsageSummary.Builder avoiding the need to create one manually via JobCapacityUsageSummary.builder() .

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to capacityUsage(List<JobCapacityUsageSummary>).

      Parameters:
      capacityUsage - a consumer that will call methods on JobCapacityUsageSummary.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • createdAt

      JobSummary.Builder createdAt(Long createdAt)

      The Unix timestamp (in milliseconds) for when the job was created. For non-array jobs and parent array jobs, this is when the job entered the SUBMITTED state (at the time SubmitJob was called). For array child jobs, this is when the child job was spawned by its parent and entered the PENDING state.

      Parameters:
      createdAt - The Unix timestamp (in milliseconds) for when the job was created. For non-array jobs and parent array jobs, this is when the job entered the SUBMITTED state (at the time SubmitJob was called). For array child jobs, this is when the child job was spawned by its parent and entered the PENDING state.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scheduledAt

      JobSummary.Builder scheduledAt(Long scheduledAt)

      The Unix timestamp (in milliseconds) for when the job was scheduled for execution. For more information on job statues, see Service job status in the Batch User Guide.

      Parameters:
      scheduledAt - The Unix timestamp (in milliseconds) for when the job was scheduled for execution. For more information on job statues, see Service job status in the Batch User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • shareIdentifier

      JobSummary.Builder shareIdentifier(String shareIdentifier)

      The share identifier for the fairshare scheduling queue that this job is associated with.

      Parameters:
      shareIdentifier - The share identifier for the fairshare scheduling queue that this job is associated with.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

      JobSummary.Builder status(String status)

      The current status for the job.

      Parameters:
      status - The current status for the job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      JobSummary.Builder status(JobStatus status)

      The current status for the job.

      Parameters:
      status - The current status for the job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • statusReason

      JobSummary.Builder statusReason(String statusReason)

      A short, human-readable string to provide more details for the current status of the job.

      Parameters:
      statusReason - A short, human-readable string to provide more details for the current status of the job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • startedAt

      JobSummary.Builder startedAt(Long startedAt)

      The Unix timestamp for when the job was started. More specifically, it's when the job transitioned from the STARTING state to the RUNNING state.

      Parameters:
      startedAt - The Unix timestamp for when the job was started. More specifically, it's when the job transitioned from the STARTING state to the RUNNING state.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • stoppedAt

      JobSummary.Builder stoppedAt(Long stoppedAt)

      The Unix timestamp for when the job was stopped. More specifically, it's when the job transitioned from the RUNNING state to a terminal state, such as SUCCEEDED or FAILED.

      Parameters:
      stoppedAt - The Unix timestamp for when the job was stopped. More specifically, it's when the job transitioned from the RUNNING state to a terminal state, such as SUCCEEDED or FAILED.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • container

      JobSummary.Builder container(ContainerSummary container)

      An object that represents the details of the container that's associated with the job.

      Parameters:
      container - An object that represents the details of the container that's associated with the job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • container

      default JobSummary.Builder container(Consumer<ContainerSummary.Builder> container)

      An object that represents the details of the container that's associated with the job.

      This is a convenience method that creates an instance of the ContainerSummary.Builder avoiding the need to create one manually via ContainerSummary.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to container(ContainerSummary).

      Parameters:
      container - a consumer that will call methods on ContainerSummary.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • arrayProperties

      JobSummary.Builder arrayProperties(ArrayPropertiesSummary arrayProperties)

      The array properties of the job, if it's an array job.

      Parameters:
      arrayProperties - The array properties of the job, if it's an array job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • arrayProperties

      default JobSummary.Builder arrayProperties(Consumer<ArrayPropertiesSummary.Builder> arrayProperties)

      The array properties of the job, if it's an array job.

      This is a convenience method that creates an instance of the ArrayPropertiesSummary.Builder avoiding the need to create one manually via ArrayPropertiesSummary.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to arrayProperties(ArrayPropertiesSummary).

      Parameters:
      arrayProperties - a consumer that will call methods on ArrayPropertiesSummary.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • nodeProperties

      JobSummary.Builder nodeProperties(NodePropertiesSummary nodeProperties)

      The node properties for a single node in a job summary list.

      This isn't applicable to jobs that are running on Fargate resources.

      Parameters:
      nodeProperties - The node properties for a single node in a job summary list.

      This isn't applicable to jobs that are running on Fargate resources.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nodeProperties

      default JobSummary.Builder nodeProperties(Consumer<NodePropertiesSummary.Builder> nodeProperties)

      The node properties for a single node in a job summary list.

      This isn't applicable to jobs that are running on Fargate resources.

      This is a convenience method that creates an instance of the NodePropertiesSummary.Builder avoiding the need to create one manually via NodePropertiesSummary.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to nodeProperties(NodePropertiesSummary).

      Parameters:
      nodeProperties - a consumer that will call methods on NodePropertiesSummary.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • jobDefinition

      JobSummary.Builder jobDefinition(String jobDefinition)

      The Amazon Resource Name (ARN) of the job definition.

      Parameters:
      jobDefinition - The Amazon Resource Name (ARN) of the job definition.
      Returns:
      Returns a reference to this object so that method calls can be chained together.