Class StepSummary
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<StepSummary.Builder,
StepSummary>
The details for a step.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic StepSummary.Builder
builder()
final Instant
The date and time the resource was created.final String
The user or system that created this resource.final DependencyCounts
The number of dependencies for the step.final Instant
endedAt()
The date and time the resource ended running.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 boolean
For responses, this returns true if the service returned a value for the TaskRunStatusCounts property.final StepLifecycleStatus
The life cycle status.final String
The life cycle status.final String
A message that describes the lifecycle of the step.final String
name()
The name of the step.static Class
<? extends StepSummary.Builder> final Instant
The date and time the resource started running.final String
stepId()
The step ID.final StepTargetTaskRunStatus
The task status to start with on the job.final String
The task status to start with on the job.final TaskRunStatus
The task run status for the job.final String
The task run status for the job.final Map
<TaskRunStatus, Integer> The number of tasks running on the job.The number of tasks running on the job.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.final Instant
The date and time the resource was updated.final String
The user or system that updated this resource.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
createdAt
The date and time the resource was created.
- Returns:
- The date and time the resource was created.
-
createdBy
The user or system that created this resource.
- Returns:
- The user or system that created this resource.
-
dependencyCounts
The number of dependencies for the step.
- Returns:
- The number of dependencies for the step.
-
endedAt
The date and time the resource ended running.
- Returns:
- The date and time the resource ended running.
-
lifecycleStatus
The life cycle status.
If the service returns an enum value that is not available in the current SDK version,
lifecycleStatus
will returnStepLifecycleStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlifecycleStatusAsString()
.- Returns:
- The life cycle status.
- See Also:
-
lifecycleStatusAsString
The life cycle status.
If the service returns an enum value that is not available in the current SDK version,
lifecycleStatus
will returnStepLifecycleStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlifecycleStatusAsString()
.- Returns:
- The life cycle status.
- See Also:
-
lifecycleStatusMessage
A message that describes the lifecycle of the step.
- Returns:
- A message that describes the lifecycle of the step.
-
name
The name of the step.
- Returns:
- The name of the step.
-
startedAt
The date and time the resource started running.
- Returns:
- The date and time the resource started running.
-
stepId
The step ID.
- Returns:
- The step ID.
-
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,
targetTaskRunStatus
will 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:
-
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,
targetTaskRunStatus
will 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:
-
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,
taskRunStatus
will 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:
-
-
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,
taskRunStatus
will 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:
-
-
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
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
The date and time the resource was updated.
- Returns:
- The date and time the resource was updated.
-
updatedBy
The user or system that updated this resource.
- Returns:
- The user or system that updated this resource.
-
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<StepSummary.Builder,
StepSummary> - 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
-