Class WorkflowStepMetadata
- java.lang.Object
-
- software.amazon.awssdk.services.imagebuilder.model.WorkflowStepMetadata
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<WorkflowStepMetadata.Builder,WorkflowStepMetadata>
@Generated("software.amazon.awssdk:codegen") public final class WorkflowStepMetadata extends Object implements SdkPojo, Serializable, ToCopyableBuilder<WorkflowStepMetadata.Builder,WorkflowStepMetadata>
Runtime details and status for the workflow step.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceWorkflowStepMetadata.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Stringaction()The step action name.static WorkflowStepMetadata.Builderbuilder()Stringdescription()Description of the workflow step.StringendTime()The timestamp when the workflow step finished.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()Stringinputs()Input parameters that Image Builder provides for the workflow step.Stringmessage()Detailed output message that the workflow step provides at runtime.Stringname()The name of the workflow step.Stringoutputs()The file names that the workflow step created as output for this runtime instance of the workflow.WorkflowStepExecutionRollbackStatusrollbackStatus()Reports on the rollback status of the step, if applicable.StringrollbackStatusAsString()Reports on the rollback status of the step, if applicable.List<SdkField<?>>sdkFields()static Class<? extends WorkflowStepMetadata.Builder>serializableBuilderClass()StringstartTime()The timestamp when the workflow step started.WorkflowStepExecutionStatusstatus()Runtime status for the workflow step.StringstatusAsString()Runtime status for the workflow step.StringstepExecutionId()A unique identifier for the workflow step, assigned at runtime.WorkflowStepMetadata.BuildertoBuilder()StringtoString()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
-
stepExecutionId
public final String stepExecutionId()
A unique identifier for the workflow step, assigned at runtime.
- Returns:
- A unique identifier for the workflow step, assigned at runtime.
-
name
public final String name()
The name of the workflow step.
- Returns:
- The name of the workflow step.
-
description
public final String description()
Description of the workflow step.
- Returns:
- Description of the workflow step.
-
action
public final String action()
The step action name.
- Returns:
- The step action name.
-
status
public final WorkflowStepExecutionStatus status()
Runtime status for the workflow step.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnWorkflowStepExecutionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- Runtime status for the workflow step.
- See Also:
WorkflowStepExecutionStatus
-
statusAsString
public final String statusAsString()
Runtime status for the workflow step.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnWorkflowStepExecutionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- Runtime status for the workflow step.
- See Also:
WorkflowStepExecutionStatus
-
rollbackStatus
public final WorkflowStepExecutionRollbackStatus 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,
rollbackStatuswill 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:
WorkflowStepExecutionRollbackStatus
-
rollbackStatusAsString
public final String 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,
rollbackStatuswill 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:
WorkflowStepExecutionRollbackStatus
-
message
public final String message()
Detailed output message that the workflow step provides at runtime.
- Returns:
- Detailed output message that the workflow step provides at runtime.
-
inputs
public final String inputs()
Input parameters that Image Builder provides for the workflow step.
- Returns:
- Input parameters that Image Builder provides for the workflow step.
-
outputs
public final String 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
public final String startTime()
The timestamp when the workflow step started.
- Returns:
- The timestamp when the workflow step started.
-
endTime
public final String endTime()
The timestamp when the workflow step finished.
- Returns:
- The timestamp when the workflow step finished.
-
toBuilder
public WorkflowStepMetadata.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<WorkflowStepMetadata.Builder,WorkflowStepMetadata>
-
builder
public static WorkflowStepMetadata.Builder builder()
-
serializableBuilderClass
public static Class<? extends WorkflowStepMetadata.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.
-
-