Class JobSummary
- java.lang.Object
-
- software.amazon.awssdk.services.batch.model.JobSummary
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<JobSummary.Builder,JobSummary>
@Generated("software.amazon.awssdk:codegen") public final class JobSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<JobSummary.Builder,JobSummary>
An object that represents summary details of a job.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
JobSummary.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description ArrayPropertiesSummary
arrayProperties()
The array properties of the job, if it's an array job.static JobSummary.Builder
builder()
ContainerSummary
container()
An object that represents the details of the container that's associated with the job.Long
createdAt()
The Unix timestamp (in milliseconds) for when the job was created.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
String
jobArn()
The Amazon Resource Name (ARN) of the job.String
jobDefinition()
The Amazon Resource Name (ARN) of the job definition.String
jobId()
The job ID.String
jobName()
The job name.NodePropertiesSummary
nodeProperties()
The node properties for a single node in a job summary list.List<SdkField<?>>
sdkFields()
static Class<? extends JobSummary.Builder>
serializableBuilderClass()
Long
startedAt()
The Unix timestamp for when the job was started.JobStatus
status()
The current status for the job.String
statusAsString()
The current status for the job.String
statusReason()
A short, human-readable string to provide more details for the current status of the job.Long
stoppedAt()
The Unix timestamp for when the job was stopped.JobSummary.Builder
toBuilder()
String
toString()
Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
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.
-
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 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
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 returnJobStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- 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 returnJobStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- 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 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
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 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
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.
-
toBuilder
public JobSummary.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<JobSummary.Builder,JobSummary>
-
builder
public static JobSummary.Builder builder()
-
serializableBuilderClass
public static Class<? extends JobSummary.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
-