Class StepSummary
- java.lang.Object
-
- software.amazon.awssdk.services.deadline.model.StepSummary
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<StepSummary.Builder,StepSummary>
@Generated("software.amazon.awssdk:codegen") public final class StepSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<StepSummary.Builder,StepSummary>
The details for a step.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceStepSummary.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static StepSummary.Builderbuilder()InstantcreatedAt()The date and time the resource was created.StringcreatedBy()The user or system that created this resource.DependencyCountsdependencyCounts()The number of dependencies for the step.InstantendedAt()The date and time the resource ended running.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasTaskRunStatusCounts()For responses, this returns true if the service returned a value for the TaskRunStatusCounts property.StepLifecycleStatuslifecycleStatus()The life cycle status.StringlifecycleStatusAsString()The life cycle status.StringlifecycleStatusMessage()A message that describes the lifecycle of the step.Stringname()The name of the step.List<SdkField<?>>sdkFields()static Class<? extends StepSummary.Builder>serializableBuilderClass()InstantstartedAt()The date and time the resource started running.StringstepId()The step ID.StepTargetTaskRunStatustargetTaskRunStatus()The task status to start with on the job.StringtargetTaskRunStatusAsString()The task status to start with on the job.TaskRunStatustaskRunStatus()The task run status for the job.StringtaskRunStatusAsString()The task run status for the job.Map<TaskRunStatus,Integer>taskRunStatusCounts()The number of tasks running on the job.Map<String,Integer>taskRunStatusCountsAsStrings()The number of tasks running on the job.StepSummary.BuildertoBuilder()StringtoString()Returns a string representation of this object.InstantupdatedAt()The date and time the resource was updated.StringupdatedBy()The user or system that updated this resource.-
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
-
createdAt
public final Instant createdAt()
The date and time the resource was created.
- Returns:
- The date and time the resource was created.
-
createdBy
public final String createdBy()
The user or system that created this resource.
- Returns:
- The user or system that created this resource.
-
dependencyCounts
public final DependencyCounts dependencyCounts()
The number of dependencies for the step.
- Returns:
- The number of dependencies for the step.
-
endedAt
public final Instant endedAt()
The date and time the resource ended running.
- Returns:
- The date and time the resource ended running.
-
lifecycleStatus
public final StepLifecycleStatus lifecycleStatus()
The life cycle status.
If the service returns an enum value that is not available in the current SDK version,
lifecycleStatuswill returnStepLifecycleStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromlifecycleStatusAsString().- Returns:
- The life cycle status.
- See Also:
StepLifecycleStatus
-
lifecycleStatusAsString
public final String lifecycleStatusAsString()
The life cycle status.
If the service returns an enum value that is not available in the current SDK version,
lifecycleStatuswill returnStepLifecycleStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromlifecycleStatusAsString().- Returns:
- The life cycle status.
- See Also:
StepLifecycleStatus
-
lifecycleStatusMessage
public final String lifecycleStatusMessage()
A message that describes the lifecycle of the step.
- Returns:
- A message that describes the lifecycle of the step.
-
name
public final String name()
The name of the step.
- Returns:
- The name of the step.
-
startedAt
public final Instant startedAt()
The date and time the resource started running.
- Returns:
- The date and time the resource started running.
-
stepId
public final String stepId()
The step ID.
- Returns:
- The step ID.
-
targetTaskRunStatus
public final StepTargetTaskRunStatus targetTaskRunStatus()
The task status to start with on the job.
If the service returns an enum value that is not available in the current SDK version,
targetTaskRunStatuswill returnStepTargetTaskRunStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromtargetTaskRunStatusAsString().- Returns:
- The task status to start with on the job.
- See Also:
StepTargetTaskRunStatus
-
targetTaskRunStatusAsString
public final String targetTaskRunStatusAsString()
The task status to start with on the job.
If the service returns an enum value that is not available in the current SDK version,
targetTaskRunStatuswill returnStepTargetTaskRunStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromtargetTaskRunStatusAsString().- Returns:
- The task status to start with on the job.
- See Also:
StepTargetTaskRunStatus
-
taskRunStatus
public final TaskRunStatus taskRunStatus()
The task run status for the job.
-
PENDING–pending and waiting for resources. -
READY–ready to process. -
ASSIGNED–assigned and will run next on a worker. -
SCHEDULED–scheduled to run on a worker. -
INTERRUPTING–being interrupted. -
RUNNING–running on a worker. -
SUSPENDED–the task is suspended. -
CANCELED–the task has been canceled. -
FAILED–the task has failed. -
SUCCEEDED–the task has succeeded.
If the service returns an enum value that is not available in the current SDK version,
taskRunStatuswill returnTaskRunStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromtaskRunStatusAsString().- Returns:
- The task run status for the job.
-
PENDING–pending and waiting for resources. -
READY–ready to process. -
ASSIGNED–assigned and will run next on a worker. -
SCHEDULED–scheduled to run on a worker. -
INTERRUPTING–being interrupted. -
RUNNING–running on a worker. -
SUSPENDED–the task is suspended. -
CANCELED–the task has been canceled. -
FAILED–the task has failed. -
SUCCEEDED–the task has succeeded.
-
- See Also:
TaskRunStatus
-
-
taskRunStatusAsString
public final String taskRunStatusAsString()
The task run status for the job.
-
PENDING–pending and waiting for resources. -
READY–ready to process. -
ASSIGNED–assigned and will run next on a worker. -
SCHEDULED–scheduled to run on a worker. -
INTERRUPTING–being interrupted. -
RUNNING–running on a worker. -
SUSPENDED–the task is suspended. -
CANCELED–the task has been canceled. -
FAILED–the task has failed. -
SUCCEEDED–the task has succeeded.
If the service returns an enum value that is not available in the current SDK version,
taskRunStatuswill returnTaskRunStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromtaskRunStatusAsString().- Returns:
- The task run status for the job.
-
PENDING–pending and waiting for resources. -
READY–ready to process. -
ASSIGNED–assigned and will run next on a worker. -
SCHEDULED–scheduled to run on a worker. -
INTERRUPTING–being interrupted. -
RUNNING–running on a worker. -
SUSPENDED–the task is suspended. -
CANCELED–the task has been canceled. -
FAILED–the task has failed. -
SUCCEEDED–the task has succeeded.
-
- See Also:
TaskRunStatus
-
-
taskRunStatusCounts
public final Map<TaskRunStatus,Integer> taskRunStatusCounts()
The number of tasks running on the job.
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
hasTaskRunStatusCounts()method.- Returns:
- The number of tasks running on the job.
-
hasTaskRunStatusCounts
public final boolean hasTaskRunStatusCounts()
For responses, this returns true if the service returned a value for the TaskRunStatusCounts property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
taskRunStatusCountsAsStrings
public final Map<String,Integer> taskRunStatusCountsAsStrings()
The number of tasks running on the job.
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
hasTaskRunStatusCounts()method.- Returns:
- The number of tasks running on the job.
-
updatedAt
public final Instant updatedAt()
The date and time the resource was updated.
- Returns:
- The date and time the resource was updated.
-
updatedBy
public final String updatedBy()
The user or system that updated this resource.
- Returns:
- The user or system that updated this resource.
-
toBuilder
public StepSummary.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<StepSummary.Builder,StepSummary>
-
builder
public static StepSummary.Builder builder()
-
serializableBuilderClass
public static Class<? extends StepSummary.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin 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.
-
-