Step (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.amplify.model.Step

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Step
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Structure for an execution step for an execution job, for an Amplify App.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Step()

Constructors
Constructor and Description
`Step()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Step`	`addScreenshotsEntry(String key, String value)`
`Step`	`clearScreenshotsEntries()` Removes all the entries added into Screenshots.
`Step`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getArtifactsUrl()` URL to the artifact for the execution step.
`String`	`getContext()` The context for current step, will include build image if step is build.
`Date`	`getEndTime()` End date/ time of the execution step.
`String`	`getLogUrl()` URL to the logs for the execution step.
`Map<String,String>`	`getScreenshots()` List of screenshot URLs for the execution step, if relevant.
`Date`	`getStartTime()` Start date/ time of the execution step.
`String`	`getStatus()` Status of the execution step.
`String`	`getStatusReason()` The reason for current step status.
`String`	`getStepName()` Name of the execution step.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setArtifactsUrl(String artifactsUrl)` URL to the artifact for the execution step.
`void`	`setContext(String context)` The context for current step, will include build image if step is build.
`void`	`setEndTime(Date endTime)` End date/ time of the execution step.
`void`	`setLogUrl(String logUrl)` URL to the logs for the execution step.
`void`	`setScreenshots(Map<String,String> screenshots)` List of screenshot URLs for the execution step, if relevant.
`void`	`setStartTime(Date startTime)` Start date/ time of the execution step.
`void`	`setStatus(String status)` Status of the execution step.
`void`	`setStatusReason(String statusReason)` The reason for current step status.
`void`	`setStepName(String stepName)` Name of the execution step.
`String`	`toString()` Returns a string representation of this object.
`Step`	`withArtifactsUrl(String artifactsUrl)` URL to the artifact for the execution step.
`Step`	`withContext(String context)` The context for current step, will include build image if step is build.
`Step`	`withEndTime(Date endTime)` End date/ time of the execution step.
`Step`	`withLogUrl(String logUrl)` URL to the logs for the execution step.
`Step`	`withScreenshots(Map<String,String> screenshots)` List of screenshot URLs for the execution step, if relevant.
`Step`	`withStartTime(Date startTime)` Start date/ time of the execution step.
`Step`	`withStatus(JobStatus status)` Status of the execution step.
`Step`	`withStatus(String status)` Status of the execution step.
`Step`	`withStatusReason(String statusReason)` The reason for current step status.
`Step`	`withStepName(String stepName)` Name of the execution step.

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

- Constructor Detail
  - Step
```
public Step()
```
- Method Detail
  - setStepName
```
public void setStepName(String stepName)
```
    Name of the execution step.
    
    Parameters:
    
    stepName - Name of the execution step.
  - getStepName
```
public String getStepName()
```
    Name of the execution step.
    
    Returns:
    
    Name of the execution step.
  - withStepName
```
public Step withStepName(String stepName)
```
    Name of the execution step.
    
    Parameters:
    
    stepName - Name of the execution step.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStartTime
```
public void setStartTime(Date startTime)
```
    Start date/ time of the execution step.
    
    Parameters:
    
    startTime - Start date/ time of the execution step.
  - getStartTime
```
public Date getStartTime()
```
    Start date/ time of the execution step.
    
    Returns:
    
    Start date/ time of the execution step.
  - withStartTime
```
public Step withStartTime(Date startTime)
```
    Start date/ time of the execution step.
    
    Parameters:
    
    startTime - Start date/ time of the execution step.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String status)
```
    Status of the execution step.
    
    Parameters:
    
    status - Status of the execution step.
    
    See Also:
    
    JobStatus
  - getStatus
```
public String getStatus()
```
    Status of the execution step.
    
    Returns:
    
    Status of the execution step.
    
    See Also:
    
    JobStatus
  - withStatus
```
public Step withStatus(String status)
```
    Status of the execution step.
    
    Parameters:
    
    status - Status of the execution step.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    JobStatus
  - withStatus
```
public Step withStatus(JobStatus status)
```
    Status of the execution step.
    
    Parameters:
    
    status - Status of the execution step.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    JobStatus
  - setEndTime
```
public void setEndTime(Date endTime)
```
    End date/ time of the execution step.
    
    Parameters:
    
    endTime - End date/ time of the execution step.
  - getEndTime
```
public Date getEndTime()
```
    End date/ time of the execution step.
    
    Returns:
    
    End date/ time of the execution step.
  - withEndTime
```
public Step withEndTime(Date endTime)
```
    End date/ time of the execution step.
    
    Parameters:
    
    endTime - End date/ time of the execution step.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLogUrl
```
public void setLogUrl(String logUrl)
```
    URL to the logs for the execution step.
    
    Parameters:
    
    logUrl - URL to the logs for the execution step.
  - getLogUrl
```
public String getLogUrl()
```
    URL to the logs for the execution step.
    
    Returns:
    
    URL to the logs for the execution step.
  - withLogUrl
```
public Step withLogUrl(String logUrl)
```
    URL to the logs for the execution step.
    
    Parameters:
    
    logUrl - URL to the logs for the execution step.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setArtifactsUrl
```
public void setArtifactsUrl(String artifactsUrl)
```
    URL to the artifact for the execution step.
    
    Parameters:
    
    artifactsUrl - URL to the artifact for the execution step.
  - getArtifactsUrl
```
public String getArtifactsUrl()
```
    URL to the artifact for the execution step.
    
    Returns:
    
    URL to the artifact for the execution step.
  - withArtifactsUrl
```
public Step withArtifactsUrl(String artifactsUrl)
```
    URL to the artifact for the execution step.
    
    Parameters:
    
    artifactsUrl - URL to the artifact for the execution step.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getScreenshots
```
public Map<String,String> getScreenshots()
```
    List of screenshot URLs for the execution step, if relevant.
    
    Returns:
    
    List of screenshot URLs for the execution step, if relevant.
  - setScreenshots
```
public void setScreenshots(Map<String,String> screenshots)
```
    List of screenshot URLs for the execution step, if relevant.
    
    Parameters:
    
    screenshots - List of screenshot URLs for the execution step, if relevant.
  - withScreenshots
```
public Step withScreenshots(Map<String,String> screenshots)
```
    List of screenshot URLs for the execution step, if relevant.
    
    Parameters:
    
    screenshots - List of screenshot URLs for the execution step, if relevant.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addScreenshotsEntry
```
public Step addScreenshotsEntry(String key,
                                String value)
```
  - clearScreenshotsEntries
```
public Step clearScreenshotsEntries()
```
    Removes all the entries added into Screenshots.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatusReason
```
public void setStatusReason(String statusReason)
```
    The reason for current step status.
    
    Parameters:
    
    statusReason - The reason for current step status.
  - getStatusReason
```
public String getStatusReason()
```
    The reason for current step status.
    
    Returns:
    
    The reason for current step status.
  - withStatusReason
```
public Step withStatusReason(String statusReason)
```
    The reason for current step status.
    
    Parameters:
    
    statusReason - The reason for current step status.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setContext
```
public void setContext(String context)
```
    The context for current step, will include build image if step is build.
    
    Parameters:
    
    context - The context for current step, will include build image if step is build.
  - getContext
```
public String getContext()
```
    The context for current step, will include build image if step is build.
    
    Returns:
    
    The context for current step, will include build image if step is build.
  - withContext
```
public Step withContext(String context)
```
    The context for current step, will include build image if step is build.
    
    Parameters:
    
    context - The context for current step, will include build image if step is build.
    
    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 Step 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 Step

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Step

Method Detail

setStepName

getStepName

withStepName

setStartTime

getStartTime

withStartTime

setStatus

getStatus

withStatus

withStatus

setEndTime

getEndTime

withEndTime

setLogUrl

getLogUrl

withLogUrl

setArtifactsUrl

getArtifactsUrl

withArtifactsUrl

getScreenshots

setScreenshots

withScreenshots

addScreenshotsEntry

clearScreenshotsEntries

setStatusReason

getStatusReason

withStatusReason

setContext

getContext

withContext

toString

equals

hashCode

clone

marshall