Class GetWorkflowStepExecutionResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<GetWorkflowStepExecutionResponse.Builder,
GetWorkflowStepExecutionResponse>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
action()
The name of the action that the specified step performs.builder()
final String
Describes the specified workflow step.final String
endTime()
The timestamp when the specified runtime instance of 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) Used to retrieve the value of a field from any class that extendsSdkResponse
.final int
hashCode()
final String
The Amazon Resource Name (ARN) of the image resource build version that the specified runtime instance of the workflow step creates.final String
inputs()
Input parameters that Image Builder provided for the specified runtime instance of the workflow step.final String
message()
The output message from the specified runtime instance of the workflow step, if applicable.final String
name()
The name of the specified runtime instance of the workflow step.final String
The action to perform if the workflow step fails.final String
outputs()
The file names that the specified runtime version of the workflow step created as output.final String
The request ID that uniquely identifies this request.Reports on the rollback status of the specified runtime version of the workflow step, if applicable.final String
Reports on the rollback status of the specified runtime version of the workflow step, if applicable.static Class
<? extends GetWorkflowStepExecutionResponse.Builder> final String
The timestamp when the specified runtime version of the workflow step started.status()
The current status for the specified runtime version of the workflow step.final String
The current status for the specified runtime version of the workflow step.final String
The unique identifier for the runtime version of the workflow step that you specified in the request.final Integer
The maximum duration in seconds for this step to complete its action.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 String
The Amazon Resource Name (ARN) of the build version for the Image Builder workflow resource that defines this workflow step.final String
The unique identifier that Image Builder assigned to keep track of runtime details when it ran the workflow.Methods inherited from class software.amazon.awssdk.services.imagebuilder.model.ImagebuilderResponse
responseMetadata
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
requestId
The request ID that uniquely identifies this request.
- Returns:
- The request ID that uniquely identifies this request.
-
stepExecutionId
The unique identifier for the runtime version of the workflow step that you specified in the request.
- Returns:
- The unique identifier for the runtime version of the workflow step that you specified in the request.
-
workflowBuildVersionArn
The Amazon Resource Name (ARN) of the build version for the Image Builder workflow resource that defines this workflow step.
- Returns:
- The Amazon Resource Name (ARN) of the build version for the Image Builder workflow resource that defines this workflow step.
-
workflowExecutionId
The unique identifier that Image Builder assigned to keep track of runtime details when it ran the workflow.
- Returns:
- The unique identifier that Image Builder assigned to keep track of runtime details when it ran the workflow.
-
imageBuildVersionArn
The Amazon Resource Name (ARN) of the image resource build version that the specified runtime instance of the workflow step creates.
- Returns:
- The Amazon Resource Name (ARN) of the image resource build version that the specified runtime instance of the workflow step creates.
-
name
The name of the specified runtime instance of the workflow step.
- Returns:
- The name of the specified runtime instance of the workflow step.
-
description
Describes the specified workflow step.
- Returns:
- Describes the specified workflow step.
-
action
The name of the action that the specified step performs.
- Returns:
- The name of the action that the specified step performs.
-
status
The current status for the specified runtime version of 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:
- The current status for the specified runtime version of the workflow step.
- See Also:
-
statusAsString
The current status for the specified runtime version of 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:
- The current status for the specified runtime version of the workflow step.
- See Also:
-
rollbackStatus
Reports on the rollback status of the specified runtime version of the workflow 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 specified runtime version of the workflow step, if applicable.
- See Also:
-
rollbackStatusAsString
Reports on the rollback status of the specified runtime version of the workflow 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 specified runtime version of the workflow step, if applicable.
- See Also:
-
message
The output message from the specified runtime instance of the workflow step, if applicable.
- Returns:
- The output message from the specified runtime instance of the workflow step, if applicable.
-
inputs
Input parameters that Image Builder provided for the specified runtime instance of the workflow step.
- Returns:
- Input parameters that Image Builder provided for the specified runtime instance of the workflow step.
-
outputs
The file names that the specified runtime version of the workflow step created as output.
- Returns:
- The file names that the specified runtime version of the workflow step created as output.
-
startTime
The timestamp when the specified runtime version of the workflow step started.
- Returns:
- The timestamp when the specified runtime version of the workflow step started.
-
endTime
The timestamp when the specified runtime instance of the workflow step finished.
- Returns:
- The timestamp when the specified runtime instance of the workflow step finished.
-
onFailure
The action to perform if the workflow step fails.
- Returns:
- The action to perform if the workflow step fails.
-
timeoutSeconds
The maximum duration in seconds for this step to complete its action.
- Returns:
- The maximum duration in seconds for this step to complete its action.
-
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<GetWorkflowStepExecutionResponse.Builder,
GetWorkflowStepExecutionResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
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
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-