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
```
Describes 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)` Add a single Screenshots entry
`Step`	`clearScreenshotsEntries()` Removes all the entries added into Screenshots.
`Step`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getArtifactsUrl()` The URL to the artifact for the execution step.
`String`	`getContext()` The context for the current step.
`Date`	`getEndTime()` The end date and time of the execution step.
`String`	`getLogUrl()` The URL to the logs for the execution step.
`Map<String,String>`	`getScreenshots()` The list of screenshot URLs for the execution step, if relevant.
`Date`	`getStartTime()` The start date and time of the execution step.
`String`	`getStatus()` The status of the execution step.
`String`	`getStatusReason()` The reason for the current step status.
`String`	`getStepName()` The name of the execution step.
`String`	`getTestArtifactsUrl()` The URL to the test artifact for the execution step.
`String`	`getTestConfigUrl()` The URL to the test configuration for the execution step.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setArtifactsUrl(String artifactsUrl)` The URL to the artifact for the execution step.
`void`	`setContext(String context)` The context for the current step.
`void`	`setEndTime(Date endTime)` The end date and time of the execution step.
`void`	`setLogUrl(String logUrl)` The URL to the logs for the execution step.
`void`	`setScreenshots(Map<String,String> screenshots)` The list of screenshot URLs for the execution step, if relevant.
`void`	`setStartTime(Date startTime)` The start date and time of the execution step.
`void`	`setStatus(String status)` The status of the execution step.
`void`	`setStatusReason(String statusReason)` The reason for the current step status.
`void`	`setStepName(String stepName)` The name of the execution step.
`void`	`setTestArtifactsUrl(String testArtifactsUrl)` The URL to the test artifact for the execution step.
`void`	`setTestConfigUrl(String testConfigUrl)` The URL to the test configuration for the execution step.
`String`	`toString()` Returns a string representation of this object.
`Step`	`withArtifactsUrl(String artifactsUrl)` The URL to the artifact for the execution step.
`Step`	`withContext(String context)` The context for the current step.
`Step`	`withEndTime(Date endTime)` The end date and time of the execution step.
`Step`	`withLogUrl(String logUrl)` The URL to the logs for the execution step.
`Step`	`withScreenshots(Map<String,String> screenshots)` The list of screenshot URLs for the execution step, if relevant.
`Step`	`withStartTime(Date startTime)` The start date and time of the execution step.
`Step`	`withStatus(JobStatus status)` The status of the execution step.
`Step`	`withStatus(String status)` The status of the execution step.
`Step`	`withStatusReason(String statusReason)` The reason for the current step status.
`Step`	`withStepName(String stepName)` The name of the execution step.
`Step`	`withTestArtifactsUrl(String testArtifactsUrl)` The URL to the test artifact for the execution step.
`Step`	`withTestConfigUrl(String testConfigUrl)` The URL to the test configuration for 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)
```
    The name of the execution step.
    
    Parameters:
    
    stepName - The name of the execution step.
  - getStepName
```
public String getStepName()
```
    The name of the execution step.
    
    Returns:
    
    The name of the execution step.
  - withStepName
```
public Step withStepName(String stepName)
```
    The name of the execution step.
    
    Parameters:
    
    stepName - The 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)
```
    The start date and time of the execution step.
    
    Parameters:
    
    startTime - The start date and time of the execution step.
  - getStartTime
```
public Date getStartTime()
```
    The start date and time of the execution step.
    
    Returns:
    
    The start date and time of the execution step.
  - withStartTime
```
public Step withStartTime(Date startTime)
```
    The start date and time of the execution step.
    
    Parameters:
    
    startTime - The start date and 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)
```
    The status of the execution step.
    
    Parameters:
    
    status - The status of the execution step.
    
    See Also:
    
    JobStatus
  - getStatus
```
public String getStatus()
```
    The status of the execution step.
    
    Returns:
    
    The status of the execution step.
    
    See Also:
    
    JobStatus
  - withStatus
```
public Step withStatus(String status)
```
    The status of the execution step.
    
    Parameters:
    
    status - The 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)
```
    The status of the execution step.
    
    Parameters:
    
    status - The 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)
```
    The end date and time of the execution step.
    
    Parameters:
    
    endTime - The end date and time of the execution step.
  - getEndTime
```
public Date getEndTime()
```
    The end date and time of the execution step.
    
    Returns:
    
    The end date and time of the execution step.
  - withEndTime
```
public Step withEndTime(Date endTime)
```
    The end date and time of the execution step.
    
    Parameters:
    
    endTime - The end date and 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)
```
    The URL to the logs for the execution step.
    
    Parameters:
    
    logUrl - The URL to the logs for the execution step.
  - getLogUrl
```
public String getLogUrl()
```
    The URL to the logs for the execution step.
    
    Returns:
    
    The URL to the logs for the execution step.
  - withLogUrl
```
public Step withLogUrl(String logUrl)
```
    The URL to the logs for the execution step.
    
    Parameters:
    
    logUrl - The 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)
```
    The URL to the artifact for the execution step.
    
    Parameters:
    
    artifactsUrl - The URL to the artifact for the execution step.
  - getArtifactsUrl
```
public String getArtifactsUrl()
```
    The URL to the artifact for the execution step.
    
    Returns:
    
    The URL to the artifact for the execution step.
  - withArtifactsUrl
```
public Step withArtifactsUrl(String artifactsUrl)
```
    The URL to the artifact for the execution step.
    
    Parameters:
    
    artifactsUrl - The URL to the artifact for the execution step.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTestArtifactsUrl
```
public void setTestArtifactsUrl(String testArtifactsUrl)
```
    The URL to the test artifact for the execution step.
    
    Parameters:
    
    testArtifactsUrl - The URL to the test artifact for the execution step.
  - getTestArtifactsUrl
```
public String getTestArtifactsUrl()
```
    The URL to the test artifact for the execution step.
    
    Returns:
    
    The URL to the test artifact for the execution step.
  - withTestArtifactsUrl
```
public Step withTestArtifactsUrl(String testArtifactsUrl)
```
    The URL to the test artifact for the execution step.
    
    Parameters:
    
    testArtifactsUrl - The URL to the test artifact for the execution step.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTestConfigUrl
```
public void setTestConfigUrl(String testConfigUrl)
```
    The URL to the test configuration for the execution step.
    
    Parameters:
    
    testConfigUrl - The URL to the test configuration for the execution step.
  - getTestConfigUrl
```
public String getTestConfigUrl()
```
    The URL to the test configuration for the execution step.
    
    Returns:
    
    The URL to the test configuration for the execution step.
  - withTestConfigUrl
```
public Step withTestConfigUrl(String testConfigUrl)
```
    The URL to the test configuration for the execution step.
    
    Parameters:
    
    testConfigUrl - The URL to the test configuration 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()
```
    The list of screenshot URLs for the execution step, if relevant.
    
    Returns:
    
    The list of screenshot URLs for the execution step, if relevant.
  - setScreenshots
```
public void setScreenshots(Map<String,String> screenshots)
```
    The list of screenshot URLs for the execution step, if relevant.
    
    Parameters:
    
    screenshots - The list of screenshot URLs for the execution step, if relevant.
  - withScreenshots
```
public Step withScreenshots(Map<String,String> screenshots)
```
    The list of screenshot URLs for the execution step, if relevant.
    
    Parameters:
    
    screenshots - The 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)
```
    Add a single Screenshots entry
    
    See Also:
    
    withScreenshots(java.util.Map<java.lang.String, java.lang.String>)
  - 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 the current step status.
    
    Parameters:
    
    statusReason - The reason for the current step status.
  - getStatusReason
```
public String getStatusReason()
```
    The reason for the current step status.
    
    Returns:
    
    The reason for the current step status.
  - withStatusReason
```
public Step withStatusReason(String statusReason)
```
    The reason for the current step status.
    
    Parameters:
    
    statusReason - The reason for the 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 the current step. Includes a build image if the step is build.
    
    Parameters:
    
    context - The context for the current step. Includes a build image if the step is build.
  - getContext
```
public String getContext()
```
    The context for the current step. Includes a build image if the step is build.
    
    Returns:
    
    The context for the current step. Includes a build image if the step is build.
  - withContext
```
public Step withContext(String context)
```
    The context for the current step. Includes a build image if the step is build.
    
    Parameters:
    
    context - The context for the current step. Includes a build image if the 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.

AWS SDK for Java 1.x API Reference - 1.12.778

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

setTestArtifactsUrl

getTestArtifactsUrl

withTestArtifactsUrl

setTestConfigUrl

getTestConfigUrl

withTestConfigUrl

getScreenshots

setScreenshots

withScreenshots

addScreenshotsEntry

clearScreenshotsEntries

setStatusReason

getStatusReason

withStatusReason

setContext

getContext

withContext

toString

equals

hashCode

clone

marshall