Class WorkflowStepMetadata
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<WorkflowStepMetadata.Builder,
WorkflowStepMetadata>
Runtime details and status for the workflow step.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
action()
The step action name.static WorkflowStepMetadata.Builder
builder()
final String
Description of the workflow step.final String
endTime()
The timestamp when the workflow step finished.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
inputs()
Input parameters that Image Builder provides for the workflow step.final String
message()
Detailed output message that the workflow step provides at runtime.final String
name()
The name of the workflow step.final String
outputs()
The file names that the workflow step created as output for this runtime instance of the workflow.Reports on the rollback status of the step, if applicable.final String
Reports on the rollback status of the step, if applicable.static Class
<? extends WorkflowStepMetadata.Builder> final String
The timestamp when the workflow step started.status()
Runtime status for the workflow step.final String
Runtime status for the workflow step.final String
A unique identifier for the workflow step, assigned at runtime.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
-
stepExecutionId
A unique identifier for the workflow step, assigned at runtime.
- Returns:
- A unique identifier for the workflow step, assigned at runtime.
-
name
The name of the workflow step.
- Returns:
- The name of the workflow step.
-
description
Description of the workflow step.
- Returns:
- Description of the workflow step.
-
action
The step action name.
- Returns:
- The step action name.
-
status
Runtime status for the workflow step.
If the service returns an enum value that is not available in the current SDK version,
status
will returnWorkflowStepExecutionStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- Runtime status for the workflow step.
- See Also:
-
statusAsString
Runtime status for the workflow step.
If the service returns an enum value that is not available in the current SDK version,
status
will returnWorkflowStepExecutionStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- Runtime status for the workflow step.
- See Also:
-
rollbackStatus
Reports on the rollback status of the step, if applicable.
If the service returns an enum value that is not available in the current SDK version,
rollbackStatus
will returnWorkflowStepExecutionRollbackStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromrollbackStatusAsString()
.- Returns:
- Reports on the rollback status of the step, if applicable.
- See Also:
-
rollbackStatusAsString
Reports on the rollback status of the step, if applicable.
If the service returns an enum value that is not available in the current SDK version,
rollbackStatus
will returnWorkflowStepExecutionRollbackStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromrollbackStatusAsString()
.- Returns:
- Reports on the rollback status of the step, if applicable.
- See Also:
-
message
Detailed output message that the workflow step provides at runtime.
- Returns:
- Detailed output message that the workflow step provides at runtime.
-
inputs
Input parameters that Image Builder provides for the workflow step.
- Returns:
- Input parameters that Image Builder provides for the workflow step.
-
outputs
The file names that the workflow step created as output for this runtime instance of the workflow.
- Returns:
- The file names that the workflow step created as output for this runtime instance of the workflow.
-
startTime
The timestamp when the workflow step started.
- Returns:
- The timestamp when the workflow step started.
-
endTime
The timestamp when the workflow step finished.
- Returns:
- The timestamp when the workflow step finished.
-
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<WorkflowStepMetadata.Builder,
WorkflowStepMetadata> - 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
-