WorkflowExecutionMetadata (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.imagebuilder.model.WorkflowExecutionMetadata

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class WorkflowExecutionMetadata
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Metadata that includes details and status from this runtime instance of the workflow.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

WorkflowExecutionMetadata()

Constructors
Constructor and Description
`WorkflowExecutionMetadata()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`WorkflowExecutionMetadata`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getEndTime()` The timestamp when this runtime instance of the workflow finished.
`String`	`getMessage()` The runtime output message from the workflow, if applicable.
`String`	`getStartTime()` The timestamp when the runtime instance of this workflow started.
`String`	`getStatus()` The current runtime status for this workflow.
`Integer`	`getTotalStepCount()` The total number of steps in the workflow.
`Integer`	`getTotalStepsFailed()` A runtime count for the number of steps in the workflow that failed.
`Integer`	`getTotalStepsSkipped()` A runtime count for the number of steps in the workflow that were skipped.
`Integer`	`getTotalStepsSucceeded()` A runtime count for the number of steps in the workflow that ran successfully.
`String`	`getType()` Indicates what type of workflow that Image Builder ran for this runtime instance of the workflow.
`String`	`getWorkflowBuildVersionArn()` The Amazon Resource Name (ARN) of the workflow resource build version that ran.
`String`	`getWorkflowExecutionId()` Unique identifier that Image Builder assigns to keep track of runtime resources each time it runs a workflow.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setEndTime(String endTime)` The timestamp when this runtime instance of the workflow finished.
`void`	`setMessage(String message)` The runtime output message from the workflow, if applicable.
`void`	`setStartTime(String startTime)` The timestamp when the runtime instance of this workflow started.
`void`	`setStatus(String status)` The current runtime status for this workflow.
`void`	`setTotalStepCount(Integer totalStepCount)` The total number of steps in the workflow.
`void`	`setTotalStepsFailed(Integer totalStepsFailed)` A runtime count for the number of steps in the workflow that failed.
`void`	`setTotalStepsSkipped(Integer totalStepsSkipped)` A runtime count for the number of steps in the workflow that were skipped.
`void`	`setTotalStepsSucceeded(Integer totalStepsSucceeded)` A runtime count for the number of steps in the workflow that ran successfully.
`void`	`setType(String type)` Indicates what type of workflow that Image Builder ran for this runtime instance of the workflow.
`void`	`setWorkflowBuildVersionArn(String workflowBuildVersionArn)` The Amazon Resource Name (ARN) of the workflow resource build version that ran.
`void`	`setWorkflowExecutionId(String workflowExecutionId)` Unique identifier that Image Builder assigns to keep track of runtime resources each time it runs a workflow.
`String`	`toString()` Returns a string representation of this object.
`WorkflowExecutionMetadata`	`withEndTime(String endTime)` The timestamp when this runtime instance of the workflow finished.
`WorkflowExecutionMetadata`	`withMessage(String message)` The runtime output message from the workflow, if applicable.
`WorkflowExecutionMetadata`	`withStartTime(String startTime)` The timestamp when the runtime instance of this workflow started.
`WorkflowExecutionMetadata`	`withStatus(String status)` The current runtime status for this workflow.
`WorkflowExecutionMetadata`	`withStatus(WorkflowExecutionStatus status)` The current runtime status for this workflow.
`WorkflowExecutionMetadata`	`withTotalStepCount(Integer totalStepCount)` The total number of steps in the workflow.
`WorkflowExecutionMetadata`	`withTotalStepsFailed(Integer totalStepsFailed)` A runtime count for the number of steps in the workflow that failed.
`WorkflowExecutionMetadata`	`withTotalStepsSkipped(Integer totalStepsSkipped)` A runtime count for the number of steps in the workflow that were skipped.
`WorkflowExecutionMetadata`	`withTotalStepsSucceeded(Integer totalStepsSucceeded)` A runtime count for the number of steps in the workflow that ran successfully.
`WorkflowExecutionMetadata`	`withType(String type)` Indicates what type of workflow that Image Builder ran for this runtime instance of the workflow.
`WorkflowExecutionMetadata`	`withType(WorkflowType type)` Indicates what type of workflow that Image Builder ran for this runtime instance of the workflow.
`WorkflowExecutionMetadata`	`withWorkflowBuildVersionArn(String workflowBuildVersionArn)` The Amazon Resource Name (ARN) of the workflow resource build version that ran.
`WorkflowExecutionMetadata`	`withWorkflowExecutionId(String workflowExecutionId)` Unique identifier that Image Builder assigns to keep track of runtime resources each time it runs a workflow.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - WorkflowExecutionMetadata
```
public WorkflowExecutionMetadata()
```
- Method Detail
  - setWorkflowBuildVersionArn
```
public void setWorkflowBuildVersionArn(String workflowBuildVersionArn)
```
    The Amazon Resource Name (ARN) of the workflow resource build version that ran.
    
    Parameters:
    
    workflowBuildVersionArn - The Amazon Resource Name (ARN) of the workflow resource build version that ran.
  - getWorkflowBuildVersionArn
```
public String getWorkflowBuildVersionArn()
```
    The Amazon Resource Name (ARN) of the workflow resource build version that ran.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the workflow resource build version that ran.
  - withWorkflowBuildVersionArn
```
public WorkflowExecutionMetadata withWorkflowBuildVersionArn(String workflowBuildVersionArn)
```
    The Amazon Resource Name (ARN) of the workflow resource build version that ran.
    
    Parameters:
    
    workflowBuildVersionArn - The Amazon Resource Name (ARN) of the workflow resource build version that ran.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setWorkflowExecutionId
```
public void setWorkflowExecutionId(String workflowExecutionId)
```
    Unique identifier that Image Builder assigns to keep track of runtime resources each time it runs a workflow.
    
    Parameters:
    
    workflowExecutionId - Unique identifier that Image Builder assigns to keep track of runtime resources each time it runs a workflow.
  - getWorkflowExecutionId
```
public String getWorkflowExecutionId()
```
    Unique identifier that Image Builder assigns to keep track of runtime resources each time it runs a workflow.
    
    Returns:
    
    Unique identifier that Image Builder assigns to keep track of runtime resources each time it runs a workflow.
  - withWorkflowExecutionId
```
public WorkflowExecutionMetadata withWorkflowExecutionId(String workflowExecutionId)
```
    Unique identifier that Image Builder assigns to keep track of runtime resources each time it runs a workflow.
    
    Parameters:
    
    workflowExecutionId - Unique identifier that Image Builder assigns to keep track of runtime resources each time it runs a workflow.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setType
```
public void setType(String type)
```
    Indicates what type of workflow that Image Builder ran for this runtime instance of the workflow.
    
    Parameters:
    
    type - Indicates what type of workflow that Image Builder ran for this runtime instance of the workflow.
    
    See Also:
    
    WorkflowType
  - getType
```
public String getType()
```
    Indicates what type of workflow that Image Builder ran for this runtime instance of the workflow.
    
    Returns:
    
    Indicates what type of workflow that Image Builder ran for this runtime instance of the workflow.
    
    See Also:
    
    WorkflowType
  - withType
```
public WorkflowExecutionMetadata withType(String type)
```
    Indicates what type of workflow that Image Builder ran for this runtime instance of the workflow.
    
    Parameters:
    
    type - Indicates what type of workflow that Image Builder ran for this runtime instance of the workflow.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    WorkflowType
  - withType
```
public WorkflowExecutionMetadata withType(WorkflowType type)
```
    Indicates what type of workflow that Image Builder ran for this runtime instance of the workflow.
    
    Parameters:
    
    type - Indicates what type of workflow that Image Builder ran for this runtime instance of the workflow.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    WorkflowType
  - setStatus
```
public void setStatus(String status)
```
    The current runtime status for this workflow.
    
    Parameters:
    
    status - The current runtime status for this workflow.
    
    See Also:
    
    WorkflowExecutionStatus
  - getStatus
```
public String getStatus()
```
    The current runtime status for this workflow.
    
    Returns:
    
    The current runtime status for this workflow.
    
    See Also:
    
    WorkflowExecutionStatus
  - withStatus
```
public WorkflowExecutionMetadata withStatus(String status)
```
    The current runtime status for this workflow.
    
    Parameters:
    
    status - The current runtime status for this workflow.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    WorkflowExecutionStatus
  - withStatus
```
public WorkflowExecutionMetadata withStatus(WorkflowExecutionStatus status)
```
    The current runtime status for this workflow.
    
    Parameters:
    
    status - The current runtime status for this workflow.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    WorkflowExecutionStatus
  - setMessage
```
public void setMessage(String message)
```
    The runtime output message from the workflow, if applicable.
    
    Parameters:
    
    message - The runtime output message from the workflow, if applicable.
  - getMessage
```
public String getMessage()
```
    The runtime output message from the workflow, if applicable.
    
    Returns:
    
    The runtime output message from the workflow, if applicable.
  - withMessage
```
public WorkflowExecutionMetadata withMessage(String message)
```
    The runtime output message from the workflow, if applicable.
    
    Parameters:
    
    message - The runtime output message from the workflow, if applicable.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTotalStepCount
```
public void setTotalStepCount(Integer totalStepCount)
```
    The total number of steps in the workflow. This should equal the sum of the step counts for steps that succeeded, were skipped, and failed.
    
    Parameters:
    
    totalStepCount - The total number of steps in the workflow. This should equal the sum of the step counts for steps that succeeded, were skipped, and failed.
  - getTotalStepCount
```
public Integer getTotalStepCount()
```
    The total number of steps in the workflow. This should equal the sum of the step counts for steps that succeeded, were skipped, and failed.
    
    Returns:
    
    The total number of steps in the workflow. This should equal the sum of the step counts for steps that succeeded, were skipped, and failed.
  - withTotalStepCount
```
public WorkflowExecutionMetadata withTotalStepCount(Integer totalStepCount)
```
    The total number of steps in the workflow. This should equal the sum of the step counts for steps that succeeded, were skipped, and failed.
    
    Parameters:
    
    totalStepCount - The total number of steps in the workflow. This should equal the sum of the step counts for steps that succeeded, were skipped, and failed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTotalStepsSucceeded
```
public void setTotalStepsSucceeded(Integer totalStepsSucceeded)
```
    A runtime count for the number of steps in the workflow that ran successfully.
    
    Parameters:
    
    totalStepsSucceeded - A runtime count for the number of steps in the workflow that ran successfully.
  - getTotalStepsSucceeded
```
public Integer getTotalStepsSucceeded()
```
    A runtime count for the number of steps in the workflow that ran successfully.
    
    Returns:
    
    A runtime count for the number of steps in the workflow that ran successfully.
  - withTotalStepsSucceeded
```
public WorkflowExecutionMetadata withTotalStepsSucceeded(Integer totalStepsSucceeded)
```
    A runtime count for the number of steps in the workflow that ran successfully.
    
    Parameters:
    
    totalStepsSucceeded - A runtime count for the number of steps in the workflow that ran successfully.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTotalStepsFailed
```
public void setTotalStepsFailed(Integer totalStepsFailed)
```
    A runtime count for the number of steps in the workflow that failed.
    
    Parameters:
    
    totalStepsFailed - A runtime count for the number of steps in the workflow that failed.
  - getTotalStepsFailed
```
public Integer getTotalStepsFailed()
```
    A runtime count for the number of steps in the workflow that failed.
    
    Returns:
    
    A runtime count for the number of steps in the workflow that failed.
  - withTotalStepsFailed
```
public WorkflowExecutionMetadata withTotalStepsFailed(Integer totalStepsFailed)
```
    A runtime count for the number of steps in the workflow that failed.
    
    Parameters:
    
    totalStepsFailed - A runtime count for the number of steps in the workflow that failed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTotalStepsSkipped
```
public void setTotalStepsSkipped(Integer totalStepsSkipped)
```
    A runtime count for the number of steps in the workflow that were skipped.
    
    Parameters:
    
    totalStepsSkipped - A runtime count for the number of steps in the workflow that were skipped.
  - getTotalStepsSkipped
```
public Integer getTotalStepsSkipped()
```
    A runtime count for the number of steps in the workflow that were skipped.
    
    Returns:
    
    A runtime count for the number of steps in the workflow that were skipped.
  - withTotalStepsSkipped
```
public WorkflowExecutionMetadata withTotalStepsSkipped(Integer totalStepsSkipped)
```
    A runtime count for the number of steps in the workflow that were skipped.
    
    Parameters:
    
    totalStepsSkipped - A runtime count for the number of steps in the workflow that were skipped.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStartTime
```
public void setStartTime(String startTime)
```
    The timestamp when the runtime instance of this workflow started.
    
    Parameters:
    
    startTime - The timestamp when the runtime instance of this workflow started.
  - getStartTime
```
public String getStartTime()
```
    The timestamp when the runtime instance of this workflow started.
    
    Returns:
    
    The timestamp when the runtime instance of this workflow started.
  - withStartTime
```
public WorkflowExecutionMetadata withStartTime(String startTime)
```
    The timestamp when the runtime instance of this workflow started.
    
    Parameters:
    
    startTime - The timestamp when the runtime instance of this workflow started.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEndTime
```
public void setEndTime(String endTime)
```
    The timestamp when this runtime instance of the workflow finished.
    
    Parameters:
    
    endTime - The timestamp when this runtime instance of the workflow finished.
  - getEndTime
```
public String getEndTime()
```
    The timestamp when this runtime instance of the workflow finished.
    
    Returns:
    
    The timestamp when this runtime instance of the workflow finished.
  - withEndTime
```
public WorkflowExecutionMetadata withEndTime(String endTime)
```
    The timestamp when this runtime instance of the workflow finished.
    
    Parameters:
    
    endTime - The timestamp when this runtime instance of the workflow finished.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public WorkflowExecutionMetadata clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class WorkflowExecutionMetadata

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

WorkflowExecutionMetadata

Method Detail

setWorkflowBuildVersionArn

getWorkflowBuildVersionArn

withWorkflowBuildVersionArn

setWorkflowExecutionId

getWorkflowExecutionId

withWorkflowExecutionId

setType

getType

withType

withType

setStatus

getStatus

withStatus

withStatus

setMessage

getMessage

withMessage

setTotalStepCount

getTotalStepCount

withTotalStepCount

setTotalStepsSucceeded

getTotalStepsSucceeded

withTotalStepsSucceeded

setTotalStepsFailed

getTotalStepsFailed

withTotalStepsFailed

setTotalStepsSkipped

getTotalStepsSkipped

withTotalStepsSkipped

setStartTime

getStartTime

withStartTime

setEndTime

getEndTime

withEndTime

toString

equals

hashCode

clone

marshall