Package software.amazon.awssdk.services.batch.model

Class JobSummary

    • Method Detail

      • jobArn

        public final String jobArn()

        The Amazon Resource Name (ARN) of the job.

        Returns:
        The Amazon Resource Name (ARN) of the job.

      • jobId

        public final String jobId()

        The job ID.

        Returns:
        The job ID.

      • jobName

        public final String jobName()

        The job name.

        Returns:
        The job name.

      • hasCapacityUsage

        public final boolean hasCapacityUsage()
        For responses, this returns true if the service returned a value for the CapacityUsage property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • capacityUsage

        public final List<JobCapacityUsageSummary> capacityUsage()

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

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasCapacityUsage() method.

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

      • createdAt

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

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

      • scheduledAt

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

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

      • shareIdentifier

        public final String shareIdentifier()

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

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

      • status

        public final JobStatus status()

        The current status for the job.

        If the service returns an enum value that is not available in the current SDK version, status will return JobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

        Returns:
        The current status for the job.
        See Also:
        JobStatus

      • statusAsString

        public final String statusAsString()

        The current status for the job.

        If the service returns an enum value that is not available in the current SDK version, status will return JobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

        Returns:
        The current status for the job.
        See Also:
        JobStatus

      • statusReason

        public final String statusReason()

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

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

      • startedAt

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

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

      • stoppedAt

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

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

      • container

        public final ContainerSummary container()

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

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

      • arrayProperties

        public final ArrayPropertiesSummary arrayProperties()

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

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

      • nodeProperties

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

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

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

      • jobDefinition

        public final String jobDefinition()

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

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

      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object

      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object

      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                              Class<T> clazz)