Class JobSummary
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<JobSummary.Builder,
JobSummary>
An object that represents summary details of a job.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal ArrayPropertiesSummary
The array properties of the job, if it's an array job.static JobSummary.Builder
builder()
final ContainerSummary
An object that represents the details of the container that's associated with the job.final Long
The Unix timestamp (in milliseconds) for when the job was created.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
jobArn()
The Amazon Resource Name (ARN) of the job.final String
The Amazon Resource Name (ARN) of the job definition.final String
jobId()
The job ID.final String
jobName()
The job name.final NodePropertiesSummary
The node properties for a single node in a job summary list.static Class
<? extends JobSummary.Builder> final Long
The Unix timestamp for when the job was started.final JobStatus
status()
The current status for the job.final String
The current status for the job.final String
A short, human-readable string to provide more details for the current status of the job.final Long
The Unix timestamp for when the job was stopped.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
jobArn
The Amazon Resource Name (ARN) of the job.
- Returns:
- The Amazon Resource Name (ARN) of the job.
-
jobId
The job ID.
- Returns:
- The job ID.
-
jobName
The job name.
- Returns:
- The job name.
-
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 thePENDING
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 thePENDING
state.
-
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 returnJobStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The current status for the job.
- See Also:
-
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 returnJobStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The current status for the job.
- See Also:
-
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
The Unix timestamp for when the job was started. More specifically, it's when the job transitioned from the
STARTING
state to theRUNNING
state.- Returns:
- The Unix timestamp for when the job was started. More specifically, it's when the job transitioned from
the
STARTING
state to theRUNNING
state.
-
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 asSUCCEEDED
orFAILED
.- 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 asSUCCEEDED
orFAILED
.
-
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
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
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
The Amazon Resource Name (ARN) of the job definition.
- Returns:
- The Amazon Resource Name (ARN) of the job definition.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<JobSummary.Builder,
JobSummary> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-